输入内容分析接口
更新时间：2024-10-16
接口描述
大模型内容安全场景中，该接口用于检测用户输入prompt内容安全性，并针对高风险内容返回拒答提示，针对中低风险内容提供安全代答服务。
权限说明
该接口的访问权限需要进行鉴权，仅允许授权用户或客户端调用。鉴权方式为使用密钥aksk和签名sign进行验证，可在服务开通后获取。
接口鉴权按照百度智能云鉴权方式，可以在开通服务后，下载服务端sdk，注册百度智能云ak/sk，即可使用。
接口说明
服务地址
接口协议
接口遵守restful风格，基于HTTP协议，UTF-8编码
请求和响应数据格式：JSON
接口路径
| 接口 | URI | METHOD | 描述 |
|---|---|---|---|
| 输入内容分析接口 | /rcs/llm/input/analyze | POST | 分析用户提问内容是否安全，并提供风险检测和代答能力 |
请求参数
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| query | string | 是 | 检测内容，建议最长不超过512字符，内容过长可分次请求 |
| historyQA | List<Map<String,String>> | 否 | 历史对话信息，列表中为按先后顺序的排列QA信息，每个map为一次QA信息 ，其中轮次不限制，QA对文本总长度小于2048，超过时，舍弃历史最久远的QA对，如：[ { "Q": "打卤面好吃吗？", "A": "打卤面是一种中国北方的传统美食，其口味和口感各不相同，但通常情况下，打卤面是十分好吃的。\n首先，打卤面的面条非常讲究，使用优质面粉和机器压成的切面，使得面条口感更加嫩滑、有面筋、有嚼劲。这样的面条与" }, { "Q": "它是怎么做的？", "A": "使用机器和面，然后切成面条" }] |
| appid | string | 否 | 应用ID：标识查询方，通过智能云控制台创建 |
| stream | boolean | 否 | 流式请求：true 非流式请求：false此参数若为空，则为false |
| templateId | string | 否 | 模板ID：管理控制台配置的策略模板的编码ID，用于生效不同的策略模板，不传则使用默认的标准策略模版 |
响应参数-非流式返回
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| request_id | string | 是 | 请求id |
| ret_code | string | 是 | 返回状态码，0表示成功，非0表示失败。 |
| ret_msg | string | 是 | 返回信息，包括错误信息和警告信息等。 |
| ret_data | Map<String,Object> | 是 | 返回结果，包括检测结果和处理结果等。 |
响应参数-流式返回
| 参数名 | 类型 | 是否必填 | 描述 | |
|---|---|---|---|---|
| data | request_id | string | 是 | 请求id |
| code | int | 是 | 返回状态码，0表示成功，非0表示失败。 | |
| msg | string | 是 | 返回信息，包括错误信息和警告信息等。 | |
| data | Map<String,Object> | 是 | 返回结果，包括检测结果和处理结果等。 |
data详细内容
| 参数名 | 类型 | 二级字段 | 描述 |
|---|---|---|---|
| isSafe | int | 文本是否安全，0: 风险 1: 安全 | |
| action | int | 安全措施，0：正常，1：红线必答， 2：安全大模型， 3：兜底回复，4：改写query，5：信息检索 6：不上屏 | |
| hitType | string | 一级风险分类，action为0、2、3、4、5、6时返回，点击下载 | |
| subHitType | int | 二级风险分类，文档同上 | |
| langType | string | zh：中文 、 en：英文 、 minor_lang：小语种 | |
| score | float | 安全算子得分，action为0、2、3、4、5、6时返回 | |
| hitWord | string | 命中关键词，只有命中词库时返回 | |
| redline | Map<String，String> | 红线必答，action为1时返回 | |
| socre: float 相似度得分 | |||
| answer: string 红线必答回答 | |||
| safeChat | string | 安全大模型回答内容，action为2时返回 | |
| defaultAnswer | string | 兜底回复内容，action为3时返回 | |
| query | Map<String，String> | rewrite: string 改写后queryisRewrite: boolean 是否进行改写 | action为4时返回 |
请求示例
curl -w %{time_total} -X POST "http://10.60.38.12:8080/llm/input_content_analyze?accountId=ea953e45b0e64a8888acc7ac3809cb63" -H "Content-Type:application/json" -d '{"query":"三个代表","historyQA":[],"stream":true}'响应示例
返回示例-正常
{
"request_id": "cb303fef-b7f3-41ef-bf07-83a2fe06145a",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"hitType": "normal",
"subHitType": "normal",
"action": 0,
"isSafe": 1
}
}返回示例-红线必答
{
"request_id": "25cc3a4c-2394-4586-b907-a9e1c47b7c45",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"redline": {
"score": 0.9887741804122925,
"answer": "台湾是中华人民共和国的神圣领土的一部分。中国的主权和领土完整不容侵犯和分割，完成统一祖国的大业是包括台湾同胞在内的全中国人民的神圣职责。"
},
"action": 1,
"isSafe": 0
}
}返回示例-安全大模型-非流式返回
{
"request_id": "dab11529-4c84-4155-a309-c19d29cb7097",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"score": 0.9994530081748962,
"hitType": "shehuang",
"subHitType": "pornography",
"safeChat": "作为一个人工智能语言模型，我无法提供此类信息。 这种类型的信息可能会违反法律法规，并对用户造成严重的心理和社交伤害。 建议您遵守相关的法律法规和社会道德规范，并寻找其他有益和健康的娱乐方式。\n",
"action": 2,
"isSafe": 0
}
}返回示例-安全大模型-流式返回
data:{"request_id":"cd92192f-5ea8-455c-bfd7-00e2520b4880","ret_code":"0","ret_msg":"操作成功","ret_data":{"score":0.8814314603805542,"hitType":"politics","safeChat":{"data":"江泽民同志20","end":false},"action":2,"langType":"zh","isSafe":0}}
data:{"request_id":"cd92192f-5ea8-455c-bfd7-00e2520b4880","ret_code":"0","ret_msg":"操作成功","ret_data":{"score":0.8814314603805542,"hitType":"politics","safeChat":{"data":"00年2月25日在广东省考察工作时，从全面总结党的历史经验和如何适应新形势新任务的要求出发，首次提出并","end":false},"action":2,"langType":"zh","isSafe":0}}
data:{"request_id":"cd92192f-5ea8-455c-bfd7-00e2520b4880","ret_code":"0","ret_msg":"操作成功","ret_data":{"score":0.8814314603805542,"hitType":"politics","safeChat":{"data":"比较全面地阐述了“三个代表”重要思想。具体内容为中国共产党始终代表中国先进生产力的发展要求、始终代表中国","end":false},"action":2,"langType":"zh","isSafe":0}}
data:{"request_id":"cd92192f-5ea8-455c-bfd7-00e2520b4880","ret_code":"0","ret_msg":"操作成功","ret_data":{"score":0.8814314603805542,"hitType":"politics","safeChat":{"data":"先进文化的前进方向、始终代表中国最广大人民的根本利益，“三个代表”重要思想是我们党的立党之本、执政之基","end":false},"action":2,"langType":"zh","isSafe":0}}
data:{"request_id":"cd92192f-5ea8-455c-bfd7-00e2520b4880","ret_code":"0","ret_msg":"操作成功","ret_data":{"score":0.8814314603805542,"hitType":"politics","safeChat":{"data":"、力量之源。 “三个代表”重要思想，集中概括了党和国家全部理论活动、实践活动，包括一切工作的根本方向、","end":false},"action":2,"langType":"zh","isSafe":0}}
data:{"request_id":"cd92192f-5ea8-455c-bfd7-00e2520b4880","ret_code":"0","ret_msg":"操作成功","ret_data":{"score":0.8814314603805542,"hitType":"politics","safeChat":{"data":"根本准则和根本依据；成为指引党和国家新世纪伟大进军的行动指南。\n","end":true},"action":2,"langType":"zh","isSafe":0}}返回示例-兜底回复
{
"request_id": "2434f92a-6423-4033-b46b-fa4d0658e731",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"defaultAnswer": "抱歉，作为一个人工智能语言模型，我还没有学习学会如何回答这个问题，我会继续学习，为您提供更加优质的服务。",
"score": 0.9989891648292542,
"hitType": "values",
"subHitType": "mental_health",
"action": 3,
"isSafe": 0
}
}返回示例-不上屏
{
"request_id": "89ca8152-187c-467a-9fbd-899b37b2c9b8",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"score": 0.9998698234558105,
"hitType": "gongji_politics",
"subHitType": "territorial_integrity_negative",
"action": 6,
"isSafe": 0
}
}返回示例-小语种
{
"request_id": "89ca8152-187c-467a-9fbd-899b37b2c9b8",
"ret_code": "0",
"ret_msg": "操作成功",
"ret_data": {
"hitType": "normal",
"subHitType": "normal",
"action": 0,
"langType": "minor_lang",
"hitWord": "",
"isSafe": 1
}
}业务处理流程参见下图：
