人脸检测和属性分析 API 文档

接口说明

基于讯飞自研的人脸检测算法，对图片中的人脸进行精准定位并标记，分析人脸性别、表情、口罩等属性信息。

该能力是通过HTTP API的方式给开发者提供一个通用的接口。HTTP API适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点。另外，请注意该接口使用的HTTP API协议不支持跨域。

接口Demo

示例demo请点击这里下载。
目前仅提供部分开发语言的demo，其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到讯飞开放平台社区分享你们的demo。

接口要求

集成人脸检测和属性分析API时，需按照以下要求。

内容	说明
传输方式	http[s] (为提高安全性，强烈推荐https)
请求地址	http[s]: //api.xf-yun.com/v1/private/s67c9c78c 注：服务器IP不固定，为保证您的接口稳定，请勿通过指定IP的方式调用接口，使用域名方式调用
请求行	POST /v1/private/s67c9c78c HTTP/1.1
接口鉴权	签名机制，详情请参照下方鉴权认证
字符编码	UTF-8
响应格式	统一采用JSON格式
开发语言	任意，只要可以向讯飞云服务发起HTTP请求的均可
适用范围	任意操作系统，但因不支持跨域不适用于浏览器
图片格式	jpg/png/bmp
图片大小	base64编码后大小不超过4M
图片要求	清晰的人脸照片，人脸大小不小于30*30像素，其中人脸俯仰角、左右偏航角、人脸翻转角60°以内识别效果更好

接口调用流程

· 通过接口密钥基于hmac-sha256计算签名，将签名以及其他参数加在请求地址后面。详见下方鉴权认证。
· 将请求参数以及图片数据放在Http Request Body中，以POST表单的形式提交，详见下方请求参数。
· 向服务器端发送Http请求后，接收服务器端的返回结果。

鉴权认证

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。

鉴权方法

通过在请求地址后面加上鉴权相关参数的方式，参数具体如下：

http示例url：

https://api.xf-yun.com/v1/private/s67c9c78c?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iSk5od3prMWtLYjUwdUVGbEUxS2xCbk83K09NTjNZUk5LZVFsYzVMYVltTT0i&host=api.xf-yun.com&date=Fri%2C+17+Jul+2020+06%3A26%3A58+GMT

鉴权参数：

参数	类型	必须	说明	示例
host	string	是	请求主机	api.xf-yun.com
date	string	是	当前时间戳，RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z")	Fri, 17 Jul 2020 06:26:58 GMT
authorization	string	是	使用base64编码的签名相关信息(签名基于hmac-sha256计算)	参考下方详细生成规则

· date参数生成规则：

date必须是UTC+0或GMT时区，RFC1123格式(Fri, 17 Jul 2020 06:26:58 GMT)。
服务端会对date进行时钟偏移检查，最大允许300秒的偏差，超出偏差的请求都将被拒绝。

· authorization参数生成格式：

1）获取接口密钥APIKey 和 APISecret。
在讯飞开放平台控制台，创建一个应用后打开人脸检测和属性分析页面可以获取，均为32位字符串。

2）参数authorization base64编码前（authorization_origin）的格式如下。

api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"

其中 api_key 是在控制台获取的APIKey，algorithm 是加密算法（仅支持hmac-sha256），headers 是参与签名的参数（见下方注释）。
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串，详见下方。

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

3）signature的原始字段(signature_origin)规则如下。

signature原始字段由 host，date，request-line三个参数按照格式拼接成，
拼接的格式为(\n为换行符,’:’后面有一个空格)：

host: $host\ndate: $date\n$request-line

假设

请求url = api.xf-yun.com
date = Fri, 17 Jul 2020 06:26:58 GMT

那么 signature原始字段(signature_origin)则为：

host: api.xf-yun.com
date: Fri, 17 Jul 2020 06:26:58 GMT
POST /v1/private/s67c9c78c HTTP/1.1

4）使用hmac-sha256算法结合apiSecret对signature_origin签名，获得签名后的摘要signature_sha。

signature_sha=hmac-sha256(signature_origin,$apiSecret)

其中 apiSecret 是在控制台获取的APISecret

5）使用base64编码对signature_sha进行编码获得最终的signature。

signature=base64(signature_sha)

