tencent cloud

APIs

DokumentasiAPIsFace RecognitionPersonnel Database Management APIsCreateFace

增加人脸

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-11-05 17:42:12

1. 接口描述

接口请求域名： iai.intl.tencentcloudapi.com 。

将一组人脸图片添加到一个人员中。一个人员最多允许包含 5 张图片。若该人员存在多个人员库中，所有人员库中该人员图片均会增加。

  • 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateFace。
Version 是 String 公共参数，本接口取值：2020-03-03。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-jakarta, ap-nanjing, ap-shanghai, ap-singapore 。
PersonId 是 String

人员ID，取值为创建人员接口中的PersonId。
Images.N 否 Array of String

图片 base64 数据。

  • base64 编码后大小不可超过5M。
  • jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
  • 人员人脸总数量不可超过5张。
  • 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
  • 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
Urls.N 否 Array of String

图片的 Url 。

  • 对应图片 base64 编码后大小不可超过5M。
  • jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
  • Url、Image必须提供一个，如果都提供，只使用 Url。
  • 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
  • 非腾讯云存储的Url速度和稳定性可能受一定影响。
  • 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
  • 人员人脸总数量不可超过5张。
  • 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
FaceMatchThreshold 否 Float

只有和该人员已有的人脸相似度超过FaceMatchThreshold值的人脸，才能增加人脸成功。

  • 默认值60分。
  • 取值范围：[0,100] 。
QualityControl 否 Integer

图片质量控制。

  • 取值范围：
    0: 不进行控制；
    1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
    2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
    3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
    4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题；
  • 默认 0。
  • 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
NeedRotateDetection 否 Integer

是否开启图片旋转识别支持。

  • 取值范围：0为不开启，1为开启。
  • 默认为0。
  • 本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
  • 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
Encryption 否 Encryption

是否需要对请求信息进行全包体加密。支持的加密算法:AES-256-CBC。有加密需求的用户可使用此参数。
EncryptedBody 否 String

加密后的密文。加密前的数据格式如下:{"Url":"","Image":""}。

3. 输出参数

参数名称 类型 描述
SucFaceNum Integer

加入成功的人脸数量。
SucFaceIds Array of String

加入成功的人脸ID列表。
RetCode Array of Integer

每张人脸图片添加结果。

  • 其他非 0 值代表算法服务异常，取值范围：
    -1101 代表未检测到人脸。
    -1102 代表图片解码失败。
    -1109 代表图片尺寸过大或者过小。
    -1601代表不符合图片质量控制要求。
    -1604 代表人脸相似度没有超过FaceMatchThreshold。
  • RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
SucIndexes Array of Integer

加入成功的人脸索引。

  • 索引顺序和入参中 Images 或 Urls 的顺序一致。
  • 例如， Urls 中 有 3 个 url，第二个 url 失败，则 SucIndexes 值为 [0,2] 。
SucFaceRects Array of FaceRect

加入成功的人脸框位置。顺序和入参中 Images 或 Urls 的顺序一致。
FaceModelVersion String

人脸识别所用的算法模型版本。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 增加人脸失败示例

输入示例

https://iai.intl.tencentcloudapi.com/?Action=CreateFace
&PersonId=1001
&Urls.0=http://test.image.myqcloud.com/testB.jpg
&Urls.1=http://test.image.myqcloud.com/testC.jpg
&Urls.2=http://test.image.myqcloud.com/testD.jpg
&Urls.3=http://test.image.myqcloud.com/testE.jpg
&Urls.4=http://test.image.myqcloud.com/testF.jpg
&<公共请求参数>

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.UploadFaceNumExceed",
            "Message": "一次最多上传四张人脸。"
        },
        "RequestId": "44506f79-2191-49bc-997b-748a566d781c"
    }
}

示例2 增加人脸成功示例

输入示例

https://iai.intl.tencentcloudapi.com/?Action=CreateFace
&PersonId=1001
&Urls.0=http://test.image.myqcloud.com/testA.jpg
&<公共请求参数>

输出示例

