接入文档
人脸搜索(海外版)
API接入
从人脸库中删除人脸
从人脸库中删除人脸

# 描述

此接口提供从指定人脸库删除特征值的功能。

# 调用URL:

https://api-sgp.yljz.com/finauth/search/group/delete

注意:在生产环境中,请使用HTTPS的通信方式。HTTP方式的通信属于不安全链路,存在安全风险,请勿在生产环境中使用。在生产环境中使用HTTP方式的,将无法得到服务可靠性保障。

# 调用方法

POST 注意:用form-data格式请求

# 请求参数

是否必选 参数名 类型 参数说明
必选 sign String 签名生成规则参考鉴权说明
必选 sign_version String 签名算法版本,请传递:hmac_sha1
必选 group_id String 用户自定义的人脸库标识
选填
face_tokens String 需要移除的人脸标识字符串
1. 可以是一个或者多个face_token组成,用逗号分隔。
2. 最多不能超过1000个face_token。
3. 若与user_id同时传入,以face_tokens为准。
选填
user_id String 用户id
1. 与face_tokens二选一必填;
2. 若同时传入以face_tokens为准;
3. user_id只支持单个删除;
4. 若user_id有多个人脸,将会全部删除;

# 返回值说明

字段 类型 说明
request_id String 用于区分每一次请求的唯一的字符串。除非发生404(API_NOT_FOUND ) 或403 (AUTHORIZATION_ERROR)错误,此字段必定返回。
group_id String 用户自定义的人脸库标识
face_removed Int 成功从人脸库中移除的face_token数量
face_count Int 操作完成后人脸库中的face_token数量
failure_detail Array 无法从人脸库中移除的face_token以及原因
face_token:人脸标识
reason:不能被移除的原因,包括 FACE_NOT_IN_GROUP
time_used
Int 整个请求所花费的时间,单位为毫秒。除非发生404(API_NOT_FOUND )或403 (AUTHORIZATION_ERROR)错误,此字段必定返回。
error String 当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节。否则此字段不存在。

返回值示例

正确请求返回示例

json
{
    "request_id": "1769740387,ba578f31-c5e9-4048-8290-2627686f97fe",
    "time_used": 101,
    "group_id": "YuanliStudent_01",
    "face_removed": 1,
    "face_count": 1,
    "failure_detail": [
        {
            "face_token": "34dce3f2d1fc4736670b4bad58523ce8",
            "reason": "FACE_NOT_IN_GROUP"
        }
    ]
}

错误返回示例

json
{
    "request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
    "time_used": 15,
    "error": "INVALID_FACE_TOKENS_SIZE"
}

# error错误信息

当前API特有的ERROR

HTTP状态代码 错误信息 说明
400 INVALID_OUTER_ID 人脸库不存在
400 INVALID_FACE_TOKENS_SIZE face_tokens数组长度不符合要求