接口描述

依据知识库与大模型进行对话问答

请求方法

POST

接口要求

无

URI
/openapi/v1/rag/talk                

请求参数

请求头header参数

请求体body参数

请求代码示例

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,
		"index": true,
    	"prompt": "请依据文档内容进行回答，不得使用超出文档内容的知识；\n- 确保您的回答既精确又实用且忠实于原文，同时覆盖所有相关的要点，以满足用户的查询需求；\n- 要求语句通顺，条理清晰，易于阅读；\n- 请不要随意发散，尽量以原文档内容输出；\n- 对于包含多个子问题的问题，请回答每一个子问题，不要遗漏问题；  \n下面是文档信息：\n{chunks}\n问题为：{question}\n开始回答：\n"
  }'

返回值说明

1.请求成功返回响应参数

returnObj表

result表

indexInfo表

inferSource表

2.请求失败返回响应参数

返回值示例

该接口为SSE接口，返回值为流式返回，返回时Content-Type为text/event-stream。

1.请求成功返回值示例（关闭引用开关index=false）

data:{     
	'statusCode': 200,          
    "error": null,
    "message": "Success",
    "returnObj": {
        "code": 0,
        "message": "success",
        "result": {
            "input": "水泥的国标",
            "output": "<think>\n好的，我现在需要处理用户的问题：“水泥的国标”。首先。。。",
            "finishState": "stop",
            "contextId": "2f963a77-e58b-467e-ad92-23ddf2e4015b",
            "inferSource": [
                {
                    "fileName": "筑府办函xx号附件.wps",
                    "fileId": 32432,
                    "fileType": "doc",
                    "contentText": "xxx",
                    "score": 0.37754068
                }
            ],
            "indexInfo": []
        },
        "details": null
    }
}

2.请求成功返回值示例（开启引用开关index=true）

data:{
    "statusCode": 200,
    "error": null,
    "message": "Success",
    "returnObj": {
        "code": 0,
        "message": "success",
        "result": {
            "input": "水泥的国标",
            "output": "根据提供的文档内容，水泥的参考标准为**GB 16780**[[1]]。。。",
            "finishState": "stop",
            "contextId": "bcca2bb9-5b45-4d41-b9b8-78a24659b3d5",
            "inferSource": [],
            "indexInfo": [
                {
                    "indexId": 1,
                    "subTitle": "",
                    "docTitle": "筑府办函xx号附件.wps",
                    "from": "Knowledge",
                    "content": "xxx",
                    "fileName": "筑府办函xx号附件.wps",
                    "fileId": 32432
                }
            ]
        },
        "details": null
	}
}

3.请求失败返回值示例   

data:{
      "statusCode": "40004",
      "error": "KQA_40004",
      "message": "接口执行异常"
}

状态码

错误码说明