You can create a similar image clustering task to group visually similar images within a specified drive.
Operation description
Before using this API, make sure you fully understand PDS billing and pricing.
This feature requires the value-added service for image processing, which is currently available at no cost for a limited time.
Follow these steps:
-
Create a similar image clustering task.
-
Use the GetTaskStatus API to check whether the similar image clustering task has completed.
-
Use the SearchSimilarImageClusters API to retrieve the clustering results.
Only one similar image clustering task can run in a drive at a time. If a previous task has not completed, calling this API again will fail.
Try it now
Test
RAM authorization
Request syntax
POST /v2/image/create_similar_image_cluster_task HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
Request body |
|
| drive_id |
string |
Yes |
Drive ID |
123 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response parameters |
||
| task_id |
string |
Task ID |
i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb |
Examples
Success response
JSON format
{
"task_id": "i:SimilarImageClustering-b67d53e7-2fe8-460f-9b95-1e93636923eb"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.