You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
veImageX
  • 文档首页
    • /
  • veImageX

使用智能背景移除获取结果图

最近更新时间：2023.05.19 16:30:11

首次发布时间：2021.11.29 19:44:20

我的收藏

针对上传的静图，支持去除上传图像背景，获取图像主体并设置主体轮廓描边的相关配置，如描边颜色、描边宽度。

请求说明

  • 接口名称：GetSegmentImage
  • 请求方式：POST
  • 接口地址示例：https://imagex.volcengineapi.com/?Action=GetSegmentImage&Version=2018-08-01
  • 请求频率限制：100 次/秒
  • 超时时间：30 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 openAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

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

Query

参数类型是否必填描述
ActionString是接口名称。
VersionString是接口版本。veImageX 当前API的版本为2018-08-01。

ServiceId

String

是

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面，在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数类型是否必填描述

Class

String

是

图片类型，支持可选择的模型如下。

  • general：通用模型v1
  • human：人脸模型v1
  • product：商品模型v1
  • humanv2：人脸模型v2
  • productv2：商品模型v2

Refine

Bool

是

处理效果，当Class取值为humanv2或productv2时，默认为true。

  • false：保留的图像主体边缘以粗线条处理，图像处理的效率更高。
  • true：保留的图像主体边缘以发丝级细线条处理，图像处理后的效果更好。

Contour

Object of Contour

否

描边设置，仅当Class取值humanv2或productv2时有效。
默认关闭，如果开启，抠出的结果图中保留的图像主体会外包一圈描边效果。

TransBgBool否是否开启透明背景裁剪设置。默认false，关闭状态。如果开启，抠出的结果图会被裁剪到刚好包住保留的图像主体。
StoreUriString否待擦除原图的存储 URI 和 URL（公网可访问的 URL）。

OutFormat

String

是

输出图片格式，取值如下所示：

  • png
  • jpeg
  • webp

Contour

参数类型是否必填描述
ColorString是描边颜色，支持以 HEX、HSL、RGP 表示。例如HEX中白色为#FFFFFF。
SizeInteger是描边宽度，单位为 px。取值范围为 0 到正整数，默认 10px。

返回参数

参数类型描述
ResUriString背景去除后的图片 URI。

示例

请求示例

POST https://imagex.volcengineapi.com?
Action=GetSegmentImage&ServiceId=example&Version=2018-08-01
{
    "Class" :"product",
    "Refine": true,
    "StoreUri":"tos-boe-i-example/6f90d0897.jpeg",
    "OutFormat":"jpeg"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetSegmentImage",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
      "Uri": "tos-boe-i-example/82d7f7e8a"
    }
}

异常返回示例

{
  "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "GetSegmentImage",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

访问错误码和附加组件错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：