假设

APISecret = apisecretXXXXXXXXXXXXXXXXXXXXXXX	
date = Fri, 17 Jul 2020 06:26:58 GMT

则signature为

signature=JNhwzk1kKb50uEFlE1KlBnO7+OMN3YRNKeQlc5LaYmM=

6）根据以上信息拼接authorization base64编码前（authorization_origin）的字符串，示例如下。

api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="JNhwzk1kKb50uEFlE1KlBnO7+OMN3YRNKeQlc5LaYmM="

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

7）最后再对authorization_origin进行base64编码获得最终的authorization参数。

authorization = base64(authorization_origin)
示例：
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iSk5od3prMWtLYjUwdUVGbEUxS2xCbk83K09NTjNZUk5LZVFsYzVMYVltTT0i

鉴权结果

如果鉴权失败，则根据不同错误类型返回不同HTTP Code状态码，同时携带错误描述信息，详细错误说明如下：

HTTP Code	说明	错误描述信息	解决方法
401	缺少authorization参数	{"message":"Unauthorized"}	检查是否有authorization参数，详情见authorization参数详细生成规则
401	签名参数解析失败	{“message”:”HMAC signature cannot be verified”}	检查签名的各个参数是否有缺失是否正确，特别确认下复制的api_key是否正确
401	签名校验失败	{“message”:”HMAC signature does not match”}	签名验证失败，可能原因有很多。 1. 检查api_key,api_secret 是否正确。 2.检查计算签名的参数host，date，request-line是否按照协议要求拼接。 3. 检查signature签名的base64长度是否正常(正常44个字节)。
403	时钟偏移校验失败	{“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”}	检查服务器时间是否标准，相差5分钟以上会报此错误

认证失败返回示例：

HTTP/1.1 403 Forbidden
Date: Thu, 06 Dec 2018 07:55:16 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
    "message": "HMAC signature does not match"
}

请求参数

在调用业务接口时，都需要在 Http Request Body 中配置以下参数，请求数据均为json字符串。

参数名	类型	必传	描述
header	object	是	用于上传平台参数
header.app_id	string	是	在平台申请的appid信息
header.status	string	是	请求状态，取值范围为：3（一次传完）
parameter	object	是	用于上传服务特性参数
parameter.s67c9c78c	object	是	用于上传功能参数
parameter.s67c9c78c.service_kind	string	是	请求功能类型，取值范围为：face_detect
parameter.s67c9c78c.detect_points	string	否	检测特征点开关 0:只检测人脸，不检测特征点 1:检测到人脸之后检测特征点
parameter.s67c9c78c.detect_property	string	否	检测人脸属性开关 0:不检测人脸属性 1:检测人脸属性
parameter.s67c9c78c.face_detect_result	object	是	用于上传响应数据参数
parameter.s67c9c78c.face_detect_result.encoding	string	否	文本编码，可选值：utf8（默认值）
parameter.s67c9c78c.face_detect_result.compress	string	否	文本压缩格式，可选值：raw（默认值）
parameter.s67c9c78c.face_detect_result.format	string	否	文本格式，可选值：json（默认值）
payload	object	是	用于上传请求数据
payload.input1	object	是	用于上传图像数据
payload.input1.encoding	string	否	图像编码可选值： jpg:jpg格式(默认值) jpeg:jpeg格式 png:png格式 bmp:bmp格式
payload.input1.image	string	是	图像数据，base64编码，需保证图像文件大小base64编码后不超过4MB
payload.input1.status	int	否	数据状态，取值范围为：3（一次传完）

请求参数示例：

{
  "header": {
    "app_id": "xxxxxxxx",
    "status": 3
  },
  "parameter": {
    "s67c9c78c": {
      "service_kind": "face_detect",
      "face_detect_result": {
        "encoding": "utf8",
        "format": "json",
        "compress": "raw"
      }
    }
  },
  "payload": {
    "input1": {
      "encoding": "jpg",
      "image": "/9j/4AAQSkZJR..."
    }
  }
}

返回参数

