Package com.google.genai.types

Class UpscaleImageConfig

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.UpscaleImageConfig

public abstract class UpscaleImageConfig
extends JsonSerializable

Configuration for upscaling an image.

For more information on this configuration, refer to the `Imagen API reference documentation <https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/imagen-api>`_.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpscaleImageConfig.Builder	Builder for UpscaleImageConfig.

Constructor Summary

Constructors

Constructor	Description
UpscaleImageConfig()

Method Summary

Modifier and Type	Method	Description
static UpscaleImageConfig.Builder	builder()	Instantiates a builder for UpscaleImageConfig.
abstract Optional<Boolean>	enhanceInputImage()	Whether to add an image enhancing step before upscaling.
static UpscaleImageConfig	fromJson(String jsonString)	Deserializes a JSON string to a UpscaleImageConfig object.
abstract Optional<HttpOptions>	httpOptions()	Used to override HTTP request options.
abstract Optional<Float>	imagePreservationFactor()	With a higher image preservation factor, the original image pixels are more respected.
abstract Optional<Boolean>	includeRaiReason()	Whether to include a reason for filtered-out images in the response.
abstract Optional<Integer>	outputCompressionQuality()	The level of compression.
abstract Optional<String>	outputGcsUri()	Cloud Storage URI used to store the generated images.
abstract Optional<String>	outputMimeType()	The image format that the output should be saved as.
abstract UpscaleImageConfig.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

UpscaleImageConfig

public UpscaleImageConfig()

Method Details

httpOptions

public abstract Optional<HttpOptions> httpOptions()

Used to override HTTP request options.

outputGcsUri

public abstract Optional<String> outputGcsUri()

Cloud Storage URI used to store the generated images.

includeRaiReason

public abstract Optional<Boolean> includeRaiReason()

Whether to include a reason for filtered-out images in the response.

outputMimeType

public abstract Optional<String> outputMimeType()

The image format that the output should be saved as.

outputCompressionQuality

public abstract Optional<Integer> outputCompressionQuality()

The level of compression. Only applicable if the ``output_mime_type`` is ``image/jpeg``.

enhanceInputImage

public abstract Optional<Boolean> enhanceInputImage()

Whether to add an image enhancing step before upscaling. It is expected to suppress the noise and JPEG compression artifacts from the input image.

imagePreservationFactor

public abstract Optional<Float> imagePreservationFactor()

With a higher image preservation factor, the original image pixels are more respected. With a lower image preservation factor, the output image will have be more different from the input image, but with finer details and less noise.

builder

public static UpscaleImageConfig.Builder builder()

Instantiates a builder for UpscaleImageConfig.

toBuilder

public abstract UpscaleImageConfig.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static UpscaleImageConfig fromJson(String jsonString)

Deserializes a JSON string to a UpscaleImageConfig object.