CreateSimilarImageClusteringTask - Intelligent Media Management

The similar image clustering feature groups images that you have indexed in a dataset into clusters based on visual similarity. This feature is useful for scenarios such as deduplicating images or selecting the best shots. For example, you can use it to filter burst photos in an album.

Operation description

Before calling this operation, review the billing methods and pricing of Intelligent Media Management (IMM).
Important The execution time of asynchronous tasks is not guaranteed.
Before calling this operation, index files to a dataset. You can index files by attaching a data source using CreateBinding, or by actively indexing files using IndexFileMeta or BatchIndexFileMeta.
Each call to this operation incrementally processes the files in the specified Dataset. You can call this operation periodically to process new files.
After clustering completes, call the QuerySimilarImageClusters operation to retrieve the clustering results.
Each similar image cluster must contain at least two images. Deleting a file from a dataset changes the similar image clusters. If deleting an image reduces a cluster to fewer than two images, the cluster is automatically deleted.
This operation is asynchronous. After a task starts, its information is retained for only seven days. You cannot query the information after this period. Call the GetTask or ListTasks operation and use the returned TaskId to view task information. You can also set the Notification parameter to receive asynchronous notification messages about the task.

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

create

*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. For more information, see Create a project.	test-project
DatasetName	string	Yes	The name of the dataset. For more information, see Create a dataset.	test-dataset
UserData	string	No	The custom information. This information is returned in the asynchronous notification message to help you associate the message with your system. The value can be up to 2,048 bytes in length.	test-data
Tags	object	No	The custom tags that are used to search for and filter asynchronous tasks.	{ "User": "Jane" }
Notification	Notification	No	The configuration of the notification message. For more information, click Notification. For more information about the format of asynchronous notification messages, see Asynchronous notification messages.

Response elements

Element	Type	Description	Example
	object	The information about the similar image clustering task.
RequestId	string	The request ID.	1B3D5E0A-D8B8-4DA0-8127-ED32C851****
TaskId	string	The task ID.	SimilarImageClustering-48d0a0f3-8459-47f4-b8af-ff49c64****
EventId	string	The event ID.	3BF-1UhtFyrua71eOkFlqYq23Co****

Examples

Success response

JSON format

{
  "RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
  "TaskId": "SimilarImageClustering-48d0a0f3-8459-47f4-b8af-ff49c64****",
  "EventId": "3BF-1UhtFyrua71eOkFlqYq23Co****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.