1. 接口描述
接口请求域名: iai.tencentcloudapi.com 。
用于创建一个空的人员库,如果人员库已存在返回错误。
可根据需要创建自定义描述字段,用于辅助描述该人员库下的人员信息。
1个APPID下最多创建10万个人员库(Group)、最多包含5000万张人脸(Face)。
不同算法模型版本(FaceModelVersion)的人员库(Group)最多可包含人脸(Face)数不同。算法模型版本为2.0的人员库最多包含100万张人脸,算法模型版本为3.0的人员库最多可包含300万张人脸。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateGroup。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
GroupName | 是 | String | 人员库名称,[1,60]个字符,可修改,不可重复。 示例值:腾讯深圳员工库 |
GroupId | 是 | String | 人员库 ID,不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B。 示例值:TencentShenZhenEmployee |
GroupExDescriptions.N | 否 | Array of String | 人员库自定义描述字段,用于描述人员库中人员属性,该人员库下所有人员将拥有此描述字段。 最多可以创建5个。 每个自定义描述字段支持[1,30]个字符。 在同一人员库中自定义描述字段不可重复。 例: 设置某人员库“自定义描述字段”为["学号","工号","手机号"], 则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段, 可在对应人员描述字段中填写内容,登记该人员的学号、工号、手机号等信息。 示例值:["\u4e8b\u4e1a\u7fa4","\u90e8\u95e8\u540d","\u7ec4\u540d"] |
Tag | 否 | String | 人员库信息备注,[0,40]个字符。 示例值:不含实习生 |
FaceModelVersion | 否 | String | 人脸识别服务所用的算法模型版本。 目前入参支持 “2.0”和“3.0“ 两个输入。 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。 2020年11月26日后开通服务的账号仅支持输入“3.0”。 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。 示例值:3.0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FaceModelVersion | String | 人脸识别所用的算法模型版本。 示例值:3.0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 错误示例
人员库ID不支持中文
输入示例
https://iai.tencentcloudapi.com/?Action=CreateGroup
&GroupName=腾讯深圳员工库
&GroupId=腾讯深圳员工库
&<公共请求参数>
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.GroupIdIllegal",
"Message": "人员库ID包含非法字符。人员库ID只支持英文、数字、-%@#&_。"
},
"RequestId": "8125dda4-2905-4e02-88bd-79a93a660ad2"
}
}
示例2 错误示例-2
人员库ID不可重复
输入示例
https://iai.tencentcloudapi.com/?Action=CreateGroup
&GroupName=腾讯深圳员工库
&GroupId=TencentShenZhenEmployee
&<公共请求参数>
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.GroupIdAlreadyExist",
"Message": "人员库ID已经存在。人员库ID不可重复。"
},
"RequestId": "76ec6e41-37d6-4ab9-abef-48ef0c6ab175"
}
}
示例3 创建人员库接口
输入示例
https://iai.tencentcloudapi.com/?Action=CreateGroup
&GroupName=某某大学竹园宿舍楼1号楼
&GroupId=ZhuYuanDormitoryNo1
&FaceModelVersion=3.0
&Tag=全是女生哦
&GroupExDescriptions.0=学院名
&GroupExDescriptions.1=专业
&GroupExDescriptions.2=年级
&GroupExDescriptions.3=学号
&<公共请求参数>
输出示例
{
"Response": {
"FaceModelVersion": "3.0",
"RequestId": "1695f3dd-b668-479e-8b87-f37de371a8ec"
}
}
示例4 创建人员库接口-2
创建人员库
输入示例
https://iai.tencentcloudapi.com/?Action=CreateGroup
&GroupName=腾讯深圳员工库
&FaceModelVersion=3.0
&GroupId=TencentShenZhenEmployee
&Tag=不含实习生
&GroupExDescriptions.0=事业群
&GroupExDescriptions.1=部门名
&GroupExDescriptions.2=组名
&<公共请求参数>
输出示例
{
"Response": {
"FaceModelVersion": "3.0",
"RequestId": "e53ee4ec-9099-4b35-a129-21dd4820ff85"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.InvalidAuthorization | 认证失败。 |
FailedOperation.ConflictOperation | 操作冲突,请勿同时操作相同的Person。 |
FailedOperation.DuplicatedGroupDescription | 同一人员库中自定义描述字段不可重复。 |
FailedOperation.GroupInDeletedState | 当前组正处于删除状态,请等待。 |
FailedOperation.GroupPersonMapExist | 组中已包含对应的人员Id。 |
FailedOperation.GroupPersonMapNotExist | 组中不包含对应的人员Id。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageDownloadError | 图片下载错误。 |
FailedOperation.ImageFacedetectFailed | 人脸检测失败。 |
FailedOperation.ImageSizeExceed | base64编码后的图片数据大小不超过5M。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.SearchFacesExceed | 检索人脸个数超过限制。 |
FailedOperation.ServerError | 算法服务异常,请重试。 |
InternalError | 内部错误。 |
InvalidParameter.InvalidParameter | 参数不合法。 |
InvalidParameterValue.AccountFaceNumExceed | 账号脸数量超出限制。 |
InvalidParameterValue.DeleteFaceNumExceed | 删除人脸数量超出限制。每个人员至少需要包含一张人脸。 |
InvalidParameterValue.FaceModelVersionIllegal | 算法模型版本不合法。 |
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.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.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 | 未知方法名。 |