ZenGuard AI
此工具可让您快速将 ZenGuard AI 设置到您的 Langchain 驱动应用程序中。ZenGuard AI 提供超高速防护栏,以保护您的 GenAI 应用程序免受以下问题:
- 提示攻击
- 偏离预定义主题
- 个人身份信息、敏感信息和关键词泄露。
- 毒性
- 等等。
此外,请查看我们的 开源 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 参考: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): 对于提示注入检测器,此字段为 null。
- latency(float or null): 执行检测所花费的时间(毫秒)
错误代码
- 401 Unauthorized: API 密钥缺失或无效。
- 400 Bad Request: 请求正文格式错误。
- 500 Internal Server Error: 内部问题,请上报团队。