Package io.github.stefanbratanov.jvm.openai

Class CreateRunRequest.Builder

java.lang.Object
io.github.stefanbratanov.jvm.openai.CreateRunRequest.Builder
Enclosing class:
CreateRunRequest
public static class CreateRunRequest.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • assistantId

      public CreateRunRequest.Builder assistantId(String assistantId)
      Parameters:
      assistantId - The ID of the assistant to use to execute this run.

    • model

      public CreateRunRequest.Builder model(String model)
      Parameters:
      model - The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

    • model

      public CreateRunRequest.Builder model(OpenAIModel model)
      Parameters:
      model - OpenAIModel to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

    • instructions

      public CreateRunRequest.Builder instructions(String instructions)
      Parameters:
      instructions - Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.

    • additionalInstructions

      public CreateRunRequest.Builder additionalInstructions(String additionalInstructions)
      Parameters:
      additionalInstructions - Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.

    • additionalMessages

      public CreateRunRequest.Builder additionalMessages(List<CreateMessageRequest> additionalMessages)
      Parameters:
      additionalMessages - Adds additional messages to the thread before creating the run.

    • tools

      public CreateRunRequest.Builder tools(List<Tool> tools)
      Parameters:
      tools - Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

    • metadata

      public CreateRunRequest.Builder metadata(Map<String,String> metadata)
      Parameters:
      metadata - Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

    • temperature

      public CreateRunRequest.Builder temperature(Double temperature)
      Parameters:
      temperature - What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

    • stream

      public CreateRunRequest.Builder stream(Boolean stream)
      Parameters:
      stream - If true, returns a stream of events that happen during the Run as server-sent events

    • build

      public CreateRunRequest build()