Package org.springframework.ai.openai.responses

Record Class HostedTool.ImageGeneration

java.lang.Object
java.lang.Record
org.springframework.ai.openai.responses.HostedTool.ImageGeneration
Record Components:
model - the image model, or null for the provider default
size - e.g. 1024x1024, or null for the provider default
All Implemented Interfaces:
HostedTool
Enclosing interface:
HostedTool
public static record HostedTool.ImageGeneration(@Nullable String model, @Nullable String size) extends Record implements HostedTool
Generate images. Generated images are surfaced as Media on the assistant message.

  • Constructor Details

    • ImageGeneration

      public ImageGeneration(@Nullable String model, @Nullable String size)
      Creates an instance of a ImageGeneration record class.
      Parameters:
      model - the value for the model record component
      size - the value for the size record component

  • Method Details

    • of

      public static HostedTool.ImageGeneration of()

    • toTool

      public com.openai.models.responses.Tool toTool()
      Description copied from interface: HostedTool
      Convert this tool to the SDK request representation.
      Specified by:
      toTool in interface HostedTool

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • model

      public @Nullable String model()
      Returns the value of the model record component.
      Returns:
      the value of the model record component

    • size

      public @Nullable String size()
      Returns the value of the size record component.
      Returns:
      the value of the size record component