请登录后查看
文字识别
- 通用表格识别
- 增值税发票识别
- 发票验真
- 通用文字识别
- 网络图片识别
- 智能文档解析
- 定额发票识别
- 身份证识别
- 手写文字识别
- 印章识别
- 行驶证识别
- 道路运输证识别
- 出租车发票识别
- 智能分类识别
- 车辆通行费发票识别
- 机动车销售发票识别
- 车牌识别
- 飞机行程单识别
- 营业执照识别
- 驾驶证识别
- 名片识别
- 火车票识别
- VIN码识别
- 护照识别
- 银行卡识别
- 保险单识别
- 财务报表识别
- 道路运输从业资格证识别
- 电子面单识别
- 自定义模板OCR
- 泰文身份证识别
- 泰国车牌识别
- 车辆合格证识别
- 承兑汇票识别
- 不动产证识别
- 哥伦比亚身份证识别
- 户口本识别
- 银行回单识别
RecognizeWebImage
网络图片识别
POST
https://ocr.af-south-1.myhuaweicloud.com/v2/{project_id}/ocr/web-image
只看必填项
填写默认值
密文显示特定参数
本文档信息来源于官网帮助中心
功能介绍
识别网络图片中的文字内容，并以JSON格式返回识别的结构化结果。支持横向、竖向、艺术字识别，支持字体分类和长图检测。
该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。
图1 网络图片示例图
约束与限制
- 支持中英文及部分中文繁体字。
- 只支持识别JPG、JPEG、PNG、BMP、TIFF、TGA、WEBP、ICO、PCX、GIF格式图片。
- 支持常见网络图片：手机截图、电脑截图、电商产品图及广告设计图等互联网图片。
- 图像各边的像素大小在15px到30000px之间。
- 图像中有效文字图片占比超过60%，避免有效文字图片占比过小。
- 支持图像中有效文字图片的任意角度的水平旋转（需开启方向检测）。
调用方法
请参见如何调用API。
前提条件
在使用之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开通服务和认证鉴权章节。
用户首次使用需要先申请开通。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。
URI
POST /v2/{project_id}/ocr/web-image
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 |
|
Content-Type |
是 |
String |
发送的实体的MIME类型，参数值为“application/json”。 |
|
Enterprise-Project-Id |
否 |
String |
企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。
企业项目创建步骤请参见用户指南。
说明：
该功能仅支持开通在华北-北京四、华东-上海一区域的API。 创建企业项目后，在传参时，有以下三类场景。
|
|
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
image |
否 |
String |
该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过30000px，支持JPG、JPEG、PNG、BMP、TIFF、TGA、WEBP、ICO、PCX、GIF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 |
|
url |
否 |
String |
该参数与image二选一。图片大小不超过10MB，图片的url路径目前支持：
说明：
|
|
detect_direction |
否 |
Boolean |
是否校正图片的倾斜角度，可选值如下。
支持任意角度的校正，未传入该参数时默认为“false”。 待识别图片如果存在倾斜，建议将此参数设置为“true”。 |
|
extract_type |
否 |
Array of strings |
结构化数据提取参数列表，目前只支持联系人信息、图像宽高，其入参值分别为“contact_info”，“image_size”。 若不填写该参数或删除该参数，默认不提取该参数值。 |
|
detect_font |
否 |
Boolean |
为Boolean类型，若不传该字段，默认不检测切片字体，为True时，将检测切片的字体类型，并返回最相似的5种字体名称。 |
|
detect_text_direction |
否 |
Boolean |
为Boolean类型，若不传该字段，默认为True，即检测每个字段的文字方向。为False时，则不检测文字方向。若图片中所有文字方向均是水平朝上时，建议将该值设为False，即不检测文字方向。 |
响应参数
根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
WebImageResult object |
调用成功时表示调用结果。 调用失败时无此字段。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
words_block_count |
Integer |
代表检测识别出来的文字块数目。 |
|
words_block_list |
Array of WebImageWordsBlockList objects |
识别文字块列表，输出顺序从左到右，从上到下。
|
|
extracted_data |
WebImageExtractedData object |
提取出的结构化JSON结果，该字典内的key值与入参列表extract_type的值一致，目前仅支持联系人、图像高宽信息提取，亦即key值为"contact_info"的字段、"image_size"字段。 若入参extract_type为空列表或该字段缺失时，不进行提取，此字段为空。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
words |
String |
文字块识别结果。 |
|
confidence |
Float |
相关字段的置信度信息，置信度越大，表示本次识别的对应字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于对应字段的准确率。 |
|
location |
Array<Array<Integer>> |
文字块的区域位置信息，列表形式，包含文字区域四个顶点的二维坐标（x,y）;坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。 |
|
font_list |
Array of strings |
文字块所属字体类型，列表形式，表示与文字块的文字最接近的字体类型。 |
|
font_scores |
Array of numbers |
文字块所属字体类型的概率，列表形式，与font_list一一对应，表示文字块的文字属于某种字体类型的概率。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
contact_info |
WebImageContactInfo object |
该字段表示提取的联系人信息，包括：姓名、联系电话、省市区以及详细地址。 若入参extract_type列表中无该字段，则此字段不存在。 |
|
image_size |
WebImageImageSize object |
该字段表示返回图片宽高信息。 如入参extract_type列表中无该字段，则此字段不存在。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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时的返回，详细地址（不含省市区）。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
height |
Integer |
传入image_size时的返回，为图像高度。 |
|
width |
Integer |
传入image_size时的返回，为图像宽度。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
调用失败时的错误码，具体请参见错误码。 调用成功时不返回此字段。 |
|
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
- 传入网络图片的base64编码进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息
POST https://{endpoint}/v2/{project_id}/ocr/web-image Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/...", "extract_type" : [ "contact_info", "image_size" ], "detect_direction" : true, "detect_font" : true } - 传入网络图片的url进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息
POST https://{endpoint}/v2/{project_id}/ocr/web-image Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", "extract_type" : [ "contact_info", "image_size" ], "detect_direction" : true, "detect_font" : true }
响应示例
状态码：200
成功响应示例
{
"result" : {
"extracted_data" : {
"contact_info" : {
"name" : "张三",
"phone" : "13112345678",
"province" : "广东省",
"city" : "深圳市",
"district" : "龙岗区",
"detail_address" : "五和大道华为D区"
},
"image_size" : {
"height" : 480,
"width" : 640
}
},
"words_block_count" : 2,
"words_block_list" : [ {
"words" : "收件人：张三，联系电话：13112345678，收件地址：广东省深圳市龙岗区五和大道华为D区",
"confidence" : 0.9188,
"location" : [ [ 13, 476 ], [ 91, 332 ], [ 125, 351 ], [ 48, 494 ] ],
"font_list" : [ "黑体", "Arial", "华文中宋体", "微软正黑粗体", "文泉驿等宽正黑体" ],
"font_scores" : [ 0.36, 0.2761, 0.2117, 0.0616, 0.0606 ]
}, {
"words" : "方正字体",
"confidence" : 0.8631,
"location" : [ [ 13, 476 ], [ 91, 332 ], [ 125, 351 ], [ 48, 494 ] ],
"font_list" : [ "方正铭石体", "方正黑简体", "文泉驿等宽正黑体", "腾祥孔淼石头简体", "微软正黑粗体" ],
"font_scores" : [ 0.9999, 0.0, 0.0, 0.0, 0.0 ]
} ]
}
}
状态码：400
失败响应示例
{
"error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
}
SDK代码示例
SDK代码示例如下。
使用SDK前建议将SDK更新至最新版，防止本地旧版SDK无法使用最新的OCR功能。
- 传入网络图片的base64编码进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.ocr.v1.region.OcrRegion; import com.huaweicloud.sdk.ocr.v1.*; import com.huaweicloud.sdk.ocr.v1.model.*; import java.util.List; import java.util.ArrayList; public class RecognizeWebImageSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); OcrClient client = OcrClient.newBuilder() .withCredential(auth) .withRegion(OcrRegion.valueOf("<YOUR REGION>")) .build(); RecognizeWebImageRequest request = new RecognizeWebImageRequest(); WebImageRequestBody body = new WebImageRequestBody(); List<String> listbodyExtractType = new ArrayList<>(); listbodyExtractType.add("contact_info"); listbodyExtractType.add("image_size"); body.withDetectFont(true); body.withExtractType(listbodyExtractType); body.withDetectDirection(true); body.withImage("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."); request.withBody(body); try { RecognizeWebImageResponse response = client.recognizeWebImage(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }
- 传入网络图片的url进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.ocr.v1.region.OcrRegion; import com.huaweicloud.sdk.ocr.v1.*; import com.huaweicloud.sdk.ocr.v1.model.*; import java.util.List; import java.util.ArrayList; public class RecognizeWebImageSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); OcrClient client = OcrClient.newBuilder() .withCredential(auth) .withRegion(OcrRegion.valueOf("<YOUR REGION>")) .build(); RecognizeWebImageRequest request = new RecognizeWebImageRequest(); WebImageRequestBody body = new WebImageRequestBody(); List<String> listbodyExtractType = new ArrayList<>(); listbodyExtractType.add("contact_info"); listbodyExtractType.add("image_size"); body.withDetectFont(true); body.withExtractType(listbodyExtractType); body.withDetectDirection(true); body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName"); request.withBody(body); try { RecognizeWebImageResponse response = client.recognizeWebImage(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }
- 传入网络图片的base64编码进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkocr.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = OcrClient.new_builder() \ .with_credentials(credentials) \ .with_region(OcrRegion.value_of("<YOUR REGION>")) \ .build() try: request = RecognizeWebImageRequest() listExtractTypebody = [ "contact_info", "image_size" ] request.body = WebImageRequestBody( detect_font=True, extract_type=listExtractTypebody, detect_direction=True, image="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." ) response = client.recognize_web_image(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
- 传入网络图片的url进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkocr.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = OcrClient.new_builder() \ .with_credentials(credentials) \ .with_region(OcrRegion.value_of("<YOUR REGION>")) \ .build() try: request = RecognizeWebImageRequest() listExtractTypebody = [ "contact_info", "image_size" ] request.body = WebImageRequestBody( detect_font=True, extract_type=listExtractTypebody, detect_direction=True, url="https://BucketName.obs.myhuaweicloud.com/ObjectName" ) response = client.recognize_web_image(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
- 传入网络图片的base64编码进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := ocr.NewOcrClient( ocr.OcrClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.RecognizeWebImageRequest{} var listExtractTypebody = []string{ "contact_info", "image_size", } detectFontWebImageRequestBody:= true detectDirectionWebImageRequestBody:= true imageWebImageRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." request.Body = &model.WebImageRequestBody{ DetectFont: &detectFontWebImageRequestBody, ExtractType: &listExtractTypebody, DetectDirection: &detectDirectionWebImageRequestBody, Image: &imageWebImageRequestBody, } response, err := client.RecognizeWebImage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
- 传入网络图片的url进行文字识别，识别过程校验图片倾斜角度，判断待识别字体类型，并校验图片是否包含联系人信息
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := ocr.NewOcrClient( ocr.OcrClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.RecognizeWebImageRequest{} var listExtractTypebody = []string{ "contact_info", "image_size", } detectFontWebImageRequestBody:= true detectDirectionWebImageRequestBody:= true urlWebImageRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName" request.Body = &model.WebImageRequestBody{ DetectFont: &detectFontWebImageRequestBody, ExtractType: &listExtractTypebody, DetectDirection: &detectDirectionWebImageRequestBody, Url: &urlWebImageRequestBody, } response, err := client.RecognizeWebImage(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功响应示例 |
|
400 |
失败响应示例 |
状态码请参见状态码。
错误码
错误码请参见错误码。
本文导读
功能介绍
约束与限制
调用方法
前提条件
URI
请求参数
响应参数
请求示例
响应示例
SDK代码示例
状态码
错误码