Package org.springframework.ai.openai

Class OpenAiImageOptions

java.lang.Object

org.springframework.ai.openai.AbstractOpenAiOptions

org.springframework.ai.openai.OpenAiImageOptions

All Implemented Interfaces:

ImageOptions, ModelOptions

public class OpenAiImageOptions
extends AbstractOpenAiOptions
implements ImageOptions

Configuration information for the Image Model implementation using the OpenAI Java SDK.

Author:

Julien Dubois, Christian Tzolov, Mark Pollack

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiImageOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IMAGE_MODEL

Fields inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
OpenAiImageOptions()

Method Summary

Modifier and Type	Method	Description
static OpenAiImageOptions.Builder	builder()
boolean	equals(Object o)
@Nullable Integer	getHeight()
@Nullable Integer	getN()
@Nullable String	getQuality()
@Nullable String	getResponseFormat()
@Nullable String	getSize()
@Nullable String	getStyle()
@Nullable String	getUser()
@Nullable Integer	getWidth()
int	hashCode()
void	setHeight(@Nullable Integer height)
void	setN(@Nullable Integer n)
void	setQuality(@Nullable String quality)
void	setResponseFormat(@Nullable String responseFormat)
void	setSize(@Nullable String size)
void	setStyle(@Nullable String style)
void	setUser(@Nullable String user)
void	setWidth(@Nullable Integer width)
com.openai.models.images.ImageGenerateParams	toOpenAiImageGenerateParams(ImagePrompt imagePrompt)
String	toString()

Methods inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getModel, getOrganizationId, getProxy, getTimeout, isGitHubModels, isMicrosoftFoundry, setApiKey, setBaseUrl, setCredential, setCustomHeaders, setDeploymentName, setGitHubModels, setMaxRetries, setMicrosoftDeploymentName, setMicrosoftFoundry, setMicrosoftFoundryServiceVersion, setModel, setOrganizationId, setProxy, setTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.image.ImageOptions

getModel

Field Details

DEFAULT_IMAGE_MODEL

public static final String DEFAULT_IMAGE_MODEL

Constructor Details

OpenAiImageOptions

public OpenAiImageOptions()

Method Details

builder

public static OpenAiImageOptions.Builder builder()

getN

public @Nullable Integer getN()

Specified by:

getN in interface ImageOptions

setN

public void setN(@Nullable Integer n)

getWidth

public @Nullable Integer getWidth()

Specified by:

getWidth in interface ImageOptions

setWidth

public void setWidth(@Nullable Integer width)

getHeight

public @Nullable Integer getHeight()

Specified by:

getHeight in interface ImageOptions

setHeight

public void setHeight(@Nullable Integer height)

getResponseFormat

public @Nullable String getResponseFormat()

Specified by:

getResponseFormat in interface ImageOptions

setResponseFormat

public void setResponseFormat(@Nullable String responseFormat)

getSize

public @Nullable String getSize()

setSize

public void setSize(@Nullable String size)

getUser

public @Nullable String getUser()

setUser

public void setUser(@Nullable String user)

getQuality

public @Nullable String getQuality()

setQuality

public void setQuality(@Nullable String quality)

getStyle

public @Nullable String getStyle()

Specified by:

getStyle in interface ImageOptions

setStyle

public void setStyle(@Nullable String style)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toOpenAiImageGenerateParams

public com.openai.models.images.ImageGenerateParams toOpenAiImageGenerateParams(ImagePrompt imagePrompt)