接口说明文档 #

总体说明 #

• 人脸检测

接口能力

人脸检测：检测图片中的人脸并标记出位置信息;

• 人脸比对

接口能力

两张人脸图片相似度对比：比对两张图片中人脸的相似度，并返回相似度分值；

业务应用

用于比对多张图片中的人脸相似度并返回两两比对的得分，可用于判断两张脸是否是同一人的可能性大小。

• 人脸搜索

业务能力

1：N人脸搜索：也称为1：N识别，在指定人脸集合中，找到最相似的人脸；

• 人脸库管理

业务能力

要完成1：N或者M：N识别，首先需要构建一个人脸库，用于存放所有人脸特征，相关接口如下：

人脸注册：向人脸库中添加人脸

① 人脸更新：更新人脸库中指定用户下的人脸信息

② 人脸删除：删除指定用户的某张人脸

③ 用户信息查询：查询人脸库中某个用户的详细信息

④ 获取用户人脸列表：获取某个用户组中的全部人脸列表

⑤ 获取用户列表：查询指定用户组中的用户列表

⑥ 复制用户：将指定用户复制到另外的人脸组

⑦ 创建用户组：创建一个新的用户组

⑧ 删除用户组：删除指定用户组

⑨ 组列表查询：查询人脸库中用户组的列表

人脸库结构

人脸库、用户组、用户、用户下的人脸层级关系如下所示：

|- 用户组一（group_id）
   |- 用户01（user_id）
      |- 人脸（faceid）
   |- 用户02（user_id）
      |- 人脸（face_id）
      ....
    ....
|- 用户组二（group_id）
|- 用户组三（group_id）
....

关于人脸库的设置限制

目前用户组上限20个；

每个用户组（group）下，可添加多个user；

每个user下对应1张人脸；

接口格式说明 #

• 变量类型定义

• 请求方式

请求方式统一使用application/json请求 直接请求

• 返回格式 ① error_code、error_msg即错误码和错误描述，详细含义请参考错误码表, error_code为0代表请求成功 ② result是接口返回的详细信息, 格式为数组;

{
    "error_code" : 0,  // 错误码 0代表成功
    "error_msg"  : "SUCCESS", // 错误信息
    "result" : {...} // 返回结果 具体内容详见相关接口
    "log_id" : 3535325235 // 请求的日志id
    "timestamp" : 1512391540 // 请求到达的时间戳 精确到秒级
    "cached" : 0 //未启用 无需处理
}

调用准备 #

1、调用接口的地址示例：[192.168.0.1]:[8300]/face-api/v3/face/detect，其中ip、端口需要替换为用户自己服务器的ip、端口，接口地址需要替换为下述接口的地址。