Class OpenAiSdkImageOptions

java.lang.Object

org.springframework.ai.openaisdk.AbstractOpenAiSdkOptions

org.springframework.ai.openaisdk.OpenAiSdkImageOptions

All Implemented Interfaces:

ImageOptions, ModelOptions

public class OpenAiSdkImageOptions
extends AbstractOpenAiSdkOptions
implements ImageOptions

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

Author:

Julien Dubois

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiSdkImageOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IMAGE_MODEL

Constructor Summary

Constructors

Constructor	Description
OpenAiSdkImageOptions()

Method Summary

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

Methods inherited from class AbstractOpenAiSdkOptions

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 Object

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

Methods inherited from interface ImageOptions

getModel

Field Details

DEFAULT_IMAGE_MODEL

public static final String DEFAULT_IMAGE_MODEL

Constructor Details

OpenAiSdkImageOptions

public OpenAiSdkImageOptions()

Method Details

builder

public static OpenAiSdkImageOptions.Builder builder()

getN

public Integer getN()

Specified by:

getN in interface ImageOptions

setN

public void setN(Integer n)

getWidth

public Integer getWidth()

Specified by:

getWidth in interface ImageOptions

setWidth

public void setWidth(Integer width)

getHeight

public Integer getHeight()

Specified by:

getHeight in interface ImageOptions

setHeight

public void setHeight(Integer height)

getResponseFormat

public String getResponseFormat()

Specified by:

getResponseFormat in interface ImageOptions

setResponseFormat

public void setResponseFormat(String responseFormat)

getSize

public String getSize()

setSize

public void setSize(String size)

getUser

public String getUser()

setUser

public void setUser(String user)

getQuality

public String getQuality()

setQuality

public void setQuality(String quality)

getStyle

public String getStyle()

Specified by:

getStyle in interface ImageOptions

setStyle

public void setStyle(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)