参数名	类型	描述
header	object	协议头部，用于描述平台特性的参数
header.sid	string	本次会话id
header.code	int	返回码 0表示会话调用成功（并不一定表示服务调用成功，服务是否调用成功以text字段中的ret为准）其它表示会话调用异常，详情请参考错误码。
header.message	string	描述信息
payload	object	数据段，用于携带响应的数据
payload.face_detect_result	object	人脸检测和属性分析响应数据块
payload.face_detect_result.compress	string	文本压缩格式，仅在设置了parameter.s67c9c78c.face_detect_result.compress参数时返回
payload.face_detect_result.encoding	string	文本编码，仅在设置了parameter.s67c9c78c.face_detect_result.encoding参数时返回
payload.face_detect_result.format	string	文本格式，仅在设置了parameter.s67c9c78c.face_detect_result.format参数时返回
payload.face_detect_result.text	string	人脸检测和属性分析返回结果，需要对其进行base64解码，解码后的返回字段如下

text字段具体信息

参数名	类型	描述	备注
ret	int	内部服务返回值	ret=0表示请求成功，否则请参考错误码表
face_num	int	人脸数量	最小值:0 最大值:9999
face_n	object	人脸信息，包含框位置、置信度和属性信息等	face_n代表第n个检测到的人脸，例如第1个，则字段名为face_1
face_n.score	float	人脸框置信度	最小值:0 最大值:1。该值越高，代表检测区域是人脸的可能性越高
face_n.x	int	人脸框左上角x坐标以图片左上角为原点，向右为正。	单位：像素。最小值:0 最大值:9999
face_n.y	int	人脸框左上角y坐标以图片左上角为原点，向下为正。	单位：像素。最小值:0 最大值:9999
face_n.w	int	人脸框宽度	单位：像素。最小值:1 最大值:9999
face_n.h	int	人脸框高度	单位：像素。最小值:1 最大值:9999
face_n.point_n	object	特征点信息，包含特征点的位置，仅在设置了parameter.s67c9c78c.detect_points=1时返回	point_n代表第n个特征点，例如第1个，则字段名为point_1
face_n.point_n.x	float	特征点的x坐标	单位：像素。最小值:0 最大值:9999
face_n.point_n.y	float	特征点的y坐标	单位：像素。最小值:0 最大值:9999
face_n.property	object	人脸属性信息，仅在设置了parameter.s67c9c78c.detect_property=1时返回	包含胡须、表情、性别、眼镜、发型和口罩
face_n.property.beard	int	是否有胡须	0:没有胡子；1:有胡子
face_n.property.expression	int	人脸表情	0:惊讶；1:害怕；2:厌恶；3:高兴；4:悲伤；5:生气；6:正常
face_n.property.gender	int	性别	0:男性；1:女性
face_n.property.glass	int	是否戴眼镜	0:不戴眼镜；1:戴眼镜
face_n.property.hair	int	发型	0:光头；1:短发；2:长发
face_n.property.mask	int	是否戴口罩	0:没戴口罩；1:戴口罩

返回参数示例：

