简要描述
- 该文档的用于记录对话系统的响应信息
响应数据说明
以下为返回的信息状态
| 字段名 | 类型 | 字段说明 | 备注 |
|---|---|---|---|
| statusCode | int | 网络与鉴权错位码 | 参照http协议规定 400 参数错误 401 Unauthorized 500 内部错误 … |
| error | string | 标识错误类型 | |
| message | string | 标识错误信息 | |
| code | int | 状态码 | 0 正常 1 nlp超时 2 单位分钟内访问量超阈值 3 每日访问量超阈值值 |
| version | string | 接口版本号 |
以下为返回的信息内容
| 字段名 | 类型 | 字段说明 | 备注 |
|---|---|---|---|
| question | string | 请求问题 | |
| uid | string | 用户id | 请求输入的用户id |
| user_id | string | 说话人ID | 系统基于人脸创建的id |
| scene_id | string | 场景名 | |
| qtime | string | 接口收到请求时间 | |
| atime | string | 接口送出响应时间 | |
| questiontime | string | NLP请求开始时间戳 | |
| answertime | string | NLP执行结束时间戳 | |
| keywords | string | 问句中存在的关系词 | |
| mode | string | 当前对话模式 | |
| response | list | 答案响应 | 详见下面答案响应 |
| graphic | dict | 答案模板 | 详见下面答案模板 |
| event | list | 事件信息 | 详见下面事件信息 |
| command | list | 命令信息 | 详见下面命令信息 |
| cooperation | dict | 人机协作信息 | 详见下面人机协作信息 |
答案响应
| 一级字段 | 二级字段 | 三级字段 | 类型 | 字段说明 | 备注 |
|---|---|---|---|---|---|
| response | list | 响应 | |||
| knowledgebase | string | 知识库 | |||
| sentence | string | 拼音纠正后问句 | |||
| answer | list | 多语言回答 | |||
| language | string | 语言类型 | 常见输出值：’cn’|’en’等 | ||
| text | string | 文本回答 | |||
| voice | string | 语音回答 | |||
| audio | string | 音频回答(链接） | |||
| answer_state | string | 当前答案所属state | |||
| instruction_id | string | 指令id | |||
| instruction | string | 指令 | |||
| source | string | 回答来源 | 详见下方source说明 | ||
| interrupt | string | 是否可打断，输出值：‘true’|‘false’等 | |||
| label | string | 标准问题 | |||
| group | string | 所属分组 | |||
| sim_query | string | 相似问题 | |||
| intent | string | 意图 | |||
| available_inputs | list | 节点后续的意图 | |||
| entities | list | 实体 | |||
| options | string | 选项 | |||
| suggests | string | 相关句子 | |||
| class | string | 答案类型 | 详见下方class说明 | ||
| callback | dict | 回送NLP信息 | |||
| question | string | 回送问题 | |||
| type | string | 回送类型 |
其中source的类型如下
| source值 | 说明 |
|---|---|
| task | 任务型对话，状态机或槽填充 |
| qa | 问答型对话 |
| bot_portrait | 机器画像 |
| third | 第三方 |
| ask | 反问 |
| repeat | 要求重复 |
| skill | 技能 |
| keyword | 仅匹配到关键词 |
| handler | 推送信息(检索失败) |
| handler_task | 任务对话推送信息 |
| handler_qa | 简单问答推送信息 |
| handler_tts | tts语音推送信息 |
| handler_expression | tts常用表达推送信息 |
| handler_music | tts视频推送信息 |
| handler_picture | tts图片推送信息 |
| other | 其他 |
其中class的类型如下
| class值 | 说明 |
|---|---|
| business | 业务型回答 |
| chat | 闲聊型回答 |
| suggest | 引导型回答 |
| noise | 噪音回答 |
| unknown | 未知兜底回答 |
答案模板
| 一级字段 | 二级字段 | 三级字段 | 类型 | 字段说明 | 备注 |
|---|---|---|---|---|---|
| graphic | dict | 模板 | |||
| template_name | string | 模板名 | |||
| template_desc | string | 模板描述 | |||
| template_title | string | 模板标题 | |||
| template_texts | list | 模板文本信息 | |||
| template_icons | list | 模板按钮信息 | |||
| template_buttons | list | 模板按钮信息 | |||
| template_links | list | 模板链接信息 | |||
| richtext_data | string | 上传内容或来源于接口内容 | |||
| richtext_type | string | 内容类型 | 待补充 | ||
| timeout | string | 图文持续时间 | |||
| misc | string | 扩展项 |
事件信息
| 一级字段 | 二级字段 | 类型 | 字段说明 | 备注 |
|---|---|---|---|---|
| event | list | 事件信息 | ||
| level | int | 事件等级(1~4) | ||
| level_name | string | 事件等级(P1~P4) | ||
| name | string | 事件名称 | ||
| origin | string | 事件请求源 | ||
| id | string | 事件id | ||
| misc | dict | 扩展项 |
命令信息
| 一级字段 | 二级字段 | 类型 | 字段说明 | 备注 |
|---|---|---|---|---|
| command | list | 命令信息 | ||
| id | string | 命令名 | ||
| name | string | 命令名称 | ||
| params | list | 命令相关参数 | ||
| misc | dict | 扩展项 |
人机协作信息
| 一级字段 | 二级字段 | 三级字段 | 类型 | 字段说明 | 备注 |
|---|---|---|---|---|---|
| cooperation | dict | 人机协作信息 | |||
| alert | bool | 是否请求人机协作 | |||
| value | float | 扩展项 | |||
| play | bool | 是否播放 | |||
| reason | dict | 原因信息 | |||
| context | list | ||||
| trigger | string | 触发原因 | |||
| value | string | ||||
| level | string |
