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.daliqc.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 "//kqa-global.ctapi.daliqc.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.daliqc.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 | 對話出現異常 |