添加人脸
功能介绍
添加人脸到人脸库中。将单张图片中的人脸添加至人脸库中,支持添加最大人脸或所有人脸。
前提条件:
请确保您已开通人脸搜索服务。
- 只支持识别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。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/face-sets/{face_set_name}/faces
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见获取项目ID/账号名/AK/SK。 |
face_set_name |
是 |
String |
人脸库名称,字符串长度1-64。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 |
Content-Type |
是 |
String |
发送的实体的MIME类型,参数值为“application/json”。 |
Enterprise-Project-Id |
否 |
String |
企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。
说明:
创建企业项目后,在传参时,有以下三类场景。
|
参数名 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|
image_url |
String |
与image_file、image_base64三选一 |
图片的URL路径,目前仅支持华为云上OBS的URL,使用时只需保证FRS有权限读取该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":"https://<bucket-name>.<endpoint>/<object-name>", "external_image_id":"imageID", "external_fields" : { "timestamp": 12, "id": "home" } }
- 使用Python3语言向人脸库中添加人脸,人脸通过图片文件传入
# -*- coding:utf-8 -*- import requests import base64 endpoint = '开通服务所在region的人脸识别服务域名' project_id = '开通服务所在region的用户项目ID' token = '用户获取得到的实际token值' headers = {'Content-Type': 'application/json', 'X-Auth-Token': token} face_set_name = 'showFaceSet' url = "https://{endpoint}/v2/{project_id}/face-sets/{face_set_name}/faces".format( endpoint=endpoint,project_id=project_id,face_set_name=face_set_name) imagepath = r'./data/face-demo.png' with open(imagepath, "rb") as bin_data: image_data = bin_data.read() image_base64 = base64.b64encode(image_data).decode("utf-8") body = { "image_base64": image_base64, "external_image_id": "imageID", "external_fields": { "timestamp": 12, "id": "home" } } response = requests.post(url, headers=headers, json=body, verify=False) print(response.text)
- 使用Java语言向人脸库中添加人脸,人脸通过图片base64编码传入
import com.huawei.trace.http.apache.httpclient.TraceApacheHttpClientBuilder; import org.apache.http.HttpEntity; import org.apache.http.HttpHeaders; import org.apache.http.HttpResponse; import org.apache.http.client.config.RequestConfig; import org.apache.http.client.methods.HttpPost; import org.apache.http.config.Registry; import org.apache.http.config.RegistryBuilder; import org.apache.http.conn.socket.ConnectionSocketFactory; import org.apache.http.conn.socket.PlainConnectionSocketFactory; import org.apache.http.conn.ssl.NoopHostnameVerifier; import org.apache.http.conn.ssl.SSLConnectionSocketFactory; import org.apache.http.entity.ContentType; import org.apache.http.entity.StringEntity; import org.apache.http.impl.client.CloseableHttpClient; import org.apache.http.impl.client.HttpClientBuilder; import org.apache.http.impl.conn.PoolingHttpClientConnectionManager; import org.apache.http.ssl.SSLContextBuilder; import org.apache.http.ssl.TrustStrategy; import org.apache.http.util.EntityUtils; import java.io.IOException; import java.nio.charset.StandardCharsets; import java.security.KeyManagementException; import java.security.KeyStoreException; import java.security.NoSuchAlgorithmException; import java.security.cert.CertificateException; import java.security.cert.X509Certificate; import java.util.concurrent.TimeUnit; import javax.net.ssl.HostnameVerifier; import javax.net.ssl.SSLContext; /** * 此demo仅供测试使用,强烈建议使用SDK * 使用前需已配置HttpClient jar包。jar包可通过下载SDK获取 */ public class AddFace { protected static HttpClientBuilder buildClient(HttpClientBuilder httpClientBuilder) { SSLContext sslContext = null; try { sslContext = new SSLContextBuilder().loadTrustMaterial(null, new TrustStrategy() { public boolean isTrusted(X509Certificate[] arg0, String arg1) throws CertificateException { return true; } }).build(); } catch (NoSuchAlgorithmException e) { throw new RuntimeException(e.getMessage()); } catch (KeyManagementException e) { throw new RuntimeException(e.getMessage()); } catch (KeyStoreException e) { throw new RuntimeException(e.getMessage()); } httpClientBuilder.setSSLContext(sslContext); httpClientBuilder.setConnectionTimeToLive(30, TimeUnit.SECONDS); HostnameVerifier hostnameVerifier = NoopHostnameVerifier.INSTANCE; SSLConnectionSocketFactory sslSocketFactory = new SSLConnectionSocketFactory(sslContext, hostnameVerifier); Registry<ConnectionSocketFactory> socketFactoryRegistry = RegistryBuilder.<ConnectionSocketFactory>create().register("http", PlainConnectionSocketFactory.getSocketFactory()).register("https", sslSocketFactory).build(); PoolingHttpClientConnectionManager connMgr = new PoolingHttpClientConnectionManager(socketFactoryRegistry); connMgr.setMaxTotal(200); connMgr.setDefaultMaxPerRoute(100); httpClientBuilder.setConnectionManager(connMgr); return httpClientBuilder; } public static String doPost(String url, String jsonStr, String token, CloseableHttpClient client) { HttpPost post = new HttpPost(url); StringEntity entity = new StringEntity(jsonStr, ContentType.APPLICATION_JSON); post.setEntity(entity); post.setHeader(HttpHeaders.CONTENT_TYPE, "application/json"); //time unit is milliseconds RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(3000).setSocketTimeout(3000).build(); post.setConfig(requestConfig); post.setHeader("X-Auth-Token", token); HttpResponse response = null; String result = ""; try { response = client.execute(post); HttpEntity responseBody = response.getEntity(); if (responseBody == null) { System.out.println("the response body is null."); return result; } else { byte[] byteStream = EntityUtils.toByteArray(responseBody); System.arraycopy(byteStream, 0, new byte[byteStream.length], 0, byteStream.length); result = new String(byteStream, StandardCharsets.UTF_8); } } catch (IOException e) { e.printStackTrace(); } return result; } public static void main(String[] args) { CloseableHttpClient client = buildClient(TraceApacheHttpClientBuilder.create()).build(); // endpoint,project_id和face_set_name需要替换成实际信息。 String url = "https://{{endpoint}}/v2/{{project_id}}/face-sets/{{face_set_name}}/faces"; String jsonStr = "{ \"image_base64\": \"/9j/4AAQSkZJRgABAgEASABIAAD...\"}"; String token = "对应region的token"; String result = doPost(url, jsonStr, token, client); System.out.println(result); } }
响应示例
状态码: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." }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。