调用CreateGroupFacesJob接口对媒体集中的人脸进行聚类操作,即将同一人物的人脸分为一组并生成人脸分组的GroupId。
背景信息
人脸聚类任务执行完成后,使用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代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateGroupFacesJob |
操作接口名称,固定取值为CreateGroupFacesJob。 |
Project | String | 是 | immimagetest |
项目名称。 |
SetId | String | 是 | set001 |
媒体集的唯一标识。 |
RegionId | String | 否 | cn-hangzhou |
项目所在地域的ID。 地域Endpoint格式为 |
NotifyTopicName | String | 否 | topic1 |
异步反向通知的TopicName。 |
NotifyEndpoint | String | 否 | http://1111111111.mns.cn-hangzhou.aliyuncs.com |
异步反向通知的Endpoint,文档转换状态可以通过该Endpoint异步通知给调用者。使用此功能需要先开通MNS服务,新建topic和queue,并配置订阅关系。具体操作,请参见消息服务MNS快速入门。 说明 MNS服务和智能媒体管理必须处于同一地域。
|
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通知的返回参数说明请参见下表。
名称 |
类型 |
描述 |
---|---|---|
eventName |
String |
任务类型,返回值固定为GroupImageFacesJob。 |
imm.JobId |
String |
人脸聚类任务的唯一标识。 |
imm.SetId |
String |
媒体集的唯一标识。 |
imm.NewGroupCount |
String |
新增人脸分组数量。 |
imm.UpdateFaceCount |
String |
更新人脸分组的人脸数量,包括新增图片和原有未分组图片中被分组的人脸。 |
imm.UpdateGroupCount |
String |
更新的人脸分组数量。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
JobId | String | GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d |
人脸聚类任务的唯一标识。 |
JobType | String | GroupImageFacesJob |
任务类型,返回值固定为GroupImageFacesJob。 |
RequestId | String | BCF7B6EC-F97D-4594-866C-B421B82B24FE |
当次请求的Request ID。 |
SetId | String | set001 |
媒体集的唯一标识。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateGroupFacesJob
&Project=immimagetest
&SetId=set001
&<公共请求参数>
正常返回示例
XML
格式
<JobType>GroupImageFacesJob</JobType>
<RequestId>BCF7B6EC-F97D-4594-866C-B421B82B24FE</RequestId>
<SetId>set001</SetId>
<JobId>GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d</JobId>
JSON
格式
{
"JobType": "GroupImageFacesJob",
"RequestId": "BCF7B6EC-F97D-4594-866C-B421B82B24FE",
"SetId": "set001",
"JobId": "GroupImageFacesJob-fb9586a7-f91d-46b9-8e70-b669892cf34d"
}