DetectImageTexts - Image text recognition API - Intelligent Media Management

Operation description

Before you call this operation, familiarize yourself with IMM billing.
Maximum image size: 20 MB.
Shortest side: at least 20 px. Longest side: at most 30,000 px.
Aspect ratio must be less than 1:2.
Images smaller than 15 × 15 px may have low recognition accuracy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

imm:DetectImageTexts

none

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. CreateProject.	test-project
SourceURI	string	Yes	The Object Storage Service (OSS) URI of the file. Format: oss://${Bucket}/${Object}. The bucket must be in the same region as the project. ${Object} is the full object path including the file extension.	oss://test-bucket/test-object.jpg
CredentialConfig	CredentialConfig	No	If you have no special requirements, leave this parameter empty. The authorization chain settings. Use authorization chains to access resources of other entities.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1B3D5E0A-D8B8-4DA0-8127-ED32C851****
OCRTexts	string	The full OCR text, concatenated from all OCRContents entries.	Intelligent Media Management.
OCRContents	array	OCR text blocks.
	OCRContents	Text blocks extracted from the image, each containing the recognized content and its bounding box.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.