平台管理

更新时间：2020-09-08

接口说明

平台管理接口主要用于搭建和管理对话平台的测试环境（offline），可以通过此类接口在无平台界面的情况下搭建知识库。目前主要支持的模块包括：目录、闲聊、文档库、意图，其他模块正在陆续开放中。

各模块时序图

渠道时序图

目录时序图

问答时序图

闲聊时序图

文档库时序图

意图时序图

闲聊库

闲聊库标准问

闲聊库标准问新建

1.接口地址： (POST) {IP}:{PORT}/open/v{versionId}/chitchat/standard/create

2.入参(需生成JSON字符串，放到请求的body中)

参数名	类型	是否可空	备注
answer	list< map>	否	答案Map列表
text	string	否	答案文本
type	string	否	答案类型（只能传数字，目前只可为1，为纯文本）
question	string	否	问题

示例：

{
    "answer":[
        {
            "text":"答案1",
            "type":"1" 
        },
        ......
    ]
    "question":“问题1”
}

3.返回值

参数名	类型	父节点	备注
code	int		HTTP状态码
time	long		时间
msg	string		状态信息
data	map		返回数据
id	int	data	闲聊标准问id

示例：

{
    "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
    "code":200,
    "time":1568274632887,
    "msg":"OK"
}

闲聊库标准问更新

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，为纯文本）

示例：

{
	"id":"003ecd4f-344c-4187-8b14-f12737161ef31"，
	"version":1,
    "answer":[
        {
            "text":"答案1",
            "type":"1" 
        },
        ......
    ]
    "question":“问题1”
}

3.返回值

参数名	类型	备注
code	int	HTTP状态码
time	long	时间
msg	string	状态信息
data	map	返回数据
version	int	版本号

示例：

{
    "data":{"version":1},
    "code":200,
    "time":1568274632887,
    "msg":"OK"
}

闲聊库标准问删除

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	版本号

示例：

{
    "code":200，
    "time":1567998660176，
    "msg":"OK"，
    "data":{
        "total": 245,
        "pn": 1,
        "ps": 10,
        "list": [
            {   
                "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
                "answer": [{"text":"答案1","type":1}]，
                "question": "问题1"，
                "created": "2019-07-22 17:52:09"，   
                "updated": "2019-07-22 17:52:09"，   
                "version": 1               
            }，
            ······
        ]
    }
}

闲聊库标准问题检索

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	版本号

示例：

{
    "code":200，
    "time":1567998660176，
    "msg":"OK"，
    "data":{
        "total": 245,
        "pn": 1,
        "ps": 10,
        "list": [
            {   
                "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
                "answer": [{"text":"答案1","type":1}]，
                "question": "问题1"，
                "created": "2019-07-22 17:52:09"，   
                "updated": "2019-07-22 17:52:09"，   
                "version": 1               
            }，
            ······
        ]
    }
}

闲聊库扩展问

闲聊库扩展问新建

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

示例：

{
    "data":{"id":"08cd59d8-0e2a-4b76-8d2f-568bacad8d5e"},
    "code":200,
    "time":1568274632887,
    "msg":"OK"
}

闲聊库扩展问更新

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	版本号

示例：

{
    "data":{"iversion":1},
    "code":200,
    "time":1568274632887,
    "msg":"OK"
}

闲聊库扩展问删除

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	版本号

示例：

{
    "code":200，
    "time":1567998660176，
    "msg":"OK"，
    "data":{
        "total": 245,
        "pn": 1,
        "ps": 10,
        "list": [
            {   
                "id":"001f1522-015d-4831-9cf6-0f8b11a78028",
                "question": "问题1"，
                "standardId": "002d1161-90a1-4ed8-a9af-71d5faa2ee6f"，
                "extendId": "001f1522-015d-4831-9cf6-0f8b11a78028"，
                "created": "2019-07-22 17:52:09"，   
                "updated": "2019-07-22 17:52:09"，
                "version": 1                   
            }，
            ······
        ]
    }
}

闲聊库标准问题检索

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	版本号

