在用户与机器人交互前,获取相关服务,使得用户可获得指定问题的关联问题答案。
接口描述
请求
GET http://apigate.hsifue.cn/api/front/linkQuestion
请求header参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| session-id | 字符串 | 服务端返回,可从以下api中获取: - 开始新会话 - 会话超时,重启会话 | 否 | C3D205E1B4C72BF451CDC326328786A5 | 索引用户信息的key |
请求param参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| robot | 字符串 | 服务端获取 | 是 | GCCP | 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取 |
| chatid | 字符串 | 服务端返回 | 是 | 74139073-4cfd-449b -9479-7e2fb4895d4d | 会话ID,同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取 |
| channel | 整型 | 1/2/3/4/5/6 | 是 | 2 | 1.PC 2.公众号 3.网站 4.个人微信 5.小程序 6.APP |
| linkId | 整型 | 关联的问题, 在答案结构中查找, 见下图: | 是 | 155268 | 关联问题ID,用于点击时查询关联的问题, 从答案结构中提取 |
| question | 字符串 | 最大长度500 | 是 | GBQ4如何使用 | 关联的问题, 在答案结构中查找, 见下图: |
| linkId 和 question 获取方式见下图: |
|---|
|
请求成功返回的数据
请求成功返回数据字段描述
| 返回字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| htmlAnswer | 字符串 | 首先打开软件,然后点击就可以了 | 答案 (如果是流程问题, 不返回该字段,返回flowItem) |
| hideUpDown | 布尔型 | false | 用于前端显示或隐藏点踩点赞页签 |
| question | 字符串 | 计价GBQ4.0项目管理界面载入XML组价后,部分单位工程组价并没有匹配进去 | 问题 |
| type | 整型 | 2 | 当前问题的类型 : - 0为常规问题 - 1为人工问题 - 2为流程问题 - 3为表格问题 |
| cid | 字符串 | 2e604f02-29c5-4843-affd-533e0e497ee8 | 单条会话的唯一标识 |
| initialQuestion | 字符串 | 计价GBQ4如何下载 | 初始问题,用于问题学习 |
| routing | 字符串 | nlu | nlu/faq,用于后台区分调用的算法引擎 |
| qid | 整型 | 133256 | 当前问题的唯一标识 |
| slotVecsState | 字符串 | None | 算法引擎使用 |
| slotsContent | 字符串 | None | 算法引擎使用 |
| slotsQueryTimes | 字符串 | None | 算法引擎使用 |
| flowItem | 对象 | 返回字段类型示例值描述id整型558流程项id, 用于获取下一个流程项isFirstItem布尔型true标识是不是第一个流程项, 用于控制是否显示标问 (只有第一个流程项的话才显示标问) - true: 是第一个流程项 - false: 不是第一个流程项flowName字符串第一步流程项名称flowContent字符串安装GBQ4流程项内容linkContent字符串下一步下一个流程项的链接入口, 点击能够展示出下一个流程项 | 流程问题的流程项(type=2) - 如果不是流程问题, 不返回该结构 |
请求成功返回的数据基本示例:常规问题
{
"code": 200,
"message": "success",
"result": {
"routing": "faq",
"qid": 12345,
"slotVecsState": "None",
"slotsContent": "None",
"slotsQueryTimes": "None",
"htmlAnswer": "<p>计价软件载入XML组价后,部分单位工程组价没有匹配进去是因为工程招标清单里面的部分单位工程清单编码和招标方给的招标控制价里面的清单编码不匹配。</p>",
"hideUpDown": false,
"question": "计价GBQ4.0项目管理界面载入XML组价后,部分单位工程组价并没有匹配进去",
"type": 0,
"initialQuestion": "计价GBQ4.0项目管理界面载入XML组价后,部分单位工程组价并没有匹配进去",
"cid": "0e7bf813-b138-4364-a16b-64eccbf63a3e"
}
}
请求成功返回的数据基本示例:流程问题
{
"code": 200,
"message": "success",
"result": {
"flowItem": {
"id": 479,
"flowContent": "<p>content1</p>",
"flowName": "name1",
"linkContent": "like1",
"isFirstItem": true
},
"hideUpDown": false,
"question": "我要进行流程问题测试2",
"type": 2,
"initialQuestion": "我要进行流程问题测试2",
"cid": "58153881-ea83-42df-b4a2-09378a3aa660"
}
}
请求失败返回的数据
请求失败返回数据基本示例 查看其它状态码
{
"code": 400,
"message": "Required parameter 'linkId' is not present"
}
{
"code": 400,
"message": "linkQuestion.linkId: value must be a number"
}
{
"code": 400,
"message": "linkQuestion.channel: value must be between 1 and 6"
}
{
"code": 400,
"message": "linkQuestion.question: Length exceeds the max value [500]"
}
{
"code": 500,
"message": "java.lang.IndexOutOfBoundsException"
}