Constructor Detail

• BetaThreadRunCreateParams.Builder

  BetaThreadRunCreateParams.Builder()

Method Detail

• threadId

   final BetaThreadRunCreateParams.Builder threadId(String threadId)

• include

   final BetaThreadRunCreateParams.Builder include(List<RunStepInclude> include)

  A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.

  See the file search tool documentation for more information.

• include

   final BetaThreadRunCreateParams.Builder include(Optional<List<RunStepInclude>> include)

  A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.

  See the file search tool documentation for more information.

• addInclude

   final BetaThreadRunCreateParams.Builder addInclude(RunStepInclude include)

  A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.

  See the file search tool documentation for more information.

• assistantId

   final BetaThreadRunCreateParams.Builder assistantId(String assistantId)

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

• assistantId

   final BetaThreadRunCreateParams.Builder assistantId(JsonField<String> assistantId)

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

• additionalInstructions

   final BetaThreadRunCreateParams.Builder additionalInstructions(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.

• additionalInstructions

   final BetaThreadRunCreateParams.Builder additionalInstructions(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.

• additionalInstructions

   final BetaThreadRunCreateParams.Builder additionalInstructions(JsonField<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 BetaThreadRunCreateParams.Builder additionalMessages(List<BetaThreadRunCreateParams.AdditionalMessage> additionalMessages)

  Adds additional messages to the thread before creating the run.

• additionalMessages

   final BetaThreadRunCreateParams.Builder additionalMessages(Optional<List<BetaThreadRunCreateParams.AdditionalMessage>> additionalMessages)

  Adds additional messages to the thread before creating the run.

• additionalMessages

   final BetaThreadRunCreateParams.Builder additionalMessages(JsonField<List<BetaThreadRunCreateParams.AdditionalMessage>> additionalMessages)

  Adds additional messages to the thread before creating the run.

• addAdditionalMessage

   final BetaThreadRunCreateParams.Builder addAdditionalMessage(BetaThreadRunCreateParams.AdditionalMessage additionalMessage)

  Adds additional messages to the thread before creating the run.

• instructions

   final BetaThreadRunCreateParams.Builder instructions(String instructions)

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

• instructions

   final BetaThreadRunCreateParams.Builder instructions(Optional<String> instructions)

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

• instructions

   final BetaThreadRunCreateParams.Builder instructions(JsonField<String> instructions)

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

• maxCompletionTokens

   final BetaThreadRunCreateParams.Builder maxCompletionTokens(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.

• maxCompletionTokens

   final BetaThreadRunCreateParams.Builder maxCompletionTokens(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.

• maxCompletionTokens

   final BetaThreadRunCreateParams.Builder maxCompletionTokens(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.

• maxCompletionTokens

   final BetaThreadRunCreateParams.Builder maxCompletionTokens(JsonField<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 BetaThreadRunCreateParams.Builder maxPromptTokens(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.

• maxPromptTokens

   final BetaThreadRunCreateParams.Builder maxPromptTokens(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.

• maxPromptTokens

   final BetaThreadRunCreateParams.Builder maxPromptTokens(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.

• maxPromptTokens

   final BetaThreadRunCreateParams.Builder maxPromptTokens(JsonField<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 BetaThreadRunCreateParams.Builder metadata(JsonValue 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 maximum of 512 characters long.

• model

   final BetaThreadRunCreateParams.Builder model(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.

• model

   final BetaThreadRunCreateParams.Builder model(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.

• model

   final BetaThreadRunCreateParams.Builder model(JsonField<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.

• model

   final BetaThreadRunCreateParams.Builder model(String value)

  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 BetaThreadRunCreateParams.Builder parallelToolCalls(Boolean parallelToolCalls)

  Whether to enable parallel function calling during tool use.

• parallelToolCalls

   final BetaThreadRunCreateParams.Builder parallelToolCalls(JsonField<Boolean> parallelToolCalls)

  Whether to enable parallel function calling during tool use.

• responseFormat

   final BetaThreadRunCreateParams.Builder responseFormat(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.

• responseFormat

   final BetaThreadRunCreateParams.Builder responseFormat(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.

• responseFormat

   final BetaThreadRunCreateParams.Builder responseFormat(JsonField<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.

• responseFormat

   final BetaThreadRunCreateParams.Builder responseFormat(AssistantResponseFormatOption.Behavior behavior)

  auto is the default value

• responseFormat

   final BetaThreadRunCreateParams.Builder responseFormat(ResponseFormatText responseFormatText)

  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.

• responseFormat

   final BetaThreadRunCreateParams.Builder responseFormat(ResponseFormatJsonObject responseFormatJsonObject)

  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.

• responseFormat

   final BetaThreadRunCreateParams.Builder responseFormat(ResponseFormatJsonSchema responseFormatJsonSchema)

  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 BetaThreadRunCreateParams.Builder temperature(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.

• temperature

   final BetaThreadRunCreateParams.Builder temperature(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.

• temperature

   final BetaThreadRunCreateParams.Builder temperature(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.

• temperature

   final BetaThreadRunCreateParams.Builder temperature(JsonField<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 BetaThreadRunCreateParams.Builder toolChoice(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.

• toolChoice

   final BetaThreadRunCreateParams.Builder toolChoice(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.

• toolChoice

   final BetaThreadRunCreateParams.Builder toolChoice(JsonField<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.

• toolChoice

   final BetaThreadRunCreateParams.Builder toolChoice(AssistantToolChoiceOption.Behavior behavior)

  none means the model will not call any tools and instead generates a message. auto 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.

• toolChoice

   final BetaThreadRunCreateParams.Builder toolChoice(AssistantToolChoice assistantToolChoice)

  Specifies a tool the model should use. Use to force the model to call a specific tool.

• tools

   final BetaThreadRunCreateParams.Builder tools(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.

• tools

   final BetaThreadRunCreateParams.Builder tools(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.

• tools

   final BetaThreadRunCreateParams.Builder tools(JsonField<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.

• addTool

   final BetaThreadRunCreateParams.Builder addTool(AssistantTool tool)

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

• addTool

   final BetaThreadRunCreateParams.Builder addTool(CodeInterpreterTool codeInterpreterTool)

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

• addTool

   final BetaThreadRunCreateParams.Builder addTool(FileSearchTool fileSearchTool)

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

• addTool

   final BetaThreadRunCreateParams.Builder addTool(FunctionTool functionTool)

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

• topP

   final BetaThreadRunCreateParams.Builder topP(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.

• topP

   final BetaThreadRunCreateParams.Builder topP(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.

• topP

   final BetaThreadRunCreateParams.Builder topP(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.

• topP

   final BetaThreadRunCreateParams.Builder topP(JsonField<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 BetaThreadRunCreateParams.Builder truncationStrategy(BetaThreadRunCreateParams.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.

• truncationStrategy

   final BetaThreadRunCreateParams.Builder truncationStrategy(Optional<BetaThreadRunCreateParams.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.

• truncationStrategy

   final BetaThreadRunCreateParams.Builder truncationStrategy(JsonField<BetaThreadRunCreateParams.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.

• additionalBodyProperties

   final BetaThreadRunCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final BetaThreadRunCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final BetaThreadRunCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final BetaThreadRunCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final BetaThreadRunCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final BetaThreadRunCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final BetaThreadRunCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final BetaThreadRunCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final BetaThreadRunCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final BetaThreadRunCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final BetaThreadRunCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final BetaThreadRunCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final BetaThreadRunCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final BetaThreadRunCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final BetaThreadRunCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final BetaThreadRunCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final BetaThreadRunCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final BetaThreadRunCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final BetaThreadRunCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final BetaThreadRunCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final BetaThreadRunCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final BetaThreadRunCreateParams build()