添加人脸样本的语法及示例_视觉智能开放平台(VIAPI)-阿里云帮助中心

功能描述

添加人脸样本能力用于向人脸数据库中添加人脸样本数据。人脸样本数据是用来标识用户的唯一性，如用户ID、员工ID等。

说明

您可以进入在线咨询获取在线人工帮助。
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。

接入指引

1. 注册阿里云账号：打开阿里云官网，在阿里云官网右上角，单击立即注册，按照操作提示完成账号注册。

2. 开通能力：请确保您已开通人脸人体服务，若未开通服务请立即开通。

重要

本能力支持企业或个人认证用户开通。更多实名认证操作信息，请参见实名认证。

3. 创建AccessKey：请确保您已创建AccessKey，如果您使用的是子账号AccessKey，您需要给子账号赋予AliyunVIAPIFullAccess权限，具体操作，请参见RAM授权。

4. 前提条件：已通过创建人脸数据库（CreateFaceDb）接口创建了数据库名称（DbName）。

5. 在线调试（可选）：您可以通过OpenAPI Explorer在线调试能力，查看完整的调用示例代码及SDK依赖信息，也可以下载完整的工程。

6. 开发接入步骤：

在SDK总览中选择您要接入使用的SDK语言。
在对应语言的SDK文档中找到AI类目为人脸人体（facebody）的SDK包进行安装。
参考文档中提供的示例代码进行适当修改后调用。

7. 示例代码：该能力常用语言的示例代码，请参见添加人脸样本示例代码。

8. 客户端直接调用：该能力常用的客户端调用方式包括以下几种。

限制说明

每个人脸数据库支持最高5万人脸特征，暂不支持扩容。人脸样本和标签组合为一个人脸特征。
每个人脸样本支持添加最多10个标签数据，暂不支持扩容。
添加人脸样本接口提交任务并发默认为2QPS。

计费说明

添加人脸样本能力可免费调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	AddFaceEntity	系统规定参数。取值：AddFaceEntity。
DbName	String	是	default	数据库名称。
EntityId	String	是	mm2	实体ID，可以包含数字、字母和下划线。
Labels	String	否	鹿班	输入标签，最多可以添加10个标签，具体格式要求如下：标签中仅支持下划线（_）和连字符（-），不支持其他特殊字符。标签之间使用英文逗号（,）分隔。

返回数据

名称	类型	示例值	描述
RequestId	String	DA7CAFEB-0A37-4496-9CDF-E3DBB6309CB2	请求ID。

SDK参考

阿里云视觉AI人脸人体类目下的添加人脸样本能力推荐使用SDK调用，支持多种编程语言，调用时请选择AI类目为人脸人体（facebody）的SDK包，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见SDK总览。

示例代码

该能力常用语言的示例代码，请参见添加人脸样本示例代码。

示例

请求示例

http(s)://facebody.cn-shanghai.aliyuncs.com/?Action=AddFaceEntity      //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&DbName=default
&EntityId=mm2
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>DA7CAFEB-0A37-4496-9CDF-E3DBB6309CB2</RequestId>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "DA7CAFEB-0A37-4496-9CDF-E3DBB6309CB2"
}

错误码

关于添加人脸样本的错误码，详情请参见常见错误码。

安全声明

请确保上传的图片或文件来源符合相应的法律法规。
通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。
平台不存储用户在使用服务过程中涉及的原始人脸图片或文件信息。
平台针对超过6个月及以上没有API服务调用的用户的人脸特征向量数据进行冻结，确保无服务调用的客户信息安全。如需解冻，请通过钉钉群（23109592）联系我们。