文档问答
wss://chatdoc.xfyun.cn/openapi/chat
对文档/知识库进行问答,流式返回
请求参数说明
在请求 URL 上带上参数:
appId
,timestamp
,signature
鉴权生成详情请参照上方鉴权认证 建立连接时,服务端会校验鉴权
#发送消息格式
- WebSocket 建立成功后,即可发送问答消息,消息格式如下:
{
"chatExtends": {
"wikiPromptTpl": "请将以下内容作为已知信息:\n<wikicontent>\n请根据以上内容回答用户的问题。\n问题:<wikiquestion>\n回答:",
"wikiFilterScore": 65,
"temperature": 0.5
},
"fileIds": ["8b1b17171212121212114fd0806"],
"messages": [
{
"role": "user",
"content": "如何理赔"
},
{
"role": "assistant",
"content": "您好,根据您提供的信息,理赔操作指引如下:\n\n1. 登录小程序,点击“理赔申请”。\n2. 选择对应保单。\n3. 上传理赔相关资料。\n4. 填写发票总金额。\n5. 填写银行账户,需精确到支行。\n6. 点击“提交”成功后,返回“理赔服务”界面,点选“理赔查询”,查看理赔进度和申请记录。\n7. 如有需要,点击“查看详情”,查看理赔详情和金额。\n\n请注意,如有严重既往症员工还请和HR部门及时报备沟通,如未及时报备,保险公司不承担相关责任。同时,索赔资料不齐全导致延迟赔付等问题也需要注意。"
},
{
"role": "user",
"content": "家属有什么福利"
}
]
}
- 参数说明:
字段名 | 类型 | 描述 | 必须 | 默认值 |
---|---|---|---|---|
fileIds | Array | 提问问题检索的文件 id 列表,必传 | Y | |
messages | Array | 问答内容列表,按时间正序,最后一条为最新提问 | Y | |
messages.role | String | user 表示是用户的问题,assistant 表示 AI 的回复 | Y | |
messages.content | String | 用户和 AI 的对话内容 | Y | |
chatExtends | Object | 大模型对话自定义扩展字段 | N | |
chatExtends.wikiPromptTpl | String | wiki 大模型问答模板,在某些场景服务默认的 prompt 回答效果不好时,业务可以考虑通过自定义 prompt 来改善。替换的问题标识,替换的文本内容标识 | N | |
chatExtends.wikiFilterScore | Float | wiki 结果分数阈值,低于这个阈值的结果丢弃。取值范围为(0,1] 参考值为:0.80非常宽松 0.82宽松 0.83标准0.84严格 0.86非常严格。服务会根据问题检索文件列表中内容相关的文段,该值设置的越高,可能丢弃的内容越多,但保留下来的内容越准确;但过高也可能导致无匹配内容 | N | 0.82 |
chatExtends.sparkWhenWithoutEmbedding | boolean | 用户问题未匹配到文档内容时,是否使用大模型兜底回答问题 | N | |
chatExtends.temperature | Float | 大模型问答时的温度,取值 0-1,temperature 越大,大模型回答随机度越高 | N |
#返回消息格式
- 客户端发送消息后,服务端处理后会返回消息,格式如下
{
"code": 0,
"content": "和指南。在此之前,我可以为您",
"fileRefer": "{\"b2de1116b590911111119d0f3dbfc8\":[3,7,8]}",
"sid": "870b299a48ba46b6b5e4dfbd99fe4497",
"status": 1
}
#返回参数说明
参数名 | 类型 | 描述 |
---|---|---|
code | Int | 错误码 ,0 标识成功 |
content | String | 错误描述 |
sid | String | 会话唯一标识 |
status | Int | 会话状态,取值为[0,1,2,99];0 代表首次结果;1 代表中间结果;2 代表最后一个结果;99 代表引用的文档及文段 |
fileRefer | String | 文档引用,status=99 的时候返回;结构是个 Map,key=文件 id,value=引用的文段列表(对应 fileTrunks 的 index) |
若返回 fileRefer 为空,提示 "抱款,在文档中没有找到与提问相关的内容,请尝试换个问题问问吧。"表示提问未匹配到文档内容,可以降低chatExtends.wikiFilterScore以降低匹配阈值,也可以开启chatExtends.sparkWhenWithoutEmbedding用大模型兜底。
请求参数
Query 参数
appId
string
可选
示例值:
xxxx
timestamp
string
可选
示例值:
xxxxxxxx
signature
string
可选
示例值:
xxxxxx
修改于 2023-12-18 06:34:36