文档

QuerySimilarImageClusters - 查询相似图片聚类

更新时间:

查询相似图片聚类列表信息。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格

  • 调用该接口前,请先通过 CreateSimilarImageClusteringTask 接口对数据集中的图片进行相似图片聚类。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:QuerySimilarImageClusterslist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称,获取方式请参见创建项目

test-project
DatasetNamestring

数据集名称,获取方式请参见创建数据集

test-dataset
NextTokenstring

翻页标记。

当文件总数大于设置的 MaxResults 时,用于翻页的 Token。从 NextToken 开始按字典序返回文件信息列表。

说明 在一次查询中首次调用此接口时,将此值设置为空。
CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****
MaxResultsinteger

返回聚类列表中最大任务数量。取值范围为(0,100 ],默认值为 100。

20
CustomLabelsstring

自定义标签,用于根据标签过滤任务。

{"key": "val"}
Sortstring

排序字段,可选值如下:

  • CreateTime:分类的创建时间。

  • UpdateTime:分类的更新时间(默认)。

UpdateTime
Orderstring

排序方式。取值范围如下:

  • asc:升序。
  • desc:降序(默认)。
asc

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

CA995EFD-083D-4F40-BE8A-BDF75FFF****
SimilarImageClustersarray

相似图片分类列表。

SimilarImageClustersSimilarImageCluster

相似图片分类具体信息。

NextTokenstring

翻页标记。当聚类列表总数大于设置的 MaxResults 时,用于翻页的 Token。符合条件的聚类列表未全部返回时,此参数才有值。

下一次查询聚类时将此值作为 NextToken 传入,将后续的聚类列表返回。

CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****

示例

正常返回示例

JSON格式

{
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFF****\n",
  "SimilarImageClusters": [
    {
      "ObjectId": "SimilarImageCluster-748a041e-4ebc-4487-9e74-9c89b1****",
      "UpdateTime": "2023-02-08T09:42:34.354969088+08:00",
      "CreateTime": "2023-02-08T09:42:34.354969088+08:00",
      "CustomLabels": {
        "test": "test",
        "test2": 1
      },
      "Files": [
        {
          "URI": "oss://test-bucket/test-object",
          "ImageScore": 0.709
        }
      ]
    }
  ],
  "NextToken": "CAESEgoQCg4KClVwZGF0ZVRpbWUQARgBIs8ECgkAAJLUwUCAQ****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-19API 内部配置变更,不影响调用查看变更详情