从媒体集中搜索与指定图片或人脸ID最相似的前N张图片，并返回相应人脸ID及边界框，返回结果按照相似度降序排列。
接口说明
背景信息
您可以使用如下两种方式从媒体集中搜索与人脸最相似的前N张图片。
通过传入媒体集中人脸ID进行搜索，具体步骤如下：
说明返回值中Faces的首个元素一定是传入的FaceId，系统不会对结果进行过滤。- 调用CreateSet接口创建媒体集。
- 调用IndexImage接口将图片索引到媒体集。
- 调用ListImages或GetImage接口获取需要进行搜索的人脸ID。
- 使用媒体集中的人脸ID，将人脸ID作为输入值，从媒体集中搜索与人脸ID对应人脸最相似的前N张图片。
通过传入图片的OSS URI进行搜索，具体步骤如下：
说明当传入的ImageUri在媒体集中存在时，则返回值中Faces的首个元素一定是传入的ImageUri内的同一个人脸，系统不会对结果进行过滤。- 将图片上传到OSS。
- 使用图片的OSS URI，将图片中的人脸作为输入值，从媒体集中搜索与图片中人脸最相似的前N张图片。
注意事项
当两个人脸的相似度Similarity>0.8时，两个人脸基本可以判断为同一人物。
搜索结果依赖索引的建立，返回结果与实际值可能有数秒的数据延迟。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Project | string | 是 | 项目名称。 | immimagetest |
| SetId | string | 是 | 媒体集的唯一标识。 | set001 |
| ImageUri | string | 否 | 图片的OSS URI。 OSS地址规则为 | oss://imm-test/testcases/face1.jpg |
| FaceId | string | 否 | 媒体集中已存在的人脸ID。 | 59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51 |
| Limit | integer | 否 | 返回最相似图片的最大个数，默认值为10，取值范围为1~100。 | 5 |
| MinSimilarity | number | 否 | 过滤返回结果中相似度低于该值的图片。 | 0.8 |
| ResponseFormat | string | 否 | 返回值的格式版本，不设置此参数则返回值的格式为旧版本，推荐设置此参数为v2。 | v2 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "31A201C4-6824-4A8F-81FE-E0659FDDF1D7",
"Faces": [
{
"ExternalId": "external001",
"Similarity": 0.860930573940277,
"FaceId": "59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51",
"ImageUri": "oss://imm-test/testcases/face1.jpg",
"SimilarFaces": [
{
"ExternalId": "external003",
"Similarity": 0.860930573940277,
"FaceId": "98ae3c032337161f997a92f8ab9ac9624113368b9e4f93f6143d54a16e51b623",
"ImageUri": "oss://imm-test/testcases/face3.jpg",
"FaceAttributes": {
"FaceBoundary": {
"Left": 267,
"Top": 152,
"Width": 139,
"Height": 141
}
}
}
],
"FaceAttributes": {
"FaceBoundary": {
"Left": 95,
"Top": 191,
"Width": 269,
"Height": 252
}
}
}
]
}错误码
访问错误中心查看更多错误码。