对话机器人服务 CBS-问答机器人API:响应参数

时间:2024-04-07 15:57:33

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

reply_type

Integer

回复类型:

0 知识库回复。

1 技能回复。

2 闲聊回复。

3 图谱回复。

4 文档回复。

5 表格回复。

qabot_answers

QaBotAnswersNew object

知识库回复。

chat_answers

ChatAnswers object

闲聊回复。

taskbot_answers

TaskBotAnswers object

技能回复。只有专业版机器人有该回复。

docqa_answers

DocqaAnswers object

文档回复。只有专业版机器人有该回复。

tableqa_answers

TableQaAnswers object

表格回复。只有专业版机器人有该回复。

session_id

String

会话id,每次对话开启,机器人创建会话id,下次请求中传入该id表示继续该对话,从用户最后一次答案开始,会话超时时间为2分钟。

kbqa_answers

KbqaAnswers object

图谱回复。只有专业版机器人有该回复。

request_id

String

请求ID。用来标记调用失败时,用来标记本次问答。

表7 QaBotAnswersNew

参数

参数类型

描述

answers

Array of QaBotAnswer objects

问答机器人 回复。

recommend_answers

Array of RecomendAnswer objects

问答机器人推荐回复。

表8 QaBotAnswer

参数

参数类型

描述

qa_pair_id

String

问答对ID,UUID格式,如:305cd440-ab4f-4704-9b30-ffa4e82a5606。

st_question

String

标准问题,如:桌面云打不开。

answer

String

答案,如:桌面云打不开了。

score

Double

相似度得分,精确到小数点后3位。

domain

String

问题类别。

top_score_question

String

最高评分的扩展问或标准问。具体见表4

表9 RecomendAnswer

参数

参数类型

描述

qa_pair_id

String

问答对ID,UUID格式,如:305cd440-ab4f-4704-9b30-ffa4e82a5606。

st_question

String

标准问题,如:桌面云打不开。

score

Double

相似度得分,精确到小数点后3位。

domain

String

问题类别。

top_score_question

String

最高评分的扩展问或标准问。具体见表4

表10 ChatAnswers

参数

参数类型

描述

answer

String

答案,如:美好的一天祝您一切顺利。

score

Float

闲聊的置信度,范围:[0.0,1.0 ]。0.0表示兜底回复。

表11 TaskBotAnswers

参数

参数类型

描述

answer

String

答案, 如:请问您需要查询哪里的天气?(##SPLIT## 标签:多个回复节点分隔符)

skill_id

String

技能标识符,UUID格式。如:9eece064-bdb5-43cb-8e0f-8c19a929e25c。

skill_responses

Array of SkillResponse objects

技能回复信息。

表12 SkillResponse

参数

参数类型

描述

skill_id

String

输入问题,不能为空,UUID格式,如:9eece064-bdb5-43cb-8e0f-8c19a929e25c。

skill_version

String

skill的版本。

frame

Frame object

命中意图。

candidate

CandidateIntention object

候选意图。

locked

Boolean

技能是否被锁定,默认是false。

related_intenions

Array of RelatedIntention objects

相关意图信息。

表13 Frame

参数

参数类型

描述

intention

String

意图。

confidence

Double

命中意图置信度。

current_slots

Array of CurrentSlot objects

当前槽位列表。

history_slots

Array of HistorySlot objects

历史槽位列表。

reply

String

机器人回复。

task_complete

Boolean

任务是否完成。

flow_complete

Boolean

对话流程是否结束。

candidate_words

Array of Strings

候选词。

intention_alias

String

意图名称。

表14 CurrentSlot

参数

参数类型

描述

slot_id

String

槽位ID,UUID格式,如:9eece064-bdb5-43cb-8e0f-8c19a929e25c。

slot_name

String

槽位名称。

slot_values

Array of SlotValue objects

槽位值。

slot_identification

String

用户设置的槽位标识。

表15 SlotValue

参数

参数类型

描述

word

String

词。

norm_word

String

通用词。

begin_position

Integer

词的起始位置。

end_position

Integer

词的结束位置。

表16 HistorySlot

参数

参数类型

描述

slot_name

String

槽位名称。

slot_values

Array of HistorySlotWord objects

槽信息。

slot_identification

String

用户设置的槽位标识。

表17 HistorySlotWord

参数

参数类型

描述

word

String

词。

norm_word

String

归一化后的词。

表18 CandidateIntention

参数

参数类型

描述

candidate_intention

String

候选意图。

candidate_confidence

Double

候选技能置信度。

表19 RelatedIntention

参数

参数类型

描述

intention

String

意图名称。

confidence

Double

意图置信度。

表20 DocqaAnswers

参数

参数类型

描述

answer

String

答案。

score

Double

文档问答回复的得分。

question

String

问题。

answer_detail

DocQueryAnswerDetail object

文档回复的详细信息。

details

Array of DocQueryAnswerDetail objects

文档回复的topN答案。

表21 DocQueryAnswerDetail

参数

参数类型

描述

answer

String

答案。

doc_id

String

文档ID。

end_index

Integer

答案结束下标。

paragraph_score

Double

段落评分。

paragraph_text

String

段落文字。

phrase_score

Double

文档问答阅读理解评分。

start_index

Integer

答案开始下标。

total_score

Double

文档问答总评分。

paragraph_number

Integer

段落在文档中的编号。

表22 TableQaAnswers

参数

参数类型

描述

table_id

String

表格ID。

answer

String

表格问答答案。

score

Double

评分。

表23 KbqaAnswers

参数

参数类型

描述

answer

String

图谱问答的答案。

score

Double

评分。

状态码: 400

表24 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码。 调用成功时无此字段。

error_msg

String

调用失败时的错误信息。 调用成功时无此字段。

support.huaweicloud.com/api-cbs/cbs_03_0115.html