StreamQuery - 流式对话
更新时间:2025-05-09
API访问域名
请求方式 | POST | 说明 |
---|---|---|
online base url | https://keyue.cloud.baidu.com/online | AI客服发布后的请求地址 |
offline base url | https://keyue.cloud.baidu.com | AI客服测试调试地址 |
后缀接口 | /core/v5/stream/query | |
Authentication | token为API Key |
说明
在流式对话模式中,系统会返回多个chunk(片段)返回。每一个 chunk 可能包含最终答案的一部分内容,系统在生成部分内容之时就将其传递给用户,而不必等到完整答案全部生成完毕。在该模式中,系统在逐步产出回答的过程里,同步地将回答的一部分逐次发送给用户,以此确保较为快速的首字输出,确保交互的即时性。
适用场景:
- 要求快速响应的场景:适用于实时互动场景,如在线游戏的客服支持或者商家的售后客服支持,客服需要对用户提出的问题及时反馈。
- 不依赖完整答案进行决策的场景:若用户仅查询一些简单信息,而无需完整分析时,可使用流式对话。
流式对话多次返回示例:
请求示例
Bash
1curl --location 'https://keyue.cloud.baidu.com/online/core/v5/stream/query'
2--header 'token: xxxx'
3--header 'Content-Type: application/json'
4--data '{
5 "queryText": "帮我写一首爱情的诗",
6 "sessionId": "a5abab29-cf1a-4ff6-be0e-8bc10e9d9152",
7 "multimodal": [
8 {
9 "fileKey": "xxxx",
10 "type": "1"
11 }
12 ],
13 "variables": {
14 "homeAddress": "chengdu"
15 }
16}'
返回示例
请求参数
Header参数
名称 | 类型 | 必选 | 中文名 | 说明 |
---|---|---|---|---|
Content-Type | string | 是 | 内容类型 | 固定值:application/json |
token | string | 是 | API KEY | 集成-API-API Key处获取。 详细获取方式参考:准备工作 |
Body参数
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
uid | string | 否 | 用户id | |
username | string | 否 | 用户名称 | |
stream | boolean | 否 | 流式接口开关 | false 关,true 开 |
startId | string | 否 | 节点id | 对话测试时使用,执行指定的节点id。和topicId配合使用 |
queryText | string | 否 | 用户问题 | 请求的问题,比如示例中的:你好 |
queryTime | string | 否 | 用户提问的时间 | 用户发起请求的时间 |
sessionId | string | 否 | 会话id | 首轮可以为空(如果首轮传了,后续需要使用首轮传的。),首轮会返回sessionId,后续对话需使用返回的sessionId |
topicId | string | 否 | 主题id | 对话测试时使用,执行指定的topic,和nodeId配合使用 |
variables | object | 否 | 变量 | Map格式,key 是变量名称,value是变量值。对话中使用的变量,如果传了会覆盖当前中对话中已有的变量值 |
agentId | string | 否 | 客服机器人id | 客服机器人的唯一标识 |
tenantId | string | 否 | 租户id | 租户的唯一标识 |
queryId | string | 否 | 对话id | 同一个sessionid内,每次对话都有一个对应的queryid |
ext | object | 否 | ||
engines | array | 否 | 使用的对话引擎 | String类型,FAQ("faq", "知识库-FAQ"),DOC_QA("docQa", "知识库-文档问答"),TASK_FLOW("taskflow", "流程画布"),TASK_BASED("task_based", "意图识别"),为null 或taskflow是支持所有引擎 可能增加新的枚举类型,请提前做好兼容适配 |
channel | string | 否 | 渠道 | 渠道管理中的渠道标识,传递该参数,可以命中FAQ中配置的条件答案 |
persona | object | 否 | 用户画像 | 快捷场景agent的用户画像 |
multimodal | List[multimodal] | 否 | 多模态输入 | 当前支持图片,不能单独使用,需要和queryText 一起传递,目前仅标准版支持,详见 multimodal 子数据 |
button | object | 否 | 按钮 | 按钮步骤会回复所有按钮的id,名称集合,点击按钮时需传递该字段,详见 button 子数据 |
chatSessionLatitudeSwitch | boolean | 否 | 单次session闲聊 | 该字段控制单次session闲聊是否开启,默认值:true |
knowledgeLabelList | list[string] | 否 | 知识库标签 | 知识库标签Id列表(高优先级),knowledgeLabelList 生效优先级大于 knowledgeLabelValue |
knowledgeLabelValue | map | 否 | 知识库标签 | 知识库标签值Map(低优先级)Map<String, List {"标签名1": ["标签值1", "标签值2"],"标签名2": ["标签值1", "标签值2"]} |
knowledgeBaseSettingVo | object | 否 | 知识库 agent 设置 | 用于知识库 agent 设置,详见knowledgeBaseSettingVo子数据 |
forcedEntries | object | 否 | 强制实体值 | 强制实体值,该实体值将会覆盖抽取到的实体值 |
multimodal子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
fileKey | string | 是 | 文件唯一标识 | 使用Upload-图片上传接口上传后返回的key |
type | string | 是 | 文件类型 | 1 :图片,目前只支持图片,上传一张图片 可能增加新的枚举类型,请提前做好兼容适配 |
button子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
id | string | 是 | 按钮id | 按钮的唯一标识 |
name | string | 是 | 按钮名称 | 按钮的名称 |
knowledgeBaseSettingVo子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
llm | object | 否 | 模型设置 | 详见 llm 子数据 |
knowledgeSearch | object | 否 | 知识检索设置 | 详见 knowledgeSearch 子数据 |
showSource | object | 否 | 来源展示 | 详见 showSource 子数据 |
faqLlm | object | 否 | FAQ大模型回复 | 详见 faqLlm 子数据 |
complexQuery | object | 否 | 复杂问题识别 | 详见 complexQuery 子数据 |
llm 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
temperature | float | 否 | 文本多样性参数 | 控制模型生成文本多样性的参数。较高的温度值(例如1.0)会使生成的文本更加随机和多样化,而较低的值(例如0.2)会使生成的文本更加确定和保守。 |
system | string | 否 | 人设 | 用于设置客服机器人的基础人设,以便回复的内容更符合 |
styleId | string | 否 | 回复风格id | 回复风格的ID,可根据需要创建不同的回复风格,此处填写创建风格后返回的ID |
name | string | 否 | 风格名称 | 回复风格的名称,方便区分。创建后可编辑 |
description | string | 否 | 风格描述 | 回复风格的描述,用于消息说明该回复风格。创建后可编辑。 |
promptOpen | string | 否 | 自定义文档知识prompt开关 | 0:关,1 :开 |
prompt | list[prompt] | 否 | 自定义prompt | 设置客服机器人根据文档知识回答客户的回复prompt,详见 prompt 子数据 |
prompt子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
type | string | 否 | 类型 | variable 为变量,text 为文本 |
value | string | 否 | 值 | 当类型为 variable 时,value 可填写已经设置好的变量(只写变量名即可),如 persona、style |
knowledgeSearch 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
document | double | 否 | 文档检索置信度 | 用于筛选文档知识的置信度阈值,大于等于此阈值则被召回 |
faq | double | 否 | FAQ检索置信度 | 用于筛选FAQ知识的置信度阈值,大于等于此阈值则被召回 |
documentCount | int | 否 | 文档检索分段数 | 用于设定与用户问题相关且置信度超过设定文档检索置信度的最大文档片段数量 |
showSource 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
open | int | 否 | 来源展示 | 0:关,1:开 |
faqLlm 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
open | int | 否 | 开关 | 0:关,1:开 |
type | int | 否 | 回复方式 | 1:风格回复,2:大模型总结 |
complexQuery 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
open | int | 否 | 开关 | 0:关,1:开 |
响应参数
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
sessionId | string | 是 | 会话ID | 用于标识本轮会话的唯一ID |
queryId | string | 是 | 查询ID | 用于标识本次会话的唯一ID |
replyStatus | int | 是 | 回复状态 | 回复状态, 默认成功 SUCCESS(200, "成功"); FAIL(4008001, "失败");QPS_LIMITED(4008002, "QPS超限"); 可能增加新的枚举类型,请提前做好兼容适配 |
answer | List[answer] | 是 | 回答列表 | 包含各个回答块的数组,详见 answer 子数据 |
variables | map | 是 | 变量 | Map<String, Object>存储会话期间的各种变量信息 |
endTime | string | 否 | 结束时间 | 会话结束时间 |
recommendList | array | 是 | 推荐列表 | 提供可能的操作或信息的推荐列表 |
rewriteQuery | string | 是 | 重写查询 | 用户输入的重写版本 |
intent | List[intent] | 是 | 意图 | 列出此次会话涉及的意图,详见 intent 子数据 |
replyInfo | object | 否 | 回复信息 | 回复相关信息,详见 replyInfo 子数据 |
needIgnoreDialogHistory | Boolean | 是 | 忽略对话历史开关 | 是否需要忽略对话历史 |
agentType | int | 是 | agent类型 | agent类型: 1, 普通agent ; 2, AI agent 可能增加新的枚举类型,请提前做好兼容适配 |
qps | int | 是 | qps | 当轮对话的qps |
totalTokens | int | 是 | 消耗token数 | 当轮会话消耗的总token数 |
statisticsInfoMap | map<string, object> | 是 | 统计信息 | 详见 statisticsInfoMap 子数据 |
firstChunkTime | float | 是 | 首字耗时(秒) | 流式返回下首字耗时(秒) |
instructionList | array | 否 | 指令收集列表 | 收集用户触发的指令,识别用户意图后触发特定的换作,一般是一个对话的终点。 |
answer 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
chunkId | int | 是 | 流式chunkId | 流式chunkId |
status | string | 是 | 流式返回数据状态 | RUNNING("running"); DONE("done"); 可能增加新的枚举类型,请提前做好兼容适配 |
topicId | string | 否 | 主题ID | 对应的主题ID |
blockId | string | 否 | 区块ID | 对应的区块ID |
nodeId | string | 否 | 节点ID | 对应的节点ID |
name | string | 否 | 节点名称 | |
taskFlowSolved | boolean | 否 | 任务流程是否结束 | 一个布尔值字段,用于标识当前任务流程的状态。 未完成状态 (false): 1.任务流程仍在进行中 2.信息收集不完整 3.即使在最后一个节点,如果业务逻辑未完成,依然为 false 完成状态 (true) 1.任务流程完全结束 2.所有必要的信息已收集完整 3.业务逻辑执行完毕 |
reply | object | 否 | 回复 | 包含回复相关详细信息的对象,详见 reply 子数据 |
instruction | map | 否 | 指令 | 发出指令后有值,指令详细信息Map<String, Map<String, String>>,外层key为指令标识,value为指令参数map |
statisticsInfo | object | 否 | 统计信息 | 详见 statisticsInfo 子数据 |
debugReplyType | string | 是 | debug节点类型 | |
debugNodeName | string | 否 | 节点名称 | |
debugInputParam | map | 否 | 节点输入参数 | |
debugCost | long | 否 | 节点运行时间 | |
debugResult | array | 否 | 节点输出结果 | 节点输出结果,详细结构为list<Map<string, object>> |
reply 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
type | int | 是 | 回复类型 | 1(文本)3(富文本)4(图片)8(列表) 可能增加新的枚举类型,请提前做好兼容适配 |
text | string | 是 | 文本 | 文本/富文本答案 |
textList | array | 否 | 文本列表 | 回复的文本列表 |
clarifyGuide | string | 否 | 澄清指南 | 提供澄清相关的指南和信息 |
replySource | string | 是 | 回复来源 | 各种回复来源类型:FAQ("faq", "知识库-FAQ"),DOC_QA("docQa", "知识库-文档"),TEXT_REPLY("text", "文本回复"),OPEN_URL("openUrl", "打开链接"),BUTTONS("buttons", "按钮回复"),INTENT_CLARIFY("intentClarify", "意图澄清"),LARGE_MODEL_REPLY("largeModelReply", "大模型回复"),COLLECT_SLOT_ENTITY("collectSlotEntity", "收集槽位实体"),CHITCHAT("chitchat", "闲聊"),UNMATCHED("unmatch", "未匹配固定话术"),SENSITIVE("sensitive", "敏感拒答话术"),SYSTEM("system", "系统异常"),INSTRUCTION("instruction", "指令"),TASK_BASE_BACK("taskBaseBack", "任务式会话拉回话术"),WELCOME("welcome", "开场白"),SILENT_REPLY("silentReply", "静默回复"),PLUGIN("plugin", "插件"),TABLE_QA("table_qa", "tqa-回复"),VIDEO_QA("video_qa", "知识库-视频"),CAPTURE("capture", "收集用户回复"),MULTI("multi", "多模态理解"); 可能增加新的枚举类型,请提前做好兼容适配 |
streamSuffix | string | 否 | 流式后缀 | 对流式结果进行干预,在streamText输出最后一个chunk时,追加该内容 |
showDocumentSource | boolean | 否 | 显示文档源 | 是否显示文档来源 |
documents | list[document] | 是 | 文档 | 知识问答信息,replySource是DOC_QA 该字段有值,详见 documents 子数据 |
tableQAInfo | object | 否 | tableQA相关信息 | 详见 tableQAInfo 子数据 |
docDebug | object | 否 | 文档调试 | 提供文档调试相关信息,replySource是DOC_QA 该字段有值 |
faqSearch | list[faqSearch] | 否 | faq | faq 检索信息,replySource是FAQ 该字段有值 |
slotCollectInfo | object | 否 | 实体收集信息 | 详见 slotCollectInfo 子数据 |
plugin | string | 否 | 插件 | 插件名, replySource是PLUGIN 该字段有值 |
url | string | 否 | 统一资源定位符 | 打开的URL, replySource是OPEN_URL 该字段有值 |
buttons | List[button] | 否 | 按钮列表 | replySource是BUTTONS时该字段有值,详见 buttons 子数据 |
intentName | string | 否 | 意图名 | |
searchInfoList | array | 否 | 搜索结果 | 列出所有触发闲聊联网搜索的结果 |
showWebSearchResult | integer | 否 | 是否开启展示搜索结果 | 是否开启展示搜索结果 0 不展示 1 展示 |
webSearchStatus | integer | 否 | 搜索状态 | 搜索状态 0 搜索中 1 搜索完成 |
webSearchResultCount | integer | 否 | 搜索结果数量 | 搜索结果数量 |
documents 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
document_id | string | 是 | 文档ID | 文档的唯一标识符 |
document_name | string | 是 | 文档名 | 文档的名称 |
web_url | string | 是 | 文档链接 | 文档链接,当knowledgeType是web时有值 |
video_url | string | 是 | 视频链接 | 视频链接,当knowledgeType是video时有值 |
start_timestamp_second | int | 是 | 开始时间戳(秒) | 视频开始播放的时间戳,当knowledgeType是video时有值 |
end_timestamp_second | int | 是 | 结束时间戳(秒) | 视频结束播放的时间戳,当knowledgeType是video时有值 |
knowledge_type | string | 是 | 文档类型 | 文档类型:doc 普通文档, web 网页知识,video 视频知识 |
data | list[data] | 是 | 数据 | 知识的数据内容,详见 data 子数据 |
data 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
segment_id | string | 是 | 段落ID | 段落的唯一标识符 |
segment_content | string | 是 | 段落内容 | 段落的文本内容 |
sentence_id | string | 是 | 句子ID | 句子的唯一标识符 |
sentence_content | string | 是 | 句子内容 | 句子的文本内容 |
score | string | 是 | 得分 | 段落相关性得分 |
segment_coord | string | 是 | 段落坐标 | 段落在文档中的位置坐标 |
video_url | string | 是 | 视频链接 | 视频链接,当knowledgeType是video时有值 |
knowledge_type | string | 是 | 知识类型 | 知识类型:doc 普通文档, web 网页知识,video 视频知识 可能增加新的枚举类型,请提前做好兼容适配 |
start_timestamp_second | int | 是 | 开始时间戳(秒) | 视频开始播放的时间戳,当knowledgeType是video时有值 |
end_timestamp_second | int | 是 | 结束时间戳(秒) | 视频结束播放的时间戳,当knowledgeType是video时有值 |
data | list[sentence_info] | 是 | 数据 | 段落中的句子数据,详见sentence_info子数据 |
sentence_info 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
sentence_id | string | 是 | 句子ID | 句子的唯一标识符 |
sentence_content | string | 是 | 句子内容 | 句子的文本内容 |
score | string | 是 | 得分 | 句子相关性得分 |
tableQAInfo 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
sourceCode | string | 解决方案代码 | LLM生成的解决query的代码 |
tableSelectResult | object | 选表结果 | 详见 tableSelectResult 子数据 |
tableSelectResult 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
file_name | string | 文件名 | |
table_name | string | 表名 | |
datasource_id | string | 数据源id | |
bos_url | string | bos链接地址 | |
file_id | string | 文件唯一标识 |
docDebug 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
search | list[object] | 文档查询 | 详见 search 子数据 |
search 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
agent_id | string | agent_id | |
available | string | 是否可用 | |
dir_id | string | 目录id | |
document_id | string | 文档ID | 文档的唯一标识符 |
document_name | string | 文档名 | 文档的名称 |
web_url | string | 文档链接 | 文档链接,当knowledgeType是web时有值 |
video_url | string | 视频链接 | 视频链接,当knowledgeType是video时有值 |
knowledge_type | string | 文档类型 | 文档类型:doc 普通文档, web 网页知识,video 视频知识 可能增加新的枚举类型,请提前做好兼容适配 |
env | string | 环境 | |
labels | string | 标签 | |
score | double | 召回评分 | |
segment_id | string | 段落ID | 段落的唯一标识符 |
segment_content | string | 段落内容 | 段落的文本内容 |
segment_coord | string | 段落坐标 | 段落在文档中的位置坐标 |
sentence_id | string | 句子ID | 句子的唯一标识符 |
sentence_content | string | 句子内容 | 句子的文本内容 |
sentence_type | string | 句子种类 | |
version | string | 版本 | |
start_timestamp_second | int | 开始时间戳(秒) | 视频开始播放的时间戳,当knowledgeType是video时有值 |
end_timestamp_second | int | 结束时间戳(秒) | 视频结束播放的时间戳,当knowledgeType是video时有值 |
faqSearch 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
answer | map | 回答 | |
faqId | string | 问答id | |
score | double | 置信度 | |
question | string | 标准问 | |
matchDetail | object | 匹配详情 | 详见 matchDetail子数据 |
matchDetail 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
score | double | 匹配置信度 | |
matchType | string | 匹配类型 | |
matchValue | string | 匹配内容 | |
matchId | string | 匹配信息id |
slotCollectInfo 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
waitCollectResultList | list[waitCollectResultList] | 是 | 待收集结果列表 | 列出待收集的结果,详见 waitCollectResultList / hasCollectResultList 子数据 |
hasCollectResultList | list[hasCollectResultList] | 是 | 已收集结果列表 | 列出已收集的结果,详见 waitCollectResultList / hasCollectResultList 子数据 |
waitCollectResultList / hasCollectResultList 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
name | string | 是 | 名称 | 待收集的槽名称 |
result | string | 是 | 结果 | 已收集的结果 |
option | array | 否 | 可选值 | 可选的答案 |
optionSize | int | 否 | 选项数量 | 选项数量 |
checkResult | string | 否 | 校验结果 | 校验结果 |
clarity | string | 否 | 清晰度 | 澄清话术 |
inputExample | string | 是 | 输入示例 | 输入的示例 |
outputExample | string | 是 | 输出示例 | 输出的示例 |
buttons 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
id | string | 否 | 按钮id | |
name | string | 否 | 按钮名称 |
statisticsInfo 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
nodeId | string | 节点id | |
type | string | 类型 | |
prompt | string | 提示词 | |
output | string | 输出 | |
instruction | string | 指令 | |
errorCode | int | 错误码 | |
errorMessage | string | 错误信息 | |
entityName | string | 实体名称 |
intent 子数据
名称 | 类型 | 必填 | 中文名 | 说明 |
---|---|---|---|---|
_effect | int | 是 | 影响 | 表示此意图的效果 |
id | string | 是 | ID | 意图的唯一标识 |
name | string | 是 | 名称 | 意图的名称 |
description | string | 否 | 描述 | 意图的描述 |
agentId | string | 否 | 客服机器人ID | 客服机器人的ID |
created | string | 否 | 创建时间 | 意图创建时间 |
updated | string | 否 | 更新时间 | 意图最后更新时间 |
confidence | float | 是 | 置信度 | 意图识别的置信度 |
source | string | 是 | 来源 | 意图识别的来源 |
threshold | float | 是 | 阈值 | 意图识别的阈值 |
system | boolean | 是 | 系统意图 | 是否为系统预定义的意图 |
needClarify | boolean | 是 | 需要澄清 | 是否需要澄清此意图 |
alias | string | 否 | 别名 | 意图的别名 |
nameZh | string | 是 | 中文名称 | 意图的中文名称 |
examples | List[object] | 否 | 示例 | 意图的示例,详见examples子数据 |
hasActiveCopy | boolean | 是 | 活跃副本 | 意图是否有活跃的副本 |
templateStr | string | 否 | 模板字符串 | 意图的模板字符串 |
createdUserName | string | 否 | 创建者用户名 | 创建此意图的用户的用户名 |
createdUserId | string | 否 | 创建者用户ID | 创建此意图的用户的用户ID |
lastEditUserName | string | 否 | 最后编辑用户名 | 最后编辑此意图的用户的用户名 |
lastEditUserId | string | 否 | 最后编辑用户ID | 最后编辑此意图的用户的用户ID |
version | int | 是 | 版本 | 意图的版本 |
industryIntent | boolean | 是 | 行业意图 | 是否为特定行业的意图 |
knnExampleStr | string | 是 | KNN示例字符串 | 用于KNN匹配的示例字符串 |
extra | string | 否 | 额外信息 | 包含额外信息的对象 |
recSource | string | 否 | 推荐来源 | 意图推荐的来源 |
isNoResponse | boolean | 是 | 无响应 | 是否未响应 |
examples子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
id | string | ID | 意图示例的唯一标识 |
value | string | 具体内容 | 意图示例的具体内容 |
intentId | string | 意图ID | 意图的ID |
agentId | string | 客服机器人ID | 客服机器人的ID |
created | string | 创建时间 | 意图示例的创建时间 |
updated | string | 更新时间 | 意图示例的修改时间 |
version | int | 版本 | 意图示例的版本标识 |
tokenValue | string | token值 | |
md5 | string | 加密字段 |
replyInfo 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
agentType | string | agent类型 | agent的具体类型, 可能增加新的枚举类型,请提前做好兼容适配 |
replySource | array | 回复来源 | 回复内容的来源信息, 可能增加新的枚举类型,请提前做好兼容适配 |
effectiveQa | boolean | 有效问答 | true 为有效, false 为无效 |
qaType | int | RAG类型 | RAG类型,1FAQ、2文档 可能增加新的枚举类型,请提前做好兼容适配 |
statisticsInfo 子数据
名称 | 类型 | 中文名 | 说明 |
---|---|---|---|
nodeId | string | 节点id | 节点的唯一标识 |
type | string | 类型 | |
prompt | string | 提示词 | |
output | string | 输出 | |
instruction | string | 指令 | |
errorCode | int | 错误码 | |
errorMessage | string | 错误信息 | |
entityName | string | 实体名称 | 实体的名称 |
请求示例
Bash
1curl --location --request POST 'https://keyue.cloud.baidu.com/online/core/v5/stream/query'
2--header 'token: xxxx'
3--header 'Content-Type: application/json'
4--data '{
5 "queryText": "你好",
6 "sessionId": "ecb95fcc-0e49-4ab0-b026-c20a8aac1585",
7 "multimodal": [
8 {
9 "fileKey": "xxxx",
10 "type": "1"
11 }
12 ],
13 "variables": {
14 "homeAddress": "chengdu"
15 }
16}'
响应示例
1{
2 "sessionId": "02329c01-7720-45e9-b19c-6dfacec87b81",
3 "queryId": "39ad613a-a089-4019-baa4-8f48558b5f63",
4 "replyStatus": 200,
5 "answer": [
6 {
7 "chunkId": 0,
8 "status": "done",
9 "topicId": "",
10 "blockId": "",
11 "nodeId": "",
12 "reply": null,
13 "instruction": null
14 }
15 ],
16 "variables": {
17 "last_response": "",
18 "last_user_response": "我要租车",
19 "LLM_rewrite_query": "我要租车",
20 "triggered_intent": [
21 "我要租车",
22 "我要租车"
23 ],
24 "last_intent": "我要租车"
25 },
26 "endTime": null,
27 "recommendList": [
28 "今天天气怎么样"
29 ],
30 "rewriteQuery": "我要租车",
31 "intent": [
32 {
33 "_effect": 0,
34 "id": "946f7bf7-0d29-11ef-81bf-fa20202f5a70",
35 "name": "h4f4e8f6",
36 "description": "",
37 "agentId": null,
38 "created": null,
39 "updated": null,
40 "confidence": 1.0,
41 "source": "knnExactly",
42 "threshold": 0.0,
43 "system": false,
44 "needClarify": false,
45 "alias": null,
46 "nameZh": "我要租车",
47 "examples": null,
48 "hasActiveCopy": false,
49 "templateStr": null,
50 "createdUserName": null,
51 "createdUserId": null,
52 "lastEditUserName": null,
53 "lastEditUserId": null,
54 "version": 0,
55 "industryIntent": false,
56 "knnExampleStr": "我要租车",
57 "extra": null,
58 "recSource": null,
59 "noResponse": false
60 }
61 ]
62}
1{
2 "sessionId": "948c2eef-02e4-46ff-b9d1-e38833b7764a",
3 "queryId": "f794f6fe-2483-46a6-86b8-711fd9627ff7",
4 "replyStatus": 200,
5 "answer": [{
6 "chunkId": 2,
7 "status": "done",
8 "topicId": "a52cce91-f235-4c6e-96b0-fdb026c0c09c",
9 "blockId": "xRGRfnMdWCTIxRoUtWAzqK37SuUxnur_ThW_",
10 "nodeId": "v8tdXcXokpltzHq5NrhXnNEEfjM0s6_wgQxy",
11 "reply": {
12 "type": 1,
13 "text": "这是一个文本节点",
14 "textList": null,
15 "clarifyGuide": null,
16 "replySource": "TEXT_REPLY",
17 "showDocumentSource": null,
18 "documents": null,
19 "docDebug": null,
20 "faqSearch": null,
21 "slotCollectInfo": null,
22 "instruction": null
23 },
24 "instruction": null
25 }],
26 "variables": {
27 "date": "2024-05-08",
28 "last_intent": "",
29 "week": "3",
30 "last_task_prompt": "这是一个文本节点",
31 "time": "19:28:50",
32 "last_response": "这是一个文本节点",
33 "last_user_response": ""
34 },
35 "endTime": null,
36 "recommendList": [],
37 "rewriteQuery": null,
38 "intent": null
39}
1{
2 "sessionId": "368bfd87-8613-411f-aef5-f0a64d899423",
3 "queryId": "29baf91e-844c-43d9-a967-e7ac48625f3d",
4 "replyStatus": 200,
5 "answer": [
6 {
7 "chunkId": 2,
8 "status": "done",
9 "topicId": "580f7938-b65b-4535-bd25-2d8efec3e857",
10 "blockId": "a0mdNQsd1qZ_DY2hlmaO_rgAr6CfSynPCY0V",
11 "nodeId": "t5tTlI6FOr3Sq49BDqINNARuIAov7z1FUpV8",
12 "reply": {
13 "type": 3,
14 "text": "<!DOCTYPE html>\n<html>\n<head>\n</head>\n<body>\n<p><strong>你好啊</strong></p>\n</body>\n</html>",
15 "textList": null,
16 "clarifyGuide": null,
17 "replySource": "TEXT_REPLY",
18 "showDocumentSource": null,
19 "documents": null,
20 "docDebug": null,
21 "faqSearch": null,
22 "slotCollectInfo": null
23 },
24 "instruction": null
25 }
26 ],
27 "variables": {
28 "date": "2024-06-06",
29 "last_intent": "",
30 "week": "4",
31 "last_task_prompt": "<!DOCTYPE html>\n<html>\n<head>\n</head>\n<body>\n<p><strong>你好啊</strong></p>\n</body>\n</html>",
32 "time": "10:34:48",
33 "last_response": "<!DOCTYPE html>\n<html>\n<head>\n</head>\n<body>\n<p><strong>你好啊</strong></p>\n</body>\n</html>",
34 "last_user_response": ""
35 },
36 "endTime": null,
37 "recommendList": [],
38 "rewriteQuery": null,
39 "intent": null
40}
1{
2 "sessionId": "0697c039-a3d2-4dfa-9dd6-e0f3480efecd",
3 "queryId": "41ee2b18-fa37-4900-982f-0ac7bd49289a",
4 "replyStatus": 200,
5 "answer": [{
6 "chunkId": 2,
7 "status": "done",
8 "topicId": "a52cce91-f235-4c6e-96b0-fdb026c0c09c",
9 "blockId": "l8-41S-gL7ri-zryMlFK_QX4HorFnQhFdOuC",
10 "nodeId": "TIBM8ImijKE3SXIiFX60rRP5Q37tS1TSQvr0",
11 "reply": {
12 "type": 1,
13 "text": "",
14 "textList": null,
15 "clarifyGuide": null,
16 "replySource": "LARGE_MODEL_REPLY",
17 "showDocumentSource": null,
18 "documents": null,
19 "docDebug": null,
20 "faqSearch": null,
21 "slotCollectInfo": null,
22 "instruction": null
23 },
24 "instruction": null
25 }],
26 "variables": {
27 "date": "2024-05-08",
28 "last_intent": "",
29 "week": "3",
30 "time": "19:31:28",
31 "last_response": "当然可以,以下是一首简短的诗歌:\n\n春风轻拂花,\n细雨滋养生。\n心中怀希望,\n未来自光明。",
32 "last_user_response": ""
33 },
34 "endTime": null,
35 "recommendList": [],
36 "rewriteQuery": null,
37 "intent": null
38}
1{
2 "sessionId": "168a6818-bb89-4a2c-a9c7-f4f55f304f2f",
3 "queryId": "67f8b037-99a4-4e33-84cb-d4c747e8c725",
4 "replyStatus": 200,
5 "answer": [
6 {
7 "chunkId": 0,
8 "status": "done",
9 "topicId": "a52cce91-f235-4c6e-96b0-fdb026c0c09c",
10 "blockId": "DoGqiBQ-iEEPhMv-GgOqiVCTnxBA5sBvrbnB",
11 "nodeId": "_z1WGiWEdEkdiuwefe7KhWqvnRdcqH0J1Xmv",
12 "reply": {
13 "type": 1,
14 "text": "很抱歉,刘星先生,我注意到您提供的身份证号码似乎不符合标准格式。身份证号码通常是一串特定的数字组合。能否请您再次确认并提供正确的身份证号码呢?这对我们的业务办理至关重要,谢谢。",
15 "textList": null,
16 "clarifyGuide": null,
17 "replySource": "COLLECT_SLOT_ENTITY",
18 "showDocumentSource": null,
19 "documents": null,
20 "docDebug": null,
21 "faqSearch": null,
22 "slotCollectInfo": {
23 "waitCollectResultList": [
24 {
25 "name": "身份证号",
26 "result": "",
27 "option": null,
28 "optionSize": null,
29 "clarity": "",
30 "inputExample": "120101200001012345,12010120000101234x",
31 "outputExample": "120101200001012000"
32 }
33 ],
34 "hasCollectResultList": [
35 {
36 "name": "人名",
37 "result": "刘星",
38 "option": null,
39 "optionSize": null,
40 "clarity": "",
41 "inputExample": "贝克汉姆,姚明",
42 "outputExample": "贝克汉姆"
43 }
44 ]
45 },
46 "instruction": null
47 },
48 "instruction": null
49 }
50 ],
51 "variables": {
52 "last_intent": null,
53 "last_task_prompt": "很抱歉,刘星先生,我注意到您提供的身份证号码似乎不符合标准格式。身份证号码通常是一串特定的数字组合。能否请您再次确认并提供正确的身份证号码呢?这对我们的业务办理至关重要,谢谢。",
54 "last_response": "很抱歉,刘星先生,我注意到您提供的身份证号码似乎不符合标准格式。身份证号码通常是一串特定的数字组合。能否请您再次确认并提供正确的身份证号码呢?这对我们的业务办理至关重要,谢谢。",
55 "last_entity_prompt": "很抱歉,刘星先生,我注意到您提供的身份证号码似乎不符合标准格式。身份证号码通常是一串特定的数字组合。能否请您再次确认并提供正确的身份证号码呢?这对我们的业务办理至关重要,谢谢。",
56 "last_user_response": "小明"
57 },
58 "endTime": null,
59 "recommendList": [],
60 "rewriteQuery": null,
61 "intent": null
62}
1{
2 "sessionId": "1b7f75ad-b9cb-4155-83b6-a4349aa30170",
3 "queryId": "47913f67-5abd-410f-9e32-e7996081789a",
4 "replyStatus": 200,
5 "answer": [
6 {
7 "chunkId": 2,
8 "status": "done",
9 "topicId": "a52cce91-f235-4c6e-96b0-fdb026c0c09c",
10 "blockId": "8P7zEt-ykB5WCCCVFg69Shlp_RxtEP4d9mYa",
11 "nodeId": "lM8hwEhaPSzK-xghkz9GOEK3ME_VlG4gXFgK",
12 "reply": null,
13 "instruction": {
14 "system_toCustomerService": {
15 "gotoBed": "sleep"
16 }
17 }
18 }
19 ],
20 "variables": {
21 "date": "2024-05-08",
22 "last_intent": "",
23 "week": "3",
24 "time": "19:39:37",
25 "last_response": "",
26 "last_user_response": ""
27 },
28 "endTime": null,
29 "recommendList": [],
30 "rewriteQuery": null,
31 "intent": null
32}
1{
2 "sessionId": "ca6b7dbd-e0cd-4c90-89a2-ad1c2c810ec2",
3 "queryId": "4d7bcbde-b17d-48ff-b9d0-5a0b4cf5ab3c",
4 "replyStatus": 200,
5 "answer": [
6 {
7 "chunkId": 0,
8 "status": "done",
9 "topicId": "",
10 "blockId": "",
11 "nodeId": "",
12 "reply": {
13 "type": 1,
14 "text": "",
15 "textList": null,
16 "clarifyGuide": null,
17 "replySource": "CHITCHAT",
18 "showDocumentSource": null,
19 "documents": null,
20 "docDebug": null,
21 "faqSearch": null,
22 "slotCollectInfo": null,
23 "instruction": null
24 },
25 "instruction": null
26 }
27 ],
28 "variables": {
29 "last_response": "是啊,今天的天气确实不错,阳光明媚的,让人心情都跟着愉悦起来了。您打算出门走走,享受一下这美好的天气吗?",
30 "last_user_response": "今天天气真好啊",
31 "LLM_rewrite_query": "今天天气真好啊",
32 "last_intent": ""
33 },
34 "endTime": null,
35 "recommendList": [
36 "今天天气怎么样"
37 ],
38 "rewriteQuery": "今天天气真好啊",
39 "intent": null
40}