1、接口描述
依据知识库与大模型进行对话问答
2、请求方法
POST
3、接口要求
无
4、URI
/openapi/v1/rag/talk
5、请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| Content-Type | 是 | String | json格式 | application/json | |
| tenantId | 是 | String | 租户ID | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪 | 33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 | 20211221T163014Z | |
| host | 是 | String | 终端节点域名，固定字段 | kqa-global.ctapi.ctyun.cn | |
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| text | 是 | String | 问题的文本内容 | - | |
| infobaseIds | 是 | Array | 文档库ID列表 | - | |
| modelId | 是 | String | 模型ID | ||
| contextId | 否 | String | 上一轮会话的ID，需要多轮对话时使用 | ||
| searchEnable | 否 | Boolean | 是否开启联网搜索 |
6、请求代码示例
Curl -X POST "https://kqa-global.ctapi.ctyun.cn/openapi/v1/rag/talk"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "tenantId:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:kqa-global.ctapi.ctyun.cn"
--data '{
"text": "总结下文档内容",
"infobaseIds": [123456789, 987654321],
"modelId": "d5f09a41d4584715a5d94a4892411c0f",
"searchEnable": false
}'
7、返回值说明
1.请求成功返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | 是 | String | 返回状态，返回200表示成功 | 200 | |
| message | 是 | String | 返回Success | Success | |
| returnObj | 是 | Object | 接口返回结果 | returnObj表 |
2. returnObj表
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| code | 是 | Int | 0表示成功 | 0 | |
| message | 是 | String | 返回success | success | |
| result | 是 | Object | 对话结果 | result表 |
3. result表
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| input | 是 | String | 对话输入文本 | 介绍下定积分 | |
| output | 是 | String | 对话输出文本 | 定积分是一种.... | |
| contextId | 是 | String | 此轮对话的ID |
4.请求失败返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | 是 | String | 错误码，放置API对应的错误码 | 40001 | |
| message | 是 | String | 失败信息 | 缺少鉴权信息 | |
| error | 是 | String | 返回对应的错误码 | KQA_40001 | |
| statusCode | 是 | String | 错误码，放置API对应的错误码 | 40001 |
8、返回值示例
该接口为SSE接口，返回值为流式返回，返回时Content-Type为text/event-stream。
1.请求成功返回值示例
data:{
'statusCode': 200,
'message': 'Success',
'returnObj': {
'code': 200,
'message': 'success',
'result': {
'input': '介绍下定积分',
'output': '定积分是一种....',
'contextId': 'demoa3c7-8523-446f-9116-cd67b3dd34fc'
}
}
}
2.请求失败返回值示例
data:{
"statusCode": "40004",
"error": "KQA_40004",
"message": "接口执行异常"
}
9、状态码
| http状态码 | 描述 |
| 200 | 表示请求成功 |
10、错误码说明
| 错误码 | 错误信息 | 错误描述 |
| 40013 | 对话出现异常 |
