接口说明
功能描述
添加人脸数据能力可以为指定数据库添加人脸数据，单个人脸数据库支持最多 5 万张人脸照片入库，人脸数据是在已创建好的人脸样本中添加，每个人脸样本最多可以添加 5 张人脸照片。 人脸照片入库量以及每个人脸样本最多添加的照片量暂不支持扩容。
- 阿里云视觉智能开放平台视觉 AI 能力 API 接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。
接入指引
- 创建 AccessKey：请确保您已创建 AccessKey，如果您使用的是子账号 AccessKey，您需要给子账号赋予 AliyunVIAPIFullAccess 权限，具体操作，请参见 RAM 授权。
- 前提条件：
- 在线调试（可选）：您可以通过OpenAPI Explorer在线调试能力，查看完整的调用示例代码及 SDK 依赖信息，也可以下载完整的工程。
- 开发接入步骤：
- 在 SDK 总览中选择您要接入使用的 SDK 语言。
- 在对应语言的 SDK 文档中找到 AI 类目为人脸人体（facebody）的 SDK 包进行安装。
- 参考文档中提供的示例代码进行适当修改后调用。
-
示例代码：该能力常用语言的示例代码，请参见添加人脸数据示例代码。
-
客户端直接调用：该能力常用的客户端调用方式包括以下几种。
输入限制
- 图像格式：JPG、JPEG、PNG。
- 图像大小：不超过 5 MB。
- 图像分辨率：大于 32×32 像素，小于 4096×4096 像素。人脸占比不低于 64×64 像素。
- URL 地址中不能包含中文字符。
- 图片中若包含多个人脸，会取最大的人脸进行添加。
限制说明
添加人脸数据接口提交任务并发默认为 2QPS。
计费说明
添加人脸数据能力可免费调用。
流控信息
请求参数
| 字段名称 | 字段详情 |
|---|---|
DbNamestring | 数据库名称。支持小写字母、数字、下划线的组合，长度 1~64。 示例值:default |
ImageUrlstring | 人脸图片地址，人脸必须是正面无遮挡人脸（若包含多张人脸则取最大人脸添加）。推荐使用上海地域的 OSS 链接，对于文件在本地或者非上海地域 OSS 链接的情况，请参见文件 URL 处理。 示例值:https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/demo/1.png |
EntityIdstring | 实体 ID，用来标识用户的唯一性，如用户 ID、员工 ID 等。每个实体可包含多张人脸图片。支持大小写字母、数字、下划线、减号的组合，长度为 1~64 字符。 示例值:U1参考取值来源: AddFaceEntity |
ExtraDatastring | 自定义信息。支持字母、数字、标点符号和汉字。不超过 512 个字符。 示例值:王小二 |
QualityScoreThresholdnumber<float> | 质量分阈值。对新增人脸图片进行质量分析判断，得到的质量分小于该阈值则表示新增人脸图片质量不符合要求，添加失败。取值范围[0.0,100.0]。0.0 或空则表示不做质量分判断逻辑。 示例值:50.0 |
SimilarityScoreThresholdInEntitynumber<float> | 类内相似度阈值。将新增人脸图片与 EntityId 内已有人脸进行相似比对，小于该阈值则表示与其他人脸图片差异较大，添加失败.；若 EntityId 内没有人脸存在，则添加成功。取值范围[0.0,100.0]。0.0 或空则表示不做类内相似度判断逻辑。参考值见人脸比对 1:1接口的返回结果字段 Thresholds。 示例值:50.0 |
SimilarityScoreThresholdBetweenEntitynumber<float> |
返回参数
| 字段名称 | 字段详情 |
|---|---|
RequestIdstring | 请求 ID。 示例值:2B93C43A-F824-40C8-AF79-844342B0F43A |
Dataobject | 返回的结果数据内容。 |
返回说明
SDK 参考
阿里云视觉 AI 人脸人体类目下的添加人脸数据能力推荐使用 SDK 调用，支持多种编程语言，调用时请选择 AI 类目为人脸人体（facebody）的 SDK 包，文件参数通过 SDK 调用可支持本地文件及任意 URL，具体可参见 SDK 总览。
示例代码
该能力常用语言的示例代码，请参见添加人脸数据示例代码。
返回示例
错误码
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2021-03-02 |