## **接口说明**
为满足用户对自有私有语料库数据的管理与操作,图灵机器人再次开放语料库API接口,接入成功后无需登录图灵机器人官网后台进行数据的相关操作,直接通过该接口就能完成对私有语料库一系列的操作,并能实现与官网私有语料库数据同步更新。
私有语料库接口暂时对标准版及专业版用户开放,提供了私有语料库相关的6个接口(匹配度设置、加密模式设置、私有语料新增、删除、修改、查询)。
## **使用说明**
### ****接口约定****
### JSON格式
数据格式统一使用JSON方式,则统一为如下方式:
JSON方式(指定header :Content-Type为application/json):
### 统一加密模式
md5(secret+timestamp)
>注:
>1.timestamp在三分钟内有效
>2.secret为密钥
### 统一返回错误码
|code| 说明|
|-|-|
|3**| 操作错误|
|301| 缺少必要参数、参数格式错误|
|4**| 权限错误|
|401| APIkey不存在或者不具有权限|
|405| token校验失败|
|5**| 接口专属错误|
* * * * *
### ****匹配度修改****
#### 请求接口
http://www.tuling123.com/v1/kb/match
#### 请求方式
HTTP GET/POST
#### 请求数据
~~~
{
"apikey":" apikey ",
"data":{
"match":60
},
"timestamp": timestamp,
"token":" token "
}
~~~
#### 参数说明
|参数名称| 参数内容|
|-|-|
|apikey| 机器人apikey(必填)|
|data| 要修改的数据|
|match| 匹配度|
|timestamp| timestamp(加密必填)|
|token| md5加密计算结果(加密必填)|
#### 返回数据说明
成功返回:
`{code: 0, data:{"match":degree}}`
#### 特殊返回错误码
|code| 说明|
|-|-|
|501| 匹配度不正确|
* * * * *
### ****语料库加密模式****
#### 请求接口
http://www.tuling123.com/v1/kb/secret
#### 请求方式
HTTP GET/POST
#### 请求数据
~~~
{
"apikey":" apikey ",
"data":{
"mod":false,
"secret":" secret "
},
"timestamp": timestamp ,
"token":" token "
}
~~~
#### 参数说明
|参数名称| 参数内容|
|-|-|
|apikey| 机器人apikey(必填)|
|data| 要修改的数据|
|mod| 加密状态|
|secret|secret|
|timestamp| timestamp(加密必填)|
|token| md5加密计算结果(加密必填)|
#### 返回数据说明
成功返回:
`{code: 0, data:{"mod":true}}`
#### 特殊返回错误码
|code| 说明|
|-|-|
|501| mod传参不正确应为布尔值或匹配度不正确|
* * * * *
### ****语料库新增****
#### 请求接口
http://www.tuling123.com/v1/kb/import
#### 请求方式
HTTP GET/POST
#### 请求数据
~~~
{
"apikey":" apikey ",
"data":{
"list":[
{"question":"question", "answer":"answer"}
]},
"timestamp": timestamp ,
"token":" token "
}
~~~
#### 参数说明
|参数名称| 参数内容|
|-|-|
|apikey| 机器人apikey(必填)|
|data| 要修改的数据|
|list| 数据列表|
|question|新增问题|
|answer|新增答案|
|timestamp| timestamp(加密必填)|
|token| md5加密计算结果(加密必填)|
#### 返回数据说明
成功返回:
~~~
{
"data": {
"successNum": 1,
"knowledgeList": [{
"id": "2146008",
"time": "2016-10-17 11:14:38",
"answer": "answer",
"label_id": 0,
"question": "question"
}]
},
"code": 0
}
~~~
#### 特殊返回错误码
|code| 说明|
|-|-|
|401| 权限错误|
|501| 网络错误 |
* * * * *
### ****语料库查询****
#### 请求接口
http://www.tuling123.com/v1/kb/select
#### 请求方式
HTTP GET/POST
#### 请求数据
~~~
{
"apikey":" apikey ",
"data": {
"pages":{
"pageNumber":1,
"pageSize":10,
"searchBy": "question"
}
},
"timestamp": timestamp ,
"token":" token "
}
~~~
#### 参数说明
|参数名称| 参数内容|
|-|-|
|apikey| 机器人apikey(必填)|
|data| 要修改的数据|
|pages| 查询返回页面格式|
|pageNumber| 页数|
|pageSize| 每页显示行数|
|searchBy| 查询的关键词|
|timestamp| timestamp(加密必填)|
|token| md5加密计算结果(加密必填)|
#### 返回数据说明
成功返回:
~~~
{
"code": 0,
"data": {
"totalCount": 2,
"knowledgeCount": 2,
"knowledgeList": [
{
"id": "2",
"question": "question2",
"answer": "您设定的question2的答案",
"time": "2015-12-03 14:34:36"
},
{
"id": "1",
"question": "question1",
"answer": "您设定的question1的答案",
"time": "2015-12-03 14:34:35"
}
]
}
}
~~~
#### 特殊返回错误码
|code| 说明|
|-|-|
|501| 网络错误 |
* * * * *
### ****语料库修改****
#### 请求接口
http://www.tuling123.com/v1/kb/update
#### 请求方式
HTTP GET/POST
#### 请求数据
~~~
{
"apikey":" apikey ",
"data":{
list:[
{"id":"1","question":"新的问题”,"answer":"新的答案"},
{"id":"2","question":"新的问题”,"answer":"新的答案"}
]},
"timestamp": timestamp ,
"token":" token "
}
~~~
#### 参数说明
|参数名称| 参数内容|
|-|-|
|apikey| 机器人apikey(必填)|
|data| 要修改的数据|
|id| 需要更改的数据id|
|question| 新的问题|
|answer| 新的答案|
|timestamp| timestamp(加密必填)|
|token| md5加密计算结果(加密必填)|
#### 返回数据说明
成功返回:
~~~
{"code":0,"data":"2"}
~~~
* * * * *
### ****语料库删除****
#### 请求接口
http://www.tuling123.com/v1/kb/delete
#### 请求方式
HTTP GET/POST
#### 请求数据
~~~
{
"apikey": "apikey",
"data": {
"clear": false,
"ids": [1,2,3]
}
"timestamp": timestamp ,
"token":" token "
}
~~~
#### 参数说明
|参数名称| 参数内容|
|-|-|
|apikey| 机器人apikey(必填)|
|data| 要修改的数据|
|clear| 是否清空数据库|
|isclear| 清空数据库标志位|
|ids| 待删除的数据id编号|
|timestamp| timestamp(加密必填)|
|token| md5加密计算结果(加密必填)|
#### 返回数据说明
成功返回:
~~~
{"code":0,"data":"3"}
~~~
#### 特殊返回错误码
|code| 说明|
|-|-|
|501| 无权删除该条数据 |
## **注意事项**
(1)使用者须为图灵机器人标准版或专业版用户;
(2)用户使用私有语料库新增接口批量导入数据时,享有与官网Excel上传导入相同的权限设置(10000条/5次/天)。官网导入数据与接口导入数据都以累计的方式进行,每天数据导入量上限为10000条,次数上限为5次;
(3)用户使用私有语料新增接口逐条添加数据时,每日导入量上限为10000条;
(4)图灵机器人对私有语料库接口提供了加密模式设置,目前分为加密和不加密两种形式,用户可按需自行设定。
(5)用户如想修改私有语料库中的数据时,推荐将该条数据删除后再重新添加。