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

接口说明

背景信息

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

通过传入媒体集中的两个人脸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暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Project	string	是	项目名称。	immimagetest
SetId	string	否	媒体集的唯一标识。	set001
ImageUriA	string	是	图片的OSS URI。 OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。通过两张图片的OSS URI进行人脸相似度比较时，必须设置此参数。	oss://imm-test/testcases/face1.jpg
ImageUriB	string	否	图片的OSS URI。 OSS地址规则为`oss://bucket/object`，其中bucket为和当前项目处于同一区域的OSS Bucket名称，object为文件路径。通过两张图片的OSS URI进行人脸相似度比较时，必须设置此参数。	oss://imm-test/testcases/face2.jpg
FaceIdA	string	否	媒体集中已存在的人脸ID。通过媒体集中的两个人脸ID进行人脸相似度比较时，必须设置此参数。	59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****
FaceIdB	string	否	媒体集中已存在的人脸ID。通过媒体集中的两个人脸ID进行人脸相似度比较时，必须设置此参数。	b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	当次请求的Request ID。	F73AC982-2B9E-4ECD-AED5-F8331C5A1988
Similarity	number	人脸相似度，该值越大则人脸相似度越高，取值范围为0～1。	0.8848152756690983
SetId	string	媒体集的唯一标识。	set001
FaceA	object	人脸信息。
FaceId	string	人脸ID。	59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a040****
FaceAttributes	object	人脸属性。
FaceBoundary	object	人脸位置框。
Top	integer	顶点Y坐标，距离顶端距离。	191
Width	integer	人脸位置框宽度。	269
Height	integer	人脸位置框高度。	252
Left	integer	顶点X坐标，距离左端距离。	95
FaceB	object	人脸信息。
FaceId	string	人脸ID。	b4a15b4f1618cdfa45a812974cfc160570052487ca1053e20bfdc12917e2****
FaceAttributes	object	人脸属性。
FaceBoundary	object	人脸位置框。
Top	integer	顶点Y坐标，距离顶端距离。	72
Width	integer	人脸位置框宽度。	83
Height	integer	人脸位置框高度。	89
Left	integer	顶点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
      }
    }
  }
}

错误码

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