/face/v2/verify
1.接口描述
该API的功能是将两张人脸图片进行比对,来判断是否为同一个人。
- 图片要求
- 格式为 JPG(JPEG),BMP,PNG,GIF,TIFF
- 宽和高大于 128px,小于等于4000px
- 小于等于 5 MB
请求方式:
POST
请求URL:
http://cloudapi.deepfinch.com/face/v2/verify
调试工具
2.请求参数
2.1 请求头域
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
X-DF-API-ID | string | 是 | API调用凭证信息,详细信息请参考API调用 |
X-DF-API-SECRET | string | 是 | API调用凭证信息,详细信息请参考API调用 |
2.2 请求体
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
api_id | string | 是 | API 账户 |
api_secret | string | 是 | API 密钥 |
file_1 | file | 见下方注释 | 第一张图片的file,本地上传选取此参数 |
url_1 | string | 见下方注释 | 第一张图片的url,从网络获取时选取此参数 |
image_id_1 | string | 见下方注释 | 第一张图片的云端id,在云端上传过可选取此参数 |
file_2 | file | 见下方注释 | 第二张图片的file,本地上传选取此参数 |
url_2 | string | 见下方注释 | 第二张图片的url,从网络获取时需选取此参数 |
image_id_2 | string | 见下方注释 | 第二张图片的云端id,在云端上传过可选取此参数 |
注释:
请求参数
file_1
,url_1
与image_id_1
三选一。请求参数
file_2
,url_2
与image_id_2
三选一。参数
file_1
与file_2
需把图片文件以 multipart/form-data 的形式放到 POST 消息体中。
3.返回参数
正常响应 (200
)
字段 | 类型 | 描述 |
---|---|---|
request_id | string | 本次请求的 id |
status | string | 状态。正常为 OK ,其他值表示失败。详见错误码 |
identical | bool | 两张图片是否为同一个人,true 同一个人,false 为不同人 |
score | float | 两张图片人脸的相似度得分,取值0至1,值越大表明是同一个人的可能性越大 |
image_id_1 | string | 第一张图片的云端id,若使用file、url方式上传第二张图片返回此参数 |
image_id_2 | string | 第二张图片的云端id,若使用file、url方式上传第一张图片返回此参数 |
注:
当图片中存在多个人脸时,系统会选出其中最大的人脸进行比对。
identical
字段是在默认阈值0.8时的人脸比对结果,相似度得分score
高于默认阈值会返回true。如果希望使用自定义阈值,请将score
字段与自定义阈值进行比较获得比对结果。
输出示例:
{
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
"status": "OK",
"identical": true,
"score": 0.928513,
"image_id_1": "xxxxx",
"image_id_2": "xxxxx"
}
4.错误码
状态码 | status 字段 |
说明 |
---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
DETETION_FAILED | 图片检测失败 |
400 |
DOWNLOAD_ERROR | 网络地址图片获取失败 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
401 |
KEY_EXPIRED | 账号过期 |
403 |
NO_PERMISSION | 无调用权限 |
403 |
OUT_OF_QUOTA | 调用次数超出限额 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
输出示例:
{
"status": "DETECTION_FAILED",
"reason": "no face detected",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}