文档

CreateFigureClusteringTask - 创建人物人脸聚类任务

创建一个人物人脸聚类任务,通过智能算法,可以在您已索引到数据集的图片中,将属于不同人物的人脸进行聚类分组。

接口说明

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

  • 调用该接口前,请确保您已通过绑定方式( CreateBinding )或者主动索引( IndexFileMeta 或者 BatchIndexFileMeta )方式将文件索引到数据集( CreateDataset )中。

  • 每次调用该接口,会增量对数据集( CreateDataset )内的文件进行处理。您可以根据新增文件情况,定期调用该接口对新文件进行处理。

  • 聚类完成后,您可以通过 GetFigureCluster 或者 BatchGetFigureCluster 接口获取特定的分组信息,也可通过 QueryFigureClusters 查询和列出数据集下的分组。

  • 从数据集中删除文件,会导致人脸聚类发生变化。当一个聚类中所有人脸所在的图片都被删除时,该聚类分组就会被删除。

  • 该接口为异步接口,获取任务开始执行后,任务信息只保存 7 天,超过 7 天则无法再获取。调用 GetTaskListTasks 接口获取返回的 TaskId,查看任务信息。也可以通过设置 Notification 消息通知参数,通过消息通知获取任务信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

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

immtest
DatasetNamestring

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

dataset001
UserDatastring

用户自定义信息,在异步消息通知中会为您返回,用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。

{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Tagsobject

自定义标签,用于对异步任务进行搜索、过滤。

{"test": "val1"}
NotificationNotification

消息通知配置,详细内容请单击 Notification 查看,异步通知消息格式请参见异步通知消息格式

返回参数

名称类型描述示例值
object

人脸聚类任务信息。

RequestIdstring

当次请求的 Request ID。

1B3D5E0A-D8B8-4DA0-8127-ED32C851****
TaskIdstring

任务 ID。

formatconvert-00bec802-073a-4b61-ba3b-39bc****
EventIdstring

事件 ID。

0ED-1Bz8z71k5TtsUejT4UJ16****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-03OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:NotifyTopicName
2023-03-09OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Notification
2022-08-16OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:NotifyEndpoint
  • 本页导读 (1)
文档反馈