功能说明
通过对接阿里云内容安全检测大模型的输入输出,保障AI应用内容合法合规。
运行属性
插件执行阶段:默认阶段
插件执行优先级:300
配置说明
Name | Type | Requirement | Default | Description |
---|---|---|---|---|
serviceName | string | requried | - | 服务名 |
servicePort | string | requried | - | 服务端口 |
serviceHost | string | requried | - | 阿里云内容安全endpoint的域名 |
accessKey | string | requried | - | 阿里云AK |
secretKey | string | requried | - | 阿里云SK |
checkRequest | bool | optional | false | 检查提问内容是否合规 |
checkResponse | bool | optional | false | 检查大模型的回答内容是否合规,生效时会使流式响应变为非流式 |
requestCheckService | string | optional | llm_query_moderation | 指定阿里云内容安全用于检测输入内容的服务 |
responseCheckService | string | optional | llm_response_moderation | 指定阿里云内容安全用于检测输出内容的服务 |
requestContentJsonPath | string | optional | messages.@reverse.0.content | 指定要检测内容在请求body中的jsonpath |
responseContentJsonPath | string | optional | choices.0.message.content | 指定要检测内容在响应body中的jsonpath |
responseStreamContentJsonPath | string | optional | choices.0.delta.content | 指定要检测内容在流式响应body中的jsonpath |
denyCode | int | optional | 200 | 指定内容非法时的响应状态码 |
denyMessage | string | optional | openai格式的流失/非流式响应,回答内容为阿里云内容安全的建议回答 | 指定内容非法时的响应内容 |
配置示例
前提条件
由于插件中需要调用阿里云内容安全服务,所以需要先创建一个DNS类型的服务,例如:
检测输入内容是否合规
检测输入与输出是否合规
指定自定义内容安全检测服务
用户可能需要根据不同的场景配置不同的检测规则,该问题可通过为不同域名/路由/服务配置不同的内容安全检测服务实现。如下图所示,我们创建了一个名为 llm_query_moderation_01 的检测服务,其中的检测规则在 llm_query_moderation 之上做了一些改动:
接下来在目标域名/路由/服务级别进行以下配置,指定使用我们自定义的 llm_query_moderation_01 中的规则进行检测:
配置非openai协议(例如百炼App)
可观测
Metric
ai-security-guard 插件提供了以下监控指标:
ai_sec_request_deny
: 请求内容安全检测失败请求数ai_sec_response_deny
: 模型回答安全检测失败请求数
Trace
如果开启了链路追踪,ai-security-guard 插件会在请求 span 中添加以下 attributes:
ai_sec_risklabel
: 表示请求命中的风险类型ai_sec_deny_phase
: 表示请求被检测到风险的阶段(取值为request或者response)
请求示例
请求内容会被发送到阿里云内容安全服务进行检测,如果请求内容检测结果为非法,网关将返回形如以下的回答: