1. 接口描述
接口请求域名： bda.tencentcloudapi.com 。
本接口用于对一组待识别的人体动作轨迹（Trace）图片，在人体库中识别出最相似的 TopK 人体，按照相似度从大到小排列。
人体动作轨迹（Trace）图片要求：图片中当且仅包含一个人体。人体完整、无遮挡。
请注意：
- 我们希望您的输入为严格符合动作轨迹图片要求的图片。如果您输入的图片不符合动作轨迹图片要求，会对最终效果产生较大负面影响；
- 人体动作轨迹，是一个包含1-5张图片的图片序列。您可以输入1张图片作为动作轨迹，也可以输入多张。单个动作轨迹中包含越多符合质量的图片，搜索效果越好。
- 构成人体动作轨迹单张图片大小不得超过2M，分辨率不得超过1920*1080。
默认接口请求频率限制：300次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SearchTrace。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-nanjing, ap-shanghai 。 |
| GroupId | 是 | String | 希望搜索的人体库ID。 示例值：12311111111 |
| Trace | 是 | Trace | 人体动作轨迹信息。 |
| MaxPersonNum | 否 | Integer | 单张被识别的人体动作轨迹返回的最相似人员数量。 默认值为5，最大值为100。 例，设MaxPersonNum为8，则返回Top8相似的人员信息。 值越大，需要处理的时间越长。建议不要超过10。 示例值：2 |
| TraceMatchThreshold | 否 | Float | 出参Score中，只有超过TraceMatchThreshold值的结果才会返回。 默认为0。范围[0, 100.0]。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Candidates | Array of Candidate | 识别出的最相似候选人。 |
| InputRetCode | Integer | 输入的人体动作轨迹图片中的合法性校验结果。 只有为0时结果才有意义。 -1001: 输入图片不合法。-1002: 输入图片不能构成动作轨迹。 |
| InputRetCodeDetails | Array of Integer | 输入的人体动作轨迹图片中的合法性校验结果详情。 -1101:图片无效，-1102:url不合法。-1103:图片过大。-1104:图片下载失败。-1105:图片解码失败。-1109:图片分辨率过高。-2023:动作轨迹中有非同人图片。-2024: 动作轨迹提取失败。-2025: 人体检测失败。 |
| BodyModelVersion | String | 人体识别所用的算法模型版本。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用失败示例
输入示例
POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchTrace
<公共请求参数>
{
"GroupId": "12311111111",
"Trace": {
"Urls": [
"http://i2.sinaimg.cn/ty/nba/2015-07-05/U10236P6T12D7648505F44DT20150705114547.jpg"
],
"BodyRects": [
{
"X": 260,
"Y": 1,
"Width": 272,
"Height": 365
}
]
},
"MaxPersonNum": 2
}输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.GroupIdNotExist",
"Message": "人体库ID不存在。"
},
"RequestId": "1a5de4e8-02a0-4b4e-8c9a-e66e6f26d12a"
}
}示例2 调用成功示例
输入示例
POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchTrace
<公共请求参数>
{
"GroupId": "12311111111",
"Trace": {
"Urls": [
"http://i2.sinaimg.cn/ty/nba/2015-07-05/U10236P6T12D7648505F44DT20150705114547.jpg"
],
"BodyRects": [
{
"X": 260,
"Y": 1,
"Width": 272,
"Height": 365
}
]
},
"MaxPersonNum": 2
}输出示例
{
"Response": {
"Candidates": [
{
"PersonId": "testG10P1",
"TraceId": "3517452339320503246",
"Score": 99.99
},
{
"PersonId": "testG10P40",
"TraceId": "3516549744519331668",
"Score": 99.99
}
],
"BodyModelVersion": "1.0",
"InputRetCode": 0,
"InputRetCodeDetails": [
0
],
"RequestId": "0301e30d-e83c-43c7-b78c-29eafea4762d"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.BodyRectIllegal | 输入的人体框不合法。 |
| FailedOperation.BodyRectNumIllegal | 输入的人体框数量不合法。 |
| FailedOperation.GroupEmpty | 搜索的人体库为空。 |
| FailedOperation.ImageResolutionExceed | 图片分辨率过大。 |
| FailedOperation.ImageSizeExceed | base64编码后的图片数据过大。 |
| FailedOperation.InnerError | 服务内部错误，请重试。 |
| FailedOperation.RequestEntityTooLarge | 整个请求体太大（通常主要是图片）。 |
| FailedOperation.RequestTimeout | 后端服务超时。 |
| InvalidParameter.InvalidParameter | 参数不合法。 |
| InvalidParameterValue.BodyRectsExceed | 传入的人体框过多。 |
| InvalidParameterValue.GroupIdIllegal | 人体库ID包含非法字符。人体库ID只支持英文、数字、-%@#&_。 |
| InvalidParameterValue.GroupIdNotExist | 人体库ID不存在。 |
| InvalidParameterValue.GroupIdTooLong | 人体库ID超出长度限制。 |
| InvalidParameterValue.ImageEmpty | 图片为空。 |
| InvalidParameterValue.SearchPersonsExceed | 搜索的人员数目超过限制。 |
| InvalidParameterValue.TraceBodyNumExceed | 创建人体动作轨迹的人体图片数量超出限制。 |
| InvalidParameterValue.TraceMatchThresholdIllegal | TraceMatchThreshold参数不合法。 |
| MissingParameter.ErrorParameterEmpty | 必选参数为空。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.NotExist | 计费状态未知，请确认是否已在控制台开通服务。 |
| UnsupportedOperation.UnknowMethod | 未知方法名。 |
