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

使用图像降噪获取结果图

最近更新时间2023.06.12 10:24:23

首次发布时间2022.10.12 11:42:27

本接口支持通过指定服务 ID 以及降噪配置,获取降噪结果图。

请求说明

  • 接口名称:GetDenoisingImage
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=GetDenoisingImage&Version=2018-08-01

说明

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

请求参数

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

Query

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

ServiceId

String

服务 ID。

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

Body

参数类型是否必填描述

StoreUri

String

待降噪的原图 URI。
若同时传入 StoreUri 和 ImageUrl,仅取值 StoreUri,ImageUrl 将会被忽略。

ImageUrlString公网可访问的待降噪的原图 URL。
OutFormatString输出格式,支持格式有:png、jpeg、webp。
IntensityFloat降噪强度,取值范围为[0,1]。取值为0时表示不降噪,取值越大降噪强度越大。

CanDemotion

Bool

是否支持降级,即发生错误时返回原图地址。
传入 StoreUri 则返回 StoreUri,传入 ImageUrl 则返回 ImageUrl。
取值如下所示:

  • true:支持降级
  • false:不支持降级

返回参数

参数类型描述
ResUriString降噪后的图片地址,根据输入时的地址决定返回值。

Demotion

Bool

是否发生降级,取值如下所示:

  • true:降级
  • false:未降级

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetDenoisingImage&Version=2018-08-01&ServiceId=xx
{
    "StoreUri":"tos-i-t3***nr/0866d.jpg",
    "ImageUrl":"http://test/tos-i-t3***nr/0866d.jpg~tplv-t3**nr-1.png",
    "OutFormat":"webp",
    "Intensity": 0.9,
    "Demotion": true

}

正常返回示例

{
	"ResponseMetadata":{
			"RequestId": "201806041104200100100232280022D30",
			"Action": "GetDenoisingImage",
			"Version": "2018-08-01",
			"Service": "imagex",
			"Region": "cn-north-1"
    },
			"Result": {
					"Uri": "tos-i-t3**nr/bedd9",
					"Demotion": false
    }
}

异常返回示例

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

错误码

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

服务端 SDK

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