文档

CompareImageFaces - 比较两个人脸的相似度

更新时间:

调用CompareImageFaces接口比较两个人脸的相似度。

接口说明

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

  • 您可以使用如下两种方式比较两个人脸的相似度。

    • 通过传入媒体集中的两个人脸 ID 进行比较,具体步骤如下:

      1. 调用 CreateSet 接口创建媒体集。
      2. 调用 IndexImage 接口将图片索引到媒体集。
      3. 调用 ListImages 或 GetImage 接口获取需要进行搜索的人脸 ID。
      4. 使用媒体集中的人脸 ID,将人脸 ID 作为输入值,比较两个人脸的相似度。
    • 通过传入两张图片的 OSS URI 进行比较,具体步骤如下:

      1. 将两张图片上传到 OSS。
      2. 使用图片的 OSS URI,将图片中的人脸作为输入值,比较两个人脸的相似度。

调试

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

授权信息

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

请求参数

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

项目名称。

immimagetest
SetIdstring

媒体集的唯一标识。

set001
ImageUriAstring

图片的 OSS URI。

OSS 地址规则为oss://bucket/object,其中 bucket 为和当前项目处于同一区域的 OSS Bucket 名称,object 为文件路径。

通过两张图片的 OSS URI 进行人脸相似度比较时,必须设置此参数。

oss://imm-test/testcases/face1.jpg
ImageUriBstring

图片的 OSS URI。

OSS 地址规则为oss://bucket/object,其中 bucket 为和当前项目处于同一区域的 OSS Bucket 名称,object 为文件路径。

通过两张图片的 OSS URI 进行人脸相似度比较时,必须设置此参数。

oss://imm-test/testcases/face2.jpg
FaceIdAstring

媒体集中已存在的人脸 ID。

通过媒体集中的两个人脸 ID 进行人脸相似度比较时,必须设置此参数。

59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****
FaceIdBstring

媒体集中已存在的人脸 ID。

通过媒体集中的两个人脸 ID 进行人脸相似度比较时,必须设置此参数。

b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****

返回参数

名称类型描述示例值
object
RequestIdstring

当次请求的 Request ID。

F73AC982-2B9E-4ECD-AED5-F8331C5A1988
Similarityfloat

人脸相似度,该值越大则人脸相似度越高,取值范围为 0~1。

0.8848152756690983
SetIdstring

媒体集的唯一标识。

set001
FaceAobject

人脸信息。

FaceIdstring

人脸 ID。

59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****
FaceAttributesobject

人脸属性。

FaceBoundaryobject

人脸位置框。

Topinteger

顶点 Y 坐标,距离顶端距离。

191
Widthinteger

人脸位置框宽度。

269
Heightinteger

人脸位置框高度。

252
Leftinteger

顶点 X 坐标,距离左端距离。

95
FaceBobject

人脸信息。

FaceIdstring

人脸 ID。

b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****
FaceAttributesobject

人脸属性。

FaceBoundaryobject

人脸位置框。

Topinteger

顶点 Y 坐标,距离顶端距离。

72
Widthinteger

人脸位置框宽度。

83
Heightinteger

人脸位置框高度。

89
Leftinteger

顶点 X 坐标,距离左端距离。

249

示例

正常返回示例

JSON格式

{
  "RequestId": "F73AC982-2B9E-4ECD-AED5-F8331C5A1988",
  "Similarity": 0.8848152756690983,
  "SetId": "set001",
  "FaceA": {
    "FaceId": "59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****",
    "FaceAttributes": {
      "FaceBoundary": {
        "Top": 191,
        "Width": 269,
        "Height": 252,
        "Left": 95
      }
    }
  },
  "FaceB": {
    "FaceId": "b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****",
    "FaceAttributes": {
      "FaceBoundary": {
        "Top": 72,
        "Width": 83,
        "Height": 89,
        "Left": 249
      }
    }
  }
}

错误码

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

  • 本页导读 (1)
文档反馈