You need to enable JavaScript to run this app.
导航

使用图像修复获取结果图

最近更新时间2023.11.16 17:41:39

首次发布时间2022.10.25 11:18:20

本接口支持通过指定服务 ID 、待擦除的图片地址以及擦除配置,获取擦除后的图片 URI。

注意事项

  • 请求频率:单用户请求频率限制为 5 次/秒
  • 超时时间:超时时间约为 10 秒
  • 前提条件:已开通图像修复组件能力。
  • 计费说明:图像修复功能属于增值服务项,故使用后会产生增值服务费用,当前支持后付费的计费方式,具体请参见增值服务
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:POST
  • 请求地址:https://imagex.volcengineapi.com/?Action=GetImageEraseResult&Version=2018-08-01

请求参数

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

Query

参数

类型

是否必选

示例值

描述

Action

String

GetImageEraseResult

接口名称。GetImageEraseResult

Version

String

2018-08-01

接口版本。

Body

参数

类型

是否必选

示例值

描述

ServiceId

String

h8****fd

服务 ID。

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

StoreUri

String

tos-example/7a7979974.jpeg

待修复原图的存储 URI 或 URL(公网可访问的 URL)。

Model

String

eraser_model_imagex_0.1.0

修复模型,支持取值如下所示:

  • 自动检测并擦除类型模型:eraser_model_imagex_0.1.0
  • 指定区域擦除模型:
    • eraser_model_imagex_0.1.0 (推荐)
    • eraser_model_aliab

BBox

Array of BBox

-

指定区域擦除时图片待修复区域。
不填表示自动检测内容并修复,若所选模型不支持自动检测,则直接返回原图。

BBox

参数

类型

是否必填

示例值

描述

X1

Float

0.68

待擦除区域矩形框的归一化左上角 X 坐标值,取值范围为[0,1]。

说明

x、y 分别是将标记位置除以原图中的宽和高后的值,即将原图中的宽和高归一化为 1。

示例:假设原图宽为 200px,高为 300px,您的待擦除区域框左上角坐标为(20,240),右下角坐标为(100,30)。对擦除矩形框两处坐标归一化处理:

  • 左上角 X 坐标值为:20/200=0.1
  • 左上角 Y 坐标值为:240/300=0.8
  • 右下角 X 坐标值为:100/200=0.5
  • 右下角 Y 坐标值为:30/300=0.1

则最终归一化左上角坐标为(0.1,0.8)、右下角坐标为(0.5,0.1)。

Y1Float0.43待擦除区域矩形框的归一化左上角 Y 坐标值,取值范围为[0,1]。

X2

Float

0.97

待擦除区域矩形框的归一化右下角 X 坐标值,取值范围为[0,1]。

Y2

Float

0.43

待擦除区域矩形框的归一化右下角 Y 坐标值,取值范围为[0,1]。

UseOCR

Integer

1

是否开启文本擦除,取值如下所示:

  • 0:(默认)关闭
  • 1:开启。仅当开启后,匹配模式和匹配文本配置才会生效。

OCRMode

Integer

1

匹配模式,仅支持取值为 1 ,表示模糊匹配:

  • 若输入匹配文本,则擦除目标区域内包含该文字的对应文本行全部内容;
  • 若不输入匹配文本,则擦除目标区域内所有检测到的文字内容。

Text

String

test

匹配文本

返回参数

参数

类型

示例值

描述

ResUri

String

tos-boe-i-v0***bf/a95***d7

修复后结果图的 URI。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageEraseResult&Version=2018-08-01
{
    "ServiceId": "v0***bf",
    "StoreUri": "test.webp",
    "Model": "eraser_model_imagex_0.1.0",
    "BBox": {
        "X1": 0.68,
        "Y1": 0.43,
        "x2": 0.97,
        "y2": 0.43,
        "UseOCR": 1,
        "OCRMode": 1,
        "Text": "test"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052415234901022524314707965A79",
        "Action": "GetImageEraseResult",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "ResUri": "tos-boe-i-v0***bf/a95***d7",
    }
}

错误码

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