基础能力接口

人脸检测

检测图片中的人脸并获得位置信息等

请求路径

/face-api/v3/face/detect

Header：

参数	值
Content-Type	application/json
token	令牌

Body请求参数

参数	必选	类型	说明
image	是	string	图片信息
image_type	是	string	图片类型 BASE64:图片的base64值，base64编码后的图片数据。

请求示例

  {
      "image": "027d8308a2ec665acb1bdf63e513bcb9",
      "image_type": "BASE64"
  }

返回结果

字段	必选	类型	说明
location	是	array	人脸位置信息
+width	是	string	人头位置框的宽度
+x	是	string	人头位置框基准点的x坐标
+y	是	string	人头位置框基准点的y坐标
++ height	是	string	人头位置框的高度

返回示例

{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "log_id": 20200610095247,
    "timestamp": 1591753967315,
    "cached": 0,
    "result": {
        "location": [
            {
                "width": 189,
                "x": 79,
                "y": 47,
                "height": 237
            }
        ]
    }
}

人脸对比

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

请求路径

/face-api/v3/face/match

Header：

参数	值
Content-Type	application/json
token	令牌

Body请求参数

参数	必选	类型	说明
image	是	string	图片BASE64编码值信息图片通过json格式上传，格式参考表格下方示例
image_type	是	string	图片类型 BASE64:图片的base64值，base64编码后的图片数据。

请求示例

  [
        {
            "image": "sfasq35sadvsvqwr5q...",
            "image_type": "BASE64"
        },
        {
            "image": "sfasq35sadvsvqwr5q...",
            "image_type": "BASE64"
        }
  ]

注意：请求体要求为json格式，可以参考请求示例。

返回结果

参数名	必选	类型	说明
score	是	float	人脸相似度得分，推荐阈值80分
face_list	是	array	人脸信息列表
+face_token	是	string	人脸的唯一标志

返回示例

{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "log_id": 20200609151213,
    "timestamp": 1591686735091,
    "cached": 0,
    "result": {
        "score": "99.0",
        "face_list": [
            {
                "face_token": ""
            },
            {
                "face_token": ""
            }
        ]
    }
}

人脸搜索

在指定人脸集合中，找到最相似的人脸

请求路径

/face-api/v3/face/identify

Header：

参数	值
Content-Type	application/json
token	令牌

Body请求参数

参数	必选	类型	说明
image	是	string	图片信息，图片上传方式根据image_type来判断
image_type	是	string	图片类型 BASE64:图片的base64值，base64编码后的图片数据。
group_id_list	是	string	从指定的group中进行查找用逗号分隔,目前仅支持一个

请求示例

  {
      "image": "027d8308a2ec665acb1bdf63e513bcb9",
      "image_type": "BASE64",
      "group_id_list": "group_repeat,group_233",

  }

返回结果

字段	必选	类型	说明
face_token	是	string	人脸标志
user_list	是	array	匹配的用户信息列表
+group_id	是	string	用户所属的group_id
+user_id	是	string	用户的user_id
+user_info	是	string	注册用户时携带的user_info
+score	是	float	用户的匹配得分，推荐阈值80分

{
    "error_code": 0,
    "error_msg": "SUCCESS",
    "log_id": 20200610103346,
    "timestamp": 1591756426293,
    "cached": 0,
    "result": {
        "face_token": "3525f0cf168546f7bd72267252be302d",
        "user_list": [
            {
                "score": 100.0,
                "group_id": "group2",
                "user_id": "u1",
                "user_info": "abc"
            }
        ]
    }
}

M:N 多人脸搜索

使用多人脸的图片, 在指定人脸集合中，查找最相似的人脸

请求路径

/face-api/v3/face/midentify

Header：

参数	值
Content-Type	application/json
token	令牌

Body请求参数

参数	必选	类型	说明
image	是	string	图片信息(*数据大小应小于10M 分辨率应小于19201080**)
image_type	是	string	图片类型 BASE64:图片的base64值.
group_id_list	是	string	从指定的group中进行查找用逗号分隔，上限10个，目前仅支持一个

请求示例

