Web Image OCR
Function
Web Image OCR recognizes characters in a web image and returns the structured result in JSON format. For details about the constraints on using this API, see Constraints. For details about how to use this API, see .
Prerequisites
Before using Web Image OCR, you need to apply for the service and complete authentication. For details, see Subscribing to OCR and Authentication.
Before using the service for the first time, you need to enable the service by clicking Subscribe. You only need to subscribe to the service once. If the service is not enabled, an error message with error code "ModelArts.4204" will be displayed when you call the service. Before calling the service, log in to the OCR console and enable the service. Ensure that the region where the service is enabled is the same as that where the service is called.
URI
POST https://{endpoint}/v2/{project_id}/ocr/web-image
Parameter |
Mandatory |
Description |
|---|---|---|
endpoint |
Yes |
Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies depending on services in different regions. For more details, see Endpoints. |
project_id |
Yes |
Project ID, which can be obtained from Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token During API authentication using a token, the token is added to requests to obtain permissions for calling the API. The value of X-Subject-Token in the response header is the obtained token. |
Content-Type |
Yes |
String |
MIME type of the request body. The value is application/json. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
image |
No. Set either this parameter or url. |
String |
Base64 character string converted from the image. The size cannot exceed 10 MB. No side of the image can be smaller than 15 or larger than 8,192 pixels. Only images in JPEG, JPG, PNG, BMP, TIFF, GIF, or WEBP format can be recognized. |
url |
No. Set either this parameter or image. |
String |
Image URL. Currently, the following URLs are supported:
NOTE:
|
detect_direction |
No |
Boolean |
Whether to enable the function of aligning tilted images. The options are as follows:
An image tilted at any angle can be aligned. If this parameter is not specified, the default value false is used. |
extract_type |
No |
Array of strings |
Structured data extraction parameter list. Currently, only the image width and height are supported. The input parameter value of the image width and height is image_size. If this parameter is not set or is deleted, this parameter will not be used. |
Response Parameters
Response parameters and status codes vary in different recognition results. They are described as below.
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
result |
WebImageResult object |
Calling result of a successful API call This parameter is not included when the API fails to be called. |
Parameter |
Type |
Description |
|---|---|---|
words_block_count |
Integer |
Number of detected text blocks |
words_block_list |
Array of WebImageWordsBlockList objects |
List of text blocks to be recognized. The output sequence is from left to right and from top to bottom. |
Parameter |
Type |
Description |
|---|---|---|
words |
String |
Recognition result of a text block |
confidence |
Float |
Confidence information of a related field. The value ranges from 0 to 1. A higher confidence level indicates a higher reliability and accuracy of the corresponding field identified. The confidence is not equal to the accuracy, and is calculated through related algorithms. |
location |
Array of integers |
Recognized location information about a text block, in list format, including the coordinates (x, y) of four vertexes in the text area. The image coordinate system is used. The coordinate origin is the upper left corner of the image, the X axis is horizontal, and the Y axis is vertical. |
extracted_data |
Object |
Structured data extraction parameter list. Currently, only the image width and height are supported. The input parameter value of the image width and height is image_size. If extract_type is left blank or missing, no information is extracted. |
image_size |
Object |
Width and height of an image If extract_type does not contain this parameter, this parameter does not exist in the response. |
height |
Integer |
Image height, which is returned when image_size is passed. |
width |
Integer |
Image width, which is returned when image_size is passed. |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code of a failed API call. For details, see Error Codes. If error code ModelArts.4204 is displayed, refer to Why Is a Message Stating "ModelArts.4204" Displayed When the OCR API Is Called? This parameter is not included when the API is successfully called. |
error_msg |
String |
Error message returned when the API fails to be called |
Request Example
- The endpoint is the request URL for calling an API. Endpoints vary depending on services and regions. For details, see Endpoints.
For example, Web Image OCR is deployed in the AP-Bangkok region. The endpoint is ocr.ap-southeast-2.myhuaweicloud.com. The request URL is https://ocr.ap-southeast-2.myhuaweicloud.com/v2/{project_id}/ocr/web-image. project_id is the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
- For details about how to obtain a token, see Making an API Request.
- Request example (Method 1: Use the image Base64 string.)
POST https://{endpoint}/v2/{project_id}/ocr/web-image Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/..." } - Request example (Method 2: Use the image 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" } - Sample code for a Python 3 request (For codes in other languages, refer to the following sample or use OCR SDK.)
# encoding:utf-8 import requests import base64 url = "https://{endpoint}/v2/{project_id}/ocr/web-image" token = "Actual token value obtained by the user" headers = {'Content-Type': 'application/json', 'X-Auth-Token': token} imagepath = r'./data/web-image-demo.png' with open(imagepath, "rb") as bin_data: image_data = bin_data.read() image_base64 = base64.b64encode(image_data).decode("utf-8") # Base64 encoding of images. payload = {"image": image_base64} # url or image. response = requests.post(url, headers=headers, json=payload) print(response.text)
Example Response
Status code: 200
Successful response example
{
"result": {
"words_block_count": 2,
"words_block_list": [
{
"words": "Words recognized from the image",
"confidence": 0.9950,
"location": [
[13, 476],
[91, 332],
[125, 351],
[48, 494]
]
},
{
"words": "Words recognized from the image",
"confidence": 0.9910,
"location": [
[13, 476],
[91, 332],
[125, 351],
[48, 494]
]
}
],
"extracted_data": {}
}
}
Status code: 400
Failure response example
{
"error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Success response |
400 |
Failure response |
For details about status codes, see Status Codes.
Error Codes
For details about error codes, see Error Codes.
