提示屏蔽API
Prompt Shield API 允许您扫描来自任何应用程序的提示和响应。您不需要使用 SecureAI 的内置聊天机器人基础设施。使用三个 REST 端点将扫描引擎集成到您自己的 LLM 管道中。 提示盾有两种使用方式:- 独立扫描 API — 下面记录的
/scan、/scan-output和/scan-conversation端点,用于您自己的 LLM 管道。 - 内联完成 — 当您调用 Chat Completion 或 OpenAI 兼容端点 时,Prompt Shield 自动运行,并且可以在每次调用时进行调整。请参阅每次调用完成时的控制。
每次调用的完成控制
当 API 密钥启用时,完成请求会自动通过 Prompt Shield 扫描输入(和输出)。您可以使用请求正文中的prompt_shield 对象覆盖单个调用的行为:
不能将
policy 与 enabled: false 组合。所应用的策略会在响应中回显(经典端点上的 metadata.prompt_shield_policy,/v1 端点上的 secureai.prompt_shield_policy)。要在不运行模型的情况下预览调用的判决,请使用策略检查。
身份验证
所有 Prompt Shield API 请求都需要Authorization 标头中的 SecureAI API 密钥:
基本网址
发布/扫描
在将单个用户提示发送给您的法学硕士之前扫描是否存在注入攻击。请求
回应
推荐的集成模式
POST /扫描输出
扫描 LLM 响应以查找妥协证据,包括系统提示泄漏、金丝雀令牌泄漏或角色漂移。请求
回应
POST /扫描对话
一次扫描整个多轮对话。这对于批量分析或评估历史对话以进行追溯检测非常有用。请求
回应
错误响应
速率限制和性能
- 正则表达式和启发式层的扫描延迟通常为 1-5 毫秒。
- 添加 ML 层会将延迟增加至 20-50 毫秒,具体取决于嵌入提供商。
- 外部 API 与您的 API 密钥分配的其余部分共享速率限制。
- 如果发动机在 30 秒内连续发生 5 次故障,断路器将返回
503响应。
在 API 密钥上启用提示屏蔽
- 转至 管理 -> API 密钥。
- 编辑用于外部调用的 API 密钥。
- 打开启用提示屏蔽。
- (可选)将 提示屏蔽灵敏度 设置为
strict、balanced或permissive。 - (可选)设置 提示屏蔽策略 以将特定策略绑定到此密钥。
- 保存。
/api/external/prompt-shield/* 请求都会通过具有配置策略的引擎。
