All Products
Search
Document Center

Intelligent Media Management:DetectImageLabels

Last Updated:Dec 11, 2024

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.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
imm:DetectImageLabelsnone
*Project
acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectNamestringYes

The name of the project. You can obtain the name of the project from the response of the CreateProject operation.

immimagetest
SourceURIstringYes

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://imm-test/testcases/facetest.jpg
ThresholdfloatNo

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.

1
CredentialConfigCredentialConfigNo

If you do not have special requirements, leave this parameter empty.

The authorization chain. This parameter is optional. For more information, see Use authorization chains to access resources of other entities.

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Labelsarray

The labels that are detected.

LabelsLabel

The label that is detected.

RequestIdstring

The request ID.

91AC8C98-0F36-49D2-8290-742E24DF1F69

Examples

Sample success responses

JSONformat

{
  "Labels": [
    {
      "Language": "zh-Hans",
      "LabelName": "",
      "LabelLevel": 1,
      "LabelConfidence": 0.9891784601980591,
      "ParentLabelName": "",
      "CentricScore": 0.7319999933242798
    }
  ],
  "RequestId": "91AC8C98-0F36-49D2-8290-742E24DF1F69"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history