com.tencentcloudapi.aiart.v20221229.models

Class ImageToImageRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.aiart.v20221229.models.ImageToImageRequest

public class ImageToImageRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ImageToImageRequest()
ImageToImageRequest(ImageToImageRequest 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
Long	getEnhanceImage() Get Switch indicating whether to enhance image clarity.
String	getInputImage() Get Base64 code of the input mage.
String	getInputUrl() Get URL of the input mage.
Long	getLogoAdd() Get Switch indicating whether to add a logo to the generated image.
LogoParam	getLogoParam() Get Logo content settings.
String	getNegativePrompt() Get Negative text description.
String	getPrompt() Get Text description.
Long	getRestoreFace() Get Maximum number of faces for detail restoration.
ResultConfig	getResultConfig() Get Configurations of the generated image, including the resolution.
String	getRspImgType() Get Image return method (base64 or url).
Float	getStrength() Get Generation strength.
String[]	getStyles() Get Image style.
void	setEnhanceImage(Long EnhanceImage) Set Switch indicating whether to enhance image clarity.
void	setInputImage(String InputImage) Set Base64 code of the input mage.
void	setInputUrl(String InputUrl) Set URL of the input mage.
void	setLogoAdd(Long LogoAdd) Set Switch indicating whether to add a logo to the generated image.
void	setLogoParam(LogoParam LogoParam) Set Logo content settings.
void	setNegativePrompt(String NegativePrompt) Set Negative text description.
void	setPrompt(String Prompt) Set Text description.
void	setRestoreFace(Long RestoreFace) Set Maximum number of faces for detail restoration.
void	setResultConfig(ResultConfig ResultConfig) Set Configurations of the generated image, including the resolution.
void	setRspImgType(String RspImgType) Set Image return method (base64 or url).
void	setStrength(Float Strength) Set Generation strength.
void	setStyles(String[] Styles) Set Image style.
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, 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

ImageToImageRequest

public ImageToImageRequest()

ImageToImageRequest

public ImageToImageRequest(ImageToImageRequest 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

getInputImage

public String getInputImage()

Get Base64 code of the input mage. Either the Base64 code or URL must be provided. If both are provided, URL prevails. Image restrictions: The single-edge resolution must be less than 5,000 and greater than 50, and the size after Base64 encoding must be less than 8 MB. Supported formats include JPG, JPEG, PNG, BMP, TIFF and WEBP.

Returns:

InputImage Base64 code of the input mage. Either the Base64 code or URL must be provided. If both are provided, URL prevails. Image restrictions: The single-edge resolution must be less than 5,000 and greater than 50, and the size after Base64 encoding must be less than 8 MB. Supported formats include JPG, JPEG, PNG, BMP, TIFF and WEBP.

setInputImage

public void setInputImage(String InputImage)

Set Base64 code of the input mage. Either the Base64 code or URL must be provided. If both are provided, URL prevails. Image restrictions: The single-edge resolution must be less than 5,000 and greater than 50, and the size after Base64 encoding must be less than 8 MB. Supported formats include JPG, JPEG, PNG, BMP, TIFF and WEBP.

Parameters:

InputImage - Base64 code of the input mage. Either the Base64 code or URL must be provided. If both are provided, URL prevails. Image restrictions: The single-edge resolution must be less than 5,000 and greater than 50, and the size after Base64 encoding must be less than 8 MB. Supported formats include JPG, JPEG, PNG, BMP, TIFF and WEBP.

getInputUrl

public String getInputUrl()

Get URL of the input mage. Either the Base64 code or URL must be provided. If both are provided, URL prevails. Image restrictions: The single-edge resolution must be less than 5,000 and greater than 50, and the size after Base64 encoding must be less than 8 MB. Supported formats include JPG, JPEG, PNG, BMP, TIFF and WEBP.

Returns:

InputUrl URL of the input mage. Either the Base64 code or URL must be provided. If both are provided, URL prevails. Image restrictions: The single-edge resolution must be less than 5,000 and greater than 50, and the size after Base64 encoding must be less than 8 MB. Supported formats include JPG, JPEG, PNG, BMP, TIFF and WEBP.

setInputUrl

public void setInputUrl(String InputUrl)

Set URL of the input mage. Either the Base64 code or URL must be provided. If both are provided, URL prevails. Image restrictions: The single-edge resolution must be less than 5,000 and greater than 50, and the size after Base64 encoding must be less than 8 MB. Supported formats include JPG, JPEG, PNG, BMP, TIFF and WEBP.

Parameters:

InputUrl - URL of the input mage. Either the Base64 code or URL must be provided. If both are provided, URL prevails. Image restrictions: The single-edge resolution must be less than 5,000 and greater than 50, and the size after Base64 encoding must be less than 8 MB. Supported formats include JPG, JPEG, PNG, BMP, TIFF and WEBP.

getPrompt

public String getPrompt()

Get Text description. It is used to increase the possibility that the generation result contains the described content. A maximum of 256 UTF-8 characters are supported.

Returns:

Prompt Text description. It is used to increase the possibility that the generation result contains the described content. A maximum of 256 UTF-8 characters are supported.

setPrompt

public void setPrompt(String Prompt)

Set Text description. It is used to increase the possibility that the generation result contains the described content. A maximum of 256 UTF-8 characters are supported.

Parameters:

Prompt - Text description. It is used to increase the possibility that the generation result contains the described content. A maximum of 256 UTF-8 characters are supported.

getNegativePrompt

public String getNegativePrompt()

Get Negative text description. It is used to reduce the possibility that the generation result contains the described content, but such content cannot be completely avoided. English is recommended. A maximum of 256 UTF-8 characters are supported.

Returns:

NegativePrompt Negative text description. It is used to reduce the possibility that the generation result contains the described content, but such content cannot be completely avoided. English is recommended. A maximum of 256 UTF-8 characters are supported.

setNegativePrompt

public void setNegativePrompt(String NegativePrompt)

Set Negative text description. It is used to reduce the possibility that the generation result contains the described content, but such content cannot be completely avoided. English is recommended. A maximum of 256 UTF-8 characters are supported.

Parameters:

NegativePrompt - Negative text description. It is used to reduce the possibility that the generation result contains the described content, but such content cannot be completely avoided. English is recommended. A maximum of 256 UTF-8 characters are supported.

getStyles

public String[] getStyles()

Get Image style. Select the desired style from the [Image Style List](https://intl.cloud.tencent.com/document/product/1668/86250?from_cn_redirect=1) and enter the style number. It is recommended to use only one style. If no style is specified, 201 (anime style) is used by default.

Returns:

Styles Image style. Select the desired style from the [Image Style List](https://intl.cloud.tencent.com/document/product/1668/86250?from_cn_redirect=1) and enter the style number. It is recommended to use only one style. If no style is specified, 201 (anime style) is used by default.

setStyles

public void setStyles(String[] Styles)

Set Image style. Select the desired style from the [Image Style List](https://intl.cloud.tencent.com/document/product/1668/86250?from_cn_redirect=1) and enter the style number. It is recommended to use only one style. If no style is specified, 201 (anime style) is used by default.

Parameters:

Styles - Image style. Select the desired style from the [Image Style List](https://intl.cloud.tencent.com/document/product/1668/86250?from_cn_redirect=1) and enter the style number. It is recommended to use only one style. If no style is specified, 201 (anime style) is used by default.

getResultConfig

public ResultConfig getResultConfig()

Get Configurations of the generated image, including the resolution. Images with the following resolutions can be generated: origin (The resolution is the same as the input image resolution, with the edge resolution of up to 2000. The image will be zoomed out proportionally if the resolution is exceeded.), 768:768 (1:1), 768:1024 (3:4), and 1024:768 (4:3). If the resolution is not specified, origin is used by default.

Returns:

ResultConfig Configurations of the generated image, including the resolution. Images with the following resolutions can be generated: origin (The resolution is the same as the input image resolution, with the edge resolution of up to 2000. The image will be zoomed out proportionally if the resolution is exceeded.), 768:768 (1:1), 768:1024 (3:4), and 1024:768 (4:3). If the resolution is not specified, origin is used by default.

setResultConfig

public void setResultConfig(ResultConfig ResultConfig)

Set Configurations of the generated image, including the resolution. Images with the following resolutions can be generated: origin (The resolution is the same as the input image resolution, with the edge resolution of up to 2000. The image will be zoomed out proportionally if the resolution is exceeded.), 768:768 (1:1), 768:1024 (3:4), and 1024:768 (4:3). If the resolution is not specified, origin is used by default.

Parameters:

ResultConfig - Configurations of the generated image, including the resolution. Images with the following resolutions can be generated: origin (The resolution is the same as the input image resolution, with the edge resolution of up to 2000. The image will be zoomed out proportionally if the resolution is exceeded.), 768:768 (1:1), 768:1024 (3:4), and 1024:768 (4:3). If the resolution is not specified, origin is used by default.

getLogoAdd

public Long getLogoAdd()

Get Switch indicating whether to add a logo to the generated image. Default value: 1. 1: add logo 0: do not add logo Other values: add logo It is recommended to use an obvious logo to indicate that the image result is generated by AI.

Returns:

LogoAdd Switch indicating whether to add a logo to the generated image. Default value: 1. 1: add logo 0: do not add logo Other values: add logo It is recommended to use an obvious logo to indicate that the image result is generated by AI.

setLogoAdd

public void setLogoAdd(Long LogoAdd)

Set Switch indicating whether to add a logo to the generated image. Default value: 1. 1: add logo 0: do not add logo Other values: add logo It is recommended to use an obvious logo to indicate that the image result is generated by AI.

Parameters:

LogoAdd - Switch indicating whether to add a logo to the generated image. Default value: 1. 1: add logo 0: do not add logo Other values: add logo It is recommended to use an obvious logo to indicate that the image result is generated by AI.

getLogoParam

public LogoParam getLogoParam()

Get Logo content settings. By default, the text "Generated by AI" is added to the bottom right corner of the generated image. You can also use other logo.

Returns:

LogoParam Logo content settings. By default, the text "Generated by AI" is added to the bottom right corner of the generated image. You can also use other logo.

setLogoParam

public void setLogoParam(LogoParam LogoParam)

Set Logo content settings. By default, the text "Generated by AI" is added to the bottom right corner of the generated image. You can also use other logo.

Parameters:

LogoParam - Logo content settings. By default, the text "Generated by AI" is added to the bottom right corner of the generated image. You can also use other logo.

getStrength

public Float getStrength()

Get Generation strength. The smaller the strength value, the more the generated image resembles the original image. Value range: (0, 1]. If the strength is not specified, the default value of the model is used. The recommended value range is 0.6 to 0.8.

Returns:

Strength Generation strength. The smaller the strength value, the more the generated image resembles the original image. Value range: (0, 1]. If the strength is not specified, the default value of the model is used. The recommended value range is 0.6 to 0.8.

setStrength

public void setStrength(Float Strength)

Set Generation strength. The smaller the strength value, the more the generated image resembles the original image. Value range: (0, 1]. If the strength is not specified, the default value of the model is used. The recommended value range is 0.6 to 0.8.

Parameters:

Strength - Generation strength. The smaller the strength value, the more the generated image resembles the original image. Value range: (0, 1]. If the strength is not specified, the default value of the model is used. The recommended value range is 0.6 to 0.8.

getRspImgType

public String getRspImgType()

Get Image return method (base64 or url). You can specify only one method. Default value: base64. The URL is valid for 1 hour.

Returns:

RspImgType Image return method (base64 or url). You can specify only one method. Default value: base64. The URL is valid for 1 hour.

setRspImgType

public void setRspImgType(String RspImgType)

Set Image return method (base64 or url). You can specify only one method. Default value: base64. The URL is valid for 1 hour.

Parameters:

RspImgType - Image return method (base64 or url). You can specify only one method. Default value: base64. The URL is valid for 1 hour.

getEnhanceImage

public Long getEnhanceImage()

Get Switch indicating whether to enhance image clarity. Default value: 0. 1: on 0: off If the switch is turned on, the image clarity will be enhanced and the generation time will increase.

Returns:

EnhanceImage Switch indicating whether to enhance image clarity. Default value: 0. 1: on 0: off If the switch is turned on, the image clarity will be enhanced and the generation time will increase.

setEnhanceImage

public void setEnhanceImage(Long EnhanceImage)

Set Switch indicating whether to enhance image clarity. Default value: 0. 1: on 0: off If the switch is turned on, the image clarity will be enhanced and the generation time will increase.

Parameters:

EnhanceImage - Switch indicating whether to enhance image clarity. Default value: 0. 1: on 0: off If the switch is turned on, the image clarity will be enhanced and the generation time will increase.

getRestoreFace

public Long getRestoreFace()

Get Maximum number of faces for detail restoration. Value range: 0 - 6. Default value: 0. If the input value is greater than 0, the value will be used as the maximum number of faces with a small area can be restored in each image. The generation time will increase according to the actual number of faces restored.

Returns:

RestoreFace Maximum number of faces for detail restoration. Value range: 0 - 6. Default value: 0. If the input value is greater than 0, the value will be used as the maximum number of faces with a small area can be restored in each image. The generation time will increase according to the actual number of faces restored.

setRestoreFace

public void setRestoreFace(Long RestoreFace)

Set Maximum number of faces for detail restoration. Value range: 0 - 6. Default value: 0. If the input value is greater than 0, the value will be used as the maximum number of faces with a small area can be restored in each image. The generation time will increase according to the actual number of faces restored.

Parameters:

RestoreFace - Maximum number of faces for detail restoration. Value range: 0 - 6. Default value: 0. If the input value is greater than 0, the value will be used as the maximum number of faces with a small area can be restored in each image. The generation time will increase according to the actual number of faces restored.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel