ZenGuard AI
此工具可让您在基于 Langchain 的应用程序中快速设置ZenGuard AI。ZenGuard AI 提供超快速的护栏，以保护您的 GenAI 应用程序免受
- 提示攻击
- 偏离预定义主题
- PII、敏感信息和关键字泄露。
- 毒性
- 等等。
此外，请查看我们的开源 Python 客户端，以获取更多灵感。
这是我们的主网站 - https://www.zenguard.ai/
更多文档
安装
使用 pip
pip install langchain-community
先决条件
生成 API 密钥
- 导航到设置
- 点击
+ 创建新的密钥。 - 将密钥命名为
Quickstart Key。 - 点击
添加按钮。 - 通过点击复制图标复制密钥值。
代码用法
使用 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(布尔值)：指示在提供的消息中是否检测到提示注入攻击。在此示例中，它是 False。score(浮点数：0.0 - 1.0)：表示检测到的提示注入攻击可能性的分数。在此示例中，它是 0.0。sanitized_message(字符串或 null)：对于提示注入检测器，此字段为 null。latency(浮点数或 null)：执行检测所用的时间（毫秒）
错误代码
401 未授权：API 密钥丢失或无效。400 错误请求：请求正文格式错误。500 内部服务器错误：内部问题，请联系团队。