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

Nested classes/interfaces inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

AbstractOpenAiOptions.AbstractBuilder<O extends AbstractOpenAiOptions,B extends AbstractOpenAiOptions.AbstractBuilder<O,B>>

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

Modifier	Constructor	Description
protected	OpenAiImageOptions(@Nullable String baseUrl, @Nullable String apiKey, @Nullable com.openai.credential.Credential credential, @Nullable String model, @Nullable String microsoftDeploymentName, @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion, @Nullable String organizationId, @Nullable Boolean isMicrosoftFoundry, @Nullable Boolean isGitHubModels, @Nullable Duration timeout, @Nullable Integer maxRetries, @Nullable Proxy proxy, @Nullable Map<String,String> customHeaders, @Nullable Integer n, @Nullable Integer width, @Nullable Integer height, @Nullable String quality, @Nullable String responseFormat, @Nullable String size, @Nullable String style, @Nullable String user)

Method Summary

Modifier and Type	Method	Description
static OpenAiImageOptions.Builder	builder()
boolean	equals(@Nullable 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()
com.openai.models.images.ImageGenerateParams	toOpenAiImageGenerateParams(ImagePrompt imagePrompt)

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

getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getModel, getOrganizationId, getProxy, getTimeout, isGitHubModels, isMicrosoftFoundry

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, 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

protected OpenAiImageOptions(@Nullable String baseUrl,
 @Nullable String apiKey,
 @Nullable com.openai.credential.Credential credential,
 @Nullable String model,
 @Nullable String microsoftDeploymentName,
 @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion,
 @Nullable String organizationId,
 @Nullable Boolean isMicrosoftFoundry,
 @Nullable Boolean isGitHubModels,
 @Nullable Duration timeout,
 @Nullable Integer maxRetries,
 @Nullable Proxy proxy,
 @Nullable Map<String,String> customHeaders,
 @Nullable Integer n,
 @Nullable Integer width,
 @Nullable Integer height,
 @Nullable String quality,
 @Nullable String responseFormat,
 @Nullable String size,
 @Nullable String style,
 @Nullable String user)

Method Details

builder

public static OpenAiImageOptions.Builder builder()

getN

public @Nullable Integer getN()

Specified by:

getN in interface ImageOptions

getWidth

public @Nullable Integer getWidth()

Specified by:

getWidth in interface ImageOptions

getHeight

public @Nullable Integer getHeight()

Specified by:

getHeight in interface ImageOptions

getResponseFormat

public @Nullable String getResponseFormat()

Specified by:

getResponseFormat in interface ImageOptions

getSize

public @Nullable String getSize()

getUser

public @Nullable String getUser()

getQuality

public @Nullable String getQuality()

getStyle

public @Nullable String getStyle()

Specified by:

getStyle in interface ImageOptions

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toOpenAiImageGenerateParams

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