通用OCR文字识别
一、接口描述
1. 功能描述
通用OCR识别任务模型的请求接口. 返回值中, 如成功识别(result.code>0),result.msg为识别结果, 识别的内容按行展示; angle表示图片旋转角度,用整数值表示顺时针旋转方向。否则(result.code<=0),返回识别失败结果说明。
2. 接口数据要求:
- 图片格式:base64编码
- 图片类型: jpg/jpeg/png
- 图片大小: 小于5M
3. 接口使用:
平台为每个API提供试用体验服务,您在AI市场选择“免费试用”规格下单后,即可开始体验业内领先的人工智能API服务。 免费试用服务具有调用量、QPS限制,如需更高性能的API服务,可以提交咨询工单,联系京东AI扩容购买。
在获得使用权限后,您可使用已经封装好的SDK/参照接口鉴权规则进行相应开发,整体流程详见 接入流程
用户需要使用图片base64编码去做请求,使用其他图片的base64编码请求成功时也会加入计费。
二、请求说明
1. 接口地址 :
https://aiapi.jd.com/Situchangjing/General_OCR
2. 请求方式:
post
3. 请求参数
(1)query请求参数
公共请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
appkey | String | 是 | 80d2b762ecb86593f9668526920f46c | 您的appkey,可在买家中心控制台中获取 |
timestamp | long | 是 | 1541491668060 | 请求的时间戳,精确到毫秒,timestamp有效期5分钟 |
sign | String | 是 | 2e148773a0337a8f2200ba90d445f083 | 签名,根据规则MD5(sectetkey+timestamp) |
(2)header请求参数
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
Content-Type | String | 是 | application/json | 标准编码格式 |
(3)body请求参数
业务请求参数
名称 | 类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
imgBase64 | String | 是 | 如下 | 图片转base64编码以后的字符串(json) |
{
"imgBase64": "图片转base64编码以后的字符串,去掉图片头"data:image/png;base64,""
}
(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)业务返回参数
result参数信息
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | string | 0 | 状态 |
message | string | success | 结果说明 |
result | Object | {...} | data |
子result字段说明
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | String | 1 | 算法服务状态码 |
angle | Integer | Success | 图片顺时针旋转角度 |
msg | [String,String,String,….] | [...] | OCR识别结果 |
2.返回示例
{
"result": {
"msg": ["ocr的结果"],
"code": "1",
"angle": 0
},
"code": 1,
"message": "Success"
}
四、错误码信息
1.系统级错误码
2.业务错误码
业务错误码(code) | message | 说明 |
---|---|---|
-1 | Image content empty | base64 字符串为空 |
-2 | Access error | 无服务访问权限或 token 失效 |
-4 | Face not detected | 未从输入图片中识别出人脸 |
-5 | Target parameter not found | 为找到 imgBase64 参数 |
0 | Unknown | 后端算法服务异常或关闭 (异常如 base64 值不 能转化为图片等) |
1 | Detected | 成功检测到人脸 |