{
    "Response": {
        "SucFaceNum": 1,
        "SucFaceIds": [
            "2875186538564559728"
        ],
        "RetCode": [
            0
        ],
        "SucIndexes": [
            0
        ],
        "SucFaceRects": [
            {
                "X": 135,
                "Y": 42,
                "Width": 98,
                "Height": 136
            }
        ],
        "FaceModelVersion": "3.0",
        "RequestId": "07d63403-a199-4bbe-b9e0-692356ac738d"
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure.InvalidAuthorization 认证失败。
FailedOperation.ConflictOperation 操作冲突，请勿同时操作相同的Person。
FailedOperation.CreateFaceConcurrent 增加人脸不支持并发操作。
FailedOperation.DecryptSystemError Decryption failed.
FailedOperation.DuplicatedGroupDescription 同一人员库中自定义描述字段不可重复。
FailedOperation.FaceSizeTooSmall 人脸框大小小于MinFaceSize设置，人脸被过滤。
FailedOperation.GroupInDeletedState 当前组正处于删除状态，请等待。
FailedOperation.GroupPersonMapExist 组中已包含对应的人员Id。
FailedOperation.GroupPersonMapNotExist 组中不包含对应的人员Id。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageDownloadError 图片下载错误。
FailedOperation.ImageFacedetectFailed 人脸检测失败。
FailedOperation.ImageResolutionExceed 图片分辨率过大。
FailedOperation.ImageResolutionTooSmall 图片短边分辨率小于64。
FailedOperation.ImageSizeExceed base64编码后的图片数据大小不超过5M。
FailedOperation.RequestLimitExceeded 请求频率超过限制。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.SearchFacesExceed 检索人脸个数超过限制。
FailedOperation.ServerError 算法服务异常，请重试。
InternalError 内部错误。
InvalidParameter.InvalidParameter 参数不合法。
InvalidParameterValue.AccountFaceNumExceed 账号脸数量超出限制。
InvalidParameterValue.DeleteFaceNumExceed 删除人脸数量超出限制。每个人员至少需要包含一张人脸。
InvalidParameterValue.FaceMatchThresholdIllegal FaceMatchThreshold参数不合法。
InvalidParameterValue.GroupExDescriptionsExceed 人员库自定义描述字段数组长度超过限制。最多可以创建5个。
InvalidParameterValue.GroupExDescriptionsNameIdentical 人员库自定义描述字段名称不可重复。
InvalidParameterValue.GroupExDescriptionsNameIllegal 人员库自定义描述字段名称包含非法字符。人员库自定义描述字段名称只支持中英文、-、_、数字。
InvalidParameterValue.GroupExDescriptionsNameTooLong 人员库自定义描述字段名称长度超出限制。
InvalidParameterValue.GroupFaceNumExceed 人员库人脸数量超出限制。
InvalidParameterValue.GroupIdAlreadyExist 人员库ID已经存在。人员库ID不可重复。
InvalidParameterValue.GroupIdIllegal 人员库ID包含非法字符。人员库ID只支持英文、数字、-%@#&_。
InvalidParameterValue.GroupIdNotExist 人员库ID不存在。
InvalidParameterValue.GroupIdTooLong 人员库ID超出长度限制。
InvalidParameterValue.GroupIdsExceed 传入的人员库列表超过限制。
InvalidParameterValue.GroupNameAlreadyExist 人员库名称已经存在。人员库名称不可重复。
InvalidParameterValue.GroupNameIllegal 人员库名称包含非法字符。人员库名称只支持中英文、-、_、数字。
InvalidParameterValue.GroupNameTooLong 人员库名称超出长度限制。
InvalidParameterValue.GroupNumExceed 人员库数量超出限制。如需增加，请联系我们。
InvalidParameterValue.GroupNumPerPersonExceed 人员库数量超出限制。单个人员最多可被添加至100个人员库。
InvalidParameterValue.GroupTagIllegal 人员库备注包含非法字符。人员库备注只支持中英文、-、_、数字。
InvalidParameterValue.GroupTagTooLong 人员库备注超出长度限制。
InvalidParameterValue.ImageEmpty 图片为空。
InvalidParameterValue.InvalidParameter Invalid encryption parameters.
InvalidParameterValue.LimitExceed 返回数量超出限制。
InvalidParameterValue.NoFaceInGroups 指定分组中没有人脸。
InvalidParameterValue.NoFaceInPhoto 图片中没有人脸。
InvalidParameterValue.OffsetExceed 起始序号过大。请检查需要请求的数组长度。
InvalidParameterValue.PersonExDescriptionInfosExceed 人员自定义描述字段数组长度超过限制。最多5个。
InvalidParameterValue.PersonExDescriptionsNameIdentical 人员自定义描述字段名称不可重复。
InvalidParameterValue.PersonExDescriptionsNameIllegal 人员自定义描述字段名称包含非法字符。人员自定义描述字段名称只支持中英文、-、_、数字。
InvalidParameterValue.PersonExDescriptionsNameTooLong 人员自定义描述字段名称长度超出限制。
InvalidParameterValue.PersonExistInGroup 组中已包含对应的人员Id。
InvalidParameterValue.PersonFaceNumExceed 人员人脸数量超出限制。单个人员最多可以包含五张人脸。
InvalidParameterValue.PersonGenderIllegal 人员性别设置出错。0代表未填写，1代表男性，2代表女性。
InvalidParameterValue.PersonIdAlreadyExist 人员ID已经存在。人员ID不可重复。
InvalidParameterValue.PersonIdIllegal 人员ID包含非法字符。人员ID只支持英文、数字、-%@#&_。
InvalidParameterValue.PersonIdNotExist 人员ID不存在。
InvalidParameterValue.PersonIdTooLong 人员ID超出长度限制。
InvalidParameterValue.PersonNameIllegal 人员名称包含非法字符。人员名称只支持中英文、-、_、数字。
InvalidParameterValue.PersonNameTooLong 人员名称超出长度限制。
InvalidParameterValue.QualityControlIllegal QualityControl参数不合法。
InvalidParameterValue.SearchPersonsExceed 搜索的人员数目超过限制。
InvalidParameterValue.UploadFaceNumExceed 一次最多上传四张人脸。
InvalidParameterValue.UrlIllegal URL格式不合法。
LimitExceeded.ErrorFaceNumExceed 人脸个数超过限制。
MissingParameter.ErrorParameterEmpty 必选参数为空。
ResourceUnavailable.Delivering 资源正在发货中。
ResourceUnavailable.Freeze 账号已被冻结。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.NotExist 计费状态未知，请确认是否已在控制台开通服务。
ResourceUnavailable.Recover 资源已被回收。
ResourceUnavailable.StopUsing 账号已停服。
ResourceUnavailable.UnknownStatus 计费状态未知。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
UnsupportedOperation.UnknowMethod 未知方法名。
Topik sebelumnya: CreatePersonTopik selanjutnya: CreateGroup

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan

Search
    Enter keywords to search documentation