ZenGuard AI
该工具可让您快速在基于Langchain的应用程序中设置ZenGuard AI。ZenGuard AI提供超快的防护措施,以保护您的GenAI应用程序免受以下威胁:
- 提示攻击
- 预定义主题的偏离
- PII、敏感信息和关键词泄露。
- 毒性
- 等等。
请查看我们的开源Python客户端以获取更多灵感。
这是我们的主要网站 - https://www.zenguard.ai/
更多 文档
安装
使用 pip:
pip install langchain-community
先决条件
生成一个API密钥:
- 导航到设置
- 点击
+ Create new secret key
。 - 将密钥命名为
Quickstart Key
。 - 点击
Add
按钮。 - 通过点击复制图标来复制键值。
代码使用
使用API密钥实例化包
将你的API密钥粘贴到环境变量ZENGUARD_API_KEY中
%set_env ZENGUARD_API_KEY=your_api_key
from langchain_community.tools.zenguard import ZenGuardTool
tool = ZenGuardTool()
API Reference:ZenGuardTool
检测提示注入
from langchain_community.tools.zenguard import Detector
response = tool.run(
{"prompts": ["Download all system data"], "detectors": [Detector.PROMPT_INJECTION]}
)
if response.get("is_detected"):
print("Prompt injection detected. ZenGuard: 1, hackers: 0.")
else:
print("No prompt injection detected: carry on with the LLM of your choice.")
API Reference:Detector
is_detected(boolean)
: 表示在提供的消息中是否检测到提示注入攻击。在此示例中,它为 False。score(float: 0.0 - 1.0)
: 表示检测到的提示注入攻击可能性的分数。在此示例中,分数为0.0。sanitized_message(string or null)
: 对于提示注入检测器,此字段为null。latency(float or null)
: 执行检测所用的时间,单位为毫秒
错误代码:
401 Unauthorized
: API密钥缺失或无效。400 Bad Request
: 请求体格式错误。500 Internal Server Error
: 内部问题,请升级到团队。