输出内容分析接口
更新时间:2024-10-16
接口描述
大模型内容安全场景中,该接口用于对底座大模型生成内容进行内容安全检测,由于大模型内容安全方案为输入安全+输出安全的多层构建方式,单独调用该接口效果无法保障,因此建议配合“输入内容分析接口”使用。
权限说明
该接口的访问权限需要进行鉴权,仅允许授权用户或客户端调用。鉴权方式为使用密钥aksk和签名sign进行验证,可在服务开通后获取。
接口鉴权按照百度智能云鉴权方式,可以在开通服务后,下载服务端sdk,注册百度智能云ak/sk,即可使用。
接口说明
服务地址
接口协议
接口遵守restful风格,基于HTTP协议,UTF-8编码
请求和响应数据格式:JSON
接口路径
URI | METHOD |
---|---|
/rcs/llm/output/analyze | POST |
请求参数
参数名 | 类型 | 是否必填 | 描述 |
---|---|---|---|
content | string | 是 | 检测内容,建议最长不超过512字符,可按段落分段请求 |
isFirst | int | 是 | 本次检测是否为首段 1: 表示是大模型输出的首段 ,2:表示不是首段,默认为1 |
reqId | string | 是 | 输入安全接口返回的 request_id,将输入和输出内容关联检测风险 |
appid | string | 否 | 应用ID:标识查询方,通过智能云控制台创建 |
templateId | string | 否 | 模板ID:管理控制台配置的策略模板的编码ID,用于生效不同的策略模板,不传则使用默认的标准策略模版 |
响应参数
参数名 | 类型 | 是否必填 | 描述 |
---|---|---|---|
request_id | string | 是 | 请求id |
ret_code | int | 是 | 返回状态码,0表示成功,非0表示失败。 |
ret_msg | string | 是 | 返回信息,包括错误信息和警告信息等。 |
ret_data | Map<String,Object> | 是 | 返回结果,包括检测结果和处理结果等。 |
data详细内容
参数名 | 类型 | 描述 |
---|---|---|
isSafe | string | 文本是否安全,0: 风险 1: 安全 |
action | int | 安全措施,0:正常, 3:首段风险-兜底回复, 6:当前段落不上屏 |
hitType | string | 一级风险分类,点击下载 |
subHitType | string | 二级风险分类,文档同上 |
hitWord | string | 命中关键词,只有命中词库时返回 |
defaultAnswer | string | 兜底回复内容,action为3时返回 |
接口示例
请求示例
POST /rcs/llm/output/analyze
Content-Type: application/json
{
"reqId":"2434f92a-6423-4033-b46b-fa4d0658e731",
"content":"我爱吃苹果",
"isFirst":1
}
返回示例-正常
{
"request_id": "2434f92a-6423-4033-b46b-fa4d0658e731",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"hitType": "",
"subHitType": "",
"action": 0,
"hitWord": "",
"isSafe": 1
}
}
返回示例-兜底回复
{
"request_id": "2434f92a-6423-4033-b46b-fa4d0658e731",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"defaultAnswer": "抱歉,作为一个人工智能语言模型,我还没有学习学会如何回答这个问题,我会继续学习,为您提供更加优质的服务。",
"hitType": "",
"subHitType": "",
"action": 3,
"hitWord": "XXX",
"isSafe": 0
}
}
返回示例-不上屏
{
"request_id": "2434f92a-6423-4033-b46b-fa4d0658e731",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"defaultAnswer": "",
"hitType": "",
"subHitType": "",
"action": 6,
"hitWord": "XXX",
"isSafe": 0
}
}