{
  "header": {
    "code": 0,
    "message": "success",
    "sid": "asexxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "payload": {
    "face_detect_result": {
      "compress": "raw",
      "encoding": "utf8",
      "format": "json",
      "text": "ewoJImZhY2VfMSIgOiAKCXsKCQkiaCIgOiA4MDMsCgkJInBvaW50XzEiIDogCgkJewoJCQkieCIgOiA0MTkuOTY3MDEwNDk4MDQ2ODgsCgkJCSJ5IiA6IDQ2Mi4wMzIwMTI5Mzk0NTMxMgoJCX0sCgkJInBvaW50XzEwIiA6IAoJCXsKCQkJIngiIDogODEyLjc4MTAwNTg1OTM3NSwKCQkJInkiIDogNTUwLjQ3ODAyNzM0Mzc1CgkJfSwKCQkicG9pbnRfMTEiIDogCgkJewoJCQkieCIgOiA1NTguODUxMDEzMTgzNTkzNzUsCgkJCSJ5IiA6IDcyOS4xNTM5OTE2OTkyMTg3NQoJCX0sCgkJInBvaW50XzEyIiA6IAoJCXsKCQkJIngiIDogNjMwLjI3Njk3NzUzOTA2MjUsCgkJCSJ5IiA6IDc3Ni44Njk5OTUxMTcxODc1CgkJfSwKCQkicG9pbnRfMTMiIDogCgkJewoJCQkieCIgOiA3MDMuODA0OTkyNjc1NzgxMjUsCgkJCSJ5IiA6IDczNS40MzI5ODMzOTg0Mzc1CgkJfSwKCQkicG9pbnRfMTQiIDogCgkJewoJCQkieCIgOiA2MzAuMDk5OTc1NTg1OTM3NSwKCQkJInkiIDogODMyLjE4OTAyNTg3ODkwNjI1CgkJfSwKCQkicG9pbnRfMTUiIDogCgkJewoJCQkieCIgOiA2MjkuNjUxOTc3NTM5MDYyNSwKCQkJInkiIDogODczLjM0MTAwMzQxNzk2ODc1CgkJfSwKCQkicG9pbnRfMTYiIDogCgkJewoJCQkieCIgOiA2MjguNzkzMDI5Nzg1MTU2MjUsCgkJCSJ5IiA6IDkyMy43MDY5NzAyMTQ4NDM3NQoJCX0sCgkJInBvaW50XzE3IiA6IAoJCXsKCQkJIngiIDogNTEwLjAyMDk5NjA5Mzc1LAoJCQkieSIgOiA1MzQuNDg0MDA4Nzg5MDYyNQoJCX0sCgkJInBvaW50XzE4IiA6IAoJCXsKCQkJIngiIDogNzU5LjAyNTAyNDQxNDA2MjUsCgkJCSJ5IiA6IDU0My41MjM5ODY4MTY0MDYyNQoJCX0sCgkJInBvaW50XzE5IiA6IAoJCXsKCQkJIngiIDogNjI5LjE5MjAxNjYwMTU2MjUsCgkJCSJ5IiA6IDcyNC4zNTc5NzExOTE0MDYyNQoJCX0sCgkJInBvaW50XzIiIDogCgkJewoJCQkieCIgOiA0OTIuNzUyOTkwNzIyNjU2MjUsCgkJCSJ5IiA6IDQ0Mi43ODYwMTA3NDIxODc1CgkJfSwKCQkicG9pbnRfMjAiIDogCgkJewoJCQkieCIgOiA1MjEuOTU2OTcwMjE0ODQzNzUsCgkJCSJ5IiA6IDg0NS40NjUwMjY4NTU0Njg3NQoJCX0sCgkJInBvaW50XzIxIiA6IAoJCXsKCQkJIngiIDogNzMzLjUwNTAwNDg4MjgxMjUsCgkJCSJ5IiA6IDg1My4zNzQwMjM0Mzc1CgkJfSwKCQkicG9pbnRfMyIgOiAKCQl7CgkJCSJ4IiA6IDU3Mi4wNzg5Nzk0OTIxODc1LAoJCQkieSIgOiA0NjguNDQ2MDE0NDA0Mjk2ODgKCQl9LAoJCSJwb2ludF80IiA6IAoJCXsKCQkJIngiIDogNjk5LjkwMzk5MTY5OTIxODc1LAoJCQkieSIgOiA0NzIuMTk2OTkwOTY2Nzk2ODgKCQl9LAoJCSJwb2ludF81IiA6IAoJCXsKCQkJIngiIDogNzc5LjA5MDAyNjg1NTQ2ODc1LAoJCQkieSIgOiA0NTIuOTEwMDAzNjYyMTA5MzgKCQl9LAoJCSJwb2ludF82IiA6IAoJCXsKCQkJIngiIDogODUwLjY1NTAyOTI5Njg3NSwKCQkJInkiIDogNDc1LjkyMTk5NzA3MDMxMjUKCQl9LAoJCSJwb2ludF83IiA6IAoJCXsKCQkJIngiIDogNDU2Ljg0Mjk4NzA2MDU0Njg4LAoJCQkieSIgOiA1MzcuNjQzMDA1MzcxMDkzNzUKCQl9LAoJCSJwb2ludF84IiA6IAoJCXsKCQkJIngiIDogNTYyLjU3NzAyNjM2NzE4NzUsCgkJCSJ5IiA6IDU1MC4zMDk5OTc1NTg1OTM3NQoJCX0sCgkJInBvaW50XzkiIDogCgkJewoJCQkieCIgOiA3MDguMDcyMDIxNDg0Mzc1LAoJCQkieSIgOiA1NTUuMTU4MDIwMDE5NTMxMjUKCQl9LAoJCSJwcm9wZXJ0eSIgOiAKCQl7CgkJCSJiZWFyZCIgOiAwLAoJCQkiZXhwcmVzc2lvbiIgOiA2LAoJCQkiZ2VuZGVyIiA6IDEsCgkJCSJnbGFzcyIgOiAxLAoJCQkiaGFpciIgOiAyLAoJCQkibWFzayIgOiAwCgkJfSwKCQkic2NvcmUiIDogMC45OTEyODI0NjMwNzM3MzA0NywKCQkidyIgOiA1NDMsCgkJIngiIDogMzcxLAoJCSJ5IiA6IDIxNAoJfSwKCSJmYWNlX251bSIgOiAxLAoJInJldCIgOiAwCn0K"
    }
  }
}

