调用CreateMergeFaceGroupsJob接口合并媒体集中的两个人脸分组。
接口说明
-
此接口已不再维护,建议使用新版(2020-09-30 版本)接口 CreateFigureClustersMergingTask 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。
-
同一时间一个媒体集中只能进行一个聚类任务(包括 CreateMergeFaceGroupsJob 和 CreateGroupFacesJob),因此调用对应接口时,请确保上一次调用已执行完成。您可以使用通知机制,传入 NotifyTopicName 和 NotifyEndpoint,及时获取任务执行结果的通知。具体操作,请参见消息服务 MNS 快速入门。
-
每个合并人脸分组任务的最长执行时间为 3 分钟。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Project | string | 是 | 项目名称。 | immimagetest |
SetId | string | 是 | 媒体集的唯一标识。 | set001 |
NotifyTopicName | string | 否 | 异步反向通知的 TopicName。 | topic1 |
NotifyEndpoint | string | 否 | 异步反向通知的 Endpoint,文档转换状态可以通过该 Endpoint 异步通知给调用者。使用此功能需要先开通 MNS 服务,新建 topic 和 queue,并配置订阅关系。具体操作,请参见消息服务 MNS 快速入门。 说明
MNS 服务和智能媒体管理必须处于同一地域。
| http://1111111111.mns.cn-hangzhou.aliyuncs.com |
GroupIdFrom | string | 否 | 待合并的分组的 GroupId,该分组中的人脸将被合并到 GroupIdTo 对应分组中。 | Group-c1f55987-360b-4640-9e2c-f5c29f930a3b |
GroupIdTo | string | 否 | 待合并的分组的 GroupId,该分组中将加入 GroupIdFrom 对应分组中的人脸。 | Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09 |
CustomMessage | string | 否 | 用户自定义信息,在通知时回原样返回。最长 1024 个字符。 | abc |
MNS 通知
请求参数中如果设置了 NotifyTopicName 和 NotifyEndpoint 支持 MNS 事件通知,则智能媒体管理会为您返回异步通知。通知的消息格式为:
{
"events": [
{
"eventName": "MergeFaceGroupsJob",
"eventSource": "acs:imm",
"eventTime": "2019-02-20T11:06:25.264Z",
"eventVersion": "1.0",
"imm": {
"ErrorCode": "",
"JobId": "MergeFaceGroupsJob-73a65fd7-cabd-4e19-a110-a159d113c6b6",
"SetId": "set001",
"Success": "true",
"UpdateFaceCount": "10",
"CustomMessage": "abc",
"GroupIdFrom": "Group-c1f55987-360b-4640-9e2c-f5c29f930a3b",
"GroupIdTo": "Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09"
}
}
]
}
MNS 通知的返回参数说明请参见下表。
名称 | 类型 | 描述 |
---|---|---|
eventName | String | 任务类型,返回值固定为 MergeFaceGroupsJob。 |
imm.JobId | String | 合并人脸分组任务的唯一标识。 |
imm.SetId | String | 媒体集的唯一标识。 |
imm.UpdateFaceCount | String | 更新人脸分组的人脸数量,包括新增图片和原有未分组图片中被分组的人脸。 |
imm.CustomMessage | String | 用户自定义信息。 |
imm.GroupIdFrom | String | 待合并的分组的 GroupId,该分组中的人脸将被合并到 GroupIdTo 对应分组中。 |
imm.GroupIdTo | String | 待合并的分组的 GroupId,该分组中将加入 GroupIdFrom 对应分组中的人脸。 |
返回参数
示例
正常返回示例
JSON
格式
{
"GroupIdFrom": "Group-c1f55987-360b-4640-9e2c-f5c29f930a3b",
"JobType": "MergeFaceGroupsJob",
"RequestId": "3FF344BF-87A9-4AC3-A3DE-9E1FAED7D1FE",
"SetId": "set001",
"GroupIdTo": "Group-c5fdad70-fd60-4c2a-8a08-ed86aca21f09",
"JobId": "MergeFaceGroupsJob-055995ef-9c5e-4db4-a99a-0900d1e31d26"
}
错误码
访问错误中心查看更多错误码。