网络图片识别
功能介绍
识别网络图片中的文字内容，并返回识别的结构化结果。
URI
URI格式：
POST /v1.0/ocr/web-image
请求消息
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
image |
与url二选一 |
String |
图像数据，base64编码，要求base64编码后大小不超过10MB。 图片最小边不小于15像素，最长边不超过8192像素，支持JPEG/JPG/PNG/BMP/TIFF/GIF/WEBP格式。 |
url |
与image二选一 |
String |
图片的URL路径，目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。 |
detect_direction |
否 |
Boolean |
图片朝向检测开关，可选值包括：
支持任意角度的图片朝向检测。未传入该参数时默认为false，即不检测图片朝向。 |
extract_type |
否 |
Array of strings |
结构化数据提取参数列表，目前只支持联系人信息、图像宽高，其入参值分别为"contact_info"，"image_size"，若该字段为空列表或缺失该字段，默认不提取。 |
响应消息
参数 |
参数类型 |
说明 |
|---|---|---|
result |
Object |
调用成功时表示调用结果。 调用失败时无此字段。 |
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 |
相关字段的置信度信息，置信度越大，表示本次识别的对应字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于对应字段的准确率。 |
error_code |
String |
调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 |
示例
- 请求样例（方式一：使用图片的BASE64编码）
POST https://{endpoint}/v1.0/ocr/web-image Request Header: Content-Type: application/json, X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/..." } - 请求样例（方式二：使用图片URL）
POST https://{endpoint}/v1.0/ocr/web-image Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }
Endpoint即调用API的请求地址，不同服务不同区域的Endpoint不同，具体请参见终端节点。
例如网络图片识别服务部署在“华南-广州”区域的Endpoint为“ocr.cn-south-1.myhuaweicloud.com”，请求URL为“https://ocr.cn-south-1.myhuaweicloud.com/v1.0/ocr/web-image”。
- 响应样例
{ "result": { "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_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }
状态码
状态码请参见状态码。
相关文档
相关产品
