Call the DetectImageLabels API to detect image labels - Intelligent Media Management

Detects scene, object, and event information in an image. Scene information includes natural landscapes, daily life, and disasters. Event information includes talent shows, office events, performances, and production events. Object information includes tableware, electronics, furniture, and transportation. The DetectImageLabels operation supports more than 30 different categories and thousands of labels.

Operation description

Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****
Make sure that an IMM project is created. For information about how to create a project, see CreateProject.
For more information about the features of this operation, see Image label detection.
For more information about the input images supported by this operation, see Limits on images.

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:DetectImageLabels

none

*Project

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project. You can obtain the name of the project from the response of the CreateProject operation.	test-project
SourceURI	string	Yes	The URI of the Object Storage Service (OSS) bucket in which you store the image. Specify the value in the oss://${Bucket}/${Object} format. `${Bucket}` specifies the name of the OSS bucket that resides in the same region as the current project. `${Object}` specifies the complete path to the image file that has an extension.	oss://test-bucket/test-object.jpg
Threshold	number	No	The threshold of the label confidence. Labels whose confidence is lower than the specified threshold are not returned in the response. Valid values: 0 to 1. If you leave this parameter empty, the algorithm provides a default threshold.	0.7
CredentialConfig	CredentialConfig	No	If you have no special requirements, leave this parameter empty. The authorization chain settings. For more information, see Use authorization chains to access resources of other entities.

Response elements

Element	Type	Description	Example
	object	The response parameters.
Labels	array	The list of labels detected.
	Label	The labels.
RequestId	string	The request ID.	91AC8C98-0F36-49D2-8290-742E24DF1F69

Examples

Success response

JSON format

{
  "Labels": [
    {
      "Language": "zh-Hans",
      "LabelName": "椅子",
      "LabelLevel": 2,
      "LabelConfidence": 0.95,
      "ParentLabelName": "家具",
      "CentricScore": 0.877,
      "LabelAlias": "",
      "Clips": [
        {
          "TimeRange": [
            0
          ]
        }
      ]
    }
  ],
  "RequestId": "91AC8C98-0F36-49D2-8290-742E24DF1F69"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.