DetectImageTexts - Intelligent Media Management - Alibaba Cloud Documentation Center

Recognizes and extracts text content from an image.

Operation description

Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
The size of the image cannot exceed 20 MB.
The shortest side of the image is not less than 20 px, and the longest side is not more than 30,000 px.
The aspect ratio of the image is less than 1:2.
We recommend that you do not use an image that is smaller than 15 px × 15 px in size. Otherwise, the recognition rate is low.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
imm:DetectImageTexts	none	*Project `acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. For more information, see CreateProject .	test-project
SourceURI	string	Yes	The Object Storage Service (OSS) URI of the file. Specify the URI in the oss://${Bucket}/${Object} format. ${Bucket} specifies the name of an OSS bucket that is in the same region as the current project. ${Object} specifies the path of the object with the extension included.	oss://test-bucket/test-object.jpg
CredentialConfig	CredentialConfig	No	If you have no special requirements, leave this field empty. The configurations of authorization chains. This parameter is optional. For more information, see Use authorization chains to access resources of other entities.

Response parameters

Parameter	Type	Description	Example
	object	The text recognition result.
RequestId	string	The request ID.	1B3D5E0A-D8B8-4DA0-8127-ED32C851****
OCRTexts	string	The full Optical Character Recognition (OCR) text, which is spliced by using the content of OCRContents.
OCRContents	array	OCR text blocks.
OCRContents	OCRContents	The text blocks extracted from the image. Each element contains text block information such as the content and location.

Examples

Sample success responses

JSONformat

{
  "RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
  "OCRTexts": "",
  "OCRContents": [
    {
      "Language": "zh-hans",
      "Contents": "",
      "Confidence": 0.8254936695098877,
      "Boundary": {
        "Width": 200,
        "Height": 300,
        "Left": 10,
        "Top": 30,
        "Polygon": [
          {
            "X": 10,
            "Y": 10
          }
        ]
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history