示例：

{
    "code":200，
    "time":1567998660176，
    "msg":"OK"，
    "data":{
        "total": 245,
        "pn": 1,
        "ps": 10,
        "list": [
            {   
                "id":"001f1522-015d-4831-9cf6-0f8b11a78028",
                "question": "问题1"，
                "standardId": "002d1161-90a1-4ed8-a9af-71d5faa2ee6f"，
                "extendId": "001f1522-015d-4831-9cf6-0f8b11a78028"，
                "created": "2019-07-22 17:52:09"，   
                "updated": "2019-07-22 17:52:09"，
                "version": 1                   
            }，
            ······
        ]
    }
}

参数名	类型	是否可空	备注
name	string	否	目录名称
parentId	string	否	父节点ID【备注：根目录id是0】
version	int	否	目录版本号

参数名	类型	是否可空	备注
name	string	否	目录名称
id	string	否	目录ID
version	int	否	目录版本号

参数名	类型	是否可空	备注
id	string	否	目录ID

{
    "code":200，
    "time":1567998660176，
    "msg":""，
    "data":[
            {   
                "id":"008ac842-082f-4492-b765-f12d19bf1fd5",
                "name": "一级目录"，
                "hasPerm": 1，   
                "parentId": "00e01f9a-7ea3-401c-a8a0-8d8aee42fd44"，
                "sort": 1， 
                "version": 1，
 
            }，
            ······
        ]
}

文档库

文档库新建

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去掉标签和空格后所剩长度)

示例

POST /open/v{versionId}/document/create
{
	"dirId": "0",
	"richText": "<p>文档库内容<a href=\"http://www.xxxx.com\" target=\"_blank\">www.xxxx.com</a></p>",
	"plainText": "文档库内容www.xxxx.com",
	"title": "文档库测试",
	"attaches": [{
		"url": "http://127.0.0.1:8888/api/v2/file/download?key=Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
		"name": "测试图.jpg",
		"key": "Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
		"size": 23663,
	}],
	"faqs": ["id1"],
	"tags": ["标签1", "标签2"],
	"wordNum": 17,
	"pictureNum": 0,
	"linkNum": 1
}

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去掉标签和空格后所剩长度)

请求示例

POST /open/v{versionId}/document/update
{
	"attaches": [{
		"url": "http://127.0.0.1:8080/api/v2/file/downloadkey=Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
		"name": "测试图.jpg",,
		"size": 23663,
		"key": "Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw=="
	}],
	"contentVersion": 0,
	"dirId": "0",
	"docEditingStatus": 2,
	"faqs": ["id1"],
	"id": "xxxxxxxxxxxxxxxxxxx",
	"linkNum": 1,
	"pictureNum": 1,
	"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>",
	"tags": ["标签1", "标签2"],
	"title": "文档库测试更新",
	"wordNum": 17,
	"plainText": "文档库内容www.xxxx.com[图片]"
}

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	修改时间戳

示例：

