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 密钥粘贴到 env ZENGUARD_API_KEY 中
%set_env ZENGUARD_API_KEY=your_api_key
from langchain_community.tools.zenguard import ZenGuardTool
tool = ZenGuardTool()
API 参考：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 参考：Detector
is_detected(boolean)：指示在提供的消息中是否检测到提示词注入攻击。在本例中，为 False。score(float: 0.0 - 1.0)：表示检测到的提示词注入攻击可能性的分数。在本例中，为 0.0。sanitized_message(string or null)：对于提示词注入检测器，此字段为空。latency(float or null)：执行检测所花费的时间，以毫秒为单位
错误代码
401 Unauthorized：API 密钥缺失或无效。400 Bad Request：请求体格式错误。500 Internal Server Error：内部问题，请上报给团队。