有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

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

创建自定义人物。

输入人物名称,基本信息,分类信息与人脸图片,创建自定义人物

人脸图片可使用图片数据(base64编码的图片数据)或者图片URL(推荐使用COS以减少下载时间,其他地址也支持),原始图片优先,也即如果同时指定了图片数据和图片URL,接口将仅使用图片数据

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCustomPerson。
Version String 公共参数,本接口取值:2021-09-03。
Region String 公共参数,详见产品支持的 地域列表
Name String 自定义人物姓名
示例值:张三
BasicInfo String 自定义人物简要信息(仅用于标记,不支持检索)
示例值:一线娱乐明星
CategoryId String 自定义分类ID,如不存在接口会报错
示例值:"123"
ImageURL String 自定义人物图片URL,可支持任意地址,推荐使用COS
示例值:http://b0-123.cos.ap-shanghai.myqcloud.com/hello.jpg
Image String 原始图片base64编码后的数据

3. 输出参数

参数名称 类型 描述
PersonId String 自定义人物Id
示例值:person-a1b2c3
ImageInfo PersonImageInfo 自定义人脸信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功创建自定义人物

输入示例

POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCustomPerson
<公共请求参数>

{
    "ImageURL": "https://test-251202813.cos.ap-guangzhou.myqcloud.com/%E6%B2%88%E8%85%BE.jpeg",
    "BasicInfo": "测试基本信息",
    "Name": "测试姓名",
    "CategoryId": "11"
}

输出示例

{
    "Response": {
        "ImageInfo": {
            "ErrorCode": "OK",
            "ErrorMsg": "OK",
            "ImageId": "image-Axgo3FYc-egMN",
            "ImageURL": "https://test-251202813.cos.ap-guangzhou.myqcloud.com/CustomImages/image-Axgo3FYc-egMN.jpeg"
        },
        "PersonId": "person-Axgo3FYc",
        "RequestId": "705f6aed-f46b-4f43-aeef-31167885d938"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.InvalidSecretId SecredId失效。
AuthFailure.SecretIdNotFound SecretId不存在。
AuthFailure.SignatureExpire 签名已过期。
AuthFailure.SignatureFailure 签名校验失败。
AuthFailure.UserInvalidStatus 用户状态异常。
AuthFailure.UserNotFound 用户无权限。
AuthFailure.UserStopArrear 用户已欠费停服。
FailedOperation.DownloadFailed 媒资文件下载失败。
FailedOperation.FeatureAlgoFailed 图片特征提取失败。
FailedOperation.MultipleFacesInImage 图片中包含多张人脸。
FailedOperation.NoFaceInImage 图片中不包含人脸。
FailedOperation.PersonDuplicated 人脸库中存在相似的人脸: %!s(MISSING)。
FailedOperation.PersonNumExceeded 自定义人物数量过多。
FailedOperation.QualityAlgoFailed 图片质量分检测失败。
FailedOperation.QualityTooLow 图片质量分过低。
FailedOperation.UploadFailed 上传文件失败。
InternalError.DBConnectionError 内部DB连接失败。
InternalError.DBOperationError 内部DB操作错误。
InternalError.InnerError 内部错误。
InternalError.InternalOverflow 自定义人物请求超过限制。
InvalidParameter.InvalidCategoryId 自定义人物类型ID不合法。
InvalidParameter.InvalidImage 图片不合法。
InvalidParameter.InvalidName 名称不合法。
InvalidParameter.InvalidParam 输入字段 %!s(MISSING) 不合法。
InvalidParameter.InvalidURL URL不合法。
InvalidParameter.UnsupportURL 不支持的URL类型。
UnauthorizedOperation.UnauthorizedProduct 用户未激活该产品。