API文档
更新时间：2022-05-06
请求说明
请求示例
HTTP 方法：POST
请求URL： https://aip.baidubce.com/rest/2.0/ai_custom/v1/ocr
URL参数：
| 参数 | 值 |
|---|---|
| access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下：
| 参数 | 值 |
|---|---|
| Content-Type | application/x-www-form-urlencoded |
Body中放置请求参数，参数详情如下：
请求参数
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| image | 和 url 二选一 | string | - | 图像数据，base64编码后进行urlencode，要求base64编码和urlencode后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/jpeg/png/bmp格式 |
| url | 和 image 二选一 | string | - | 图片完整URL，URL长度不超过1024字节，URL对应的图片base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/jpeg/png/bmp格式，当image字段存在时url字段失效，不支持https的图片链接。当image字段存在时 url 字段失效 |
| modelId | 是 | string | - | 模型 ID，自训练产出模型的唯一标示，可用于调用指定的已发布模型进行结构化识别，可在「我的模型」页查看并复制使用 |
| detect_direction | 是 | string | true/false | 是否开启图像方向矫正功能，可选值有： - true：开启图像方向矫正功能，可自动矫正不同旋转角度的图片进行识别； - false：关闭图像矫正功能，如要识别的内容均为正向图片，建议可关闭此功能避免误矫正。 |
返回说明
返回参数
| 字段 | 类型 | 说明 |
|---|---|---|
| log_id | int | 调用请求的唯一日志id，如需技术支持进行问题排查请反馈此id以快速进行问题定位 |
| error_code | int | 0代表成功，如果有错误码返回可以参考错误码列表排查问题 |
| error_msg | string | 如果error_code具体的失败信息，可以参考下方错误码列表排查问题 |
| result | Object | 识别返回的结果，每一个key代表识别字段名称，对应的value为该字段的识别结果 |
| + “key” | Array | 识别内容，“key”为数据标注时创建的字段名称，将不同版式的内容进行归一化输出 |
| ++ probability | Object | 字段的置信度，包括平均和最小置信度 |
| +++ average | int | 字段的平均置信度 |
| +++ min | int | 字段的最小置信度 |
| ++ location | Object | 字段在原图上对应的矩形框位置 |
| +++ top | int | 字段文本框左上角点的上边距 |
| +++ left | int | 字段文本框左上角点的左边距 |
| +++ width | int | 字段文本框的宽度 |
| +++ height | int | 字段文本框的高度 |
| ++ word | string | 字段识别结果 |
返回示例
{
"log_id":"161648117706127",
"result":{
"收款卡号":[
{
"probability":{
"average":0.9972677230834961,
"min":0.6964160077398716
},
"location":{
"top":404,
"left":451,
"width":303,
"height":61
},
"word":"119086830765501"
}
],
"日期":[
{
"probability":{
"average":0,
"min":0
},
"location":{
"top":-1,
"left":-1,
"width":0,
"height":0
},
"word":"20180330"
}
]
}
}