文档中心>API 中心

人员库升级

最近更新时间:2024-04-03 11:20:18

我的收藏

1. 接口描述

此接口处于预下线状态 。

预计下线时间:2023-05-10 16:24:03

接口请求域名: iai.tencentcloudapi.com 。

避免官网歧义

升级人员库。升级过程中,人员库仍然为原算法版本,人员库相关操作仍然支持。升级完成后,人员库为新算法版本。
单个人员库有且仅支持一次回滚操作。

升级是一个耗时的操作,执行时间与人员库的人脸数相关,升级的人员库中的人脸数越多,升级的耗时越长。升级接口是个异步任务,调用成功后返回JobId,通过GetUpgradeGroupFaceModelVersionResult查询升级进度和结果。如果升级成功,人员库版本将切换到新版本。如果想回滚到旧版本,可以调用RevertGroupFaceModelVersion进行回滚。

注:某些接口无法进行跨人员库版本操作,例如SearchFaces,SearchPersons和CopyPerson等。当业务有多个Group操作的场景时,如同时搜索Group1和Group2,如果升级了Group1,此时Group1和Group2版本不同,造成了跨版本操作,将导致Search接口无法正常执行,返回不允许执行跨版本操作错误,升级前需考虑业务是否有多库操作的场景,否则会影响线上接口表现。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:UpgradeGroupFaceModelVersion。
Version String 公共参数,本接口取值:2020-03-03。
Region String 公共参数,详见产品支持的 地域列表
GroupId String 需要升级的人员库ID。
示例值:1001
FaceModelVersion String 需要升级至的算法模型版本。默认为最新版本。不可逆向升级
示例值:3.0

3. 输出参数

参数名称 类型 描述
JobId String 升级任务ID,用于查询、获取升级的进度和结果。
示例值:251007453_upgrade_group_qta_1596529493_gjwh07X7
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 升级失败

当人员库存在一些无法升级的人脸时,返回FailedOperation.GroupLostFaces错误,并返回一个Url查看具体的PersonId和FaceId,需要删除这些Person或Face,或者重新创建,才可以升级成功。
文件格式:
[{
person_id: 丢失的人员ID,
face_id: 丢失的人脸ID,
type: 1 // 丢图类型,1. 未知原因,暂无其它类别
}]

输入示例

https://iai.tencentcloudapi.com/?Action=UpgradeGroupFaceModelVersion
&GroupId=1002
&FaceModelVersion=3.0
&<公共请求参数>

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.GroupLostFaces",
            "Message": "人员库中人脸图片丢失,详情可参见https://iaiface-upgradegroup-failedface-1254418846.cos.ap-guangzhou.myqcloud.com/1253657503/1002.json"
        },
        "RequestId": "3ad7ccb4-29b5-46b4-adcd-69fd6728d530"
    }
}

示例2 人员库升级

输入示例

https://iai.tencentcloudapi.com/?Action=UpgradeGroupFaceModelVersion
&GroupId=1001
&FaceModelVersion=3.0
&<公共请求参数>

输出示例

{
    "Response": {
        "JobId": "251007453_upgrade_group_qta_1596529493_gjwh07X7",
        "RequestId": "d1388dbb-c9f0-4b7a-8528-ebf61f718e67"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.GroupCannotUpgrade 指定人员库的升级操作无法执行。
FailedOperation.GroupLostFaces 人员库存在人脸图片丢失。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.ServerError 算法服务异常,请重试。
InvalidParameterValue.FaceModelVersionIllegal 算法模型版本不合法。
InvalidParameterValue.GroupIdIllegal 人员库ID包含非法字符。人员库ID只支持英文、数字、-%@#&_。
InvalidParameterValue.GroupIdNotExist 人员库ID不存在。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
ResourceUnavailable.StopUsing 账号已停服。
ResourcesSoldOut.ChargeStatusException 计费状态异常。