文档

CreateGroupFacesJob - 人脸聚类

更新时间:

按照人物将人脸分组。

接口说明

  • 此接口已不再维护,建议使用新版(2020-09-30 版本)接口 CreateFigureClusteringTask 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

  • 人脸聚类任务执行完成后,使用 ListFaceGroups 接口查看已有分组列表,并可以使用 FindImages 接口根据 GroupId 搜索该组的人脸图片。

  • 人脸分组的 GroupId 以Group-{UUID-v4}格式命名,即 Group-后接一个 UUIDv4 格式的字符串。人脸的分组包括如下保留的特殊分组命名:

    • group-none:该人脸暂无合适的分组,后续在媒体集中新增图片后进行人脸聚类操作时,该人脸可能被分入组中。

    • group-not-grouped:该人脸暂未进行过聚类操作,即在媒体集中新增图片后,未进行人脸聚类。

  • group-none-by-user:由用户手动操作,记录该人脸无合适的分组,后续在媒体集中新增图片后进行人脸聚类操作时,该人脸仍不会被分组。

  • 人脸聚类功能只对在 2019 年 03 月 12 日之后使用 IndexImage 接口将图片索引到媒体集中的图片有效。历史图片如需使用此功能,请从媒体集中删除并重新索引。

  • 该接口为增量聚类。调用该接口时,系统只会对媒体集中新增和未分组的图片进行分类,不会修改已分类人脸的分组。

  • 每个聚类任务的最长执行时间为 2 分钟,单次最多能处理 5100 张图片中的人脸。如果媒体集中添加的图片个数超过限制数量,则需要多次调用该接口。

  • 同一时间一个媒体集中只能进行一个聚类任务(包括 CreateMergeFaceGroupsJob 和 CreateGroupFacesJob),因此调用该接口时,请确保上一次调用已执行完成。您可以使用通知机制,传入 NotifyTopicName 和 NotifyEndpoint,及时获取任务执行结果的通知。

  • 如果一个分组已形成,则该分组不会合并到其他分组。

调试

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

授权信息

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

请求参数

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

项目名称。

immimagetest
SetIdstring

媒体集的唯一标识。

set001
NotifyTopicNamestring

异步反向通知的 TopicName。

topic1
NotifyEndpointstring

异步反向通知的 Endpoint,文档转换状态可以通过该 Endpoint 异步通知给调用者。使用此功能需要先开通 MNS 服务,新建 topic 和 queue,并配置订阅关系。具体操作,请参见消息服务 MNS 快速入门

说明 MNS 服务和智能媒体管理必须处于同一地域。
http://1111111111.mns.cn-hangzhou.aliyuncs.com

MNS 通知

请求参数中如果设置了 NotifyTopicName 和 NotifyEndpoint 支持 MNS 事件通知,则智能媒体管理会为您返回异步通知。通知的消息格式为:

{
    "events": [
        {
            "eventName": "GroupImageFacesJob",
            "eventSource": "acs:imm",
            "eventTime": "2019-02-20T11:06:25.264Z",
            "eventVersion": "1.0",
            "imm": {
                "ErrorCode": "",
                "JobId": "GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d",
                "NewGroupCount": "1",
                "SetId": "set001",
                "Success": "true",
                "UpdateFaceCount": "10",
                "UpdateGroupCount": "1"
            }
        }
    ]
}

MNS 通知的返回参数说明请参见下表。

名称类型描述
eventNameString任务类型,返回值固定为 GroupImageFacesJob。
imm.JobIdString人脸聚类任务的唯一标识。
imm.SetIdString媒体集的唯一标识。
imm.NewGroupCountString新增人脸分组数量。
imm.UpdateFaceCountString更新人脸分组的人脸数量,包括新增图片和原有未分组图片中被分组的人脸。
imm.UpdateGroupCountString更新的人脸分组数量。

返回参数

名称类型描述示例值
object
JobTypestring

任务类型,返回值固定为 GroupImageFacesJob。

GroupImageFacesJob
RequestIdstring

当次请求的 Request ID。

BCF7B6EC-F97D-4594-866C-B421B82B24FE
SetIdstring

媒体集的唯一标识。

set001
JobIdstring

人脸聚类任务的唯一标识。

GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d

示例

正常返回示例

JSON格式

{
  "JobType": "GroupImageFacesJob",
  "RequestId": "BCF7B6EC-F97D-4594-866C-B421B82B24FE",
  "SetId": "set001",
  "JobId": "GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d"
}

错误码

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