com.tencentcloudapi.aiart.v20221229.models

Class ReplaceBackgroundRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.aiart.v20221229.models.ReplaceBackgroundRequest

public class ReplaceBackgroundRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ReplaceBackgroundRequest()
ReplaceBackgroundRequest(ReplaceBackgroundRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getBackgroundTemplate() Get 背景模板。 仅当 Prompt = "BackgroundTemplate" 时生效，可支持的模板详见 [商品背景模板列表](https://cloud.tencent.com/document/product/1668/115391) ，请传入字段“背景名称”中的值。
Long	getLogoAdd() Get 为生成结果图添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。
LogoParam	getLogoParam() Get 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。
String	getMaskUrl() Get 商品 Mask 图 Url，要求背景透明，保留商品主体。 如果不传，将自动使用内置的商品分割算法得到 Mask。 支持自定义上传 Mask，如果该参数不为空，则以实际上传的数据为准。 图片限制：Mask 图必须和商品原图分辨率一致，转成 Base64 字符串后小于 6MB，格式仅支持 png。
String	getNegativePrompt() Get 反向提示词。 最多支持256个 utf-8 字符，支持中、英文。
String	getProduct() Get 商品图中的商品主体名称。 最多支持50个 utf-8 字符，支持中、英文。 建议说明商品主体，否则影响生成效果。
String	getProductUrl() Get 商品原图 Url。 图片限制：单边分辨率小于4000，长宽比在2:5 ~ 5:2之间，转成 Base64 字符串后小于 6MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。
String	getPrompt() Get 对新背景的文本描述。 最多支持256个 utf-8 字符，支持中、英文。 如果 Prompt = "BackgroundTemplate" 代表启用背景模板，需要在参数 BackgroundTemplate 中指定一个背景名称。
String	getResolution() Get 替换背景后生成的商品图分辨率。 支持生成单边分辨率大于500且小于4000、长宽比在2:5 ~ 5:2之间的图片，不传默认生成1280:1280。 建议图片比例为1:1、9:16、16:9，生成效果更佳，使用其他比例的生成效果可能不如建议比例。
String	getRspImgType() Get 返回图像方式（base64 或 url) ，二选一，默认为 base64。url 有效期为1小时。 生成图分辨率较大时建议选择 url，使用 base64 可能因图片过大导致返回失败。
void	setBackgroundTemplate(String BackgroundTemplate) Set 背景模板。 仅当 Prompt = "BackgroundTemplate" 时生效，可支持的模板详见 [商品背景模板列表](https://cloud.tencent.com/document/product/1668/115391) ，请传入字段“背景名称”中的值。
void	setLogoAdd(Long LogoAdd) Set 为生成结果图添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。
void	setLogoParam(LogoParam LogoParam) Set 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。
void	setMaskUrl(String MaskUrl) Set 商品 Mask 图 Url，要求背景透明，保留商品主体。 如果不传，将自动使用内置的商品分割算法得到 Mask。 支持自定义上传 Mask，如果该参数不为空，则以实际上传的数据为准。 图片限制：Mask 图必须和商品原图分辨率一致，转成 Base64 字符串后小于 6MB，格式仅支持 png。
void	setNegativePrompt(String NegativePrompt) Set 反向提示词。 最多支持256个 utf-8 字符，支持中、英文。
void	setProduct(String Product) Set 商品图中的商品主体名称。 最多支持50个 utf-8 字符，支持中、英文。 建议说明商品主体，否则影响生成效果。
void	setProductUrl(String ProductUrl) Set 商品原图 Url。 图片限制：单边分辨率小于4000，长宽比在2:5 ~ 5:2之间，转成 Base64 字符串后小于 6MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。
void	setPrompt(String Prompt) Set 对新背景的文本描述。 最多支持256个 utf-8 字符，支持中、英文。 如果 Prompt = "BackgroundTemplate" 代表启用背景模板，需要在参数 BackgroundTemplate 中指定一个背景名称。
void	setResolution(String Resolution) Set 替换背景后生成的商品图分辨率。 支持生成单边分辨率大于500且小于4000、长宽比在2:5 ~ 5:2之间的图片，不传默认生成1280:1280。 建议图片比例为1:1、9:16、16:9，生成效果更佳，使用其他比例的生成效果可能不如建议比例。
void	setRspImgType(String RspImgType) Set 返回图像方式（base64 或 url) ，二选一，默认为 base64。url 有效期为1小时。 生成图分辨率较大时建议选择 url，使用 base64 可能因图片过大导致返回失败。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReplaceBackgroundRequest

public ReplaceBackgroundRequest()

ReplaceBackgroundRequest

public ReplaceBackgroundRequest(ReplaceBackgroundRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getProductUrl

public String getProductUrl()

Get 商品原图 Url。 图片限制：单边分辨率小于4000，长宽比在2:5 ~ 5:2之间，转成 Base64 字符串后小于 6MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。

Returns:

ProductUrl 商品原图 Url。 图片限制：单边分辨率小于4000，长宽比在2:5 ~ 5:2之间，转成 Base64 字符串后小于 6MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。

setProductUrl

public void setProductUrl(String ProductUrl)

Set 商品原图 Url。 图片限制：单边分辨率小于4000，长宽比在2:5 ~ 5:2之间，转成 Base64 字符串后小于 6MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。

Parameters:

ProductUrl - 商品原图 Url。 图片限制：单边分辨率小于4000，长宽比在2:5 ~ 5:2之间，转成 Base64 字符串后小于 6MB，格式支持 jpg、jpeg、png、bmp、tiff、webp。

getPrompt

public String getPrompt()

Get 对新背景的文本描述。 最多支持256个 utf-8 字符，支持中、英文。 如果 Prompt = "BackgroundTemplate" 代表启用背景模板，需要在参数 BackgroundTemplate 中指定一个背景名称。

Returns:

Prompt 对新背景的文本描述。 最多支持256个 utf-8 字符，支持中、英文。 如果 Prompt = "BackgroundTemplate" 代表启用背景模板，需要在参数 BackgroundTemplate 中指定一个背景名称。

setPrompt

public void setPrompt(String Prompt)

Set 对新背景的文本描述。 最多支持256个 utf-8 字符，支持中、英文。 如果 Prompt = "BackgroundTemplate" 代表启用背景模板，需要在参数 BackgroundTemplate 中指定一个背景名称。

Parameters:

Prompt - 对新背景的文本描述。 最多支持256个 utf-8 字符，支持中、英文。 如果 Prompt = "BackgroundTemplate" 代表启用背景模板，需要在参数 BackgroundTemplate 中指定一个背景名称。

getNegativePrompt

public String getNegativePrompt()

Get 反向提示词。 最多支持256个 utf-8 字符，支持中、英文。

Returns:

NegativePrompt 反向提示词。 最多支持256个 utf-8 字符，支持中、英文。

setNegativePrompt

public void setNegativePrompt(String NegativePrompt)

Set 反向提示词。 最多支持256个 utf-8 字符，支持中、英文。

Parameters:

NegativePrompt - 反向提示词。 最多支持256个 utf-8 字符，支持中、英文。

getProduct

public String getProduct()

Get 商品图中的商品主体名称。 最多支持50个 utf-8 字符，支持中、英文。 建议说明商品主体，否则影响生成效果。

Returns:

Product 商品图中的商品主体名称。 最多支持50个 utf-8 字符，支持中、英文。 建议说明商品主体，否则影响生成效果。

setProduct

public void setProduct(String Product)

Set 商品图中的商品主体名称。 最多支持50个 utf-8 字符，支持中、英文。 建议说明商品主体，否则影响生成效果。

Parameters:

Product - 商品图中的商品主体名称。 最多支持50个 utf-8 字符，支持中、英文。 建议说明商品主体，否则影响生成效果。

getBackgroundTemplate

public String getBackgroundTemplate()

Get 背景模板。 仅当 Prompt = "BackgroundTemplate" 时生效，可支持的模板详见 [商品背景模板列表](https://cloud.tencent.com/document/product/1668/115391) ，请传入字段“背景名称”中的值。

Returns:

BackgroundTemplate 背景模板。 仅当 Prompt = "BackgroundTemplate" 时生效，可支持的模板详见 [商品背景模板列表](https://cloud.tencent.com/document/product/1668/115391) ，请传入字段“背景名称”中的值。

setBackgroundTemplate

public void setBackgroundTemplate(String BackgroundTemplate)

Set 背景模板。 仅当 Prompt = "BackgroundTemplate" 时生效，可支持的模板详见 [商品背景模板列表](https://cloud.tencent.com/document/product/1668/115391) ，请传入字段“背景名称”中的值。

Parameters:

BackgroundTemplate - 背景模板。 仅当 Prompt = "BackgroundTemplate" 时生效，可支持的模板详见 [商品背景模板列表](https://cloud.tencent.com/document/product/1668/115391) ，请传入字段“背景名称”中的值。

getMaskUrl

public String getMaskUrl()

Get 商品 Mask 图 Url，要求背景透明，保留商品主体。 如果不传，将自动使用内置的商品分割算法得到 Mask。 支持自定义上传 Mask，如果该参数不为空，则以实际上传的数据为准。 图片限制：Mask 图必须和商品原图分辨率一致，转成 Base64 字符串后小于 6MB，格式仅支持 png。

Returns:

MaskUrl 商品 Mask 图 Url，要求背景透明，保留商品主体。 如果不传，将自动使用内置的商品分割算法得到 Mask。 支持自定义上传 Mask，如果该参数不为空，则以实际上传的数据为准。 图片限制：Mask 图必须和商品原图分辨率一致，转成 Base64 字符串后小于 6MB，格式仅支持 png。

setMaskUrl

public void setMaskUrl(String MaskUrl)

Set 商品 Mask 图 Url，要求背景透明，保留商品主体。 如果不传，将自动使用内置的商品分割算法得到 Mask。 支持自定义上传 Mask，如果该参数不为空，则以实际上传的数据为准。 图片限制：Mask 图必须和商品原图分辨率一致，转成 Base64 字符串后小于 6MB，格式仅支持 png。

Parameters:

MaskUrl - 商品 Mask 图 Url，要求背景透明，保留商品主体。 如果不传，将自动使用内置的商品分割算法得到 Mask。 支持自定义上传 Mask，如果该参数不为空，则以实际上传的数据为准。 图片限制：Mask 图必须和商品原图分辨率一致，转成 Base64 字符串后小于 6MB，格式仅支持 png。

getResolution

public String getResolution()

Get 替换背景后生成的商品图分辨率。 支持生成单边分辨率大于500且小于4000、长宽比在2:5 ~ 5:2之间的图片，不传默认生成1280:1280。 建议图片比例为1:1、9:16、16:9，生成效果更佳，使用其他比例的生成效果可能不如建议比例。

Returns:

Resolution 替换背景后生成的商品图分辨率。 支持生成单边分辨率大于500且小于4000、长宽比在2:5 ~ 5:2之间的图片，不传默认生成1280:1280。 建议图片比例为1:1、9:16、16:9，生成效果更佳，使用其他比例的生成效果可能不如建议比例。

setResolution

public void setResolution(String Resolution)

Set 替换背景后生成的商品图分辨率。 支持生成单边分辨率大于500且小于4000、长宽比在2:5 ~ 5:2之间的图片，不传默认生成1280:1280。 建议图片比例为1:1、9:16、16:9，生成效果更佳，使用其他比例的生成效果可能不如建议比例。

Parameters:

Resolution - 替换背景后生成的商品图分辨率。 支持生成单边分辨率大于500且小于4000、长宽比在2:5 ~ 5:2之间的图片，不传默认生成1280:1280。 建议图片比例为1:1、9:16、16:9，生成效果更佳，使用其他比例的生成效果可能不如建议比例。

getLogoAdd

public Long getLogoAdd()

Get 为生成结果图添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。

Returns:

LogoAdd 为生成结果图添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。

setLogoAdd

public void setLogoAdd(Long LogoAdd)

Set 为生成结果图添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。

Parameters:

LogoAdd - 为生成结果图添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示结果图是 AI 生成的图片。

getLogoParam

public LogoParam getLogoParam()

Get 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。

Returns:

LogoParam 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。

setLogoParam

public void setLogoParam(LogoParam LogoParam)

Set 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。

Parameters:

LogoParam - 标识内容设置。 默认在生成结果图右下角添加“图片由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。

getRspImgType

public String getRspImgType()

Get 返回图像方式（base64 或 url) ，二选一，默认为 base64。url 有效期为1小时。 生成图分辨率较大时建议选择 url，使用 base64 可能因图片过大导致返回失败。

Returns:

RspImgType 返回图像方式（base64 或 url) ，二选一，默认为 base64。url 有效期为1小时。 生成图分辨率较大时建议选择 url，使用 base64 可能因图片过大导致返回失败。

setRspImgType

public void setRspImgType(String RspImgType)

Set 返回图像方式（base64 或 url) ，二选一，默认为 base64。url 有效期为1小时。 生成图分辨率较大时建议选择 url，使用 base64 可能因图片过大导致返回失败。

Parameters:

RspImgType - 返回图像方式（base64 或 url) ，二选一，默认为 base64。url 有效期为1小时。 生成图分辨率较大时建议选择 url，使用 base64 可能因图片过大导致返回失败。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.