zh:server_docs:corp_user_info:person_search_person_by_face

通过人脸照片搜索人员

概述

  • API 用于通过多张人脸照片搜索出企业下每张人脸最匹配的人员,也就是人脸识别搜索。

授权方式

数据维度授权 企业级授权 API 为企业级授权,企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式
接口维度授权 默认授权 API 为默认授权,您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式

注意事项

  • 根据 2021年8月1日生效实施的《最高人民法院关于审理使用人脸识别技术处理个人信息相关民事案件适用法律若干问题的规定》,您需要和猎户星空签定有关人脸识别的《数据委托处理协议》后才能调用此 API;
  • 详情请咨询猎户星空售前技术支持;

请求

HTTP URL 路径 /v1/person/search_person_by_multi_face
HTTP Method POST
Content-Type multipart/form-data
参数 类型 必填 说明
Authorization string
  • 访问凭证 access_token
  • 格式:Bearer access_token
  • 示例:Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • 请参考:鉴权方法
参数 类型 必填 参数说明
ov_corpid string 人员所属企业 id
face_content_1 file 第一张人脸照片。只允许 jpeg/png 类型的图片,文件扩展名必须是 jpg/jpeg/png。需要使用 Content-Type: multipart/form-data 的标准上传文件的方式提交。
face_content_2 file 第二张人脸照片。提交方式同上。
face_content_3 file 第三张人脸照片。提交方式同上。
# 请根据您的区域替换域名
curl --location 'https://openapi.orionstar.com/v1/person/search_person_by_multi_face' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --form 'ov_corpid=test_ov_corpid' \
     --form 'face_content_1=@face1.jpeg' \
     --form 'face_content_2=@face2.jpeg'

响应

参数 类型 参数说明
code int 错误代码。0 是成功,非 0 是失败,请参考 错误代码
msg string 错误描述,当失败的时候会给出具体的错误描述。
req_id string 日志跟踪 id,当遇到问题需要猎户星空协助查问题时候,请提供此跟踪 id 值。
data object 业务数据 data 对象,详见下述 响应体 data 对象
参数 类型 参数说明
multi_list array 搜索结果对象列表数组,数组的每个元素都是一个人脸照片搜索信息对象,每个人脸照片搜索信息对象中包含了通过此照片搜索到的人员(与给定的人脸照片达到相似距离阈值并且是最相似的人员)。
multi_list[].index string 对应请求中的照片的索引,与请求体参数中的人脸照片的参数名相同,例如:face_content_1。
multi_list[].person_list array 搜索到的人员信息列表。请参考 person - 人员信息对象
参数 类型 参数说明
person_id string 人员 id
full_name string 姓名
gender string 性别
0:未知
1:男
2:女
extinfo string 自定义扩展信息,猎户星空会原样存储并原样送出。长度不能超过 512 个字。
create_time string 创建时间,整数时间戳,单位是秒。
update_time string 最后修改时间,整数时间戳,单位是秒。
{
    "code": 0,
    "msg": "",
    "data": {
        "multi_list" : [
            {
                "index" : "face_content_1",
                "person_list" : [
                    {
                        "person_id" : "test_person_id",
                        "full_name" : "姓名",
                        "gender" : "1",
                        "extinfo": "",
                        "create_time": "1711966681",
                        "update_time": "1711966681"
                    }
                ]
            },
            // ... 省略其他搜索信息对象
        ]
    }
}
  • Last modified: 2024-05-15 19:29 +0800