Constructor Detail

Method Detail

• assistantId

   final String assistantId()

  The ID of the assistant to use to execute this run.

• additionalInstructions

   final Optional<String> 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

   final Optional<List<RunCreateParams.AdditionalMessage>> additionalMessages()

  Adds additional messages to the thread before creating the run.

• instructions

   final Optional<String> instructions()

  Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.

• maxCompletionTokens

   final Optional<Long> maxCompletionTokens()

  The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status incomplete. See incomplete_details for more info.

• maxPromptTokens

   final Optional<Long> maxPromptTokens()

  The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status incomplete. See incomplete_details for more info.

• metadata

   final Optional<RunCreateParams.Metadata> 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, and querying for objects via API or the dashboard.

  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

• model

   final Optional<ChatModel> 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.

• parallelToolCalls

   final Optional<Boolean> parallelToolCalls()

  Whether to enable parallel function calling during tool use.

• reasoningEffort

   final Optional<ReasoningEffort> reasoningEffort()

  o-series models only

  Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

• responseFormat

   final Optional<AssistantResponseFormatOption> responseFormat()

  Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 * Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

  Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

  Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

  Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

• temperature

   final Optional<Double> 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.

• toolChoice

   final Optional<AssistantToolChoiceOption> toolChoice()

  Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

• tools

   final Optional<List<AssistantTool>> tools()

  Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

• topP

   final Optional<Double> topP()

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or temperature but not both.

• truncationStrategy

   final Optional<RunCreateParams.TruncationStrategy> truncationStrategy()

  Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run.

• _assistantId

   final JsonField<String> _assistantId()

  Returns the raw JSON value of assistantId.

  Unlike assistantId, this method doesn't throw if the JSON field has an unexpected type.

• _additionalInstructions

   final JsonField<String> _additionalInstructions()

  Returns the raw JSON value of additionalInstructions.

  Unlike additionalInstructions, this method doesn't throw if the JSON field has an unexpected type.

• _additionalMessages

   final JsonField<List<RunCreateParams.AdditionalMessage>> _additionalMessages()

  Returns the raw JSON value of additionalMessages.

  Unlike additionalMessages, this method doesn't throw if the JSON field has an unexpected type.

• _instructions

   final JsonField<String> _instructions()

  Returns the raw JSON value of instructions.

  Unlike instructions, this method doesn't throw if the JSON field has an unexpected type.

• _maxCompletionTokens

   final JsonField<Long> _maxCompletionTokens()

  Returns the raw JSON value of maxCompletionTokens.

  Unlike maxCompletionTokens, this method doesn't throw if the JSON field has an unexpected type.

• _maxPromptTokens

   final JsonField<Long> _maxPromptTokens()

  Returns the raw JSON value of maxPromptTokens.

  Unlike maxPromptTokens, this method doesn't throw if the JSON field has an unexpected type.

• _metadata

   final JsonField<RunCreateParams.Metadata> _metadata()

  Returns the raw JSON value of metadata.

  Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.

• _model

   final JsonField<ChatModel> _model()

  Returns the raw JSON value of model.

  Unlike model, this method doesn't throw if the JSON field has an unexpected type.

• _parallelToolCalls

   final JsonField<Boolean> _parallelToolCalls()

  Returns the raw JSON value of parallelToolCalls.

  Unlike parallelToolCalls, this method doesn't throw if the JSON field has an unexpected type.

• _reasoningEffort

   final JsonField<ReasoningEffort> _reasoningEffort()

  Returns the raw JSON value of reasoningEffort.

  Unlike reasoningEffort, this method doesn't throw if the JSON field has an unexpected type.

• _responseFormat

   final JsonField<AssistantResponseFormatOption> _responseFormat()

  Returns the raw JSON value of responseFormat.

  Unlike responseFormat, this method doesn't throw if the JSON field has an unexpected type.

• _temperature

   final JsonField<Double> _temperature()

  Returns the raw JSON value of temperature.

  Unlike temperature, this method doesn't throw if the JSON field has an unexpected type.

• _toolChoice

   final JsonField<AssistantToolChoiceOption> _toolChoice()

  Returns the raw JSON value of toolChoice.

  Unlike toolChoice, this method doesn't throw if the JSON field has an unexpected type.

• _tools

   final JsonField<List<AssistantTool>> _tools()

  Returns the raw JSON value of tools.

  Unlike tools, this method doesn't throw if the JSON field has an unexpected type.

• _topP

   final JsonField<Double> _topP()

  Returns the raw JSON value of topP.

  Unlike topP, this method doesn't throw if the JSON field has an unexpected type.

• _truncationStrategy

   final JsonField<RunCreateParams.TruncationStrategy> _truncationStrategy()

  Returns the raw JSON value of truncationStrategy.

  Unlike truncationStrategy, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final RunCreateParams.Body.Builder toBuilder()

• validate

   final RunCreateParams.Body validate()

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static RunCreateParams.Body.Builder builder()

  Returns a mutable builder for constructing an instance of Body.

  The following fields are required:

  .assistantId()