请求方式:POST (HTTPS)
请求地址:
https://open.welink.huaweicloud.com/api/aiservice/v1/ocr/web-image
认证方式: access_token,请参考获取access_token
请求头部:
Content-Type: application/json
x-wlk-Authorization: access_token
请求参数
{
"image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
}
请求参数说明
参数 | 必选 | 参数类型 | 说明 |
---|---|---|---|
image | 是 | String | 图像数据,base64编码,要求base64编码后大小不超过10MB。图片最小边不小于15像素,最长边不超过8192像素,支持JPEG/JPG/PNG/BMP/TIFF/GIF/WEBP格式。 |
detectDirection | 否 | Boolean | 若不传该字段,默认不检测图像倾斜角度文字方向,为True时,支持任意角度的旋转倾斜。 |
extractType | 否 | Array[String] | 结构化数据提取参数列表,目前只支持联系人信息、图像宽高,其入参值分别为"contact_info","image_size",若该字段为空列表或缺失该字段,默认不提取。 |
请求示例
curl -X POST \
'https://open.welink.huaweicloud.com/api/aiservice/v1/ocr/web-image' \
-H 'Accept-Charset: UTF-8' \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: access_token' \
-d '{"image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."}'
响应格式说明
返回结果 正常返回结果
{
"code": "0",
"data": {
"words_block_count": 2,
"words_block_list": [
{
"words": "文字块1",
"confidence": 0.9950,
"location": [
[13, 476],
[91, 332],
[125, 351],
[48, 494]
]
},
{
"words": "文字块2",
"confidence": 0.9910,
"location": [
[13, 476],
[91, 332],
[125, 351],
[48, 494]
]
}
],
"extracted_data": {}
},
"error": "",
"message": "ok"
}
异常返回结果
- Token验证失败响应示例
{ "code": "58401", "data": null, "error": "Failed to verify the token.", "message": "Login authentication failed." }
返回参数说明
网络图片识别响应参数说明请参见表。
- 响应参数说明
参数 | 必选 | 参数类型 | 说明 |
---|---|---|---|
code | 是 | String | 错误码 |
message | 是 | String | 调用成功时为"ok"。调用失败时的错误信息。 |
data | 是 | Object | 调用成功时表示调用结果,详见data数据结构。调用失败时为null。 |
error | 是 | String | 错误信息。 |
data 数据结构
参数 | 必选 | 参数类型 | 说明 |
---|---|---|---|
words_block_count | 是 | Integer | 代表检测识别出来的文字块数目。 |
words_block_list | 是 | Array of objects | 识别文字块列表,输出顺序从左到右,从上到下。 |
words | 是 | String | 文字块识别结果。 |
location | 是 | Array of objects | 文字块的区域位置信息,列表形式,分别表示文字块4个顶点的x, y坐标; 图像坐标原点为图像左上角,x轴沿水平方向,y轴沿竖直方向。 |
extracted_data | 否 | Object | 提取出的结构化JSON结果,该字典内的key值与入参列表extract_type的值一致,目前仅支持联系人信息提取,亦即key值为"contact_info"的字段。若入参extract_type为空列表或该字段缺失时,不进行提取,此字段为空。 |
contact_info | 否 | Object | 该字段表示提取的联系人信息,包括:姓名、联系电话、省市区以及详细地址。若入参extract_type列表中无该字段,则此字段不存在。 |
image_size | 否 | Object | 该字段表示返回图片宽高信息。如入参extract_type列表中无该字段,则此字段不存在。 |
height | 否 | Integer | 传入image_size时的返回,为图像高度。 |
width | 否 | Integer | 传入image_size时的返回,为图像宽度。 |
name | 否 | String | 传入contact_info时的返回,为姓名。 |
phone | 否 | String | 传入contact_info时的返回,联系电话。 |
province | 否 | String | 传入contact_info时的返回,省。 |
city | 否 | String | 传入contact_info时的返回,市。 |
district | 否 | String | 传入contact_info时的返回,县区。 |
detail_address | 否 | String | 传入contact_info时的返回,详细地址(不含省市区)。 |
confidence | 是 | Float | 相关字段的置信度信息,置信度越大,表示本次识别的对应字段的可靠性越高,在统计意义上,置信度越大,准确率越高。置信度由算法给出,不直接等价于对应字段的准确率。 |
错误码说明
错误码 | 说明 |
---|---|
0 | 成功。 |
58401 | 无权限。 |
58402 | 非法输入参数。 |
58500 | 服务异常。 |
58001 | OCR服务异常。 |