文档中心

使用综合增强获取结果图

最近更新时间：2023.11.10 14:53:39

首次发布时间：2023.05.25 17:12:10

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

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 20 秒。

请求说明

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

说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`i2****hg`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
ImageUri	String	是	`tos-example/7a7979974.jpeg`	图片存储 URI 或访问 URL。图片 URI 格式，例如：tos-example/7a7979974.jpeg 图片 URL 格式，可公网访问。例如：https://example.org/tos-example/7a7979974.jpeg~tplv.png
Mode	Integer	是	`0`	优化策略，取值如下所示： `0`：通用画质提升 `1`：显著画质提升说明推荐优先使用通用方案，显著画质提升方案画质分提高 10% 左右，但体积会有一定浮动提升。以上幅度变化基于测试集总结，具体以使用场景为准。
EnableConfig	Boolean	否	`true`	内是否启用高级配置，取值如下所示： `true`：开启。开启后，下述高级配置才会生效。 `false`：（默认）关闭。说明适用于 8000 x 8000 以分辨率图像的画质增强。
ArStrength	Float	否	`0.20`	去压缩失真强度，取值范围为[0,1]。取值为`0`时表示不处理，取值越大去压缩失真强度越大。
DeblurStrength	Float	否	`0.20`	去模糊强度，取值范围为[0,1]。取值为`0`时表示不处理，取值越大去模糊强度越大。
DenoiseStrength	Float	否	`0.30`	降噪强度，取值范围为[0,1]。取值为`0`时表示不降噪，取值越大降噪强度越大。
Saturation	Float	否	`1.5`	饱和度，取值范围为[0,2]。取值大于 `1` 表示提升饱和度，取值小于 `1` 表示降低饱和度。
Brightness	Integer	否	`95`	亮度，取值范围为[90,100]。取值越小，亮度提升越明显。
EnableSuperResolution	Boolean	否	`true`	是否开启超分配置，仅满足图像输入边界的图像执行超分处理。取值如下所示： `true`：开启。仅当开启后，下述超分配置才会生效。 `false`：（默认）关闭。说明适用于 8000 x 8000 以内分辨率图像的画质增强。
Multiple	Integer	否	`2`	超分倍率，仅支持 2 倍和 4 倍。说明 4 倍超分辨率只适用于 4000 x 4000 以内分辨率图像的画质增强。
ShortMin	Integer	否	`200`	执行超分处理的短边范围最小值，仅当满足图像边界输入的图像执行超分处理。单位为 px。
ShortMax	Integer	否	`700`	执行超分处理的短边范围最大值，仅当满足图像边界输入的图像执行超分处理。单位为 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`: 既缩小又放大，即按照自定义“宽/高”输出结果图，该操作可能导致图片变形

返回参数

参数	类型	示例值	描述
ResUri	String	`tos-i-v0***bf/a957dcc7cb89b0a4e2889466f2fdc9d7`	结果图地址

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetComprehensiveEnhanceImage&Version=2018-08-01
{
    "ServiceId": "v0***bf",
    "ImageUri": "tos-example/7a7979974.jpeg",
    "Mode": 0,
    "EnableConfig": true,
    "ArStrength": 0.20，
    "DeblurStrength": 0.30,
    "DenoiseStrength": 0.40,
    "EnableSuperResolution": true,
    "Multiple": 2,
    "ShortMin": 300,
    "ShortMax": 700,
    "LongMin": 400,
    "LongMax": 800,
    "EnableDownsample": true,
    "DownsampleOutWidth": 800,
    "DownsampleOutHeight": 1000,
    "DownsampleMode": 0
}

返回示例

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

错误码

访问公共错误码和域名相关错误码获取详细信息。

注意事项

请求说明

请求参数

Query

Body

返回参数

示例

请求示例

返回示例

错误码