全部文档

根据问题id，获取答案

用户与机器人交互前，获取相关服务，使用户在提问后能够获取指定问题答案。

接口描述

  • 点击以下问题, 通过该接口返回答案
    - 点击智能提示的问题
    - 点击引导的问题
    - 点击热门问题

请求

GET http://apigate.hsifue.cn/api/front/answer

请求header参数

参数 参数类型 参数约束 是否必传 示例值 描述
session-id 字符串 服务端返回,可从以下api中获取: - 开始新会话 - 会话超时，重启会话 否 C3D205E1B4C72BF451CDC326328786A5 索引用户信息的key

请求param参数

参数 参数类型 参数约束 是否必传 示例值 描述
qid 整型 服务端获取 是 133256 服务端返回的问题的标识,可从以下api中获取: - 获取Top热门问题 - 获取智能提示的问题 - 根据算法匹配，获取答案 - 根据算法匹配，获取答案V2
robot 字符串 服务端获取 是 GCCP 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取
clickQuestion 字符串 当前点击的问题 是 GBQ4如何使用 用户点击的问题
chatid 字符串 服务端获取 是 74139073-4cfd-449b -9479-7e2fb4895d4d 会话ID，同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取
clickType 整型 0/1/2/3 是 1 取值范围: - 0:智能提示点击 - 1:换一批引导问题点击 - 2:热门问题点击 - 3:直推下挂点击
channel 整型 1/2/3/4/5/6 是 2 1.PC 2.公众号 3.网站 4.个人微信 5.小程序 6.APP
initialQuestion 字符串 通过下图场景获取 否 GBQ4如何 初始问题（用于知识学习）, 不同的场景下获取的方式见下图

初始问题（用于知识学习）, 仅在以下两种情况传该参数，获取方式见下图

场景1-1:点击直推下引导的问题 场景1-2:点击换一批引导的问题
img img

请求成功返回的数据

请求成功返回字段描述

返回字段 类型 示例值 描述
cid 字符串 2e604f02-29c5-4843-affd-533e0e497ee8 单条会话的唯一标识
htmlAnswer 字符串 首先打开软件，然后点击就可以了 问题的答案(如果是流程问题, 不返回该字段，返回flowItem)
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",
            "cid ": "2e604f02-29c5-4843-affd-533e0e497ee8",
            "initialQuestion": "云计量只旋转图纸，不旋转构件",
            "htmlAnswer": "<p><span class='zc - highlight '>软件暂时不能处理。</span></p><p>，可以用柱代替布置。</p>"
        }   
    }

请求成功返回的数据基本示例:流程问题

    {
		"code": 200,
		"message": "success",
        "result": {
            "cid ": "2e604f02-29c5-4843-affd-533e0e497ee8",
            "initialQuestion": "云计量只旋转图纸，不旋转构件",
            "flowItem": {
           		"id": 558,
           		"isFirstItem": true,
           		"flowName": "第一步",
           		"flowContent": "<p>安装GBQ4</p>",
           		"linkContent": "下一步",
           	}			
        }   
    }

请求失败返回的数据

请求失败返回的数据基本示例 查看其它状态码

   	{
        "code": 400,
		"message": "Required parameter 'qid' is not present"
   	}

	{
    	"code": 400,
    	"message": "answer.channel: value must be between 1 and 6"
	}
	
	{
    	"code": 400,
    	"message": "answer.qid: value must be a number"
	}
	
	{
    	"code": 400,
    	"message": "answer.clickType: value must be between 0 and 3"
	}

    {
        "code": 500,
		"message": "java.lang.NullPointerException"
    }