Package org.springframework.ai.openai

Class OpenAiImageOptions

java.lang.Object

org.springframework.ai.openai.OpenAiImageOptions

All Implemented Interfaces:

ImageOptions, ModelOptions

public class OpenAiImageOptions
extends Object
implements ImageOptions

OpenAI Image API options. OpenAiImageOptions.java

Since:

0.8.0

Author:

Mark Pollack, Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiImageOptions.Builder

Constructor Summary

Constructors

Constructor	Description
OpenAiImageOptions()

Method Summary

Modifier and Type	Method	Description
static OpenAiImageOptions.Builder	builder()
OpenAiImageOptions	copy()	Create a copy of this options instance.
boolean	equals(Object o)
static OpenAiImageOptions	fromOptions(OpenAiImageOptions fromOptions)	Create a new OpenAiImageOptions instance from an existing one.
Integer	getHeight()
String	getModel()
Integer	getN()
String	getQuality()
String	getResponseFormat()
String	getSize()
String	getStyle()
String	getUser()
Integer	getWidth()
int	hashCode()
void	setHeight(Integer height)
void	setModel(String model)
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)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

OpenAiImageOptions

public OpenAiImageOptions()

Method Details

builder

public static OpenAiImageOptions.Builder builder()

fromOptions

public static OpenAiImageOptions fromOptions(OpenAiImageOptions fromOptions)

Create a new OpenAiImageOptions instance from an existing one.

Parameters:

fromOptions - The options to copy from

Returns:

A new OpenAiImageOptions instance

getN

public Integer getN()

Specified by:

getN in interface ImageOptions

setN

public void setN(Integer n)

getModel

public String getModel()

Specified by:

getModel in interface ImageOptions

setModel

public void setModel(String model)

getQuality

public String getQuality()

setQuality

public void setQuality(String quality)

getResponseFormat

public String getResponseFormat()

Specified by:

getResponseFormat in interface ImageOptions

setResponseFormat

public void setResponseFormat(String responseFormat)

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)

getStyle

public String getStyle()

Specified by:

getStyle in interface ImageOptions

setStyle

public void setStyle(String style)

getUser

public String getUser()

setUser

public void setUser(String user)

getSize

public String getSize()

setSize

public void setSize(String size)

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

copy

public OpenAiImageOptions copy()

Create a copy of this options instance.

Returns:

A new instance with the same options