{
    "code":200,
    "time":1568257385194,
    "msg":"OK"
    "data":{
        "total":1,
        "pn":1,
        "ps":20,
        "list":[
            {
             "id": "0849962b-7622-4cc6-9928-d1186784f8f7",
             "title": "这是一个文档",
             "lastEditTime": "2019-11-05 11:36:38",
             "lastEditUsername": "MOCK_USER_NAME",
             "updated": "2019-11-05 11:36:38" 
            } 
    },   
}

文档库详情

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	创建日期

示例：

{
    "code":200，
    "time":1567998660176，
    "msg":""，
    "data":{
        "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
        "contentVersion": 0，
        "created": "2019-07-22 17:52:09"，  
        "createdUsername": "MOCK_USER_NAME"，
        "dirId": "8034e73a-16e9-4d8e-b61f-33b1eff858d4"，
        "docEditingStartTime": ""，
        "docEditingStatus": 0,
        "docEditingUserId": "MOCK_USER_ID",
        "docEditingUserName": "MOCK_USER_NAME",
        "faqs":["23084a68-b7b9-43c8-b014-194fa2348b29"],
        "lastEditTime": "2019-07-16 11:02:22",
        "lastEditUserName": "MOCK_USER_NAME",
        "linkNum": 0,
        "overtime": 0,
        "pictureNum": 0,
        "richText": "<p><span style="background-color: rgb(255, 255, 0);">test</span></p>",
        "tags": ["测试"， "文档"],
        "title": "这是一个文档",
        "version": 0,
        "wordNum": 200,
        "attaches": [
            {                "url":"http://cp01mkse0.epc.baidu.com:8499/api/v2/file/downloadkey=Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
                "name": "我的文档.xlsx",
                "originAddress": "http://cp01-mk-se0.epc.baidu.com:8499/api/v2/file/download?key=Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
                "originFile": "我的文档.xlsx"，
                "size": 200,
                "key": "Ym9zXzBkZmM5NWZjLWNjMDYtNDIwMi1iZmE2LTA4YmFkMjkzMGM4Mg==",
                "uid": "MOCK_USER_NAME",
                "username": "MOCK_USER_ID",
                "time": 1563417098146,
                "created": "2019-11-25 22:31:43"	
            },
            ......
     
        ]
    }
}

文档库搜索

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

示例：

{
    "time":1571137306169,
    "data":{
        "total":1,
        "ps":20,
        "list":[
            {
                "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
                "plainText":"富文本的回答内容。表头<aicp_em_highlight>1</aicp_em_highlight>表头2回答<aicp_em_highlight>1</aicp_em_highlight>回答2[图片]链接地址www",
                "dirId":"ff7c8a87-420e-499b-afdf-27ff0040c317",
                "id":"617d60e1-c05c-48c4-a3f7-ceacd2eb0a01",
                "title":"<aicp_em_highlight>文档</aicp_em_highlight><aicp_em_highlight>库</aicp_em_highlight><aicp_em_highlight>1</aicp_em_highlight>",
                "lastEditTime":"2019-10-15 17:26:36",
                "lastEditUserId":"32500597715",
                "lastEditUsername":"aicp",
                "updated":"2019-10-15 17:26:36",
                "tags":[
                    "标签1",
                    "标签2",
                    "标签3",
                    "标签4"
                ]
            }
        ],
        "pn":1
    },
    "code":200,
    "msg":"OK"
}

意图

意图不响应

意图不响应问题创建

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

示例：

{
	"code":200，
	"data":{"id":"xxxxx"}，
	"time":1567998660176，
	"msg":"OK"，
 }

意图不响应问题更新

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	版本号

示例：

{
	"code":200，
	"data":{"version":1}，
	"time":1567998660176，
	"msg":"OK"，
 }

意图不响应问题删除

1、接口地址： (POST) {IP}:{PORT}/open/v{versionId}/intent/noresp/delete

2、入参(需生成json字符串，放到请求的body中)

参数名	类型	是否可空	备注
id	string	否	意图不响应问题ID

3、返回值

参数名	类型	备注
code	int	HTTP状态码
time	long	时间
msg	string	状态信息

示例：

{
	"code":200，
	"time":1567998660176，
	"msg":"OK"，
 }

意图不响应问题列表

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	版本号

示例：

{
	"code":200，
	"time":1567998660176，
	"msg":""，
	"data":{
		"total": 245,
		"pn": 1,
		"ps": 10,
		"list": [
			{	
				"id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
				"question": "一个问题"，
				"agentId": "53639538-1519-4a0b-bcfd-a6ee8f970173"，
				"lastModifyUser": "user1"，
				"createUser": "user1"，
				"created": "2019-07-22 17:52:09"，	
				"updated": "2019-07-22 17:52:09"，
				"version": 1,
			}，
			······
		]
	}
}

意图模板

意图模板新建

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

示例

	"data":{"id":"xxxxxxx"}，
	"code":200，
	"time":1567998660176，
	"msg":"OK"，
 }

意图模板更新

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	更新后意图模板版本号

