主体分割（公测中）--图像技术-火山引擎

文档中心

导航

主体分割（公测中）

最近更新时间：2024.09.10 17:15:22首次发布时间：2024.08.15 14:04:26

接口简介

运用先进的图像处理技术，对图片进行智能分割，可将图片中的主要实体均分割出来

限制条件

名称	内容
图片要求	1.图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG/PNG格式。 2.最小 128 x 128 像素，最大 4096 x 4096 像素； 3. base64格式下单张图片最大4.7Mb。

Demo展示

原图	分割主体前景图	分割主体mask

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

请求参数
（1）header请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数
业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：SaliencySeg
Version	必选	String	版本号，取值：2022-08-31

（3）Body参数
业务请求参数

参数	可选/必选	类型	说明
req_key	必选	string	取固定值: saliency_seg
binary_data_base64	必选（二选一，优先生效）	array of string	输入图片base64数组，仅支持一张图
image_urls	必选（二选一）	array of string	图片文件URL数组，仅支持一张图
~~return_url~~	可选	~~bool~~	~~输出是否返回图片链接，目前默认返回的jpeg格式，暂不支持透明度通道（Alpha通道）~~
only_mask	可选	int	0: 返回裁剪出主体区域的BGRA透明图片 1: 返回原图大小Mask分割图 2: 返回裁剪出主体区域的BGR前景图叠加方形纯色背景 3: 返回原图大小的BGRA透明前景图 4: 返回原图大小的BGRA透明前景图+原图大小mask两个产物默认值：0 注：如使用0, 3, 4等需要返回透明底图的方式，需配合使用rgb=[-1, -1, -1]
rgb	可选	array of int	取值范围0～255，且仅当only_mask=2、3或4时才生效，返回抠出mask区域的rgb颜色的背景叠前景（当rgb为[-1,-1,-1]时，返回BGRA的透明图）默认值：[255, 255, 255] 注：业务使用请设置[-1,-1,-1]获得rgba透明底结果；如需指定背景色设置非[-1,-1,-1]值（如[255, 255, 255]设置白背景）后处理时或性能不佳。
refine_mask	可选	int	0：不对边缘增强 1：对边缘增强（matting lite 更快) 2：对边缘增强（matting large) （需精细化分割推荐开启该参数）默认值：0 注：参数设为2时，且4通道返回结果时，将会对部分背景区域的rgb值设置为0，以减少产物体积

输出说明

（1）通用输出参数
请参考通用返回字段及错误码
（2）业务输出参数
data 字段说明

字段	类型	说明	备注
binary_data_base64	array of string	返回主体分割图片的Base64编码
image_urls	array of string	图片url数组

错误码

（1）通用错误码
请参考通用返回字段及错误码
（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功
400	61003	Invalid Input Image: Image do not contain segment object	图片中不包含可用于分割的物体

示例

请求参数：

{
    "image_urls": [
        "https://xxx"
    ],
    "only_mask": 3, //建议值
    "refine_mask": 0,
    "req_key": "saliency_seg",
    "rgb": [ //建议值
        -1,
        -1,
        -1
    ]
}

返回参数：

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": "Success"
        },
        "bbox": [
            [
                1096,
                438,
                1857,
                1766
            ]
        ],
        "binary_data_base64": [
            ""
        ],
        "contours_point": [
            [
                [
                    [
                        2076,
                        440
                    ],
                    [
                        2058,
                        441
                    ] 
                ]
            ]
        ],
        "ori_height": [
            2204
        ],
        "ori_width": [
            3306
        ],
        "seg_score": [
            0.005572378635406494
        ],
        "shadow": [
            null
        ],
        "shadow_pos": [
            null
        ]
    },
    "message": "Success",
    "request_id": "202408151152110AC5DB88EDFEDACF402A",
    "status": 10000,
    "time_elapsed": "1.440610819s"
}