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

人像分割

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

我的收藏

本页目录：

1. 接口描述

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

即二分类人像分割，识别传入图片中人体的完整轮廓，进行抠像。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：SegmentPortraitPic。
Version 是 String 公共参数，本接口取值：2020-03-24。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore 。
Image 否 String 图片 base64 数据，base64 编码后大小不可超过5M。
图片分辨率须小于2000*2000。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
示例值：xxxxx
Url 否 String 图片的 Url 。
Url、Image必须提供一个，如果都提供，只使用 Url。
图片分辨率须小于2000*2000 ，图片 base64 编码后大小不可超过5M。
图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
非腾讯云存储的Url速度和稳定性可能受一定影响。
支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
示例值：IamNotAUrl
RspImgType 否 String 返回图像方式（base64 或 Url ) ，二选一。url有效期为30分钟。
示例值：url
Scene 否 String 适用场景类型。

取值：GEN/GS。GEN为通用场景模式；GS为绿幕场景模式，针对绿幕场景下的人像分割效果更好。
两种模式选择一种传入，默认为GEN。
示例值：GEN

3. 输出参数

参数名称 类型 描述
ResultImage String 处理后的图片 base64 数据，透明背景图。
注意：此字段可能返回 null，表示取不到有效值。
示例值：**
ResultMask String 一个通过 base64 编码的文件，解码后文件由 Float 型浮点数组成。这些浮点数代表原图从左上角开始的每一行的每一个像素点，每一个浮点数的值是原图相应像素点位于人体轮廓内的置信度（0-1）转化的灰度值（0-255）。
注意：此字段可能返回 null，表示取不到有效值。
示例值：**
HasForeground Boolean 图片是否存在前景。
注意：此字段可能返回 null，表示取不到有效值。
示例值：false
ResultImageUrl String 支持将处理过的图片 base64 数据，透明背景图以Url的形式返回值，Url有效期为30分钟。
注意：此字段可能返回 null，表示取不到有效值。
示例值：""
ResultMaskUrl String 一个通过 base64 编码的文件，解码后文件由 Float 型浮点数组成。支持以Url形式的返回值；Url有效期为30分钟。
注意：此字段可能返回 null，表示取不到有效值。
示例值：“”
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用失败示例

输入示例

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

{
    "Url": "IamNotAUrl"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.UrlIllegal",
            "Message": "URL格式不合法。"
        },
        "RequestId": "46ed6f32-549f-4377-8116-2d55e4574528"
    }
}

示例2 调用成功示例

输入示例

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

{
    "Url": "test.jpg"
}

输出示例

{
    "Response": {
        "ResultImage": "iVBORw0KGgoAAAANSUhEUgAAAiYAAAFuCAYAAAC1LdPaAAAgAElEQVR4AbTB0ZJlyXUYy4g8DT1hICNl5P9/50WdFdJqWIJ7ioWahnDl7r/99me+MzM8VTwNh39FxWcqS+Wcw3cqLpUnlUtFZamorMPvqaiorJlBReWcg4rKUuk9/DMqKirWaVCpWBUVFRVXRcWTysi3KpbKUlkq68TfqaioLJWZQWWpqCyVz1SeVN7vN/+IgA4UIaui4vp4x1UxHlbFer//ylWxKr5SsSpWRULFk8pSUXlS+YrKUlkqS0VFZVUsFZWOLBUVFRWVpaKiUlGxVFR+eKioqFBRUVGZGb6jsSqeKtbM8KTyJN8757BUVkVFxTrn8KTyVKHypH...",
        "ResultMask": "...XWPBHiy5s9MsfGWqRxIlxe+DdQbyLK9a6lDSLpaFbtC21I3GK/okoooooooooooooooooooooooor+Qb/g73/bN1j4HfsbeCP2evCt7qum6x8e9cuDrN5YnT3spfDWi8T6bfrOHvImnnbfHJbKmQMM/av8AMAJJJJOSeST1J9TRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRXV+BvHPi/wCGni3QPHfgPxDqfhXxf4X1K11jQPEGjXUlnqWl6lZyrNbXdrcREPHLFIoYHocYIIJFf7FX/BAn9qf41fthf8E2fgz8Y/j74oXxl8RdRivtL1LxE1lBZXOow6XcPaW096tviOa8aKNTPcbVaaTLsMk1+0dFFFFFFFFFFFFFFFFFFFFFFFf5jX/B5jqOoSft8fCfTZL68fToPg3p88Fg9zO1lDPJqFwJJorUuYI5ZAAHkSMOwADE4r+Oyiiiiv/Z",
        "HasForeground": true,
        "ResultMaskUrl": "",
        "ResultImageUrl": "",
        "RequestId": "9cf173a5-4ae5-46fb-9898-6c876263780d"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.BalanceInsufficient 余额不足，开通失败，请充值后再开通。
FailedOperation.DownloadError 文件下载失败。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageDownloadError 图片下载错误。
FailedOperation.ImageNotForeground 图片不存在前景。
FailedOperation.ImageNotSupported 不支持的图片文件。
FailedOperation.ImageResolutionExceed 图片分辨率过大。
FailedOperation.ImageResolutionInsufficient 图片分辨率过小。
FailedOperation.ImageSizeExceed base64编码后的图片数据过大。
FailedOperation.InnerError 服务内部错误，请重试。
FailedOperation.ProfileNumExceed 人像数过多。
FailedOperation.RequestEntityTooLarge 整个请求体太大（通常主要是图片）。
FailedOperation.RequestTimeout 后端服务超时。
FailedOperation.RpcFail RPC请求失败，一般为算法微服务故障。
FailedOperation.SegmentFailed 人像分割失败。
FailedOperation.ServerError 算法服务异常，请重试。
FailedOperation.UnKnowError 内部错误。
InvalidParameter.InvalidParameter 参数不合法。
InvalidParameterValue.ImageEmpty 图片为空。
InvalidParameterValue.UrlIllegal URL格式不合法。
LimitExceeded.TooLargeFileError 文件太大。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.NotExist 计费状态未知，请确认是否已在控制台开通服务。
UnsupportedOperation.UnknowMethod 未知方法名。
中国站