Package bg.codexio.ai.openai.api.payload.assistant.request

Record Class AssistantRequest

java.lang.Object
java.lang.Record
bg.codexio.ai.openai.api.payload.assistant.request.AssistantRequest
All Implemented Interfaces:
Streamable
public record AssistantRequest(String model, String name, String description, String instructions, List<AssistantTool> tools, List<String> fileIds, Map<String,String> metadata) extends Record implements Streamable

  • Constructor Details

    • AssistantRequest

      public AssistantRequest(String model, String name, String description, String instructions, List<AssistantTool> tools, List<String> fileIds, Map<String,String> metadata)
      Creates an instance of a AssistantRequest record class.
      Parameters:
      model - the value for the model record component
      name - the value for the name record component
      description - the value for the description record component
      instructions - the value for the instructions record component
      tools - the value for the tools record component
      fileIds - the value for the fileIds record component
      metadata - the value for the metadata record component

  • Method Details

    • builder

      public static AssistantRequest.Builder builder()

    • stream

      public boolean stream()
      Specified by:
      stream in interface Streamable

    • 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 String model()
      Returns the value of the model record component.
      Returns:
      the value of the model 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

    • instructions

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

    • tools

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

    • fileIds

      public List<String> fileIds()
      Returns the value of the fileIds record component.
      Returns:
      the value of the fileIds record component

    • metadata

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