Package io.github.stefanbratanov.jvm.openai

Record Class CreateRunRequest

java.lang.Object
java.lang.Record
io.github.stefanbratanov.jvm.openai.CreateRunRequest
public record CreateRunRequest(String assistantId, Optional<String> model, Optional<String> instructions, Optional<String> additionalInstructions, Optional<List<CreateMessageRequest>> additionalMessages, Optional<List<Tool>> tools, Optional<Map<String,String>> metadata, Optional<Double> temperature, Optional<Double> topP, Optional<Boolean> stream, Optional<Integer> maxPromptTokens, Optional<Integer> maxCompletionTokens, Optional<TruncationStrategy> truncationStrategy, Optional<AssistantsToolChoice> toolChoice, Optional<AssistantsResponseFormat> responseFormat) extends Record

  • Constructor Details

    • CreateRunRequest

      public CreateRunRequest(String assistantId, Optional<String> model, Optional<String> instructions, Optional<String> additionalInstructions, Optional<List<CreateMessageRequest>> additionalMessages, Optional<List<Tool>> tools, Optional<Map<String,String>> metadata, Optional<Double> temperature, Optional<Double> topP, Optional<Boolean> stream, Optional<Integer> maxPromptTokens, Optional<Integer> maxCompletionTokens, Optional<TruncationStrategy> truncationStrategy, Optional<AssistantsToolChoice> toolChoice, Optional<AssistantsResponseFormat> responseFormat)
      Creates an instance of a CreateRunRequest record class.
      Parameters:
      assistantId - the value for the assistantId record component
      model - the value for the model record component
      instructions - the value for the instructions record component
      additionalInstructions - the value for the additionalInstructions record component
      additionalMessages - the value for the additionalMessages record component
      tools - the value for the tools 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
      stream - the value for the stream record component
      maxPromptTokens - the value for the maxPromptTokens record component
      maxCompletionTokens - the value for the maxCompletionTokens record component
      truncationStrategy - the value for the truncationStrategy record component
      toolChoice - the value for the toolChoice record component
      responseFormat - the value for the responseFormat record component

  • Method Details

    • newBuilder

      public static CreateRunRequest.Builder newBuilder()

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

    • assistantId

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

    • model

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

    • instructions

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

    • additionalInstructions

      public Optional<String> additionalInstructions()
      Returns the value of the additionalInstructions record component.
      Returns:
      the value of the additionalInstructions record component

    • additionalMessages

      public Optional<List<CreateMessageRequest>> additionalMessages()
      Returns the value of the additionalMessages record component.
      Returns:
      the value of the additionalMessages record component

    • tools

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

    • metadata

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

    • temperature

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

    • topP

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

    • stream

      public Optional<Boolean> stream()
      Returns the value of the stream record component.
      Returns:
      the value of the stream record component

    • maxPromptTokens

      public Optional<Integer> maxPromptTokens()
      Returns the value of the maxPromptTokens record component.
      Returns:
      the value of the maxPromptTokens record component

    • maxCompletionTokens

      public Optional<Integer> maxCompletionTokens()
      Returns the value of the maxCompletionTokens record component.
      Returns:
      the value of the maxCompletionTokens record component

    • truncationStrategy

      public Optional<TruncationStrategy> truncationStrategy()
      Returns the value of the truncationStrategy record component.
      Returns:
      the value of the truncationStrategy record component

    • toolChoice

      public Optional<AssistantsToolChoice> toolChoice()
      Returns the value of the toolChoice record component.
      Returns:
      the value of the toolChoice record component

    • responseFormat

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