平台管理
接口说明
平台管理接口主要用于搭建和管理对话平台的测试环境(offline),可以通过此类接口在无平台界面的情况下搭建知识库。目前主要支持的模块包括:目录、闲聊、文档库、意图,其他模块正在陆续开放中。
各模块时序图
渠道时序图
目录时序图
问答时序图
闲聊时序图
文档库时序图
意图时序图
问答库
问答库标准问
问答库标准问创建
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/standard/create
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 父节点 | 是否可空 | 备注 |
---|---|---|---|---|
question | string | 否 | 问题 | |
answer | map< string, object> | 否 | 回答 | |
type | int | answer | 否 | 类型;0 是多答案;1是单答案 |
text | string | answer | 是 | 如果是单答案,必须传 |
list | list< map> | answer | 是 | 答案列表(多答案必须传) |
text | string | answer.list | 是 | 答案内容【类型为:1 文本 3 富文本 时填写到该字段】 |
type | int | answer.list | 是 | 类型【候选项: 1文本 3富文本 4图片】 |
url | string | answer.list | 是 | 图片地址【类型是 4 图片时必传】 |
dirId | string | 是 | 目录id,默认是根目录0 | |
tags | list< string> | 是 | 关键词【字符串列表】 | |
suggestList | list< map> | 是 | 关联问题 | |
id | string | suggestList | 是 | 问题ID |
channelAnswers | list< map> | 是 | 渠道答案【外呼agent不支持渠道答案,该参数及子参数都不需要传】 | |
channelName | string | channelAnswers | 否 | 渠道名称 |
answer | map | channelAnswers | 否 | 答案 |
type | int | channelAnswers.answer | 否 | 类型;0 是多答案;1是单答案 |
text | string | channelAnswers.answer | 是 | 如果是单答案,必须传 |
list | list< map> | channelAnswers.answer | 是 | 答案列表(多答案必传) |
text | string | channelAnswers.answer.list | 是 | 答案内容。 |
type | int | channelAnswers.answer.list | 是 | 类型; 1文本 3富文本 4图片 |
url | string | channelAnswers.answer.list | 是 | 图片地址【类型是 4 图片时必传】 |
channelId | string | channelAnswers | 否 | 渠道id |
请求示例
1POST /open/v{versionId}/faq/standard/create
2{
3 "dirId": "0",
4 "answer": {
5 "list": [{
6 "text": "通用答案1",
7 "type": 1
8 }, {
9 "type": 1,
10 "text": "通用答案2"
11 }],
12 "type": 0
13 },
14 "channelAnswers": [{
15 "channelId": "c0eb33d8-1276-4501-9961-fd8154524940",
16 "answer": {
17 "list": [{
18 "type": 1,
19 "text": "渠道答案1"
20 }, {
21 "type": 1,
22 "text": "渠道答案2"
23 }],
24 "type": 0
25 },
26 "channelName": "测试渠道"
27 }],
28 "question": "FAQ测试",
29 "tags": ["标签1", "标签2"],
30 "suggestList": [{
31 "id": "c0eb33d8-1276-4501-9961-fd8154524940"
32 }]
33}
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
id | string | data | 标准问ID |
示例:
1{
2 "data":{"id":"082bde30-f1c2-41aa-8138-d21e8711e227"},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
问答库标准问更新
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/standard/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 父节点 | 是否可空 | 备注 |
---|---|---|---|---|
id | string | 否 | id | |
editVersion | int | 否 | 编辑的版本 | |
question | string | 否 | 问题 | |
answer | map< string, object> | 否 | 回答 | |
type | int | answer | 否 | 类型;0 是多答案;1是单答案 |
text | string | answer | 是 | 如果是单答案,必须传 |
list | list< map> | answer | 是 | 答案列表(多答案必传) |
text | string | answer.list | 是 | 答案内容。 |
url | string | answer.list | 是 | 图片地址【类型是 4 图片时必传】 |
type | int | answer.list | 是 | 类型; 1文本 3富文本 4图片 |
dirId | string | 是 | 目录id | |
tags | list< string> | 是 | 关键词【字符串列表】 | |
status | int | 是 | 状态【0 生效;1 失效】 | |
suggestList | list< map> | 是 | 关联问题 | |
id | string | suggestList | 是 | 问题ID |
deleteChannelAnswer | list< string> | 是 | 删除的渠道答案id列表【外呼agent不支持渠道答案,该参数不需要传】 | |
channelAnswers | list | 是 | 渠道答案【外呼agent不支持渠道答案,该参数及子参数都不需要传】 | |
id | string | channelAnswers | 否 | id |
channelName | string | channelAnswers | 否 | 渠道名称 |
answer | map | channelAnswers | 否 | 答案 |
type | int | channelAnswers.answer | 否 | 类型;0 是多答案;1是单答案 |
text | string | channelAnswers.answer | 是 | 如果是单答案,必须传 |
list | list< map> | channelAnswers.answer | 是 | 答案列表(多答案必传) |
text | string | channelAnswers.answer.list | 是 | 答案内容。 |
url | string | channelAnswers.answer.list | 是 | 图片地址【类型是 4 图片时必传】 |
type | int | channelAnswers.answer.list | 是 | 类型; 1文本 3富文本 4图片 |
channelId | string | channelAnswers | 否 | 渠道Id |
请求示例
1POST /open/v{versionId}/faq/standard/update
2{
3 "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
4 "question": "FAQ测试更新",
5 "answer": {
6 "list": [{
7 "text": "更新通用答案1",
8 "type": 1
9 }, {
10 "type": 1,
11 "text": "更新通用答案2"
12 }],
13 "type": 0
14 },
15 "dirId": "0",
16 "tags": ["标签1", "标签2"],
17 "editVersion": 0,
18 "channelAnswers": [{
19 "channelId": "xxxxxxxxxxxxxxxxxxxxxxxxx",
20 "answer": {
21 "type": 1,
22 "text": "新增渠道答案1"
23 },
24 "channelName": "新增渠道测试"
25 }],
26 "suggestList": [{
27 "id": "XXXXXXXXXXXXXXX"
28 }],
29 "deleteChannelAnswer": ["xxxxxxxxxxxxxxxxxxxxxxxxx"]
30}
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
version | int | data | 版本号 |
示例:
1{
2 "data":{"version":1},
3 "code":4002801,
4 "time":1568277015660,
5 "msg":"OK"
6}
问答库标准问列表
1、接口地址:GET {IP}:{PORT}/open/v{versionId}/faq/standard
2、入参
参数名 | 类型 | 父节点 | 是否可空 | 备注 |
---|---|---|---|---|
status | int | 是 | 未失效 0;失效 1 | |
pn | int | 是 | 页码,默认为1 | |
ps | int | 是 | 每页数据条数,默认为10 | |
dirId | string | 是 | 目录id | |
keyword | string | 是 | 关键词 | |
orderBy | string | 是 | 排序字段【现在支持编辑时间排序和默认排序两种排序方式。默认排序不用传该字段,编辑时间传lastEditTime】 | |
order | string | 是 | 升序【asc】还是降序【desc】 | |
searchType | string | 是 | 默认为“default”。如果值为“standard”,则只检索条件变为只匹配标准问问题 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 查询页数 |
ps | int | data | 每页大小 |
list | list | data | 数据列表 |
id | string | list | 标准问id |
question | string | list | 问题 |
answer | map | list | 答案 |
type | int | answer | 0 是多答案;1 是单答案 |
text | string | answer | 答案。【当answer下的type是1的时】 |
list | list | answer | 答案列表。【当answer下的type字段是0时,单答案没有list属性】 |
text | string | answer.list | 答案 |
type | int | answer.list | 1文本; 3富文本; 4图片; |
url | string | answer.list | 图片地址 |
status | int | list | 状态标识,0 生效,1 失效 |
dirId | string | list | 目录id |
tags | list | list | 标签信息 |
updated | string | list | 更新时间 |
created | string | list | 创建时间 |
editVersion | int | list | 编辑版本 |
expire | string | list | 过期时间 |
effect | string | list | 生效时间 |
isActiveHook | int | list | 0 未使用webhook ;1 使用webhook |
instruction | string | list | 指令 |
suggestList | list | list | 关联问题列表,默认为空列表 |
channelAnswers | list | list | 渠道列表【列表页时,该字段为空list】 |
示例:
1{
2 "data":{
3 "total":1,
4 "pn":1,
5 "ps":20,
6 "list":[
7 {
8 "id":"e3980621-748a-4714-b079-ee85a720dd05",
9 "question":"山东济南",
10 "answer":{
11 "list":[
12 {
13 "text":"济南是经济强省山东的省会。",
14 "type":1
15 },
16 {
17 "type":4,
18 "url":"http://localhost:8080/api/v2/file/download?key=Ym9zXzc5YjE1M2VhLTM5ODEtNGNkNS1iMDBmLTc5MTA0MDYwMmJjNA=="
19 }
20 ],
21 "type":0
22 },
23 "status":0,
24 "dirId":"bddc9428-01ce-45d9-9d51-7120c02a40ea",
25 "tags":[
26 "省会",
27 "泉城"
28 ],
29 "updated":"2019-09-12 11:02:22",
30 "created":"2019-09-12 11:02:22",
31 "editVersion":0,
32 "expire":"2099-12-31 23:59:59",
33 "effect":"2000-01-01 00:00:00",
34 "isActiveHook":1,
35 "instruction":"9eb5c8d6-34f8-4dba-8bcf-54c4958ff8d9",
36 "suggestList":[]
37 }
38 ]
39 },
40 "code":200,
41 "time":1568257385194,
42 "msg":"OK"
43}
问答库标准问详情
1、接口地址: GET {IP}:{PORT}/open/v{versionId}/faq/standard/detail
2、入参(放到Query Param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 标准问id |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
id | string | data | |
question | string | data | 问题 |
answer | map | data | 答案 |
type | int | answer | 类型 0 多答案;1 单答案 |
text | string | answer | 单答案内容 |
list | list< map> | answer | 当且仅当answer.type = 0时,出现此字段 |
text | string | answer.list | 答案内容 |
type | string | answer.list | 答案类型 1文本 3富文本 4图片 |
url | string | answer.list | 图片地址,当answer.list.type=4时,出现此字段 |
status | int | data | 状态标识,0 生效,1 失效 |
dirId | string | data | 目录id |
tags | list | data | 标签信息,内容string类型 |
updated | string | data | 更新时间 "2019-09-12 16:30:15" |
created | string | data | 创建时间 "2019-09-12 16:30:15" |
editVersion | int | data | 版本号信息 |
expire | string | data | 过期时间 "2099-12-31 23:59:59" |
effect | string | data | 生效时间 "2000-12-31 23:59:59" |
channelAnswers | list | data | 渠道答案 |
id | string | channelAnswers | 渠道答案id |
answer | map | channelAnswers | 答案 |
type | int | channelAnswers.answer | 类型 0 多答案;1 单答案 |
text | string | channelAnswers.answer | 单答案内容 |
list | list< map> | channelAnswers.answer | 当且仅当answer.type = 0时,出现此字段 |
text | string | channelAnswers.answer.list | 答案内容 |
type | string | channelAnswers.answer.list | 答案类型 1文本 3富文本 4图片 |
url | string | channelAnswers.answer.list | 图片地址,当answer.list.type=4时,出现此字段 |
channelId | string | channelAnswers | 渠道id |
channelName | string | channelAnswers | 渠道名 |
isActiveHook | int | channelAnswers | 0 未使用webhook ;1 使用webhook |
instruction | string | channelAnswers | 指令 |
suggestList | list | data | 通用答案中关联问题 |
id | string | suggestList | 关联问题ID |
score | int | suggestList | 相似度 |
question | string | suggestList | 问题 |
isActiveHook | int | data | 0 未使用webhook ;1 使用webhook |
instruction | string | data | 指令 |
lastEditUserId | string | data | 最后修改人Id |
lastEditUsername | string | Data | 最后修改人 |
示例:
1{
2 "data":{
3 "id":"e3980621-748a-4714-b079-ee85a720dd05",
4 "question":"山东济南",
5 "answer":{
6 "list":[
7 {
8 "text":"济南是经济强省山东的省会。",
9 "type":1
10 },
11 {
12 "type":4,
13 "url":"http://localhost:8080/api/v2/file/download?key=Ym9zXzc5YjE1M2VhLTM5ODEtNGNkNS1iMDBmLTc5MTA0MDYwMmJjNA=="
14 },
15 {
16 "type":3,
17 "text":"l这是font-size: 18px;">富文本http://www.baidu.com" target="_blank">百度"
18 }
19 ],
20 "type":0
21 },
22 "status":0,
23 "dirId":"bddc9428-01ce-45d9-9d51-7120c02a40ea",
24 "tags":[
25 "省会",
26 "泉城"
27 ],
28 "updated":"2019-09-12 16:30:15",
29 "created":"2019-09-12 11:02:22",
30 "editVersion":2,
31 "expire":"2099-12-31 23:59:59",
32 "effect":"2000-01-01 00:00:00",
33 "lastEditUserId":"xxxxxx",
34 "lastEditUsername":"xxxxxxx",
35 "channelAnswers":[
36 {
37 "channelId":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
38 "channelName":"渠道2",
39 "answer":{
40 "text":"答案",
41 "type":1
42 },
43 "id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
44 "isActiveHook":0,
45 "instruction":""
46 },
47 {
48 "channelDelete":0,
49 "channelId":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
50 "channelName":"渠道1",
51 "answer":{
52 "text":"这是font-size: 16px;">渠道1font-size: 16px;">的信息http://www.baidu.com" target="_blank">百度",
53 "type":3
54 },
55 "id":"34926436-6a73-4c92-b164-246359b12140",
56 "isActiveHook":0,
57 "instruction":""
58 }
59 ],
60 "isActiveHook":1,
61 "instruction":"9eb5c8d6-34f8-4dba-8bcf-54c4958ff8d9",
62 "suggestList":[
63 {
64 "score":1,
65 "id": "c0eb33d8-1276-4501-9961-fd8154524940",
66 "question":"北京"
67 }
68 ]
69 },
70 "code":200,
71 "time":1568605316034,
72 "msg":"OK"
73}
问答库标准问删除
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/standard/delete
2、入参(放在query param中)
参数名 | 类型 | 父节点 | 是否可空备注 |
---|---|---|---|
id | string | 否 | 标准问id |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
示例:
1{
2 "data":null,
3 "code":200,
4 "time":1568600520307,
5 "msg":"OK"
6}
4.1.6 问答库标准问生效/失效
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/expire
2、入参(虚将json字符串写入到body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 渠道id |
status | int | 是 | 状态标识,0-上线,1-下线,默认为0 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":null
6}
FAQ-标准问识别(算子)
1、接口地址:GET {IP}:{PORT}/core/v{versionId}/faq/recall
2、入参
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
top | int | 是 | 返回结果数,默认返回5条,最大不能超过10条, 超过按照10条返回 |
query | string | 否 | 查询语句 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
questions | list | data | 查询页数 |
question | string | questions | 问题 |
confidence | double | questions | 相似度 |
answers | map | questions | 回答内容 |
channel | string | questions | 渠道 |
dir | string | questions | 目录标识 |
list | list | answer | 答案 |
text | string | list | 答案内容 |
type | string | list | 答案类型 1文本 3富文本 4图片 |
url | string | list | 图片地址,当answer.list.type=4时,出现此字段 |
detail | list | questions | 扩展问详情 最大值3个 |
question | string | detail | 扩展问 |
confidence | double | detail | 相似度 |
type | int | detail | 问题的类型 0是扩展问 3是模板 |
示例:
1{
2 "time": 1573721580227,
3 "data": {
4 "total": 2,
5 "questions": [
6 {
7 "question": "我爱中国",
8 "confidence": 1,
9 "dir" : "0",
10 "answers": [
11 {
12 "channel": "c1",
13 "list": [
14 {
15 "type": 1,
16 "text": "渠道答案",
17 "url": null
18 }
19 ]
20 },
21 {
22 "channel": "通用渠道",
23 "list": [
24 {
25 "type": 1,
26 "text": "通用答案",
27 "url": null
28 }
29 ]
30 }
31 ],
32 "detail": [
33 {
34 "question": "我爱中国首都",
35 "confidence": 0.06000000238418579,
36 "type": 0
37 },
38 {
39 "question": "我爱北京",
40 "confidence": 0.03333333507180214,
41 "type": 0
42 }
43 ]
44 },
45 {
46 "question": "我爱上海",
47 "confidence": 0.03333333507180214,
48 "dir" : "0",
49 "answers": [
50 {
51 "channel": "通用渠道",
52 "list": [
53 {
54 "type": 1,
55 "text": "通用答案",
56 "url": null
57 }
58 ]
59 }
60 ],
61 "detail": []
62 }
63 ]
64 },
65 "code": 200,
66 "msg": "OK"
67}
FAQ高亮搜索
1、接口地址: (GET) {IP}:{PORT}/open/v{versionId}/faq/search
2、入参
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
keyword | String | 否 | 关键字 |
pn | int | 是 | 查询页数,默认为1 |
ps | int | 是 | 每页条数,默认为20 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 查询页数 |
ps | int | data | 每页大小 |
list | list | data | 数据列表 |
id | string | list | 闲聊标准问ID |
question | string | list | 问题 |
dirId | string | list | 目录Id |
created | string | list | 创建时间 |
updated | string | list | 修改时间 |
lastEditTime | string | list | 最后编辑时间 |
lastEditUsername | string | list | 最后编辑人 |
status | int | list | 0 生效 、1 失效 |
tags | string[] | list | 标签数组 |
answer | map<string, object> | list | 答案 |
type | int | answer | 类型 0 多答案;1 单答案t |
text | string | answer | 单答案 |
list | list< map> | answer | 当且仅当answer.type = 0时,出现此字段 |
text | string | answer.list | 答案文本 |
type | int | answer.list | 答案类型 1文本 3富文本 4图片 |
url | string | answer.list | 答案类型 1文本 3富文本 4图片 |
id | string | channelAnswers | 渠道答案id |
answer | map | channelAnswers | 答案 |
type | int | channelAnswers.answer | 类型 0 多答案;1 单答案 |
text | string | channelAnswers.answer | 单答案内容 |
list | list< map> | channelAnswers.answer | 当且仅当answer.type = 0时,出现此字段 |
text | string | channelAnswers.answer.list | 答案内容 |
type | string | channelAnswers.answer.list | 答案类型 1文本 3富文本 4图片 |
url | string | channelAnswers.answer.list | 图片地址,当answer.list.type=4时,出现此字段 |
channelId | string | channelAnswers | 渠道id |
channelName | string | channelAnswers | 渠道名称 |
示例:
1{
2 "time": 1582191583052,
3 "data": {
4 "list": [{
5 "id": "XXXXXXXX",
6 "question": "<aicp_em_highlight>多渠道</aicp_em_highlight>测试",
7 "dirId": "0",
8 "lastEditTime": "2020-01-19 11:16:18",
9 "lastEditUserId": "XXXXXXXX",
10 "lastEditUsername": "XXXXXXXX",
11 "status": 0,
12 "tags": [],
13 "channelAnswers": [{
14 "channelId": "XXXXXXXX",
15 "channelName": "渠道",
16 "answer": {
17 "text": "1111",
18 "type": 1
19 },
20 "id": "XXXXXXXX"
21 }],
22 "answer": {
23 "text": "111",
24 "type": 1
25 }
26 }, {
27 "id": "XXXXXXXX",
28 "question": "<aicp_em_highlight>多渠道</aicp_em_highlight>测试1",
29 "dirId": "0",
30 "lastEditTime": "2020-01-19 11:44:29",
31 "lastEditUserId": "XXXXXXXX",
32 "lastEditUsername": "XXXXXXXX",
33 "status": 0,
34 "tags": [],
35 "channelAnswers": [{
36 "channelDelete": 0,
37 "channelId": "65150ea4-067c-4a38-9ca1-1638068f4e12",
38 "channelName": "XXXXXXXX",
39 "answer": {
40 "text": "11",
41 "type": 1
42 },
43 "id": "XXXXXXXX"
44 }],
45 "answer": {
46 "text": "111",
47 "type": 1
48 }
49 }],
50 "total": 2,
51 "ps": 10,
52 "pn": 1
53 },
54 "code": 200,
55 "msg": "OK"
56}
问答库扩展问
问答库扩展问创建
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/extend/create
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
question | string | 否 | FAQ扩展问问题 |
faqId | string | 否 | FAQ标准问ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | map | 返回数据 | |
id | string | 扩展问ID |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":{"id":"08a43c53-4406-4d14-a91f-97e8af587567"}
6}
问答库扩展问更新
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/extend/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
question | string | 否 | FAQ扩展问问题 |
faqId | string | 否 | FAQ标准问ID |
id | string | 否 | FAQ扩展问ID |
editVersion | int | 否 | FAQ扩展问版本号 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | map | 返回数据 | |
version | int | data | 版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":{"version":1}
6}
问答库扩展问列表
1、接口地址:GET {IP}:{PORT}/open/v{versionId}/faq/extend
2、入参(放到query param)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
faqId | string | 否 | FAQ ID |
keyword | string | 是 | 关键字 |
pn | int | 是 | 查询页数,默认为1 |
ps | int | 是 | 每页条数,默认为20 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 查询页数 |
ps | int | data | 每页大小 |
list | list | data | 数据列表 |
id | string | list | 闲聊标准问ID |
question | string | list | 问题 |
faqId | string | list | faqID |
created | string | list | 创建时间 |
updated | string | list | 修改时间 |
editVersion | int | list | FAQ扩展问版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"",
5 "data":{
6 "total": 245,
7 "pn": 1,
8 "ps": 10,
9 "list": [
10 {
11 "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
12 "question": "问题1",
13 "faqId": "002d1161-90a1-4ed8-a9af-71d5faa2ee6f",
14 "created": "2019-07-22 17:52:09",
15 "updated": "2019-07-22 17:52:09",
16 "editVersion": 1
17 },
18 ······
19 ]
20 }
21}
问答库扩展问删除
1、接口地址: POST {IP}:{PORT}/open/v{versionId}/faq/extend/delete
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 扩展问ID |
faqId | string | 否 | FAQ标准问ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":null
6}
问答库不响应问
问答库不响应问创建
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/noresp/create
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
question | string | 否 | 不响应问问题 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
id | int | 不响应问ID |
示例:
1{
2 "code":4002801,
3 "time":1568613825147,
4 "msg":"OK",
5 "data":{"id":"08a43c53-4406-4d14-a91f-97e8af587567"}
6}
问答库不响应问更新
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/noresp/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
question | string | 否 | 不响应问问题 |
version | string | 否 | 不响应问版本 |
id | string | 否 | 不响应问ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
version | int | data | 版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":{"version":1}
6}
问答库不响应问列表
1、接口地址:GET {IP}:{PORT}/open/v{versionId}/faq/noresp
2、入参 (Query param)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
ps | string | 是 | 页面大小,默认20 |
pn | string | 是 | 页码,默认1 |
keyword | string | 是 | 问题关键词 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据 | |
total | int | data | 数据总量 |
ps | int | data | 页面大小 |
pn | int | data | 页码 |
list | list | data | 数据列表 |
id | string | list | 不响应问ID |
question | string | list | 不响应问问题 |
created | string | list | 创建时间 |
update | string | list | 更新时间 |
version | int | list | 不响应问数据版本 |
示例:
1{
2 "data":{
3 "total":3,
4 "pn":1,
5 "ps":20,
6 "list":[
7 {
8 "id":"6fee54bf-4d5b-4b59-81b6-d9a9f61fabe9",
9 "question":"不响应问1",
10 "created":"2019-09-16 14:03:44",
11 "updated":"2019-09-16 14:14:27",
12 "version":1
13 },
14 {
15 "id":"b55ba26a-2a5e-46ee-a2e5-06d6b8360ffb",
16 "question":"不响应问2",
17 "created":"2019-09-10 15:22:28",
18 "updated":"2019-09-10 15:22:28",
19 "version":0
20
21 },
22 {
23 "id":"c824edc1-3c20-4cdf-9abb-66d9259e3e30",
24 "question":"不响应问3",
25 "created":"2019-09-10 15:22:00",
26 "updated":"2019-09-10 15:22:08",
27 "version":1
28 }
29 ]
30 },
31 "code":200,
32 "time":1568614468691,
33 "msg":"OK"
34}
问答库不响应问删除
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/noresp/delete
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 不响应问ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":null
6}
问答库模板
问答库模板创建
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/template/create
2、入参(json格式放到body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
faqId | string | 否 | FAQ标准问ID |
template | string | 否 | FAQ模板内容 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
id | int | data | 模板ID |
示例:
1{
2 "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
问答库模板更新
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/template/update
2、入参(json格式放到body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 模板ID |
faqId | string | 否 | FAQ标准问ID |
template | string | 否 | FAQ模板 |
version | int | 否 | 版本号 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据 | |
version | int | data | 版本号 |
示例:
1{
2 "data":{"version":1},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
问答库模板列表
1、接口地址:GET {IP}:{PORT}/open/v{versionId}/faq/template
2、入参
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
faqId | string | 否 | FAQ标准问id |
pn | int | 是 | 页码,默认为1 |
ps | int | 是 | 每页数据条数,默认为20 |
keyword | string | 是 | 检索关键字 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据 | |
total | int | data | 总大小 |
pn | int | data | 查询页数 |
ps | int | data | 每页大小 |
list | list | data | 数据列表 |
id | string | list | 模板ID |
faqId | string | list | FAQ标准问ID |
template | string | list | 模板字符串 |
created | tring | list | 创建时间 |
update | string | list | 修改时间 |
示例:
1{
2 "data":{
3 "total":1,
4 "pn":1,
5 "ps":20,
6 "list":[
7 {
8 "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
9 "faqId": "2bc7647e-ab25-47c0-915a-e7e5d95d4472",
10 "template": "[W:0-4]",
11 "created": "2019-07-24 19:22:57",
12 "update": "2019-07-24 19:23:29"
13 }
14 },
15 "code":200,
16 "time":1568257385194,
17 "msg":"OK"
18}
问答库模板删除
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/faq/template/delete
2、入参(json格式放到body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 模板ID |
faqId | tring | 否 | FAQ标准问ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
示例:
1{
2 "data":null,
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK "
6}
FAQ-推荐问题查询列表【BOT级别】
1、header
key | value |
---|---|
Authorization | NGD {token} |
这个接口的token 与其他接口不同,这个token是bot级别的token
2、接口地址:GET {IP}:{PORT}/core/v{versionId}/faq/bot/standardSuggest
3、入参
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
top | int | 是 | 返回结果数,默认返回5条 |
query | string | 否 | 查询语句 |
channel | string | 是 | 渠道信息 |
4、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
questions | list | data | 查询页数 |
id | string | questions | id |
question | string | questions | 问题 |
suggestions | list< string> | questions | 关联列表 |
confidence | double | questions | 相似度 |
isChannelAnswer | boolean | questions | 是否是渠道答案 |
answer | list | questions | 回答内容 |
list | list | questions.answer | 答案列表 |
text | string | questions.answer.list | 答案内容 |
type | string | questions.answer.list | 答案类型 |
url | string | questions.answer.list | 图片地址,当answer.list.type=4时,出现此字段 |
示例:
1{
2 "time":1573721580227,
3 "data":{
4 "total":1,
5 "questions":[
6 {
7 "id":"c51676e3-4ff6-463a-a8b7-5512281104a3",
8 "question":"测试问答",
9 "answer":{
10 "list": [{
11 "type":1,
12 "text":"答案",
13 "url":null
14 }]
15 },
16 "suggestions":null,
17 "confidence":0.6871752738952637,
18 "isChannelAnswer":false
19 }
20 ]
21 },
22 "code":200,
23 "msg":"OK"
24}
问答库标准问推荐列表【AGENT级别】
1、接口地址:GET {IP}:{PORT}/core/v{versionId}/faq/agent/standardSuggest
2、入参(json格式放到body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
top | int | 是 | 返回结果数,默认返回5条 |
query | string | 是 | 查询语句 |
channel | string | 是 | 渠道信息 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
questions | list | data | 查询页数 |
id | string | questions | id |
question | string | questions | 问题 |
suggestions | list | questions | 关联列表 |
confidence | double | questions | 相似度 |
isChannelAnswer | boolean | questions | 是否是渠道答案 |
answer | map | questions. | 回答内容 |
list | list | questions.answer | 答案列表 |
text | string | questions.answer.list | 答案内容 |
type | string | questions.answer.list | 答案类型 |
url | string | questions.answer.list | 图片地址,当answer.list.type=4时,出现此字段 |
示例:
1{
2 "time":1573721580227,
3 "data":{
4 "total":1,
5 "questions":[
6 {
7 "id":"c51676e3-4ff6-463a-a8b7-5512281104a3",
8 "question":"测试问答",
9 "answer":{
10 "list": [{
11 "type":1,
12 "text":"答案",
13 "url":null
14 }]
15 },
16 "suggestions":null,
17 "confidence":0.6871752738952637,
18 "isChannelAnswer":false
19 }
20 ]
21 },
22 "code":200,
23 "msg":"OK"
24}
闲聊库
闲聊库标准问
闲聊库标准问新建
1.接口地址: (POST) {IP}:{PORT}/open/v{versionId}/chitchat/standard/create
2.入参(需生成JSON字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
answer | list< map> | 否 | 答案Map列表 |
text | string | 否 | 答案文本 |
type | string | 否 | 答案类型(只能传数字,目前只可为1,为纯文本) |
question | string | 否 | 问题 |
示例:
1{
2 "answer":[
3 {
4 "text":"答案1",
5 "type":"1"
6 },
7 ......
8 ]
9 "question":“问题1”
10}
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | map | 返回数据 | |
id | int | data | 闲聊标准问id |
示例:
1{
2 "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
闲聊库标准问更新
1.接口地址:(POST) {IP}:{PORT}/open/v{versionId}/chitchat/standard/update
2.入参(需生成JSON字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 父节点 | 备注 |
---|---|---|---|---|
id | string | 否 | 标准问ID | |
question | string | 否 | 问题 | |
version | int | 否 | 闲聊标准问版本号 | |
answer | list< map> | 否 | 答案列表 | |
text | string | 否 | answer | 答案文本 |
type | string | 否 | answer | 答案类型(只能传数字,目前只可为1,为纯文本) |
示例:
1{
2 "id":"003ecd4f-344c-4187-8b14-f12737161ef31",
3 "version":1,
4 "answer":[
5 {
6 "text":"答案1",
7 "type":"1"
8 },
9 ......
10 ]
11 "question":“问题1”
12}
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | map | 返回数据 | |
version | int | 版本号 |
示例:
1{
2 "data":{"version":1},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
闲聊库标准问删除
1.接口地址:(POST) {IP}:{PORT}/open/v{versionId}/chitchat/standard/delete
2.入参(需生成JSON字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 标准问ID |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
闲聊库标准问列表
1.接口地址:(GET) {IP}:{PORT}/open/v{versionId}/chitchat/standard
2.入参(写入到param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
pn | int | 是 | 查询页数,默认为1 |
ps | int | 是 | 每页数量,默认为10 |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 当前页数 |
ps | int | data | 每页数量 |
list | list | data | 数据列表 |
id | string | list | 闲聊标准问ID |
answer | list< map> | list | 答案列表 |
text | string | 否 | 答案文本 |
type | string | 否 | 答案类型(目前只可为1,为纯文本) |
question | string | list | 问题 |
created | string | list | 创建时间 |
updated | string | list | 修改时间 |
version | int | list | 版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":{
6 "total": 245,
7 "pn": 1,
8 "ps": 10,
9 "list": [
10 {
11 "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
12 "answer": [{"text":"答案1","type":1}],
13 "question": "问题1",
14 "created": "2019-07-22 17:52:09",
15 "updated": "2019-07-22 17:52:09",
16 "version": 1
17 },
18 ······
19 ]
20 }
21}
闲聊库标准问题检索
1.(GET) {IP}:{PORT}/open/v{versionId}/chitchat/standard/keyword
2.入参(写入param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
pn | int | 是 | 查询页数,默认为1 |
ps | int | 是 | 每页数量,默认为10 |
keyword | string | 否 | 关键字 |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 当前页数 |
ps | int | data | 每页数量 |
list | List | data | 数据列表 |
id | itring | list | 闲聊标准问ID |
answer | list< map> | list | 答案列表 |
text | string | 否 | 答案文本 |
type | string | 否 | 答案类型(只能传数字,目前只可为1,为纯文本) |
question | string | list | 问题 |
created | string | list | 创建时间 |
updated | string | list | 修改时间 |
version | int | list | 版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":{
6 "total": 245,
7 "pn": 1,
8 "ps": 10,
9 "list": [
10 {
11 "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
12 "answer": [{"text":"答案1","type":1}],
13 "question": "问题1",
14 "created": "2019-07-22 17:52:09",
15 "updated": "2019-07-22 17:52:09",
16 "version": 1
17 },
18 ······
19 ]
20 }
21}
闲聊库扩展问
闲聊库扩展问新建
1.接口地址: (POST) {IP}:{PORT}/open/v{versionId}/chitchat/extend/create
- 入参(需生成JSON字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
question | string | 否 | 扩展问问题 |
standardId | string | 否 | 标准问ID |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | map | 返回数据 | |
id | int | data | 闲聊扩展问ID |
示例:
1{
2 "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
闲聊库扩展问更新
1.接口地址: (POST) {IP}:{PORT}/open/v{versionId}/chitchat/extend/update
- 入参(需生成JSON字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
question | string | 否 | 扩展问问题 |
standardId | string | 否 | 标准问ID |
id | string | 否 | 闲聊扩展问ID |
version | int | 否 | 版本号 |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
version | int | data | 版本号 |
示例:
1{
2 "data":{"iversion":1},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
闲聊库扩展问删除
1.接口地址: (POST) {IP}:{PORT}/open/v{versionId}/chitchat/extend/delete
2.入参(需生成JSON字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 扩展问ID |
standardId | string | 否 | 标准问ID |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
闲聊库扩展问列表
1.接口地址:(GET) {IP}:{PORT}/open/v{versionId}/chitchat/extend
2.入参(写入param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
pn | int | 是 | 查询页数,默认为1 |
ps | int | 是 | 每页数量,默认为10 |
standardId | string | 否 | 标准问ID |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 当前页数 |
ps | int | data | 每页数量 |
list | List | data | 数据列表 |
id | string | list | 闲聊扩展问ID |
question | string | list | 问题 |
standardId | string | list | 标准问ID |
extendId | string | list | 扩展问ID |
created | string | list | 创建时间 |
updated | string | list | 修改时间 |
version | int | list | 版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":{
6 "total": 245,
7 "pn": 1,
8 "ps": 10,
9 "list": [
10 {
11 "id":"001f1522-015d-4831-9cf6-0f8b11a78028",
12 "question": "问题1",
13 "standardId": "002d1161-90a1-4ed8-a9af-71d5faa2ee6f",
14 "extendId": "001f1522-015d-4831-9cf6-0f8b11a78028",
15 "created": "2019-07-22 17:52:09",
16 "updated": "2019-07-22 17:52:09",
17 "version": 1
18 },
19 ······
20 ]
21 }
22}
闲聊库标准问题检索
1.接口地址:(GET) {IP}:{PORT}/open/v{versionId}/chitchat/extend/keyword
2.入参(写入param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
pn | int | 是 | 查询页数,默认为1 |
ps | int | 是 | 每页数量,默认为10 |
standardId | string | 否 | 标准问ID |
keyword | string | 否 | 关键字 |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 当前页数 |
ps | int | data | 每页数量 |
list | List | data | 数据列表 |
id | string | list | 闲聊扩展问ID |
question | string | list | 问题 |
standardId | string | list | 标准问ID |
extendId | string | list | 扩展问ID |
created | string | list | 创建时间 |
updated | string | list | 修改时间 |
version | int | list | 版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":{
6 "total": 245,
7 "pn": 1,
8 "ps": 10,
9 "list": [
10 {
11 "id":"001f1522-015d-4831-9cf6-0f8b11a78028",
12 "question": "问题1",
13 "standardId": "002d1161-90a1-4ed8-a9af-71d5faa2ee6f",
14 "extendId": "001f1522-015d-4831-9cf6-0f8b11a78028",
15 "created": "2019-07-22 17:52:09",
16 "updated": "2019-07-22 17:52:09",
17 "version": 1
18 },
19 ······
20 ]
21 }
22}
目录
目录创建
1.接口地址:(POST) {IP}:{PORT}/open/v{versionId}/directory/create
2.入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
name | string | 否 | 目录名称 |
parentId | string | 否 | 父节点ID【备注:根目录id是0】 |
version | int | 否 | 目录版本号 |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | map | 返回数据 | |
id | string | data | 目录ID |
version | int | data | 版本号 |
示例:
1{
2 "data":{"version":1, "id":"0a3d1e60-809a-4266-82f9-ba65ec4452d8"},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
目录更新
1.接口地址: (POST) {IP}:{PORT}/open/v{versionId}/directory/update
2.入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
name | string | 否 | 目录名称 |
id | string | 否 | 目录ID |
version | int | 否 | 目录版本号 |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | map | 返回数据 | |
version | int | data | 版本号 |
示例:
1{
2 "data":{"version":1},
3 "code":200,
4 "time":1568274632887,
5 "msg":"OK"
6}
目录删除
1.接口地址: (POST) {IP}:{PORT}/open/v{versionId}/directory/delete
- 入参(需生成JSON字符串并放入请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 目录ID |
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
目录列表
1.接口地址:(GET) {IP}:{PORT}/open/v{versionId}/directory
2.入参(写入param中)
无
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | list | 返回数据 | |
id | string | data | 目录ID |
name | string | data | 目录名称 |
parentId | string | data | 父节点ID |
sort | int | data | 排序顺序 |
version | int | data | 版本号 |
hasPerm | int | data | 是否具有权限 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"",
5 "data":[
6 {
7 "id":"008ac842-082f-4492-b765-f12d19bf1fd5",
8 "name": "一级目录",
9 "hasPerm": 1,
10 "parentId": "00e01f9a-7ea3-401c-a8a0-8d8aee42fd44",
11 "sort": 1,
12 "version": 1,
13
14 },
15 ······
16 ]
17}
文档库
文档库新建
1、接口地址:(POST) {IP}:{PORT}/open/v{versionId}/document/create
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 父节点 | 备注 |
---|---|---|---|---|
dirId | string | 否 | 目录id | |
title | string | 否 | 标题 | |
richText | string | 否 | 富文本数据 | |
plainText | string | 否 | 纯文本数据【如果有富文本的情况下,需要把富文本中的纯文字提取出来,放到这个字段中;如果富文本中包含图片,纯文本中需要加"[图片]",以支持图片检索和搜索的显示】 | |
attaches | list | 是 | 关联的附件列表 | |
url | string | 否 | attaches | 地址 |
name | string | 否 | attaches | 名称 |
key | string | 否 | attaches | 获取预览地址时使用 |
size | string | 否 | attaches | 文件大小 |
faqs | list< string> | 是 | 关联标准问的id列表 | |
tags | list< string> | 是 | 标签列表 | |
linkNum | int | 是 | 链接数【页面展示用】 | |
pictureNum | int | 是 | 图片数【页面展示用】 | |
wordNum | int | 是 | 文档字符数(如果richText不为空,则此字段必传,数量为richText去掉标签和空格后所剩长度) |
示例
1POST /open/v{versionId}/document/create
2{
3 "dirId": "0",
4 "richText": "<p>文档库内容<a href=\"http://www.xxxx.com\" target=\"_blank\">www.xxxx.com</a></p>",
5 "plainText": "文档库内容www.xxxx.com",
6 "title": "文档库测试",
7 "attaches": [{
8 "url": "http://127.0.0.1:8888/api/v2/file/download?key=Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
9 "name": "测试图.jpg",
10 "key": "Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
11 "size": 23663,
12 }],
13 "faqs": ["id1"],
14 "tags": ["标签1", "标签2"],
15 "wordNum": 17,
16 "pictureNum": 0,
17 "linkNum": 1
18}
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
id | string | data | 文档库ID |
文档库更新
1、接口地址:(POST) {IP}:{PORT}/open/v{versionId}/document/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 父节点 | 备注 |
---|---|---|---|---|
id | string | 否 | 文档id | |
contentVersion | string | 否 | 内容版本号 | |
dococEditStatus | short | 是 | 更新状态,0表示未正在编辑,1表示正在编辑 | |
dirIds | string | 否 | 目录id | |
title | string | 是 | 关联的标题(如果未更改标题,则传入原标题) | |
richText | string | 是 | 富文本数据 | |
plainText | string | 是 | 纯文本数据【如果有富文本的情况下,需要把富文本中的纯文字提取出来,放到这个字段中。纯文本不可单独存在】 | |
attaches | list | 是 | 关联的附件列表 | |
url | string | 否 | attaches | 地址 |
name | string | 否 | attaches | 名称 |
key | string | 否 | attaches | 获取预览地址时使用 |
size | string | 否 | attaches | 文件大小 |
faqs | list< string> | 是 | 关联标准问的id列表 | |
tags | list< sring> | 是 | 标签列表 | |
linkNum | int | 是 | 链接数【页面展示用】 | |
pictureNum | int | 是 | 图片数【页面展示用】 | |
wordNum | int | 是 | 文档字符数(如果richText不为空,则此字段必传,数量为richText去掉标签和空格后所剩长度) |
请求示例
1POST /open/v{versionId}/document/update
2{
3 "attaches": [{
4 "url": "http://127.0.0.1:8080/api/v2/file/downloadkey=Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
5 "name": "测试图.jpg",,
6 "size": 23663,
7 "key": "Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw=="
8 }],
9 "contentVersion": 0,
10 "dirId": "0",
11 "docEditingStatus": 2,
12 "faqs": ["id1"],
13 "id": "xxxxxxxxxxxxxxxxxxx",
14 "linkNum": 1,
15 "pictureNum": 1,
16 "richText": "<p>文档库内容<a href=\"http://www.xxxx.com\" target=\"_blank\">www.xxxx.com</a><img src=\"http://cp01-mk-se0.epc.baidu.com:8499/api/v2/file/download?key=Ym9zX2E1ZDczZWQ3LTgzNWEtNDJkNy05NzBmLWUwZjM1MThmMDc1Nw==\" style=\"\"></p>",
17 "tags": ["标签1", "标签2"],
18 "title": "文档库测试更新",
19 "wordNum": 17,
20 "plainText": "文档库内容www.xxxx.com[图片]"
21}
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
contentVersion | int | 文档内容版本 |
文档库删除
1、接口地址:(POST) {IP}:{PORT}/open/v{versionId}/document/delete
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | String | 否 | 文档库ID |
3、返回值
参数名 | 类型可空 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 |
文档库列表
1、接口地址:(GET) {IP}:{PORT}/open/v{versionId}/document
2、入参 (写入到param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
dirId | string | 是 | 目录ID |
title | string | 是 | 关联的标题 |
keyword | string | 是 | 关键字 |
tagKeyword | string | 是 | 标签关键字(与keyword联合使用。当keyword与tagKeyword同时存在时,标题,纯文本,附件按keyword搜索,标签按tagKeyword搜索。tagKeyword单独存在不生效) |
pn | int | 是 | 查询页数,默认为1 |
ps | int | 是 | 每页数据条数,默认为20 |
order | string | 是 | 排序顺序("desc"为降序,“asc为升序”) |
orderBy | string | 是 | 以何字段排序,候选值为“created_username”和“title” |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 当前页数 |
ps | int | data | 每页数量 |
list | list | data | 数据列表 |
id | string | list | 文档ID |
title | string | list | 文档标题 |
lastEditTime | string | list | 最后编辑时间戳 |
lastEditUsername | string | list | 最后修改人名称 |
updated | string | list | 修改时间戳 |
示例:
1{
2 "code":200,
3 "time":1568257385194,
4 "msg":"OK"
5 "data":{
6 "total":1,
7 "pn":1,
8 "ps":20,
9 "list":[
10 {
11 "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
12 "title": "这是一个文档",
13 "lastEditTime": "2019-11-05 11:36:38",
14 "lastEditUsername": "MOCK_USER_NAME",
15 "updated": "2019-11-05 11:36:38"
16 }
17 },
18}
文档库详情
1、接口地址: (GET) {IP}:{PORT}/open/v{versionId}/document/detail
2、入参(写入到param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 文档库ID |
action | string | 是 | 当前动作。(如果传值为"edit",则表示是编辑类型的详情查询,则需要登记编辑状态和账户信息,其他值不生效) |
log | string | 是 | log类型。(如果值为"statistics",则使用静态操作记录,其他值不生效) |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
id | string | data | 文档ID |
contentVersion | int | data | 内容的version;原来的version用于判断目录的变更; |
created | string | data | 创建时间 |
createdUsername | string | data | 创建者用户名 |
dirId | string | data | 目录ID |
version | int | data | 版本号 |
docEditingStartTime | string | data | 文档编辑开始时间 |
docEditingStatus | short | data | 文档编辑状态 |
docEditingUserid | string | data | 文档编辑者用户ID |
docEditingUsername | string | data | 文档编辑者用户名 |
faqs | list | data | faqID列表 |
lastEditTime | string | data | 最近一次编辑时间 |
lastEditUsername | string | data | 最近一次编辑者用户名 |
linkNum | int | data | 链接数量 |
overtime | int | data | 超时次数 |
pictureNum | int | data | 图片数量 |
richText | string | data | 富文本 |
tags | list | data | 标签列表 |
title | string | data | 标题 |
wordNum | int | data | 字数 |
attaches | list | data | 附件 |
url | string | attaches | 附件url |
name | string | attaches | 附件名称 |
originAddress | string | attaches | 原始地址 |
originFile | string | attaches | 原始文件 |
size | int | attaches | 文件大小 |
key | string | attaches | 预览地址使用的键 |
uid | string | attaches | 用户ID |
username | string | attaches | 用户名称 |
time | long | attaches | 毫秒级时间戳 |
created | string | attaches | 创建日期 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"",
5 "data":{
6 "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
7 "contentVersion": 0,
8 "created": "2019-07-22 17:52:09",
9 "createdUsername": "MOCK_USER_NAME",
10 "dirId": "8034e73a-16e9-4d8e-b61f-33b1eff858d4",
11 "docEditingStartTime": "",
12 "docEditingStatus": 0,
13 "docEditingUserId": "MOCK_USER_ID",
14 "docEditingUserName": "MOCK_USER_NAME",
15 "faqs":["23084a68-b7b9-43c8-b014-194fa2348b29"],
16 "lastEditTime": "2019-07-16 11:02:22",
17 "lastEditUserName": "MOCK_USER_NAME",
18 "linkNum": 0,
19 "overtime": 0,
20 "pictureNum": 0,
21 "richText": "<p><span style="background-color: rgb(255, 255, 0);">test</span></p>",
22 "tags": ["测试", "文档"],
23 "title": "这是一个文档",
24 "version": 0,
25 "wordNum": 200,
26 "attaches": [
27 { "url":"http://cp01mkse0.epc.baidu.com:8499/api/v2/file/downloadkey=Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
28 "name": "我的文档.xlsx",
29 "originAddress": "http://cp01-mk-se0.epc.baidu.com:8499/api/v2/file/download?key=Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
30 "originFile": "我的文档.xlsx",
31 "size": 200,
32 "key": "Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
33 "uid": "MOCK_USER_NAME",
34 "username": "MOCK_USER_ID",
35 "time": 1563417098146,
36 "created": "2019-11-25 22:31:43"
37 },
38 ......
39
40 ]
41 }
42}
文档库搜索
1、接口地址:(GET) {IP}:{PORT}/open/v{versionId}/document/search
2、入参(写入到param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
keyword | string | 否 | 关键词 |
ps | int | 是 | 页面大小【默认20】 |
pn | int | 是 | 页码【默认1】 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 当前页数 |
ps | int | data | 每页数量 |
list | list | data | 数据列表 |
id | string | list | 文档ID |
agendId | string | list | agentID |
title | string | list | 文档标题 |
plainText | string | list | 富文本内容 |
updated | string | list | 更新时间 |
tags | list< string> | list | 标签列表 |
dirId | string | list | 目录id |
示例:
1{
2 "time":1571137306169,
3 "data":{
4 "total":1,
5 "ps":20,
6 "list":[
7 {
8 "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
9 "plainText":"富文本的回答内容。表头<aicp_em_highlight>1</aicp_em_highlight>表头2回答<aicp_em_highlight>1</aicp_em_highlight>回答2[图片]链接地址www",
10 "dirId":"ff7c8a87-420e-499b-afdf-27ff0040c317",
11 "id":"617d60e1-c05c-48c4-a3f7-ceacd2eb0a01",
12 "title":"<aicp_em_highlight>文档</aicp_em_highlight><aicp_em_highlight>库</aicp_em_highlight><aicp_em_highlight>1</aicp_em_highlight>",
13 "lastEditTime":"2019-10-15 17:26:36",
14 "lastEditUserId":"32500597715",
15 "lastEditUsername":"aicp",
16 "updated":"2019-10-15 17:26:36",
17 "tags":[
18 "标签1",
19 "标签2",
20 "标签3",
21 "标签4"
22 ]
23 }
24 ],
25 "pn":1
26 },
27 "code":200,
28 "msg":"OK"
29}
意图
意图不响应
意图不响应问题创建
1、接口地址: {IP}:{PORT}/open/v{versionId}/intent/noresp/create
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
question | string | 否 | 意图不响应问题 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据信息 | |
id | string | id |
示例:
1{
2 "code":200,
3 "data":{"id":"xxxxx"},
4 "time":1567998660176,
5 "msg":"OK",
6 }
意图不响应问题更新
1、接口地址: (POST) {IP}:{PORT}/open/v{versionId}/intent/noresp/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图不响应问题ID |
question | string | 否 | 意图不响应问题 |
version | string | 否 | 意图不响应问题版本 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据信息 | |
version | int | 版本号 |
示例:
1{
2 "code":200,
3 "data":{"version":1},
4 "time":1567998660176,
5 "msg":"OK",
6 }
意图不响应问题删除
1、接口地址: (POST) {IP}:{PORT}/open/v{versionId}/intent/noresp/delete
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图不响应问题ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 }
意图不响应问题列表
1、接口地址: (GET) {IP}:{PORT}/open/v{versionId}/intent/noresp
2、入参
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
keyword | string | 是 | 问题关键字 |
pn | int | 是 | 页码,默认为1 |
ps | int | 是 | 每页数据条数,默认为10 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 查询页数 |
ps | int | data | 每页大小 |
list | list | data | 数据列表 |
id | string | list | 意图不响应问题id |
question | string | list | 意图不响应问题 |
agentId | string | list | agent ID |
lastModifyUser | string | list | 最后一次修改的用户 |
createUser | string | list | 创建者用户 |
created | string | list | 创建时间 |
updated | string | list | 最后修改时间 |
version | int | list | 版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"",
5 "data":{
6 "total": 245,
7 "pn": 1,
8 "ps": 10,
9 "list": [
10 {
11 "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
12 "question": "一个问题",
13 "agentId": "53639538-1519-4a0b-bcfd-a6ee8f970173",
14 "lastModifyUser": "user1",
15 "createUser": "user1",
16 "created": "2019-07-22 17:52:09",
17 "updated": "2019-07-22 17:52:09",
18 "version": 1,
19 },
20 ······
21 ]
22 }
23}
意图模板
意图模板新建
1、接口地址: (POST) {IP}:{PORT}/open/v{versionId}/intent/template/create
2、说明:用于意图模板的新建
3、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
template | string | 否 | 意图模板 |
intentId | string | 否 | 意图ID |
4、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据信息 | |
id | string | id |
示例
1 "data":{"id":"xxxxxxx"},
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 }
意图模板更新
1、接口地址: (POST) {IP}:{PORT}/open/v{versionId}/intent/template/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图模板ID |
template | string | 否 | 意图模板 |
intentId | string | 否 | 意图ID |
version | int | 否 | 意图模板版本号 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据信息 | |
version | int | data | 更新后意图模板版本号 |
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 "data":
6 {
7 "version":1
8 }
9 }
意图模板删除
1、接口地址: (POST) {IP}:{PORT}/open/v{versionId}/intent/template/delete
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图模板ID |
intentId | string | 否 | 意图ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 }
意图模板列表
1、接口地址: (GET) {IP}:{PORT}/open/v{versionId}/intent/template
2、入参
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
intentId | string | 否 | 意图ID |
keyword | string | 是 | 意图关键字 |
pn | int | 是 | 页码,默认为1 |
ps | int | 是 | 每页数据条数,默认为10 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 查询页数 |
ps | int | data | 每页大小 |
list | list | data | 数据列表 |
id | string | list | 意图id |
template | string | list | 意图模板 |
updated | string | list | 最后更新时间 |
created | string | list | 创建时间 |
intentId | string | list | 意图ID |
version | int | list | 意图模板版本号 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"",
5 "data":{
6 "total": 245,
7 "pn": 1,
8 "ps": 10,
9 "list": [
10 {
11 "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
12 "template": "模板",
13 "created": "2019-07-22 17:52:09",
14 "updated": "2019-07-22 17:52:09",
15 "intentId": "1fe0ed0f-6e4a-45a4-bdf8-78928f58519c",
16 "version": 0
17 },
18 ······
19 ]
20 }
21}
意图示例
意图示例创建
1、接口地址:(POST) {IP}:{PORT}/open/v{versionId}/intent/example/create
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
example | string | 否 | 意图示例 |
intentId | string | 否 | 意图id【数据存储ID】 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据信息 | |
id | string | data | id |
示例:
1{
2 "code":4002801,
3 "time":1568613825147,
4 "msg":"新建意图示例成功",
5 "data":{"id":"xxxxx"}
6}
意图示例修改
1、接口地址:(POST) {IP}:{PORT}/open/v{versionId}/intent/example/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图示例Id |
intentId | string | 否 | 意图id【数据存储Id】 |
value | String | 否 | 意图示例修改值 |
version | int | 否 | 版本号 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据信息 | |
version | int | 版本信息 |
示例:
1{
2
3 "data":{"version":1},
4 "code":4002801,
5 "time":1568613825147,
6 "msg":"编辑意图示例成功"
7}
意图示例删除
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/intent/example/delete
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图示例id |
intentId | string | 否 | 意图id【数据存储ID】 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 |
示例:
1{
2 "code":4002801,
3 "time":1568613825147,
4 "msg":"删除意图示例成功"
5}
意图示例列表
1、接口地址:GET {IP}:{PORT}/open/v{versionId}/intent/example
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
intentId | string | 否 | 意图Id |
ps | int | 是 | 页面大小【默认是10】 |
pn | int | 是 | 页码【默认是1】 |
keyword | string | 是 | 搜索关键词 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | object | 数据 | |
list | list | data | 数据列表 |
id | string | list | 意图示例id |
value | string | list | 意图示例示例值 |
updated | string | list | 更新时间 |
created | string | list | 创建时间 |
intentId | string | list | 意图Id |
agentId | string | list | agentId |
version | int | list | 版本号 |
示例:
1{
2 "time":1572334765237,
3 "data":{
4 "total":2,
5 "ps":10,
6 "list":[
7 {
8 "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
9 "created":"2020-03-20 18:57:41",
10 "intentId":"6dfe3f25-2a51-4928-9bf1-ac360abf992a",
11 "id":"fa6893b6-befc-472e-9e88-2a63a4dc8c4e",
12 "value":"智能客服",
13 "version":1,
14 "updated":"2020-03-20 18:57:41"
15 },
16 {
17 "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
18 "created":"2020-03-20 18:57:41",
19 "intentId":"6dfe3f25-2a51-4928-9bf1-ac360abf992a",
20 "id":"ceeca60d-44d0-4234-8ea7-7e9fd06ab090",
21 "value":"智能秘书",
22 "version":1,
23 "updated":"2020-03-20 18:57:41"
24 }
25 ],
26 "pn":1
27 },
28 "code":200,
29 "msg":"OK"
30}
用户意图
用户意图新建
1、接口地址:(POST) {IP}:{PORT}/open/v{versionId}/user/intent/create
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
name | string | 否 | 意图名称 |
nameZh | string | 否 | 意图中文名称 |
alias | string | 是 | 意图别名 |
description | string | 是 | 描述 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据信息 | |
id | string | data | id信息 |
示例:
1{
2 "data":{"id":"xxxxxxx"}
3 "code":200,
4 "time":1567998660176,
5 "msg":"OK",
6 }
用户意图更新
1、接口地址: (POST) {IP}:{PORT}/open/v{versionId}/user/intent/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图ID |
name | string | 否 | 意图名称 |
nameZh | string | 否 | 意图中文名称 |
alias | string | 是 | 意图别名(多个别名以“,”隔开) |
description | string | 是 | 描述 |
version | int | 否 | 版本号 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 数据信息 | |
version | int | data | 版本号 |
示例:
1{
2 "data":{"version": 1},
3 "code":200,
4 "time":1567998660176,
5 "msg":"OK",
6 }
用户意图删除
1、接口地址: (POST) {IP}:{PORT}/open/v{versionId}/user/intent/delete
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"OK",
5 }
用户意图列表
1、接口地址: (GET) {IP}:{PORT}/open/v{versionId}/user/intent
2、入参
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
keyword | string | 是 | 意图关键字 |
pn | int | 是 | 页码,默认为1 |
ps | int | 是 | 每页数据条数,默认为20 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
total | int | data | 总大小 |
pn | int | data | 查询页数 |
ps | int | data | 每页大小 |
list | list | data | 数据列表 |
id | string | list | 意图id |
name | string | list | 意图名称 |
description | string | list | 意图描述 |
updated | string | list | 最后更新时间 |
created | string | list | 创建时间 |
agentId | string | list | agentID |
alias | string | list | 意图别名 |
nameZh | string | list | 意图中文名称 |
version | int | list | 版本号 |
createdUserId | string | list | 创建者id |
createdUsername | string | list | 创建者 |
lastEditUsername | string | list | 最后编辑者名称 |
lastEditUserId | string | list | 最后编辑者id |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"",
5 "data":{
6 "total": 245,
7 "pn": 1,
8 "ps": 10,
9 "list": [
10 {
11 "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
12 "name": "intent__name",
13 "created": "2019-07-22 17:52:09",
14 "updated": "2019-07-22 17:52:09",
15 "description": "意图描述",
16 "agendId": "1fe0ed0f-6e4a-45a4-bdf8-78928f58519c",
17 "alias": "别名",
18 "nameZh": " 中文名称",
19 "version": 1,
20 "createdUserId": "32500597715",
21 "createdUsername": "aicp",
22 "lastEditUsername": "aicp",
23 "lastEditUserId": "32500597715",
24 },
25 ······
26 ]
27 }
28}
用户意图详情
1、接口地址: (GET) {IP}:{PORT}/open/v{versionId}/user/intent/detail
2、入参(写入到param中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 意图ID |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
id | string | data | 意图id |
name | string | data | 意图名称 |
description | string | data | 意图描述 |
alias | string | data | 意图别名 |
nameZh | string | data | 意图中文名称 |
示例:
1{
2 "code":200,
3 "time":1567998660176,
4 "msg":"",
5 "data":{
6 "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
7 "name": "intent__name",
8 "description": "意图描述",
9 "alias": "别名",
10 "nameZh": " 中文名称"
11 }
12}
系统意图
系统意图生效
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/sys/intent/enable
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 系统意图id |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 |
示例:
1{
2 "code":200,
3 "time":1568613825147,
4 "msg":"启动系统意图成功"
5}
系统意图失效
1、接口地址:POST {IP}:{PORT}/open/v{versionId}/sys/intent/disable
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
id | string | 否 | 系统意图id |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 |
示例:
1{
2 "code":200,
3 "time":1568613825147,
4 "msg":"禁用系统意图成功"
5}
系统意图列表
1、接口地址:(GET) {IP}:{PORT}/open/v{versionId}/sys/intent
2、入参(query param)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
ps | int | 是 | 页面大小【默认20】 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | object | 数据 | |
total | int | data | 数据总量 |
ps | int | data | 页面大小 |
pn | int | data | 页码 |
list | list | data | 数据列表 |
agentId | string | list | agentId |
created | long | list | 创建时间戳 |
nameZh | string | list | 意图中文名称 |
intro | string | list | 系统意图示例,类似这些对话会被识别为该意图,以“\x01”分割 |
name | string | list | 意图ID |
description | string | list | 意图描述 |
id | string | list | 数据存储id |
updated | string | list | 数据更新时间戳 |
addedSystem | boolean | list | 当前agent是否已启用该系统意图 |
示例:
1{
2
3 "time":1572255991674,
4
5 "data":{
6 "total":6,
7 "ps":20,
8 "list":[
9 {
10 "agentId":"sys_agent_id",
11 "created":"",
12 "nameZh":"挂断意图",
13 "intro":"挂断 \x01exit",
14 "name":"sys_exit",
15 "description":"挂断意图",
16 "id":"sys_intent_9",
17 "updated":""
18 },
19 {
20 "agentId":"sys_agent_id",
21 "addedSystem":true,
22 "created":1560280513000,
23 "nameZh":"转人工意图",
24 "intro":"转人工",
25 "name":"sys_manual_service",
26 "description":"转人工意图",
27 "id":"sys_intent_7",
28 "updated":""
29 }
30 ],
31 "pn":1
32 },
33
34 "code":200,
35
36 "msg":"OK"
37
38}
系统意图详情
1、接口地址:GET {IP}:{PORT}/open/v{versionId}/sys/intent/detail
2、入参(query param)
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
intentId | int | 否 | 意图Id |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | object | 数据 | |
nameZh | string | data | 意图中文名称 |
intro | string | data | 系统意图的补充描述 |
name | string | data | 意图ID |
description | string | data | 描述 |
id | string | data | 数据存储id |
示例:
1{
2 "time":1572264401019,
3 "data":{
4 "enable":true,
5 "nameZh":"挂断意图",
6 "intro":"挂断 \x01exit",
7 "name":"sys_exit",
8 "description":"挂断意图",
9 "id":"sys_intent_9"
10 },
11 "code":200,
12 "msg":"OK"
13}
FAQ NLU 分析
版本:(since 5.6)
1、接口地址:GET {IP}:{PORT}/open/v{versionId}/nlu/faq/recognize
2、入参
参数名 | 类型 | 是否可空 | 备注 |
---|---|---|---|
query | string | 否 | 请求文本 |
3、返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | ||
total | int | data | 返回总数量 |
list | list | data | 数据列表 |
id | string | list | id |
question | string | list | 问题 |
faqId | string | list | 标准问id |
standardQuestion | string | list | 标准问问题 |
template | string | list | 模板 |
source | string | list | 来源 |
score | string | list | 置信度 |
示例:
1{
2 "time":1585021517982,
3 "data":{
4 "list":[
5 {
6 "id":"6cddd214-9a9a-4894-9a0f-9d2751b8c743",
7 "question":"测试德",
8 "faqId":"7af4c95b-16d3-4e0d-91db-71a821d88c6e",
9 "standardQuestion":"nlu 测试吧",
10 "template":null,
11 "source":"extend",
12 "score":1
13 }
14 ],
15 "total":1
16 },
17 "code":200,
18 "msg":"OK"
19}