Query face clusters that contain a specific face from an image - Intelligent Media Management - Alibaba Cloud - Intelligent Media Management

Operation description

Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).
Before you call this operation, make sure that you have clustered all faces in the dataset by calling the CreateFigureClusteringTask operation.

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

list

*Dataset

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

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the project.	test-project
DatasetName	string	Yes	The name of the dataset.	test-dataset
SourceURI	string	No	The OSS URI of the image. Specify the URI in the `oss://${Bucket}/${Object}` format, where `${Bucket}` is the name of the bucket in the same region as the current project and `${Object}` is the path of the object including the extension.	oss://test-bucket/test-object
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.
RequestId	string	The request ID.	C2734912-E6D5-052C-AC67-6A9FD02*****
Clusters	array<object>	The face clusters.
	object	The face cluster details.
Boundary	Boundary	The bounding box of the face.
ClusterId	string	The ID of the face cluster that contains faces similar to the face within the bounding box.	Cluster-ca730577-06b1-42c7-a25b-8f2c7******
Similarity	number	The similarity between the face within the bounding box and the face cluster. Valid values: 0 to 1.	0.87413794

Examples

Success response

JSON format

{
  "RequestId": "C2734912-E6D5-052C-AC67-6A9FD02*****",
  "Clusters": [
    {
      "Boundary": {
        "Width": 200,
        "Height": 300,
        "Left": 10,
        "Top": 30,
        "Polygon": [
          {
            "X": 10,
            "Y": 10
          }
        ]
      },
      "ClusterId": "Cluster-ca730577-06b1-42c7-a25b-8f2c7******",
      "Similarity": 0.87413794
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.