使用综合增强获取结果图--veImageX-火山引擎

文档中心

立即注册

导航

使用综合增强获取结果图

最近更新时间：2024.06.13 11:50:15首次发布时间：2024.05.10 15:17:38

本接口支持通过指定服务 ID 、原图地址和综合增强配置，获取处理后结果图 URI。

注意事项

计费说明：画质增强功能属于附加组件下智能处理模块，属于后付费计费，使用后会产生附加组件智能处理费用。
前提条件：请确保已开通智能处理计费配置。
使用限制：使用组件前，请先确认画质增强使用限制。
请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 20 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。详情参见服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=GetComprehensiveEnhanceImage&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetComprehensiveEnhanceImage`	接口名称。当前 API 的名称为 `GetComprehensiveEnhanceImage`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`i2****hg`	服务 ID。
ImageUri	String	是	`tos-example/7a7979974.jpeg`	待增强图片的存储 URI 或访问 URL（公网可访问）。您可在控制台资源管理获取图片的存储 URI 以及访问 URL。
Mode	Integer	是	`0`	优化策略，取值如下所示： `0`：通用画质提升 `1`：显著画质提升说明推荐优先使用通用方案，显著画质提升方案画质分提高 10% 左右，但体积会有一定浮动提升。以上幅度变化基于测试集总结，具体以使用场景为准。
EnableConfig	Boolean	否	`true`	是否启用高级配置，取值如下所示： `true`：开启。开启后，下述高级配置才会生效。 `false`：（默认）关闭。说明适用于 8000 x 8000 以分辨率图像的画质增强。
ArStrength	Float	否	`0.2`	去压缩失真强度，取值范围为[0,1]。取值为`0`时表示不处理，取值越大去压缩失真强度越大。
DeblurStrength	Float	否	`0.2`	去模糊强度，取值范围为[0,1]。取值为`0`时表示不处理，取值越大去模糊强度越大。
DenoiseStrength	Float	否	`0.2`	降噪强度，取值范围为[0,1]。取值为`0`时表示不降噪，取值越大降噪强度越大。
Saturation	Float	否	`1.5`	饱和度，取值范围为[0,2]。取值大于 `1` 表示提升饱和度，取值小于 `1` 表示降低饱和度。
Brightness	Integer	否	`95`	`EnableConfig` 取值为 `true` 时，为必填。亮度，取值范围为[90,100]。取值越小，亮度提升越明显。
EnableSuperResolution	Boolean	否	`true`	是否开启超分配置，仅满足图像输入边界的图像执行超分处理。取值如下所示： `true`：开启。仅当开启后，下述超分配置才会生效。 `false`：（默认）关闭。说明适用于 8000 x 8000 以内分辨率图像的画质增强。
Multiple	Integer	否	`2`	超分倍率，仅支持 2 倍和 4 倍。说明 4 倍超分辨率只适用于 4000 x 4000 以内分辨率图像的画质增强。
ShortMin	Integer	否	`200`	`EnableSuperResolution` 取值为 `true` 时，为必填。执行超分处理的短边范围最小值，仅当满足图像边界输入的图像执行超分处理。单位为 px。
ShortMax	Integer	否	`700`	`EnableSuperResolution` 取值为 `true` 时，为必填。执行超分处理的短边范围最大值，仅当满足图像边界输入的图像执行超分处理。单位为 px。
LongMin	Integer	否	`300`	执行超分处理的长边范围最小值，仅当满足图像边界输入的图像执行超分处理。单位为 px。
LongMax	Integer	否	`800`	执行超分处理的长边范围最大值，仅当满足图像边界输入的图像执行超分处理。单位为 px。
EnableDownsample	Boolean	否	`true`	是否开启下采样，即图片在执行增强效果的同时可自定义输出图片分辨率大小。取值如下所示： `true`：开启。仅当开启后，下述下采样配置才会生效。 `false`：（默认）关闭。说明适用于 8000 x 8000 以内分辨率图像的画质增强。
DownsampleOutWidth	Integer	否	`10`	下采样输出图片宽度，图片将适配对应大小。单位为 px。
DownsampleOutHeight	Integer	否	`10`	下采样输出图片高度，图片将适配对应大小。单位为 px。
DownsampleMode	Integer	否	`1`	下采样模式，取值如下所示： `0`: 仅缩小，图片大于设置的“宽/高”时，将缩小图片 `1`: 仅放大，图片小于设置的“宽/高”时，将放大图片 `2`: 既缩小又放大，即按照自定义“宽/高”输出结果图，该操作可能导致图片变形
EnableTextEnhance	Boolean	否	`false`	是否使用文字增强，取值如下所示： `false`：（默认）不使用 `true`：使用
TextEnhanceStrength	Float	否	`0.5`	文字增强强度，取值范围[0,1]，默认值为 0.5。取值越大文字增强效果越强，但也更容易出现白边、色偏、对比度增大、非 CG 文字与背景产生割裂感等问题。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ResUri	String	`tos-i-v0***bf/a957dcc7cb89b0a4e2889466f2fdc9d7`	结果图 URI。您可使用结果图 URI（即 `ResUri`）拼接完整访问 URL 后，在浏览器查看图像增强效果。

请求示例

POST https://imagex.volcengineapi.com/?Action=GetComprehensiveEnhanceImage&Version=2023-05-01&ServiceId=i2****hg
{
    "ServiceId": "i2****hg",
    "ImageUri": "tos-example/7a7979974.jpeg",
    "Mode": 0,
    "EnableConfig": true,
    "ArStrength": 0,
    "DeblurStrength": 0,
    "DenoiseStrength": 0,
    "EnableSuperResolution": true,
    "Multiple": 2,
    "ShortMin": 200,
    "ShortMax": 700,
    "LongMin": 300,
    "LongMax": 800,
    "EnableDownsample": true,
    "DownsampleOutWidth": 10,
    "DownsampleOutHeight": 10,
    "DownsampleMode": 1,
    "Saturation": 1.5,
    "Brightness": 95,
    "EnableTextEnhance": true,
    "TextEnhanceStrength": 0.5
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetComprehensiveEnhanceImage",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "ResUri": "tos-i-v0***bf/a957dcc7cb89b0a4e2889466f2fdc9d7"
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

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