SearchImageFigureCluster - Intelligent Media Management - Alibaba Cloud Documentation Center

Queries face clusters that contain a specific face in an image. Each face cluster contains information such as bounding boxes and similarity.

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 created a face clustering task by calling the CreateFigureClusteringTask operation to cluster all faces in the dataset.

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:SearchImageFigureCluster	list	*Dataset `acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}`	none	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 OSS 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 with the extension included.	oss://test-bucket/test-object
CredentialConfig	CredentialConfig	No	If you have no special requirements, leave this parameter empty. The configurations of authorization chains. For more information, see Use authorization chains to access resources of other entities.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C2734912-E6D5-052C-AC67-6A9FD02*****
Clusters	array<object>	The face clusters.
Clusters	object	The face cluster.
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	float	The similarity between the face within the bounding box and the face cluster. Valid value: 0 to 1.	0.87413794

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history