Package com.google.genai.types

Class ImageConfig

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ImageConfig

public abstract class ImageConfig
extends JsonSerializable

The image generation configuration to be used in GenerateContentConfig.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ImageConfig()

Method Summary

Modifier and Type	Method	Description
abstract Optional<String>	aspectRatio()	Aspect ratio of the generated images.
static ImageConfig.Builder	builder()	Instantiates a builder for ImageConfig.
static ImageConfig	fromJson(String jsonString)	Deserializes a JSON string to a ImageConfig object.
abstract Optional<String>	imageSize()	Optional.
abstract Optional<Integer>	outputCompressionQuality()	Compression quality of the generated image (for ``image/jpeg`` only).
abstract Optional<String>	outputMimeType()	MIME type of the generated image.
abstract ImageConfig.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

setMaxReadLength, stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

ImageConfig

public ImageConfig()

Method Details

aspectRatio

public abstract Optional<String> aspectRatio()

Aspect ratio of the generated images. Supported values are "1:1", "2:3", "3:2", "3:4", "4:3", "9:16", "16:9", and "21:9".

imageSize

public abstract Optional<String> imageSize()

Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.

outputMimeType

public abstract Optional<String> outputMimeType()

MIME type of the generated image. This field is not supported in Gemini API.

outputCompressionQuality

public abstract Optional<Integer> outputCompressionQuality()

Compression quality of the generated image (for ``image/jpeg`` only). This field is not supported in Gemini API.

builder

public static ImageConfig.Builder builder()

Instantiates a builder for ImageConfig.

toBuilder

public abstract ImageConfig.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ImageConfig fromJson(String jsonString)

Deserializes a JSON string to a ImageConfig object.