CreateFigureClusteringTask - Intelligent Media Management

Creates a face clustering task to cluster faces of different persons in images by person based on the intelligent algorithms.

Operation description

Before you call this operation, make sure that you are familiar with the billing of Intelligent Media Management (IMM).****

**

Note Asynchronous processing does not guarantee timely task completion.
Before you call this operation, make sure that you have indexed file metadata into the dataset automatically by calling the CreateBinding operation or manually by calling the IndexFileMeta or BatchIndexFileMeta operation.
Each call to the operation incrementally processes metadata in the dataset. You can regularly call this operation to process incremental files.

After the clustering task is completed, you can call the GetFigureCluster or BatchGetFigureCluster operation to query information about a specific cluster. You can also call the QueryFigureClusters operation to query all face clusters of the specified dataset.
Removing image information from the dataset causes changes to face clusters. When images that contain all faces in a cluster are removed, the cluster is deleted.
This operation is an asynchronous operation. After a task is executed, the task information is retained only for seven days and cannot be retrieved when the retention period elapses. You can call the GetTask or ListTasks operation to query information about the task. If you specify Notification , you can obtain information about the task based on notifications.

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:CreateFigureClusteringTask	create	*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.	immtest
DatasetName	string	Yes	The name of the dataset.	dataset001
UserData	string	No	The custom information, which is returned in an asynchronous notification and facilitates notification management. The maximum length of the value is 2,048 bytes.	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tags	object	No	The custom tags. You can search for or filter asynchronous tasks by custom tag.	{"test": "val1"}
Notification	Notification	No	The notification settings. For information about the asynchronous notification format, see Asynchronous message examples.

Response parameters

Parameter	Type	Description	Example
	object	The information about the face clustering task.
RequestId	string	The request ID.	1B3D5E0A-D8B8-4DA0-8127-ED32C851****
TaskId	string	The task ID.	formatconvert-00bec802-073a-4b61-ba3b-39bc****
EventId	string	The event ID.	0ED-1Bz8z71k5TtsUejT4UJ16****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
  "TaskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-04-03	The request parameters of the API has changed	View Change Details
2023-03-09	The request parameters of the API has changed	View Change Details
2022-08-16	The request parameters of the API has changed	View Change Details