You need to enable JavaScript to run this app.
导航
身份认证
  • 文档首页
    • /
  • 身份认证

FaceCompare接口

最近更新时间：2023.06.15 16:47:43

首次发布时间：2023.06.15 16:47:43

我的收藏

接口简介

人脸比对1:1能力。基于您输入的两张图片，分别挑选两张图片中的最大人脸进行比较，判断是否为同一人，同时返回这两个人脸的矩形框坐标、比对的置信度以及不同误识率的置信度阈值。

限制条件

名称内容

图片要求

1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。
2. 图片文件大小：最大 5 MB。
3. 图片分辨率最大2000 x 2000像素。

请求说明

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/json

请求参数
（1）header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数

名称类型是否必填描述
X-DateString是使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z

Authorization

String

是

HMAC-SHA256：签名方法
-Credential为签名凭证，其中:
-AccessKeyId为访问密钥ID，可在 访问密钥（Access Key） 获取；
-ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201；
-Region为请求地区，国内一般为为cn-north-1；
-Service为请求的服务，一般为cv；
-SignedHeaders为参与签名计算的头部信息，content-type 和 host 为必选头部；
-Signature为签名，可在 签名方法 获取。
注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考 快速接入
例如：HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString否指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数
业务请求参数

参数可选/必选类型说明
Action必选string接口名，取值：FaceCompare
Version必选string版本号，取值：2022-08-31

（3）Body参数
业务请求参数

参数可选/必选类型说明
req_key必选string算法名称，取固定值为"face_compare"
binary_data_base64可选array of string输入图片的base64数组，与图片链接二选一。此算法需要输入 2 张人脸图，第一张为xxx，第二张为xxx
image_urls可选array of string输入图片的下载链接数组。需要输入两个图片下载链接

输出说明

（1）通用输出参数
请参考通用返回字段及错误码
（2）业务输出参数
data 字段说明

字段类型说明
is_matchbool两张图片的最大人脸是否为同一个人
confidencefloat64两张图片中的最大人脸属于同一个人的置信度，取值范围 0~100。如果某张图片中没有人脸，则返回的置信度为 0
thresholdsarray of float64误识率在 1/1000000，1/100000, 1/10000 的情况下分别对应的置信度阈值。例如[62.3,66.4,78.7]，表示误识率为 1/10000 的情况下，置信度（Confidence）超过 62.3%就可以认为是同一个人
rect_a_listarray of int图像A与图像B比较，最相似人脸在图像A中的矩形框[left, top, width, height]，例如[106,61,86,112]。如果图片中没有人脸，则返回的矩形框数值均为 0
rect_b_listarray of int图像A与图像B比较，最相似人脸在图像B中的矩形框[left, top, width, height]，例如[771, 118, 222, 303]。如果图片中没有人脸，则返回的矩形框数值均为 0

（3）输出示例

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": ""
        },
        "binary_data_base64": [],
        "confidence": "0.9187902094005184",
        "is_match": true,
        "rect_a_list": [
            "50",
            "88",
            "211",
            "291"
        ],
        "rect_b_list": [
            "45",
            "43",
            "138",
            "158"
        ],
        "thresholds": [
            "0.6",
            "0.6912050687673438",
            "0.782830156949857"
        ]
    },
    "message": "Success",
    "request_id": "202306151625009C29D6967AE1C60E9B98",
    "status": 10000,
    "time_elapsed": "2.024174068s"
}

错误码

（1）通用错误码
请参考通用返回字段及错误码

（2）业务错误码

HttpCode错误码错误消息描述
20010000无请求成功