Package io.github.stefanbratanov.jvm.openai

Record Class ResponseFormat

java.lang.Object
java.lang.Record
io.github.stefanbratanov.jvm.openai.ResponseFormat
All Implemented Interfaces:
AssistantsResponseFormat
public record ResponseFormat(String type, Optional<JsonSchema> jsonSchema) extends Record implements AssistantsResponseFormat
An object specifying the format that the model must output.

  • Constructor Details

    • ResponseFormat

      public ResponseFormat(String type, Optional<JsonSchema> jsonSchema)
      Creates an instance of a ResponseFormat record class.
      Parameters:
      type - the value for the type record component
      jsonSchema - the value for the jsonSchema record component

  • Method Details

    • text

      public static ResponseFormat text()

    • json

      public static ResponseFormat json()

    • jsonSchema

      public static ResponseFormat jsonSchema(JsonSchema jsonSchema)

    • 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.

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • jsonSchema

      public Optional<JsonSchema> jsonSchema()
      Returns the value of the jsonSchema record component.
      Returns:
      the value of the jsonSchema record component