文档

CreateFacesSearchingTask - 创建相似人脸图片检索任务

更新时间:

从媒体集中搜索与指定图片或人脸ID最相似的前N张图片,并返回相应人脸ID及边界框,返回结果按照相似度降序排列。

接口说明

  • 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格
  • 对于每一个输入的图片,只会选取图片中人脸框范围最大的人脸进行人脸搜索。人脸框检测结果与 DetectImageFaces 一致。
  • 该接口为异步接口,获取任务开始执行后,任务信息只保存 7 天,超过 7 天则无法再获取。调用 GetTaskListTasks 接口获取返回的TaskId,查看任务信息。也可以通过设置 Notification 消息通知参数,通过消息通知获取任务信息。

调试

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

授权信息

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

请求参数

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

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

test-project
DatasetNamestring

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

test-dataset
UserDatastring

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

{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Sourcesobject []

图片列表。

URIstring

图片的 OSS 地址。

OSS 地址规则为 oss://${Bucket}/${Object},其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称,${Object}为包含文件扩展名的文件完整路径。

oss://test-bucket/test-object
MaxResultlong

最相似的 N 个人脸,取值范围为 0~100,默认值为 5。

100
NotificationNotification

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

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

B1E79399-05F7-06D8-95FE-EBE17BA*****
TaskIdstring

任务 ID。

CreateFacesSearchingTask-00bec802-073a-4b61-ba*****
EventIdstring

事件 ID。

0ED-1Bz8z71k5TtsUejT4UJ16****

示例

正常返回示例

JSON格式

{
  "RequestId": "B1E79399-05F7-06D8-95FE-EBE17BA*****",
  "TaskId": "CreateFacesSearchingTask-00bec802-073a-4b61-ba*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16****"
}

错误码

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

变更历史

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