创建人员

最近更新时间:2021-03-05 08:01:43

我的收藏

1. 接口描述

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

创建人员,添加对应人员的人体轨迹信息。

请注意:

  • 我们希望您的输入为 严格符合轨迹图片 要求的图片。如果您输入的图片不符合轨迹图片要求,会对最终效果产生较大负面影响。请您尽量保证一个Trace中的图片人体清晰、无遮挡、连贯;
  • 一个人体轨迹(Trace)可以包含1-5张人体图片。提供越多质量高的人体图片有助于提升最终识别结果;
  • 无论您在单个Trace中提供了多少张人体图片,我们都将生成一个对应的轨迹(Trace)信息。即,Trace仅和本次输入的图片序列相关,和图片的个数无关;
  • 输入的图片组中,若有部分图片输入不合法(如图片大小过大、分辨率过大、无法解码等),我们将舍弃这部分图片,确保合法图片被正确搜索。即,我们将尽可能保证请求成功,去除不合法的输入;
  • 构成人体轨迹单张图片大小不得超过2M,分辨率不得超过1920*1080。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePerson。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
GroupId String 待加入的人员库ID。
PersonName String 人员名称。[1,60]个字符,可修改,可重复。
PersonId String 人员ID,单个腾讯云账号下不可修改,不可重复。
支持英文、数字、-%@#&_,,长度限制64B。
Trace Trace 人体轨迹信息。

3. 输出参数

参数名称 类型 描述
TraceId String 人员轨迹唯一标识。
BodyModelVersion String 人体识别所用的算法模型版本。
InputRetCode Integer 输入的人体轨迹图片中的合法性校验结果。
只有为0时结果才有意义。
-1001: 输入图片不合法。-1002: 输入图片不能构成轨迹。
InputRetCodeDetails Array of Integer 输入的人体轨迹图片中的合法性校验结果详情。
-1101:图片无效,-1102:url不合法。-1103:图片过大。-1104:图片下载失败。-1105:图片解码失败。-1109:图片分辨率过高。-2023:轨迹中有非同人图片。-2024: 轨迹提取失败。-2025: 人体检测失败。
RetCode 的顺序和入参中Images 或 Urls 的顺序一致。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用失败示例

输入示例

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

{
    "GroupId": "testG3",
    "PersonName": "testG3P1",
    "PersonId": "testG3P1",
    "Trace": {
        "Urls": [
            "IamNotUrl"
        ],
        "BodyRects": [
            {
                "X": 1,
                "Y": 2,
                "Width": 3,
                "Height": 4
            }
        ]
    }
}

输出示例

{
  "Response": {
    "TraceId": "",
    "BodyModelVersion": "",
    "InputRetCode": -1001,
    "InputRetCodeDetails": [
      -1102
    ],
    "RequestId": "78b14df0-9ca6-45e0-b5d4-f053db01f9bb"
  }
}

示例2 调用成功示例

输入示例

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

{
    "GroupId": "testG3",
    "PersonName": "testG3P1",
    "PersonId": "testG3P1",
    "Trace": {
        "Urls": [
            "http://i2.sinaimg.cn/ty/nba/2015-07-05/U10236P6T12D7648505F44DT20150705114547.jpg"
        ],
        "BodyRects": [
            {
                "X": 1,
                "Y": 2,
                "Width": 3,
                "Height": 4
            }
        ]
    }
}

输出示例

{
  "Response": {
    "TraceId": "testCreatePerson123",
    "BodyModelVersion": "1.0",
    "InputRetCode": 0,
    "InputRetCodeDetails": [
      0
    ],
    "RequestId": "2d44289d-eeb1-4109-8c2e-3c3e514094b9"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.BodyRectIllegal 输入的人体框不合法。
FailedOperation.BodyRectNumIllegal 输入的人体框数量不合法。
FailedOperation.InnerError 服务内部错误,请重试。
FailedOperation.RequestEntityTooLarge 整个请求体太大(通常主要是图片)。
FailedOperation.RequestTimeout 后端服务超时。
InvalidParameter.InvalidParameter 参数不合法。
InvalidParameterValue.AccountTraceNumExceed 账号人体轨迹数量超出限制。
InvalidParameterValue.BodyModelVersionIllegal 算法模型版本不合法。
InvalidParameterValue.BodyRectsExceed 传入的人体框过多。
InvalidParameterValue.GroupIdIllegal 人体库ID包含非法字符。人体库ID只支持英文、数字、-%@#&_。
InvalidParameterValue.GroupIdNotExist 人体库ID不存在。
InvalidParameterValue.GroupIdTooLong 人体库ID超出长度限制。
InvalidParameterValue.GroupTraceNumExceed 人体库人体轨迹数量超出限制。
InvalidParameterValue.ImageEmpty 图片为空。
InvalidParameterValue.PersonIdAlreadyExist 人员ID已经存在。人员ID不可重复。
InvalidParameterValue.PersonIdIllegal 人员ID包含非法字符。人员ID只支持英文、数字、-%@#&_。
InvalidParameterValue.PersonIdTooLong 人员ID超出长度限制。
InvalidParameterValue.PersonNameIllegal 人员名称包含非法字符。
InvalidParameterValue.PersonNameTooLong 人员名称超出长度限制。
InvalidParameterValue.TraceBodyNumExceed 创建人体轨迹的人体图片数量超出限制。
MissingParameter.ErrorParameterEmpty 必选参数为空。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
目录