相似图片聚类功能，可以将您已索引到数据集内的图片按照相似度生成聚类，用于图片去重、选优等场景，例如可以通过该功能筛选相册中连拍的图片。
接口说明
-
请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
-
调用该接口前，请确保您已通过绑定方式（ CreateBinding ）或者主动索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式将文件索引到数据集（Dataset）中。
-
每次调用该接口，会增量对数据集
Dataset内的文件进行处理。您可以根据新增文件情况，定期调用该接口对新文件进行处理。 -
聚类完成后，您可以通过 QuerySimilarImageClusters 接口获取聚类结果。
-
每组相似图片聚类限制图片数量不低于 2 张。从数据集（Dataset）中删除文件，会导致相似图片聚类发生变化。当您从数据集（Dataset）中删除图片导致聚类中图片数小于 2 张时，该聚类会自动删除。
-
该接口为异步接口，获取任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的
TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| imm:CreateSimilarImageClusteringTask |
|
| 无 | |
| imm:CreateSimilarImageClusteringTask |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 项目名称，获取方式请参见创建项目。 | test-project |
| DatasetName | string | 是 | 数据集名称，获取方式请参见创建数据集。 | test-dataset |
| UserData | string | 否 | 用户自定义信息，在异步消息通知中会为您返回，方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。 | test-data |
| Tags | object | 否 | 自定义标签，用于对异步任务进行搜索、过滤。 | { "User": "Jane" } |
| Notification | Notification | 否 | 消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
"TaskId": "SimilarImageClustering-48d0a0f3-8459-47f4-b8af-ff49c64****",
"EventId": "3BF-1UhtFyrua71eOkFlqYq23Co****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-04-03 | OpenAPI 入参发生变更 | 查看变更详情 |