Package org.springframework.ai.google.genai.image

Class GoogleGenAiImageOptions

java.lang.Object

org.springframework.ai.google.genai.image.GoogleGenAiImageOptions

All Implemented Interfaces:

org.springframework.ai.image.ImageOptions, org.springframework.ai.model.ModelOptions

public class GoogleGenAiImageOptions
extends Object
implements org.springframework.ai.image.ImageOptions

Options for the Image supported by the GenAI SDK

Since:

2.0.1

Author:

Olivier Le Quellec

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GoogleGenAiImageOptions.Builder
static enum	GoogleGenAiImageOptions.PersonGeneration
static enum	GoogleGenAiImageOptions.SafetyFilterLevel

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MODEL_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GoogleGenAiImageOptions(@Nullable String model, @Nullable Integer n, @Nullable String aspectRatio, @Nullable Integer seed, @Nullable GoogleGenAiImageOptions.SafetyFilterLevel safetyFilterLevel, @Nullable GoogleGenAiImageOptions.PersonGeneration personGeneration, @Nullable String outputMimeType, @Nullable Integer outputCompressionQuality, @Nullable Map<String,String> labels, @Nullable String imageSize, @Nullable Float temperature, @Nullable Float topP, @Nullable Float topK, @Nullable Integer maxOutputTokens)

Method Summary

Modifier and Type	Method	Description
static GoogleGenAiImageOptions.Builder	builder()
boolean	equals(@Nullable Object o)
@Nullable String	getAspectRatio()
@Nullable Integer	getHeight()	Image height is not directly configurable Use getAspectRatio() or getImageSize() instead.
@Nullable String	getImageSize()
@Nullable Map<String,String>	getLabels()
@Nullable Integer	getMaxOutputTokens()
@Nullable String	getModel()
@Nullable Integer	getN()
@Nullable Integer	getOutputCompressionQuality()
@Nullable String	getOutputMimeType()
@Nullable GoogleGenAiImageOptions.PersonGeneration	getPersonGeneration()
@Nullable String	getResponseFormat()
@Nullable GoogleGenAiImageOptions.SafetyFilterLevel	getSafetyFilterLevel()
@Nullable Integer	getSeed()
@Nullable String	getStyle()
@Nullable Float	getTemperature()
@Nullable Float	getTopK()
@Nullable Float	getTopP()
@Nullable Integer	getWidth()	Image width is not directly configurable Use getAspectRatio() or getImageSize() instead.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MODEL_NAME

public static final String DEFAULT_MODEL_NAME

Constructor Details

GoogleGenAiImageOptions

protected GoogleGenAiImageOptions(@Nullable String model,
 @Nullable Integer n,
 @Nullable String aspectRatio,
 @Nullable Integer seed,
 @Nullable GoogleGenAiImageOptions.SafetyFilterLevel safetyFilterLevel,
 @Nullable GoogleGenAiImageOptions.PersonGeneration personGeneration,
 @Nullable String outputMimeType,
 @Nullable Integer outputCompressionQuality,
 @Nullable Map<String,String> labels,
 @Nullable String imageSize,
 @Nullable Float temperature,
 @Nullable Float topP,
 @Nullable Float topK,
 @Nullable Integer maxOutputTokens)

Method Details

builder

public static GoogleGenAiImageOptions.Builder builder()

getModel

public @Nullable String getModel()

Specified by:

getModel in interface org.springframework.ai.image.ImageOptions

getN

public @Nullable Integer getN()

Specified by:

getN in interface org.springframework.ai.image.ImageOptions

getWidth

public @Nullable Integer getWidth()

Image width is not directly configurable Use getAspectRatio() or getImageSize() instead.

Specified by:

getWidth in interface org.springframework.ai.image.ImageOptions

Returns:

always null

getHeight

public @Nullable Integer getHeight()

Image height is not directly configurable Use getAspectRatio() or getImageSize() instead.

Specified by:

getHeight in interface org.springframework.ai.image.ImageOptions

Returns:

always null

getResponseFormat

public @Nullable String getResponseFormat()

Specified by:

getResponseFormat in interface org.springframework.ai.image.ImageOptions

getStyle

public @Nullable String getStyle()

Specified by:

getStyle in interface org.springframework.ai.image.ImageOptions

getAspectRatio

public @Nullable String getAspectRatio()

getSeed

public @Nullable Integer getSeed()

getSafetyFilterLevel

public @Nullable GoogleGenAiImageOptions.SafetyFilterLevel getSafetyFilterLevel()

getPersonGeneration

public @Nullable GoogleGenAiImageOptions.PersonGeneration getPersonGeneration()

getOutputMimeType

public @Nullable String getOutputMimeType()

getOutputCompressionQuality

public @Nullable Integer getOutputCompressionQuality()

getLabels

public @Nullable Map<String,String> getLabels()

getImageSize

public @Nullable String getImageSize()

getTemperature

public @Nullable Float getTemperature()

getTopP

public @Nullable Float getTopP()

getTopK

public @Nullable Float getTopK()

getMaxOutputTokens

public @Nullable Integer getMaxOutputTokens()

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object