智能对话平台API如何使用?(1)_问答-阿里云开发者社区

1. 问答服务API

问答服务的调用采用Restful API方式，服务内部不保存状态，所以调用和调用之间相互独立。调用API需要校验权限，详细说明见 https://help.aliyun.com/document_detail/50410.html。
问答服务的输入为目前与用户对话的内容，输出是与输入最匹配的三个知识点，默认第一位最匹配的。

注意：调用问答服务前，知识库必须先发布，可以在管控台点击“发布”按钮或调用 single:online 接口发布。

服务提供方式

协议	URL	方法	参数
HTTPS	nlsapi.aliyun.com/qas	POST	body中的json字符串

请求示例

<divre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

{
"version": "2.0",
"app_key": "nui-abcefghi",
"question": "你是谁？",
"optional": {"domains":"theme1;theme2;theme3","top":3}
}

请求参数说明

参数	类型	是否必须	说明
version	String	是	协议版本号，必须是2.0
app_key	String	是	创建项目时返回的appId，加上”nui-“前缀
question	String	是	问题
optional/domains	String	否	主题列表，多个主题用分号隔开。如果设置了主题，就从这些主题中匹配答案，否则就从该用户的全部知识库匹配答案
optional/top	Integer	否	返回答案数量，默认3个

返回结果示例

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

{
"id": "921a3c8ac36c4df39dd714dd52344a53",
"success": true,
"error_code": "",
"error_message": "",
"answers": [
{
"question": "",
"answer": "",
"score": "",
"domain": "",
"optional": {}
},
{
"question": "",
"answer": "",
"score": "",
"domain": "",
"optional": {}
},
{
"question": "",
"answer": "",
"score": "",
"domain": "",
"optional": {}
}
]
}

返回参数说明

参数	类型	是否必须	说明
id	String	是	请求id
success	Boolean	是	请求是否处理成功
error_code	String	否	如果失败，对应的错误码
error_message	String	否	错误信息
answers[]/question	String	是	知识库中匹配到的问题
answers[]/answer	String	是	知识库中匹配到的答案
answers[]/score	Float	是	该答案对应的得分（0-1.0之间）,分越高，答案越准确
answers[]/domain	String	是	该条答案所在的主题
answers[]/optional	Object	否	附加数据，不同的业务定义自己的数据格式

2. 知识库管理API

2.1 通用接口

服务提供方式

协议	URL	方法	参数
HTTPS	nlsapi.aliyun.com/manage/qas	POST	body中为json字符串，query中需要一个action参数

请求参数说明

参数名	类型	示例	备注
action	String	projects:list	全小写，在query中，https://nlsapi.aliyun.com/manage/qas?action=projects:list
	String	{“offset”:0, “pageSize”:10}	在body中，action对应的参数组

返回结果为json格式，所有接口返回结果格式一致，唯一区别为data里面的内容。

参数	类型	是否必须	说明
requestId	String	是	唯一请求id
resultCode	Integer	是	错误码
resultMessage	String	是	返回信息
data	Object	是	每个业务的返回数据

错误码为调用返回的resultCode，具体数值如下：

错误码	说明
0	成功
1	登录超时
2	输入参数错误
3	服务器内部错误
4	项目名重复
5	项目个数达到最大
6	资源不存在
100	token错误

2.2 具体调用参数说明

2.2.1 创建项目

Action: projects:create
请求参数说明

参数	类型	是否必须	说明
name	String	是	项目名，最大长度为40
description	String	是	项目描述，最大长度为160

请求示例<divre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

{
"name":"测试项目",
"description":"这是一个测试项目"
}

返回结果<divre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

{
"requestId": "xxxxx-xxx-xxx",
"resultCode": 0,
"resultMessage": "OK",
"data": {
"id": 1,
"name": "测试项目",
"description": "这是一个测试项目",
"appId": "wdhlqi9a",
"createTime": "2010-11-10 13:46:00"
}
}

返回结果说明

参数	类型	是否必须	说明
id	Long	是	项目id
name	String	是	项目名
description	String	是	项目描述
appId	String	是	项目appId，加上”nui-“前缀即app key
createTime	String	是	项目创建时间

2.2.2 列出项目

Action: projects:list
请求参数：

参数	类型	是否必须	说明
offset	Integer	是	从第几个项目开始列出
pageSize	Integer	是	每页个数

请求示例：<divre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

{
"offset":0,
"pageSize":10
}

返回结果：<divre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

