图灵机器人API是在人工智能的核心能力(包括语义理解、智能问答、场景交互、知识管理等)的基础上,为广大开发者、合作伙伴和企业提供的一系列基于云计算和大数据平台的在线服务和开发接口。
开发者可以利用图灵机器人的API创建各种在线服务,灵活定义机器人的属性、编辑机器人的智能问答内容,打造个人专属智能交互机器人,也支持多渠道(微信公众平台、QQ聊天)的快速接入。
图灵机器人是国内第一家个性化智能机器人开放平台,为广大开发者提供智能机器人API端口。图灵机器人基于DeepQA深度问答技术,对中文的识别准确率高达90%,是目前中文语境下高智能度的机器人。图灵机器人具有高智能、一键接入、个性化、跨平台四大特点,通过图灵机器人开放平台,任何人都可以方便快捷的为微信公众号、微博、QQ群、WEB网站、智能客服系统以及智能家居系统、智能车载系统等软硬件领域接入一位聪明的图灵机器人。
智能对话、语料库、技能服务是图灵机器人三大核心功能。智能对话是指,图灵机器人可赋予软硬件产品中文自然语言交互的能力;语料库是指图灵机器人用户可为机器人导入独家内容以满足个性化及商业化需要;技能服务是指,图灵机器人打包提供超500种实用生活服务技能,涵盖生活、出行、学习、金融、购物等多个领域,一站式满足用户需求。
图灵机器人应用广泛,目前已应用于实体机器人,如家用服务机器人、儿童陪伴机器人等,虚拟机器人,如智能客服系统、微信公众号、QQ机器人、APP应用等,智能家居控制系统、智能车载等领域。已为超18万合作方提供技术支持。
登录图灵机器人官方网站http://www.tuling123.com/,点击右上角“注册”按钮进行注册并激活帐号,如下图所示:
每一个激活用户都可以通过图灵机器人开放平台获取多个APIKEY(当前每个用户可最多获取5个APIKEY),用户可以根据自己的需要获取不同的图灵APIKEY来应用于多种场景,获取成功后就等于拿到了开启图灵服务的钥匙。
登录图灵帐号,进入个人中心,在“我的机器人》机器人详情》接入”页面即可看到每一个机器人的API KEY,如下图所示:
http://www.tuling123.com/openapi/api
HTTP POST
注:若之前使用get请求方式,仍能继续使用,日后将对该请求方式不再进行更新及维护工作,建议采用post请求方式。
请求参数格式为json
请求示例:
{
“key”: “APIKEY”,
“info”: “今天天气怎么样”,
“loc”:“北京市中关村”,
“userid”:“123456”
}
参数 | 是否必须 | 长度 | 示例 | 说明 |
---|---|---|---|---|
key | 必须 | 32 | 1ca8089********736b8ce41591426(32位) | 注册之后在机器人接入页面获得(参见本文档第2部分) |
info | 必须 | 1-30 | 打招呼“你好” 查天气“北京今天天气” |
请求内容,编码方式为UTF-8 |
userid | 1-32 | abc123(支持0-9,a-z,A-Z组合,不能包含特殊字符) | 用户唯一标志(对应自己的每一个用户) 用户对话上下文控制 |
|
注:【1】图灵机器人在天气、航班、列车等场景下支持上下文,下面以航班查询为例 示例: { “key”: “APIKEY”, “info”: “北京到上海的飞机”, “userid”:“12345678” } 信息不完整时,当使用userid参数,可进入上下文语境。 图灵机器人:亲爱的,您准备哪天去上海? { “key”: “APIKEY”, “info”: “明天”, “userid”:“12345678” } 图灵机器人:亲,已帮你找到航班信息(并给出对应url) |
||||
loc | 非必须 | 1-30 |
北京市中关村 江西省南昌市 |
位置信息,请求跟地理位置相关的内容时使用,编码方式UTF-8 |
自定义唯一 userid(1-32位,字母与数字组成)
Code | 说明 |
---|---|
100000 | 文本类 |
200000 | 链接类 |
302000 | 新闻类 |
308000 | 菜谱类 |
313000(儿童版) | 儿歌类 |
314000(儿童版) | 诗词类 |
注:儿歌类,诗词类两个功能目前只对儿童版API开放
(1)请求示例
{
“key”:“APIKEY”,
“info”:“你好”,
“userid”:“123456”
}
(2)返回数据
{
"code":100000,
"text":"你也好 嘻嘻"
}
(3)数据说明
字段 | 说明 |
---|---|
code | 文本类标识码 |
text | 结果 |
(1)请求示例
{
“key”: “APIKEY”,
“info”: “小狗的图片”,
“userid”:“123456”
}
(2)返回数据
{
"code": 200000,
"text": "亲,已帮你找到图片",
"url": "http://m.image.so.com/i?q=%E5%B0%8F%E7%8B%97"
}
(3)数据说明
字段 | 说明 |
---|---|
code | 链接类标识码 |
text | 提示语 |
url | 链接地址 |
(1)请求示例
{
“key”: “APIKEY”,
“info”: “我想看新闻”,
“userid”:“123456”
}
(2)返回数据
{
"code": 302000,
"text": "亲,已帮您找到相关新闻",
"list": [
{
"article": "工信部:今年将大幅提网速降手机流量费",
"source": "网易新闻",
"icon": "",
"detailurl": "http://news.163.com/15/0416/03/AN9SORGH0001124J.html"
},
{
"article": "北京最强沙尘暴午后袭沪 当地叫停广场舞",
"source": "网易新闻",
"icon": "",
"detailurl": "http://news.163.com/15/0416/14/ANB2VKVC00011229.html"
},
{
"article": "公安部:小客车驾照年内试点自学直考",
"source": "网易新闻",
"icon": "",
"detailurl": "http://news.163.com/15/0416/01/AN9MM7CK00014AED.html"
} ]
}
(3)数据说明
字段 | 说明 |
---|---|
code | 新闻类标识码 |
text | 提示语 |
list | 信息列表 |
article | 新闻标题 |
source | 新闻来源 |
icon | 新闻图片 |
detailurl | 新闻详情链接 |
(1)请求示例
{
“key”: “APIKEY”,
“info”: “北京到拉萨的火车”,
“userid”:“123456”
}
(2)返回数据
{
"code": 200000,
"text": "亲,已帮你找到列车信息",
"url": "http://touch.qunar.com/h5/train/trainList?startStation=%E5%8C%97%E4%BA%AC&endStation=%E6%8B%89%E8%90%A8&searchType=stasta&date=2015-12-25&sort=3&filterTrainType=1&filterTrainType=2&filterTrainType=3&filterTrainType= 4&filterTrainType=5&filterTrainType=6&filterTrainType=7&filterDeptTimeRa"
}
(3)数据说明
字段 | 说明 |
---|---|
code | 链接类标识码 |
text | 提示语 |
url | 链接地址 |
(1)请求示例
{
“key”: “APIKEY”,
“info”: “明天北京到拉萨的飞机”,
“userid”:“123456”
}
(2)返回数据
{
"code": 200000,
"text": "亲,已帮您找到航班信息",
"url": "http://touch.qunar.com/h5/flight/flightlist?bd_source=chongdong&startCity=%E5%8C%97%E4%BA%AC&destCity=%E6%8B%89%E8%90%A8&startDate=2015-12-25&backDate=&flightType=oneWay&priceSortType=1"
}
(3)数据说明
字段 | 说明 |
---|---|
code | 链接类标识码 |
text | 提示语 |
url | 链接地址 |
(1)请求示例
{
“key”: “APIKEY”,
“info”: “鱼香肉丝怎么做”,
“userid”:“123456”
}
(2)返回数据
{
"code": 308000,
"text": "亲,已帮您找到菜谱信息",
"list": [{
"name": "鱼香肉丝",
"icon": "http://i4.xiachufang.com/image/280/cb1cb7c49ee011e38844b8ca3aeed2d7.jpg",
"info": "猪肉、鱼香肉丝调料 | 香菇、木耳、红萝卜、黄酒、玉米淀粉、盐",
"detailurl": "http://m.xiachufang.com/recipe/264781/"
}]
}
(3)数据说明
字段 | 说明 |
---|---|
code | 菜谱类标识码 |
text | 提示语 |
name | 菜名 |
info | 菜谱信息 |
detailurl | 详情链接 |
icon | 信息图标 |
注:该功能仅限儿童版使用
(1)请求示例
{
“key”: “APIKEY”,
“info”: “给我唱一首刘德华的忘情水”,
“userid”:“自定义唯一 userid(1-32位,字母与数字组成)”
}
(2)返回数据
{
"code": 313000,
"text": "开始播放音乐。",
"function": {
"song": "刘德华",
"singer": "忘情水"
}
}
(3)数据说明
字段 | 说明 |
---|---|
code | 儿歌类标识码 |
text | 提示语 |
song | 歌曲名 |
singer | 歌手 |
注:该功能仅限儿童版使用
(1)请求示例
{
“key”: “APIKEY”,
“info”: “背一首李白的望庐山瀑布” ,
“userid”:“自定义唯一 userid(1-32位,字母与数字组成)”
}
(2)返回数据
{
"code": 314000,
"text": "开始朗读诗词。",
"function": {
"author": "李白",
"name": "望庐山瀑布"
}
}
(3)数据说明
字段 | 说明 |
---|---|
code | 诗词类标识码 |
text | 提示语 |
author | 作者 |
name | 诗词名 |
{
"code":*****,
"text":"相应提示语"
}
异常码(code) | 说明 |
---|---|
40001 | 参数key错误 |
40002 | 请求内容info为空 |
40004 | 当天请求次数已使用完 |
40007 | 数据格式异常 |
(1)非必须,推荐使用非加密模式;如需要对对话内容保密可接入加密操作。
(2)请求方式必须为HTTP POST;
(3)需在个人中心“我的机器人》机器人详情》接入”(微信公众号除外)开启加密功能secret,开启之后原HTTP GET请求将被禁止;
(4)加密示例demo可在个人中心“我的机器人》机器人详情》接入”(微信公众号除外)中下载文档获取。
http://www.tuling123.com/openapi/api
HTTP POST
UTF-8(调用图灵API的各个环节的编码方式均为UTF-8)
(1)时间戳用户校验请求,请尽可能的准确
(2)在图灵官网个人中心”我的机器人》机器人详情》接入“页获取APIKey,secret(默认为关闭状态,使用需打开),计算当前的时间戳
示例如下:
secret = 123
timestamp = 456789
apiKey = key
(1)说明:MD5为32位算法,生成的aesKey为全小写keyParam = secret+timestamp+apiKey
(2)对keyParam进行MD5(32位算法)加密,生成aesKey,对“123456789key”进行加密之后得到aesKey = 912194e51267870e9283e9a035360a78;
(1)说明:AES采用128位加密算法请求参数,例如:
param = {"info":"你好"}
(2)通过上面生成的aesKey,对请求参数param进行AES加密,得到data
data = TwPFGlIQk/yl2qDbNyuSQg9JMeV6aLdCS7yo6lT5Ia0=
{
key:key,
timestamp:456789,
data:TwPFGlIQk/yl2qDbNyuSQg9JMeV6aLdCS7yo6lT5Ia0=
}
A:注册登录图灵官网www.tuling123.com后,在个人中心的“我的机器人》机器人详情》接入”页面,就能获取到图灵机器人给每个用户分配的APIKEY,获取APIKEY后就等于找到了开启图灵服务的钥匙,用户可以根据自己的需要自行选择使用场景。
A:userid为必须参数,该参数是开发者自己的用户唯一标识,每个userid对应相应的权限设置,每个用户的userid的唯一性保证用户对话上下文的正确性
A:当您的机器人找不到答案的时候,它就会进入到“无答案”的功能设置中。此时免费版和标准版有不同的使用权限。免费版中返回结果只能是学用户说话,标准版除了可以在“无答案”时使用学用户说话模式,也可以自定义”无答案“时的内容。例如:您在图灵后台的“功能选择”中只开启了“聊天”功能,当您查询天气时,此时就会处于“无答案”的状态,机器人则会根据用户的等级和设置进行相应的回答。
A:可能是因为浏览器版本过低导致的,建议您使用主流的浏览器或将浏览器进行升级,目前图灵机器人对IE8及以下浏览器不进行兼容支持。
A:出现这类情况,有可能是编码格式不统一导致的,图灵机器人的接口编码统一采用UTF-8格式。建议您将所有的编码格式换成UTF-8。