base64解码后的text示例：

{
  "face_1": {
    "h": 803,
    "point_1": {
      "x": 419.96701049804688,
      "y": 462.03201293945312
    },
    "point_10": {
      "x": 812.781005859375,
      "y": 550.47802734375
    },
    ...
    ...
    ...
    },
    "point_8": {
      "x": 562.5770263671875,
      "y": 550.30999755859375
    },
    "point_9": {
      "x": 708.072021484375,
      "y": 555.15802001953125
    },
    "property": {
      "beard": 0,
      "expression": 6,
      "gender": 1,
      "glass": 1,
      "hair": 2,
      "mask": 0
    },
    "score": 0.99128246307373047,
    "w": 543,
    "x": 371,
    "y": 214
  },
  "face_num": 1,
  "ret": 0
}

错误码

备注：如出现下述列表中没有的错误码，可到这里查询。

错误码	错误描述	说明	处理方式
10010	service license not enough	授权不足	联系技术人员
10019	service read buffer timeout, session timeout	session 超时	联系技术人员
10106	wrapper output data invalid(key or type)	参数校验失败	依据错误提示信息检查参数是否正确上传，尤其是face_detect_result
10163	param validate error:...	参数校验失败	1)依据错误提示信息检查参数是否正确上传 2)检查图片大小是否超过上限，base64编码后大小不能超过4M
10222	context deadline exceeded	调用失败	1)检查图片格式是否不符合要求（jpg/png/bmp） 2)检查图片数据是否正确上传，尤其是payload中的image是否传入 3)检查图片大小是否超过上限，base64编码后大小不能超过4M
10313	invalid appid	appid不合法	检查app_id参数是否正确上传或是否为空
20002	人脸检测接口失败	未能成功进行人脸检测	1)检测输入图像是否包含人脸或人脸是否符合要求 2)检查人脸是否符合要求 3)检查参数合法性
20007	请求图像数据丢包	服务接收到空的图像数据	检查是否成功提交图像数据
21006	提特征接口失败	未能从输入图像中提取主要人脸特征	1)检查输入的图像中是否包含人脸 2)检查参数合法性

调用示例

人脸检测和属性分析demo python3语言

人脸检测和属性分析demo java jdk8语言

注：其他开发语言请参照接口调用流程进行开发，也欢迎热心的开发者到讯飞开放平台社区分享你们的demo。

常见问题

人脸检测和属性分析的主要功能是什么？

答：对图片中的人脸进行精准定位并标记，分析人脸性别、表情、口罩等属性信息。

人脸检测和属性分析支持什么应用平台？

答：目前支持Web API应用平台。

人脸检测和属性分析对人脸有什么要求吗？

答：需要清晰的人脸照片，人脸大小不小于30*30像素，其中人脸俯仰角、左右偏航角、人脸翻转角60°以内识别效果更好。

在这篇文章中：

# 人脸检测和属性分析 API 文档

# 接口说明

# 接口Demo

# 接口要求

# 接口调用流程

# 鉴权认证

# 鉴权方法

# 鉴权结果

# 请求参数

# 返回参数

# 错误码

# 调用示例

# 常见问题

# 人脸检测和属性分析的主要功能是什么？

# 人脸检测和属性分析支持什么应用平台？

# 人脸检测和属性分析对人脸有什么要求吗？