API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 人体分析 > 人体检测相关接口 > 人体检测与属性分析

人体检测与属性分析

最近更新时间：2024-03-12 01:10:02

我的收藏

本页目录：

1. 接口描述

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

检测给定图片中的人体（Body）的位置信息及属性信息。

默认接口请求频率限制：300次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DetectBody。
Version 是 String 公共参数，本接口取值：2020-03-24。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。
Image 否 String 人体图片 Base64 数据。
图片 base64 编码后大小不可超过5M。
图片分辨率不得超过 1920 * 1080 。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
示例值：image
MaxBodyNum 否 Integer 最多检测的人体数目，默认值为1（仅检测图片中面积最大的那个人体）； 最大值10 ，检测图片中面积最大的10个人体。
示例值：1
Url 否 String 人体图片 Url 。
Url、Image必须提供一个，如果都提供，只使用 Url。
图片 base64 编码后大小不可超过5M。
图片分辨率不得超过 1920 * 1080 。
图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
示例值：url
AttributesOptions 否 AttributesOptions 是否返回年龄、性别、朝向等属性。
可选项有 Age、Bag、Gender、UpperBodyCloth、LowerBodyCloth、Orientation。
如果此参数为空则为不需要返回。
需要将属性组成一个用逗号分隔的字符串，属性之间的顺序没有要求。
关于各属性的详细描述，参见下文出参。
最多返回面积最大的 5 个人体属性信息，超过 5 个人体（第 6 个及以后的人体）的 BodyAttributesInfo 不具备参考意义。
示例值：test

3. 输出参数

参数名称 类型 描述
BodyDetectResults Array of BodyDetectResult 图中检测出来的人体框。
示例值：[]
BodyModelVersion String 人体识别所用的算法模型版本。
示例值：1.0
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用失败示例

输入示例

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

{
    "Url": "IamNotUrl"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.UrlIllegal",
            "Message": "URL格式不合法。"
        },
        "RequestId": "b5f77c78-efaf-42d1-b0ac-419cc70b4994"
    }
}

示例2 调用成功示例

输入示例

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

{
    "Url": "test.jpg"
}

输出示例

{
    "Response": {
        "BodyDetectResults": [
            {
                "BodyRect": {
                    "X": 260,
                    "Y": 1,
                    "Width": 272,
                    "Height": 365
                },
                "Confidence": 0.91490805149078,
                "BodyAttributeInfo": {
                    "UpperBodyCloth": {
                        "Color": {
                            "Type": "xx",
                            "Probability": 0.0
                        },
                        "Sleeve": {
                            "Type": "xx",
                            "Probability": 0.0
                        },
                        "Texture": {
                            "Type": "xx",
                            "Probability": 0.0
                        }
                    },
                    "Orientation": {
                        "Type": "xx",
                        "Probability": 0.0
                    },
                    "LowerBodyCloth": {
                        "Color": {
                            "Type": "xx",
                            "Probability": 0.0
                        },
                        "Length": {
                            "Type": "xx",
                            "Probability": 0.0
                        },
                        "Type": {
                            "Type": "xx",
                            "Probability": 0.0
                        }
                    },
                    "Gender": {
                        "Type": "xx",
                        "Probability": 0.0
                    },
                    "Age": {
                        "Type": "xx",
                        "Probability": 0.0
                    },
                    "Bag": {
                        "Type": "xx",
                        "Probability": 0.0
                    }
                }
            }
        ],
        "BodyModelVersion": "1.0",
        "RequestId": "13ce6864-614a-4a9f-8207-c68fc9c552c4"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.BodyQualityNotQualified 人体质量分过低。
FailedOperation.ImageBodyDetectFailed 人体检测失败。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageDownloadError 图片下载错误。
FailedOperation.ImageNotSupported 不支持的图片文件。
FailedOperation.ImageResolutionExceed 图片分辨率过大。
FailedOperation.ImageSizeExceed base64编码后的图片数据过大。
FailedOperation.InnerError 服务内部错误，请重试。
FailedOperation.NoBodyInPhoto 图片中没有人体。
FailedOperation.RequestEntityTooLarge 整个请求体太大（通常主要是图片）。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.RpcFail RPC请求失败，一般为算法微服务故障。
FailedOperation.UnKnowError 内部错误。
InvalidParameter.InvalidParameter 参数不合法。
InvalidParameterValue.ImageEmpty 图片为空。
InvalidParameterValue.UrlIllegal URL格式不合法。
MissingParameter.ErrorParameterEmpty 必选参数为空。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.NotExist 计费状态未知，请确认是否已在控制台开通服务。
UnsupportedOperation.UnknowMethod 未知方法名。
中国站