Package io.github.stefanbratanov.jvm.openai

Record Class Assistant

java.lang.Object
java.lang.Record
io.github.stefanbratanov.jvm.openai.Assistant
public record Assistant(String id, long createdAt, String name, String description, String model, String instructions, List<Tool> tools, ToolResources toolResources, Map<String,String> metadata, Double temperature, Double topP, AssistantsResponseFormat responseFormat) extends Record
Represents an assistant that can call the model and use tools.

  • Constructor Details

    • Assistant

      public Assistant(String id, long createdAt, String name, String description, String model, String instructions, List<Tool> tools, ToolResources toolResources, Map<String,String> metadata, Double temperature, Double topP, AssistantsResponseFormat responseFormat)
      Creates an instance of a Assistant record class.
      Parameters:
      id - the value for the id record component
      createdAt - the value for the createdAt record component
      name - the value for the name record component
      description - the value for the description record component
      model - the value for the model record component
      instructions - the value for the instructions record component
      tools - the value for the tools record component
      toolResources - the value for the toolResources record component
      metadata - the value for the metadata record component
      temperature - the value for the temperature record component
      topP - the value for the topP record component
      responseFormat - the value for the responseFormat record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • id

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

    • createdAt

      public long createdAt()
      Returns the value of the createdAt record component.
      Returns:
      the value of the createdAt record component

    • name

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

    • description

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

    • model

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

    • instructions

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

    • tools

      public List<Tool> tools()
      Returns the value of the tools record component.
      Returns:
      the value of the tools record component

    • toolResources

      public ToolResources toolResources()
      Returns the value of the toolResources record component.
      Returns:
      the value of the toolResources record component

    • metadata

      public Map<String,String> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component

    • temperature

      public Double temperature()
      Returns the value of the temperature record component.
      Returns:
      the value of the temperature record component

    • topP

      public Double topP()
      Returns the value of the topP record component.
      Returns:
      the value of the topP record component

    • responseFormat

      public AssistantsResponseFormat responseFormat()
      Returns the value of the responseFormat record component.
      Returns:
      the value of the responseFormat record component