Package org.springframework.ai.model.openai.autoconfigure

Class OpenAiImageProperties

java.lang.Object

org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

org.springframework.ai.model.openai.autoconfigure.OpenAiImageProperties

@ConfigurationProperties("spring.ai.openai.image")
public class OpenAiImageProperties
extends AbstractOpenAiProperties

OpenAI SDK Image autoconfiguration properties.

Author:

Christian Tzolov, Thomas Vitale, lambochen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OpenAiImageProperties.Options

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PREFIX

Fields inherited from class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
OpenAiImageProperties()

Method Summary

Modifier and Type	Method	Description
@Nullable Integer	getHeight()
@Nullable String	getModel()
@Nullable Integer	getN()
OpenAiImageProperties.Options	getOptions()	Deprecated, for removal: This API element is subject to removal in a future version.
@Nullable String	getQuality()
@Nullable String	getResponseFormat()
@Nullable String	getSize()
@Nullable String	getStyle()
@Nullable String	getUser()
@Nullable Integer	getWidth()
void	setHeight(@Nullable Integer height)
void	setModel(@Nullable String model)
void	setN(@Nullable Integer n)
void	setOptions(OpenAiImageProperties.Options options)
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)
OpenAiImageOptions	toOptions()

Methods inherited from class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

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

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_PREFIX

public static final String CONFIG_PREFIX

See Also:

• Constant Field Values

Constructor Details

OpenAiImageProperties

public OpenAiImageProperties()

Method Details

getModel

public @Nullable String getModel()

Overrides:

getModel in class AbstractOpenAiProperties

setModel

public void setModel(@Nullable String model)

Overrides:

setModel in class AbstractOpenAiProperties

getN

public @Nullable Integer getN()

setN

public void setN(@Nullable Integer n)

getWidth

public @Nullable Integer getWidth()

setWidth

public void setWidth(@Nullable Integer width)

getHeight

public @Nullable Integer getHeight()

setHeight

public void setHeight(@Nullable Integer height)

getQuality

public @Nullable String getQuality()

setQuality

public void setQuality(@Nullable String quality)

getResponseFormat

public @Nullable String getResponseFormat()

setResponseFormat

public void setResponseFormat(@Nullable String responseFormat)

getSize

public @Nullable String getSize()

setSize

public void setSize(@Nullable String size)

getStyle

public @Nullable String getStyle()

setStyle

public void setStyle(@Nullable String style)

getUser

public @Nullable String getUser()

setUser

public void setUser(@Nullable String user)

toOptions

public OpenAiImageOptions toOptions()

getOptions

@DeprecatedConfigurationProperty(replacement="spring.ai.openai.image")
@Deprecated(since="2.0.0",
            forRemoval=true)
public OpenAiImageProperties.Options getOptions()

Deprecated, for removal: This API element is subject to removal in a future version.

setOptions

public void setOptions(OpenAiImageProperties.Options options)