{
	"code":200，
	"time":1567998660176，
	"msg":"OK"，
  "data":
     {
         "version":1
     }
 }

意图模板删除

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	状态信息

示例：

{
	"code":200，
	"time":1567998660176，
	"msg":"OK"，
 }

意图模板列表

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	意图模板版本号

示例：

{
	"code":200，
	"time":1567998660176，
	"msg":""，
	"data":{
		"total": 245,
		"pn": 1,
		"ps": 10,
		"list": [
			{	
				"id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
				"template": "模板"，
				"created": "2019-07-22 17:52:09"，	
				"updated": "2019-07-22 17:52:09"，
				"intentId": "1fe0ed0f-6e4a-45a4-bdf8-78928f58519c"，
        "version": 0
			}，
			······
		]
	}
}

意图示例

意图示例创建

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

示例：

{
    "code":4002801,
    "time":1568613825147,
    "msg":"新建意图示例成功",
    "data":{"id":"xxxxx"}
}

意图示例修改

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	版本信息

示例：

{
   
    "data":{"version":1},
    "code":4002801,
    "time":1568613825147,
    "msg":"编辑意图示例成功"
}

意图示例删除

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	状态信息

示例：

{
    "code":4002801,
    "time":1568613825147,
    "msg":"删除意图示例成功"
}

意图示例列表

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	版本号

示例：

{
    "time":1572334765237,
    "data":{
        "total":2,
        "ps":10,
        "list":[
            {
                "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
                "created":"2020-03-20 18:57:41",
                "intentId":"6dfe3f25-2a51-4928-9bf1-ac360abf992a",
                "id":"fa6893b6-befc-472e-9e88-2a63a4dc8c4e",
                "value":"智能客服",
                "version":1,
                "updated":"2020-03-20 18:57:41"
            },
            {
                "agentId":"4429d24c-286f-4ce2-acc6-83eca9577309",
                "created":"2020-03-20 18:57:41",
                "intentId":"6dfe3f25-2a51-4928-9bf1-ac360abf992a",
                "id":"ceeca60d-44d0-4234-8ea7-7e9fd06ab090",
                "value":"智能秘书",
                "version":1,
                "updated":"2020-03-20 18:57:41"
            }
        ],
        "pn":1
    },
    "code":200,
    "msg":"OK"
}

用户意图

用户意图新建

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信息

示例：

{
	"data":{"id":"xxxxxxx"}
	"code":200，
	"time":1567998660176，
	"msg":"OK"，
 }

用户意图更新

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	版本号

示例：

{
	"data":{"version": 1}，
	"code":200，
	"time":1567998660176，
	"msg":"OK"，
 }

用户意图删除

1、接口地址： (POST) {IP}:{PORT}/open/v{versionId}/user/intent/delete

2、入参(需生成json字符串，放到请求的body中)

参数名	类型	是否可空	备注
id	string	否	意图ID

3、返回值

参数名	类型	备注
code	int	HTTP状态码
time	long	时间
msg	string	状态信息

示例：

{
	"code":200，
	"time":1567998660176，
	"msg":"OK"，
 }

用户意图列表

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

示例：

{
	"code":200，
	"time":1567998660176，
	"msg":""，
	"data":{
		"total": 245,
		"pn": 1,
		"ps": 10,
		"list": [
			{	
				"id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
				"name": "intent__name"，
				"created": "2019-07-22 17:52:09"，	
				"updated": "2019-07-22 17:52:09"，
				"description": "意图描述"，
				"agendId": "1fe0ed0f-6e4a-45a4-bdf8-78928f58519c"，
				"alias": "别名"，
				"nameZh": " 中文名称",
				"version": 1,
        "createdUserId": "32500597715",
        "createdUsername": "aicp",
        "lastEditUsername": "aicp",
        "lastEditUserId": "32500597715",
			}，
			······
		]
	}
}

用户意图详情

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	意图中文名称

示例：

{
	"code":200，
	"time":1567998660176，
	"msg":""，
	"data":{
               "id":"00ace67f-43c4-43e0-a7fa-b436af338d99",
                "name": "intent__name"，
                "description": "意图描述"，
                "alias": "别名"，
                "nameZh": " 中文名称"
	}
}

