Class OpenAiImageOptions

java.lang.Object
org.springframework.ai.openai.OpenAiImageOptions
All Implemented Interfaces:
org.springframework.ai.image.ImageOptions, org.springframework.ai.model.ModelOptions

public class OpenAiImageOptions extends Object implements org.springframework.ai.image.ImageOptions
OpenAI Image API options. OpenAiImageOptions.java
Since:
0.8.0
Author:
Mark Pollack, Christian Tzolov
  • 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 org.springframework.ai.image.ImageOptions
    • setN

      public void setN(Integer n)
    • getModel

      public String getModel()
      Specified by:
      getModel in interface org.springframework.ai.image.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 org.springframework.ai.image.ImageOptions
    • setResponseFormat

      public void setResponseFormat(String responseFormat)
    • getWidth

      public Integer getWidth()
      Specified by:
      getWidth in interface org.springframework.ai.image.ImageOptions
    • setWidth

      public void setWidth(Integer width)
    • getHeight

      public Integer getHeight()
      Specified by:
      getHeight in interface org.springframework.ai.image.ImageOptions
    • setHeight

      public void setHeight(Integer height)
    • getStyle

      public String getStyle()
      Specified by:
      getStyle in interface org.springframework.ai.image.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