添加人脸
功能介绍
添加人脸到人脸库中，检测到传入的单张图片中存在多少张人脸，则增加多少张人脸到人脸库当中。
前提条件：
- 只支持识别JPG、PNG、JPEG、BMP格式的图片。
- application/json请求的body中，请使用标准Json格式。
- Base64编码中请勿使用回车换行。
- 系统不保存用户图片。
- 图片大小小于8MB，由于过大图片会导致时延较长，并且图片信息量不大，建议小于1MB。
- 图片分辨率小于4096*2160，图片中人脸像素大于80*80，建议120*120以上。
- 为保证识别效果，人脸图片建议要求如下：
- 光照大于200lux、无反光强光阴影现象。
- 人脸无遮挡、整体清晰无拖尾抖动等运动模糊。
- 侧脸不超过30°、俯仰角小于15°、偏转角小于15°、图片中人脸保持竖置正脸。
- 其他的约束限制信息请参见约束与限制章节。
- 由于过大图片对识别算法精度无明显提升，同时会导致时延较长，建议传入图片小于1MB，一般500KB左右足够。
- OBS上存储的图片也建议小于1MB。
- 图片中人脸像素建议120*120以上。
URI
POST /v2/{project_id}/face-sets/{face_set_name}/faces
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参见获取项目ID/账号名/AK/SK。 |
|
face_set_name |
是 |
String |
人脸库名称。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，响应消息头中X-Subject-Token的值即为Token。 |
|
Content-Type |
是 |
String |
发送的实体的MIME类型，参数值为“application/json”。 |
|
参数名 |
参数类型 |
是否必选 |
说明 |
|---|---|---|---|
|
image_url |
String |
与image_file、image_base64三选一 |
图片的URL路径，目前仅支持华为云上OBS的URL，且人脸识别服务有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 |
|
image_file |
File |
与image_url、image_base64三选一 |
本地图片文件，图片不能超过8MB，建议小于1MB。上传文件时，请求格式为multipart。 |
|
image_base64 |
String |
与image_file、image_url三选一 |
图像数据，Base64编码，要求：
|
|
external_image_id |
String |
否 |
用户指定的图片外部ID，与当前图像绑定。用户没提供，系统会生成一个。 该ID长度范围为1～36位，可以包含字母、数字、中划线或者下划线，不包含其他的特殊字符。 |
|
external_fields |
Object |
否 |
根据用户自定义数据类型，填入相应的数值。 需在创建人脸库时定义external_fields字段，才可以在添加人脸时使用该字段，参考自定义字段。 |
|
single |
boolean |
否 |
是否将图片中的最大人脸添加至人脸库。可选值包括：
|
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
face_set_id |
String |
人脸库ID。 调用失败时无此字段。 |
|
face_set_name |
String |
人脸库名称。 调用失败时无此字段。 |
|
faces |
Array of FaceSetFace objects |
人脸库当中的人脸结构，详见FaceSetFace。 调用失败时无此字段。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bounding_box |
BoundingBox object |
人脸在图像中的位置。 BoundingBox结构见BoundingBox。 |
|
external_fields |
Object |
用户添加的额外字段。 |
|
external_image_id |
String |
人脸所在的外部图片ID。 |
|
face_id |
String |
人脸ID，由系统内部生成的唯一ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
width |
Integer |
矩形框宽度。 |
|
top_left_y |
Integer |
矩形框左上角纵坐标。 |
|
top_left_x |
Integer |
矩形框左上角横坐标。 |
|
height |
Integer |
矩形框高度。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
调用失败时的错误码。 调用成功时无此字段。 |
|
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
X-Auth-Token值获取方法请参见认证鉴权。
- 请求样例（方式一：使用图片的BASE64编码）
POST https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT... Request Body: { "image_base64": "/9j/4AAQSkZJRgABAgEASABIAAD", "external_image_id": "imageID", "external_fields": { "timestamp": 12, "id": "home" } } - 请求样例（方式二：使用图片文件）
POST https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces Request Header: X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT... Request Body: image_file: File(图片文件) external_image_id: imageID external_fields: {"timestamp" : 12,"id" : "home"} - 请求样例（方式三：使用图片URL）
POST https://{endpoint}/v2/{project_id}/face-sets/showFaceSet/faces Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT... Request Body: { "image_url":"/BucketName/ObjectName", "external_image_id":"imageID", "external_fields" : { "timestamp": 12, "id": "home" } }
响应示例
状态码：200
{
"face_set_id": "T785tx1N",
"face_set_name": "showFaceSet",
"faces": [
{
"bounding_box": {
"width": 63,
"top_left_y": 100,
"top_left_x": 221,
"height": 63
},
"external_image_id": "Xr0phyap",
"external_fields" : {
"timestamp": 12,
"id": "home"
},
"face_id": "JLa9hYLl"
}
]
}
状态码：400
{
"error_code": "FRS.0404",
"error_msg": "Detect no face, can not add it to face set."
}
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。