{  
    "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD...",  
    "image_type": "BASE64",  
    "group_id_list": "group1"
}

返回结果

字段	必选	类型	说明
face_num	是	int	图片中的人脸数量
face_list	是	array	人脸信息列表
+face_token	是	string	人脸标志
+location	是	array	人脸在图片中的位置
++x	是	double	人脸区域离左边界的距离
++y	是	double	人脸区域离上边界的距离
++width	是	double	人脸区域的宽度
++height	是	double	人脸区域的高度
+user_list	是	array	匹配的用户信息列表
++group_id	是	string	用户所属的group_id
++user_id	是	string	用户的user_id
++user_info	是	string	注册用户时携带的user_info
++score	是	float	用户的匹配得分 80分以上可以判断为同一人，此分值对应万分之一误识率

返回示例

{
  "error_code": 0,
  "error_msg": "SUCCESS",
  "log_id": 20200610103657,
  "timestamp": 1591756617507,
  "cached": 0,
  "result": {
      "face_num": 1,
      "face_list": [
          {
              "face_token": "3525f0cf168546f7bd72267252be302d",
              "location": {
                  "width": 80,
                  "x": 283,
                  "y": 72,
                  "height": 102
              },
              "user_list": [
                  {
                      "score": 100.0,
                      "group_id": "group2",
                      "user_id": "u1",
                      "user_info": "abc"
                  }
              ]
          }
      ]
  }
}

人脸质量检测

检测图片中的人脸并获得人脸质量分数

请求路径

/face-api/faceQuality

Header：

参数	值
Content-Type	application/json
token	令牌

Body请求参数

参数	必选	类型	说明
image	是	string	图片信息

请求示例

  {
      "image": "027d8308a2ec665acb1bdf63e513bcb9"
  }

返回结果

字段	必选	类型	说明
flag	是	boolean	请求处理成功失败标识
resultCode	是	int	请求处理成功失败标识，0成功，1失败
message	是	String	请求处理信息
data	是	Object	接口处理结果
records	是	Object	算法检测结果
result	是	String	检测成功失败标识
score	是	String	人脸检测分数

返回示例

{
    "flag": true,
    "resultCode": 0,
    "message": "系统处理正常",
    "data": {
        "records": {
            "result": "ok",
            "score": "0.7157076"
        }
    }
}

活体检测

捕捉视频中用户的动作

请求路径:

/face-api/v3/face/livingDetect

Header：

参数	值
Content-Type	application/json
token	令牌

Body请求参数

参数名	示例值	参数类型	是否必填	参数描述
video	base64码	string	是	人脸图片base64码
action	blink	string	是	捕捉动作类型blink:眨眼

请求示例

{
	"video": "iVBORw0KGgoAAAANSUhEUgAAAJAAAADECAYAAABwWahZAAAgAE",
	"action": "blink"
}

返回结果

参数名	必选	类型	说明
flag	是	boolean	请求处理成功失败标识（AI能开平台）
resultCode	是	int	请求处理成功失败标识，0成功，1失败（AI能开平台）
message	是	String	请求处理信息（AI能开平台）
data	是	Object	接口处理结果（AI能开平台）
+traceId	是	String	业务流水号（AI能开平台）
+serialNumber	是	String	序列号（AI能开平台）
+capabilityId	是	float	能力ID（AI能开平台）
+results	是	Object	比对结果（AI能开平台）
++result	是	Object	检测结果，1成功（算法侧）
++msg	是	String	检测结果信息（算法侧）

返回示例

{
    "flag": true,
    "resultCode": 0,
    "message": "系统处理结果正常",
    "data": {
        "traceId": "8253182113767317504",
        "serialNumber": null,
        "capabilityId": "LivingAction",
        "results": {
            "result": 1,
            "status": "0000:Success."
        }
    }
}

基础能力接口 #

人脸检测 #

人脸对比 #

人脸搜索 #

M:N 多人脸搜索 #

人脸质量检测 #

活体检测 #

基础能力接口

人脸检测

人脸对比

人脸搜索

M:N 多人脸搜索

人脸质量检测

活体检测