地址识别
一、接口描述
1. 功能描述
自动识别文本中的人名、电话、地址四级信息
2. 接口使用
平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。
在获得使用权限后,您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见接入流程
请求说明
1. 接口地址 :
https://aiapi.jd.com/jdai/IntelligentTextParsing
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 |
是 |
姓名:张飞:北京崇文区二环到三环13558589696 |
待解析原始文本 |
4、请求代码示例
{
"text":"姓名:张飞:北京崇文区二环到三环13558589696"
}
三、返回说明
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 |
查询成功 |
参见下方错误码-系统级错误码数 |
data |
object |
{...} |
查询结果 |
(2)业务返回参数
data参数信息
名称 |
类型 |
示例值 |
描述 |
name |
string |
"张飞" |
姓名 |
mobilePhone |
string |
"13558589696" |
电话 |
phone |
string |
"13558589696" |
电话 |
text |
string |
"13558589696" |
输入文本 |
addressInfo |
object |
|
四级信息 |
fullAddress |
string |
"北京崇文区" |
全地址 |
detailAddress |
string |
"京东总部4号楼" |
去除四级行政区的地址描述 |
provCode |
string |
"1" |
省编码 |
provName |
string |
"北京" |
省名称 |
cityCode |
string |
"2802" |
市编码 |
cityName |
string |
"东城区" |
市名称 |
districtCode |
string |
"2821" |
区编码 |
districtName |
string |
"内环到三环里" |
区名称 |
townCode |
string |
"123" |
乡镇编码 |
townName |
string |
"黄村镇" |
乡镇名称 |
2.返回示例
{
"message": "success",
"result": {
"addressInfo": {
"cityCode": "2802",
"cityName": "东城区",
"detailAddress": "",
"districtCode": "2821",
"districtName": "内环到三环里",
"fullAddress": "北京崇文区",
"provCode": "1",
"provName": "北京"
},
"mobilePhone": "13558589696",
"name": "张飞",
"phone": "13558589696",
"text": "姓名:张飞:北京崇文区二环到三环13558589696"
},
"status": 200
}
四、错误码
1.系统级错误码
详见返回码
2.业务错误码
业务错误码(status) |
message |
说明 |
200 |
"success" |
查询成功 |
400 |
"Bad Request, Invalid param" |
入参错误 |
204 |
"No Content!" |
请求无结果 |
500 |
"Internal Server Error" |
服务端异常 |