{
"requestId": "xxxxx-xxx-xxx",
"resultCode": 0,
"resultMessage": "OK",
"data": {
"total": 100,
"offset": 0,
"pageSize": 10,
"items": [
{
"id": 1,
"name": "test1",
"description": "test1 desc text",
"appId": "wdhlqi9a",
"createTime": "2010-11-10 13:46:00"
},
{
"id": 2,
"name": "test2",
"description": "test2 desc text",
"appId": "wdhlqi9a",
"createTime": "2010-11-10 13:46:00"
}
]
}
}

返回结果说明

参数	类型	是否必须	说明
id	Long	是	项目id
name	String	是	项目名
description	String	是	项目描述
appId	String	是	项目appId
createTime	String	是	创建时间
total	Integer	是	项目总数

2.2.3 更新项目

Action: projects:update
请求参数：

参数	类型	是否必须	说明
id	Long	是	项目id
name	String	是	项目名，最大长度40
description	String	是	项目描述，最大长度160

{
"id":1,
"name":"test",
"description":"test description"
}

{
"requestId": "xxxxx-xxx-xxx",
"resultCode": 0,
"resultMessage": "OK",
"data": {
"id": 1,
"name": "test1",
"description": "test1 desc text",
"appId": "wdhlqi9a",
"createTime": "2010-11-10 13:46:00"
}
}

返回结果说明：

参数	类型	是否必须	说明
id	Long	是	项目id
name	String	是	项目名
description	String	是	项目描述
appId	String	是	项目appId
createTime	String	是	创建时间

2.2.4 删除项目

Action: projects:delete
注：该操作会删除项目相关的所有信息，包括主题、知识点等，请谨慎操作。
请求参数：

参数	类型	是否必须	说明
id	Long	是	项目id

{
"id":1
}

{
"requestId":"xxxx-xxx-xxx",
"resultCode":0,
"resultMessage":"OK",
"data":""
}

2.2.5 获得项目详细信息

Action: projects:get
请求参数：

参数	类型	是否必须	说明
id	Long	是	项目id

{
"id":1
}

{
"requestId": "xxxxx-xxx-xxx",
"resultCode": 0,
"resultMessage": "OK",
"data": {
"id": 1,
"name": "测试项目",
"description": "这是一个测试项目",
"appId": "wdhlqi9a",
"createTime": "2010-11-10 13:46:00"
}
}

返回结果说明：

参数	类型	是否必须	说明
id	Long	是	项目id
name	String	是	项目名
description	String	是	项目描述
appId	String	是	项目appId
createTime	String	是	创建时间

2.2.6 创建主题

Action: theme:create
请求参数：

参数	类型	是否必须	说明
name	String	是	主题名，最大长度30
description	String	是	描述，最大长度50
projectId	Long	是	项目id

{
"name":"test",
"description":"desc",
"projectId":1
}

{
"requestId":"xxxx-xxx-xx",
"resultCode":"0",
"resultMessage":"OK",
"data": {
"id":1,
"name":"test",
"description":"desc",
"projectId":1
}
}

返回结果说明

参数	类型	是否必须	说明
id	Long	是	主题id
name	String	是	主题名称
description	String	是	主题描述
projectId	Long	是	项目id

2.2.7 列出主题

Action: theme:list
请求参数：

参数	类型	是否必须	说明
offset	Integer	是	从第几个主题开始列出
pageSize	Integer	是	每页个数
projectId	Long	是	项目id

{
"offset":0,
"pageSize":10,
"projectId":1
}

{
"requestId":"xxxx-xxx-xx",
"resultCode":0,
"resultMessage":"OK",
"data":{
"total":100,
"offset":0,
"pageSize":10,
"items":[
{
"id":1,
"name":"test1",
"description":"desc1",
"projectId":1
},
{
"id":2,
"name":"test2",
"description":"desc2",
"projectId":1
}
]
}
}

返回结果说明：

参数	类型	是否必须	说明
id	Long	是	主题id
name	String	是	主题名称
description	String	是	主题描述
projectId	Long	是	项目id
total	Integer	是	总主题数

2.2.8 更新主题

Action: theme:update
请求参数：

参数	类型	是否必须	说明
name	String	是	主题名，最大长度30
description	String	是	描述，最大长度50
projectId	Long	是	项目id
id	Long	是	主题id

{
"id":1,
"name":"test",
"description":"desc1",
"projectId":1
}

{
"requestId":"xxxx-xxx-xx",
"resultCode":"0",
"resultMessage":"OK",
"data": {
"id":1,
"name":"test",
"description":"desc",
"projectId":1
}
}

返回结果说明

参数	类型	是否必须	说明
id	Long	是	主题id
name	String	是	主题名称
description	String	是	主题描述
projectId	Long	是	项目id

智能对话平台API如何使用?(1)

相关课程

相关电子书

相关实验场景

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

智能对话平台API如何使用?(1)

相关课程

相关文章

相关电子书

相关实验场景