文本分类
一、接口描述
1. 功能描述
识别用户话术的领域信息,当前版本在13个领域上进行分类:歌曲、广播、故事、百科、天气、时间、新闻、生活查询、岀行、股票、购物、音箱指令、家居指令、闲聊、翻译、计算机、闹钟。
types |
0 |
1 |
2 |
3 |
4 |
5 |
6 |
domain name |
other |
calcu |
chat |
info |
instruct |
local |
news |
types |
7 |
8 |
9 |
10 |
11 |
12 |
domain name |
radio |
reject |
song |
story |
weather |
shopping |
2. 接口使用
平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。
免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。
在获得使用权限后,您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程
二、请求说明
1. 接口地址 :
https://aiapi.jd.com/jdai/textClassification
2. 请求方式:
post
3. 请求参数
(1)query请求参数
公共请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
appkey |
string |
是 |
80d2b762ecb86593f9668526920f46c |
您的appkey,可在买家中心控制台中获 |
timestamp |
long |
是 |
1541491668060 |
请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign |
string |
是 |
2e148773a0337a8f2200ba90d445f083 |
签名,根据规则MD5(sectetkey+timestamp) |
业务请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
Content-Type |
string |
是 |
application/json |
表示请求JSON格式的文本信息 |
(3)body请求参数
业务请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
text |
string |
是 |
克林顿访问中国 |
输入文本 |
4、请求代码示例
建议您使用我们提供的SDK进行调用,SDK获取及调用方式详见本页一接口描述中的2接口使用
三、返回说明
1、返回参数
(1)公共返回参数
名称 |
类型 |
示例值 |
描述 |
code |
string |
1000 |
参见下方错误码-系统级错误码 |
charge |
boolean |
false 或 true |
false:不扣费, true:扣费 |
remainTimes |
long |
1305 |
剩余调用次数;免费api:每天剩余调用次数;收费api:剩余次数;无限制时为-1 |
remainSeconds |
long |
1223456 |
剩余调用时间(s);免费api:-1;收费api:剩余调用时间;无限制时为-1 |
msg |
string |
查询成功 |
参见下方错误码-系统级错误码数 |
result |
object |
{...} |
查询结果 |
(2)业务返回参数
名称 |
类型 |
示例值 |
描述 |
status |
int |
0 |
参照四、错误码-业务错误码 |
message |
string |
ok |
参照四、错误码-业务错误码 |
request_id |
string |
5893465d31284468a8014de6ee430f8e |
便于双方定位问题 |
types |
list |
[{"type": 3, "probability": 0.727774441242218, "domainName": "info"},,...] |
文本分类结果,详情下面types字段说明 |
types字段说明
名称 |
类型 |
示例值 |
描述 |
type |
int |
3 |
分类序号 |
probability |
double |
0.727774441242218 |
分类概率 |
domainName |
string |
info |
分类名称 |
2、返回示例
{
"code": "10000",
"charge": false,
"remainTimes": 4998,
"remainSeconds": -1,
"msg": "查询成功",
"result": {
"status": 0,
"request_id": xxx,
"message": "ok",
"types": [
{
"type": 3,
"probability": 0.727774441242218,
"domainName": "info"
},
{
"type": 8,
"probability": 0.2294873297214508,
"domainName": "reject"
},
{
"type": 9,
"probability": 0.042706381529569626,
"domainName": "song"
}
]
}
}
四、错误码
1.系统级错误码
详见返回码
2.业务错误码
业务错误码(status) |
message |
说明 |
12001 |
"Invalid parameter" |
无效参数 |
12002 |
"Missing parameter" |
缺少参数 |
12003 |
"Error parsing parameter information" |
参数解析错误 |