1. 知识库专业问答API
用于维护机器人知识库语料
专业问答-查询列表
/knowledge/template/getTemplateList
接口描述
查询专业问答标准问题列表数据
调用协议
HTTPS GET
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
keyword | String | 否 | 搜索关键词,模糊搜索 |
topicLevel | Number | 否 | 分类查层级,1: 一级,2:二级,3:三级 |
topic | String | 否 | 当前分类名称 |
parentTopic | String | 否 | 父级分类名称 |
isSuggest | String | 否 | 是否作为推荐问题,0:否,1:是 |
operator | String | 否 | 编辑人员 |
startDate | String | 否 | 创建时间 |
endDate | String | 否 | 结束时间 |
from | Number | 否 | 知识来源,0单个添加,1批量导入,2相似问法学习,3未知问题学习,4不满意问题学习,5人工收录,6标注系统 |
status | Number | 否 | 问题状态,0永久有效,1有效期,2停用 |
v_startDate | String | 否 | 有效期开始时间 |
v_endDate | String | 否 | 有效期结束时间 |
pageSize | Number | 否 | 展示内容数量,默认10 |
offset | Number | 否 | 展示内容偏移量,默认0 |
响应参数
参数 | 类型 | 说明 |
---|---|---|
similarQues | Number | 相似问题数量 |
source | string | 数据来源 |
firstTopic | string | 一级分类 |
secondTopic | string | 二级分类 |
questionId | Number | 问题Id |
question | string | 问题 |
answerId | Number | 答案Id |
answer | string | 问题答案 |
editor | string | 编辑人员 |
editTime | DateTime | 编辑时间 |
standId | string | 所属标准问题的标准问题Id,若本身为标准问题,则值为0 |
suggest | Number | 是否作为推荐问题,1可推荐,0不推荐 |
status | Number | 有效期状态,0::永久有效,1,有效期限制,2,无效 |
validStartTime | DateTime | 有效期开始时间,若有效期状态为0,值为null |
validEndTime | DateTime | 有效期结束时间,若有效期状态为0,值为null |
associateQuestions | String | 关联问题Id,问题Id的数组 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": {
"data": [
{
"similarQues": 9,
"tags": "",
"source": "3464095125@qq.com",
"firstTopic": "售后",
"secondTopic": "",
"currUser": 1,
"question": "购物小票有什么用",
"editor": "2994109427@qq.com",
"suggest": 0,
"editTime": "2018-11-26 11:25:02",
"questionId": 1731958,
"standId": 0,
"status": 0,
"validStartTime": null,
"validEndTime": null,
"answer": "购物小票,就是在收银台支付成功之后,商场开局的小票。有的可以凭小票后期补发票。一定要仔细阅读小票的内容。有的小票就直接说明哪些东西不予退换喔。",
"answerType": "0",
"associateQuestions": "[1732100]",
"answerId": 1188636,
"validity": "永久有效"
}
],
"total": 2347,
"num": []
},
"msg": "success"
}
专业问答-增加
/knowledge/template/addTemplate
接口描述
为机器人添加一个标准问题
调用协议
HTTPS POST
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
question | String | 是 | 问题内容 |
topicLevels | String Array | 是 | 分类,格式:默认分类[],一级分类["xxx1"]二级分类["xxx1","xxx2"] |
openQuestionId | String | 否 | 外部平台问题Id,默认-1 |
answerText | String | 否 | 问题答案,长度<6000 |
similarQues | String Array | 否 | 相似问题,格式["xxx1","xxx2",...] |
associateQuestions | Number Array | 否 | 关联问题,格式[questionId1,questionId2,...] |
date | Object | 否 | 有效期,2:停用,0:永久有效,1:期限有效,格式{"type":2},{"type":0},{"type":1,"start":"2018-12-06 16:41:40","end":"2018-12-06 16:41:40"} |
响应参数
参数 | 类型 | 说明 |
---|---|---|
id | Number | 问题id |
question | String | 问题 |
answerId | Number | 答案id |
answer | String | 答案 |
tags | String | 标签,可忽略 |
mig_similar_question_id | Number | 标准问题or相似问题判断,-1:标准问题,0:相似问题 |
editor | String | 编辑人员 |
answerType | Number | 目前答案均为富媒体类型,可忽略 |
editTime | DateTime | 编辑时间 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": [
{
"id": 1732135,
"question": "小测试",
"answer": "1543218713987_LMtmY_%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20180912190000.jpg",
"tags": "",
"answerId": 1188666,
"mig_similar_question_id": -1,
"editor": "iaskOpen",
"answerType": 0,
"editTime": "2018-11-26 16:15:27"
}
],
"msg": "success"
}
专业问答-删除
/knowledge/template/deleteTemplate
接口描述
删除专业问答的标准问题及其相关的相似问题
调用协议
HTTPS POST
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
ids | String[] | 是 | 标准问题Id数组,格式:[xxx,xxx] |
响应参数
参数 | 类型 | 说明 |
---|---|---|
data | Object | 调用引擎索引接口的返回响应 |
code | Number | 200:删除成功,500:删除失败 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": {
"code": "200",
"msg": "操作成功",
"count": 0,
"data": {},
"page": null,
"pageNum": null,
"pageTotal": null
},
"msg": "删除成功"
}
专业问答-停用启用
/knowledge/template/changeStatus
接口描述
开启/关闭选中问题的引擎索引服务
调用协议
HTTPS POST
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
ids | String[] | 是 | 标准问题Id数组,格式:[xxx,xxx] |
type | String | 是 | 执行的操作,start:启用,stop:停用 |
响应参数
参数 | 类型 | 说明 |
---|---|---|
data | Object | 调用引擎索引接口的返回响应 |
code | Number | 200:删除成功,500:删除失败 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": {
"code": "200",
"msg": "操作成功",
"count": 0,
"data": {},
"page": null,
"pageNum": null,
"pageTotal": null
},
"msg": "删除成功"
}
专业问答-设置有效期
/knowledge/template/setValidDate
接口描述
开启/关闭选中问题的引擎索引服务
调用协议
HTTPS POST
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
ids | String[] | 是 | 标准问题Id数组,格式:[xxx,xxx] |
date | Object | 是 | 2:停用,0:永久有效,1:期限有效,格式{"type":2},{"type":0},{"type":1,"start":"2018-12-06 16:41:40","end":"2018-12-06 16:41:40"} |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": 'ok',
"msg": "success"
}
专业问答-查询详情
/knowledge/template/getTemplateDetailById
接口描述
查询专业问答标准问题的详细数据
调用协议
HTTPS GET
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
id | String[] | 是 | 标准问题Id |
响应参数
参数 | 类型 | 说明 |
---|---|---|
similarQues | Number | 相似问题数量 |
source | string | 数据来源 |
firstTopic | string | 一级分类 |
secondTopic | string | 二级分类 |
questionId | Number | 问题Id |
question | string | 问题 |
answerId | Number | 答案Id |
answer | string | 问题答案 |
editor | string | 编辑人员 |
editTime | DateTime | 编辑时间 |
standId | string | 所属标准问题的标准问题Id,若本身为标准问题,则值为0 |
suggest | Number | 是否作为推荐问题,1可推荐,0不推荐 |
status | Number | 有效期状态,0::永久有效,1,有效期限制,2,无效 |
validStartTime | DateTime | 有效期开始时间,若有效期状态为0,值为null |
validEndTime | DateTime | 有效期结束时间,若有效期状态为0,值为null |
associateQuestions | Object Array | 关联问题Id,问题Id的数组 |
similarQuestions | Object Array | 相似问题的对象数组 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": {
"similarQues": 9,
"tags": "",
"source": "3464095125@qq.com",
"firstTopic": "售后",
"secondTopic": "",
"currUser": 1,
"question": "购物小票有什么用",
"editor": "2994109427@qq.com",
"suggest": 0,
"editTime": "2018-11-26 11:25:02",
"questionId": 1731958,
"standId": 0,
"status": 0,
"validStartTime": null,
"validEndTime": null,
"answer": "购物小票,就是在收银台支付成功之后,商场开局的小票。有的可以凭小票后期补发票。一定要仔细阅读小票的内容。有的小票就直接说明哪些东西不予退换喔。",
"answerType": "0",
"associateQuestions": [{
"questionId": 1732100,
"question": "腾讯王卡是一个什么产品?"
}],
"answerId": 1188636,
"validity": "永久有效",
"similarQuestions": [{
"isStand": 0,
"id": 1731959,
"operator": "3464095125@qq.com",
"question": "购物小票的功能",
"editTime": "2018-11-04 22:31:19"
}]
},
"msg": "success"
}
专业问答-获取分类
/knowledge/template/getTemplateTopic
接口描述
查询专业问答的分类,提供给分类过滤器
调用协议
HTTPS GET
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
响应参数
参数 | 类型 | 说明 |
---|---|---|
label | String | 分类名称 |
value | Number | 分类Id |
children | Array | 子分类 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": [{
"label": "其他",
"value": 345662,
"children": [{
"label": "申请办理",
"value": 345661
}]
}],
"msg": "success"
}
专业问答-获取编辑人列表
/knowledge/template/getTemplateEditorList
接口描述
查询专业问答的分类,提供给分类过滤器
调用协议
HTTPS GET
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
响应参数
参数 | 类型 | 说明 |
---|---|---|
data | Array | 可选的编辑人员 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": [
"iaskOpen"
],
"msg": "success"
}
相似问法-添加
/knowledge/template/addSimilarQuestion
接口描述
为知识库专业问答的标准问题添加相似问法
调用协议
HTTPS POST
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
standId | Number | 是 | 标准问题ID |
similarQues | String | 是 | 相似问题 |
answerId | Number | 是 | 答案ID |
响应参数
参数 | 类型 | 说明 |
---|---|---|
id | Number | 标准问题Id |
question | String | 相似问题 |
answer | String | 答案 |
isStand | Number | 是否是标准问题,0:相似问题,1标准问题 |
operator | String | 编辑人员 |
editTime | DateTime | 编辑时间 |
tags | String | 标签 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": {
"id": 1732139,
"question": "逗比测试",
"isStand": 0,
"operator": " iaskOpen",
"editTime": "2018-11-26 16:31:44",
"answerId": "1188663",
"tags": "",
"answer": "1543218713987_LMtmY_%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20180912190000.jpg"
},
"msg": "success"
}
相似问法-删除
/knowledge/template/deleteSimilarQuestion
接口描述
删除标准问题下的相似问法
调用协议
HTTPS POST
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
questionId | Number | 是 | 相似问题ID |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": true,
"msg": "success"
}
相似问法-修改
/knowledge/template/addSimilarQuestion
接口描述
更新专业问答标准问题的相似问法
调用协议
HTTPS POST
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
standId | Number | 是 | 标准问题ID |
similarQues | String | 是 | 相似问题 |
questionId | Number | 是 | 相似问题ID |
响应参数
参数 | 类型 | 说明 |
---|---|---|
data | Object | 调用引擎索引接口的返回响应 |
code | Number | 200:删除成功,500:删除失败 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": {
"code": "200",
"msg": "操作成功",
"count": 0,
"data": {},
"page": null,
"pageNum": null,
"pageTotal": null
},
"msg": "success"
}
相似问法-获取列表
/knowledge/template/getSimilarQuestion
接口描述
获取标准问题下的相似问题列表
调用协议
HTTPS GET
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
productId | String | 是 | 应用ID |
standId | Number | 是 | 标准问题ID |
响应参数
参数 | 类型 | 说明 |
---|---|---|
id | Number | 是否是标准问题,此处可忽略 |
isStand | Number | 相似问法id |
operator | String | 2操作人员 |
question | String | 相似问题 |
editTime | DateTime | 编辑时间 |
返回示例
HTTPS 200 OK
{
"code": 0,
"data": [{
"isStand": 0,
"id": 1731959,
"operator": "3464095125@qq.com",
"question": "购物小票的功能",
"editTime": "2018-11-04 22:31:19"
}],
"msg": "success"
}