系统意图

系统意图生效

1、接口地址：POST {IP}:{PORT}/open/v{versionId}/sys/intent/enable

2、入参(需生成json字符串，放到请求的body中)

参数名	类型	是否可空	备注
id	string	否	系统意图id

3、返回值

参数名	类型	备注
code	int	HTTP状态码
time	long	时间
msg	string	状态信息

示例：

{
    "code":200,
    "time":1568613825147,
    "msg":"启动系统意图成功"
}

系统意图失效

1、接口地址：POST {IP}:{PORT}/open/v{versionId}/sys/intent/disable

2、入参(需生成json字符串，放到请求的body中)

参数名	类型	是否可空	备注
id	string	否	系统意图id

3、返回值

参数名	类型	备注
code	int	HTTP状态码
time	long	时间
msg	string	状态信息

示例：

{
    "code":200,
    "time":1568613825147,
    "msg":"禁用系统意图成功"
}

系统意图列表

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是否已启用该系统意图

示例：

{

    "time":1572255991674,

    "data":{
        "total":6,
        "ps":20,
        "list":[
            {
                "agentId":"sys_agent_id",
                "created":"",
                "nameZh":"挂断意图",
                "intro":"挂断 \x01exit",
                "name":"sys_exit",
                "description":"挂断意图",
                "id":"sys_intent_9",
                "updated":""
            },
            {
                "agentId":"sys_agent_id",
                "addedSystem":true,
                "created":1560280513000,
                "nameZh":"转人工意图",
                "intro":"转人工",
                "name":"sys_manual_service",
                "description":"转人工意图",
                "id":"sys_intent_7",
                "updated":""
            }
        ],
        "pn":1
    },

    "code":200,

    "msg":"OK"

}

系统意图详情

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

示例：

{
    "time":1572264401019,
    "data":{
        "enable":true,
        "nameZh":"挂断意图",
        "intro":"挂断 \x01exit",
        "name":"sys_exit",
        "description":"挂断意图",
        "id":"sys_intent_9"
    },
    "code":200,
    "msg":"OK"
}

FAQ NLU 分析

版本：(since 6.1)

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	置信度

示例：

{
    "time":1585021517982,
    "data":{
        "list":[
            {
                "id":"6cddd214-9a9a-4894-9a0f-9d2751b8c743",
                "question":"测试德",
                "faqId":"7af4c95b-16d3-4e0d-91db-71a821d88c6e",
                "standardQuestion":"nlu 测试吧",
                "template":null,
                "source":"extend",
                "score":1
            }
        ],
        "total":1
    },
    "code":200,
    "msg":"OK"
}

开放接口总览

统计分析

平台管理

接口说明

各模块时序图

渠道时序图

目录时序图

问答时序图

闲聊时序图

文档库时序图

意图时序图

闲聊库

闲聊库标准问

闲聊库标准问新建

闲聊库标准问更新

闲聊库标准问删除

闲聊库标准问列表

闲聊库标准问题检索

闲聊库扩展问

闲聊库扩展问新建

闲聊库扩展问更新

闲聊库扩展问删除

闲聊库扩展问列表

闲聊库标准问题检索

目录

目录创建

目录更新

目录删除

目录列表

文档库

文档库新建

文档库更新

文档库删除

文档库列表

文档库详情

文档库搜索

意图

意图不响应

意图不响应问题创建

意图不响应问题更新

意图不响应问题删除

意图不响应问题列表

意图模板

意图模板新建

意图模板更新

意图模板删除

意图模板列表

意图示例

意图示例创建

意图示例修改

意图示例删除

意图示例列表

用户意图

用户意图新建

用户意图更新

用户意图删除

用户意图列表

用户意图详情

系统意图

系统意图生效

系统意图失效

系统意图列表

系统意图详情

FAQ NLU 分析

产品与文档反馈

提交失败

温馨提示

提交成功

温馨提示