团队文档智能问答
根据团队文档内容进行问答
请求说明
请求地址 | https://openapi.wps.cn/v7/sse/aidocs/search/gpt |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 读写智能文档库数据(用户授权) kso.aidocs.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
session_id | string | 是 | 会话id(同一个会话窗口需保持id一致,目的是为了记录该会话窗口中的对话历史记录) |
search_name | string | 是 | query词 |
qa_drive_ids | list[string] | 是 | 团队id列表 |
qa_group_names | list[string] | 是 | 团队名列表 |
qa_file_ids | list[object] | 否 | 文件id列表 |
prompt | object | 否 | 提示词 |
∟ model_parameter | dist[string]any | 否 | # 通用llm参数 "temperature" "max_tokens" "top_p" "top_k" "stop" |
∟ custom_message | string | 否 | prompt参数:替换定制提示词内容,传空或不传为以下文本内容。回答尽量使用{language}以markdown格式化输出。当存在较多的关键信息对时可以使用表格描述,无需使用代码块(如:'''markdown''')。遇到主观性问题,应提供与该问题相关的客观信息、分析框架或考虑因素,而不直接下结论。如果问题无法通过文档直接回答,但可以通过推理得出结论,模型应进行合理推理并回答,包括计算题。回答的最后不需要再次进行总结。 |
switch_markdown | bool | 否 | 是否返回markdown结果 |
请求地址示例
[POST] https://openapi.wps.cn/v7/sse/aidocs/search/gpt
响应体示例
json
data:{"code":100000,"data":{"code":800300,"dynamic":{"process_display":"正在生成答案","is_cache":false,"is_abstract":false,"intent":"qa"},"qa_drive_ids":["2366176164"],"query":"GPT-4的多模态处理能力","session_id":"ssi3TlSf2LUCVN5zI9I0eIIS2","x_request_id":"495df17f-ba3b-4ef1-a65c-a3916c33b483"},"msg":""}
event:message
data:{"code":100000,"data":{"code":800300,"dynamic":{"process_display":"正在生成答案","is_cache":false,"is_abstract":false,"answer_citations":[{"text":"GPT-4的多模态处理能力显著增强,","reply_sources":null}],"intent":"qa"},"qa_drive_ids":["2366176164"],"query":"GPT-4的多模态处理能力","session_id":"ssi3TlSf2LUCVN5zI9I0eIIS2","x_request_id":"495df17f-ba3b-4ef1-a65c-a3916c33b483"},"msg":""}
event:message
data:{"code":100000,"data":{"code":800300,"dynamic":{"process_display":"正在生成答案","is_cache":false,"is_abstract":false,"answer_citations":[{"text":"它不仅能处理文本输入,","reply_sources":null}],"intent":"qa"},"qa_drive_ids":["2366176164"],"query":"GPT-4的多模态处理能力","session_id":"ssi3TlSf2LUCVN5zI9I0eIIS2","x_request_id":"495df17f-ba3b-4ef1-a65c-a3916c33b483"},"msg":""}
event:message
data:{"code":100000,"data":{"code":100100,"dynamic":{"caution":"AI生成的内容仅供参考,请注意甄别信息准确性。","is_cache":false,"is_abstract":false,"intent":"KEYWORD"},"qa_drive_ids":[283985025],"query":"创建知识空间","relative_image_urls":["http://zhai-datas.ks3-cn-beijing.ksyun.com/docqa/test/v1/document/66a1b04dfa00030a48d2036d/2zYtpg2R_f_LltHGxTmdc2LVW4xMGhOZaqxP1IgojJw/66d66a090c8dab4ef150031a/media/1725327883395/GGoOhRiQBDMlIQWPNbDO.png.png?Expires=1726097356\u0026AWSAccessKeyId=AKLTP2nm01iKR4GUG1OE34YG\u0026Signature=3LSRgS2k6%2FO9CwVB7dKjQMNL%2F04%3D"],"result":{"files":[{"fileid":100107470668,"scr_fileid":"100107470668","mtime":-1,"link_url":"https://365.kdocs.cn/l/crjfHXQSniYE","fname":"产品操作手册.doc","pages":[{"index":0,"score":0,"paragraphs":[{"index":2,"bnd_box":{"x1":0.17495380480430034,"x2":0.8725012598689736,"x3":0.8725012598689736,"x4":0.17495380480430034,"y1":0.16492457536524527,"y2":0.16492457536524527,"y3":0.21083264045611116,"y4":0.21083264045611116},"angle":0,"ref_score":0.6262598324422022,"content":"","relative_image_url":null,"block_position":{"gcp":10,"len":45}},{"index":4,"bnd_box":{"x1":0.21073408365529986,"x2":0.8725012598689736,"x3":0.8725012598689736,"x4":0.21073408365529986,"y1":0.2671338638793206,"y2":0.2671338638793206,"y3":0.29005820168666113,"y4":0.29005820168666113},"angle":0,"ref_score":0.6262598324422022,"content":"","relative_image_url":null,"block_position":{"gcp":61,"len":17}},{"index":5,"bnd_box":{"x1":0.21073408365529986,"x2":0.8725012598689736,"x3":0.8725012598689736,"x4":0.21073408365529986,"y1":0.29011759116284597,"y2":0.29011759116284597,"y3":0.31304192897018646,"y4":0.31304192897018646},"angle":0,"ref_score":0.6262598324422022,"content":"","relative_image_url":null,"block_position":{"gcp":78,"len":17}},{"index":6,"bnd_box":{"x1":0.21073408365529986,"x2":0.8725012598689736,"x3":0.8725012598689736,"x4":0.21073408365529986,"y1":0.3131013184463713,"y2":0.3131013184463713,"y3":0.33602565625371184,"y4":0.33602565625371184},"angle":0,"ref_score":0.6262598324422022,"content":"","relative_image_url":["http://zhai-datas.ks3-cn-beijing.ksyun.com/docqa/test/v1/document/66a1b04dfa00030a48d2036d/2zYtpg2R_f_LltHGxTmdc2LVW4xMGhOZaqxP1IgojJw/66d66a090c8dab4ef150031a/media/1725327883395/GGoOhRiQBDMlIQWPNbDO.png.png?Expires=1726097356\u0026AWSAccessKeyId=AKLTP2nm01iKR4GUG1OE34YG\u0026Signature=3LSRgS2k6%2FO9CwVB7dKjQMNL%2F04%3D"],"block_position":{"gcp":95,"len":17}}],"blocks":null}],"foot_mark":1}]},"session_id":"ssi3TlSf2LUCVN5zI9I0eIIS66","x_request_id":"7090f4ce-844c-46d8-aa6d-6517611a9c96"},"msg":""}
event:message
data:{"code":100000,"data":{"code":100200,"dynamic":{"generated_query":["GPT-4相较于前代有哪些能力提升?","在解决复杂问题和ChatGPT对比中,GPT-4表现如何?","GPT-4何时发布,由哪家公司推出?"]},"qa_drive_ids":["2366176164"],"query":"GPT-4的多模态处理能力","session_id":"ssi3TlSf2LUCVN5zI9I0eIIS2","x_request_id":"495df17f-ba3b-4ef1-a65c-a3916c33b483"},"msg":""}
流式状态码详细说明
状态码 | 描述 |
---|---|
100101 | 大模型服务异常 |
100102 | 审核错误 |
100103 | 解析文档失败 |
100106 | AI网关审核未通过 |
100107 | 用户对文件无访问权限 |
100108 | 召回文档为空 |
100109 | 参数错误 |
100600 | 权益出错 |
100112 | 大模型无回答 |
100113 | 心跳保活(忽略) |
100115 | 问答服务已关闭 |
100116 | 搜索引擎服务出错 |
800100 | 正在理解问题 |
800200 | 召回片段内容 |
800300 | 答案生成 |
100100 | 答案生成结束 |
100200 | 推荐问题生成 |
响应详细说明
初始查询响应:
{
"code": 100000, // 主状态码,表示整体请求成功
"data": {
"code": 800200, // 子状态码,表示文档检索阶段
"dynamic": {
"process_display": "正在检索文档", // 当前处理阶段描述
"is_cache": false, // 是否使用缓存结果
"is_abstract": false, // 是否生成摘要
"intent": "qa" // 请求意图类型(问答类)
},
"qa_drive_ids": ["2366176164"], // 关联的知识库ID
"session_id": "ssi3TlSf2LUCVN5zI9I0eIIS2", // 会话唯一标识
"x_request_id": "495df17f-ba3b-4ef1-a65c-a3916c33b483" // 请求唯一标识
}
}
文档召回内容(核心段落结构示例):
"recall_content": [
{
"score": 0.6428, // 相关性评分(0-1)
"file_meta": {
"fileid": 315743139990, // 内部文件ID
"scr_fileid": "315743139990", // 原始文件ID
"mtime": 1721958441, // 文件修改时间戳
"link_url": "https://kdocs.cn/l/cglJ1sCrIH2q", // 文档源链接
"fname": "OpenAI发布GPT-4,大模型的发展进入新的里程碑.pdf" // 文件名
},
"paragraphs": [
{
"bnd_box": { // 内部参数请忽略
"x1": 0.0183, "y1": 0.0448,
"x2": 0.0445, "y2": 0.0448,
"x3": 0.0445, "y3": 0.8091,
"x4": 0.0183, "y4": 0.8091
},
"content": "行业报告行业点评证券研究报告", // 提取的文本内容
"relative_image_url": [...] // 关联图片URL(含签名参数)
}
]
}
]
答案生成阶段
{
"code": 800300, // 子状态码,表示答案生成阶段
"dynamic": {
"answer_citations": [
{
"text": "GPT-4的多模态处理能力显著增强,", // 引用文本片段
"reply_sources": null // 引用来源
}
]
}
}
后续推荐问题
"generated_query": [
"GPT-4相较于前代有哪些能力提升?", // 推荐问题(追问)
"在解决复杂问题和ChatGPT对比中,GPT-4表现如何?",
"GPT-4何时发布,由哪家公司推出?"
]