调用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对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
imm:CompareImageFaces		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
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	float	人脸相似度，该值越大则人脸相似度越高，取值范围为 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
      }
    }
  }
}

错误码

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