All Implemented Interfaces:


public final class BetaThreadRunCreateParams.BetaThreadRunCreateBody

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BetaThreadRunCreateParams.BetaThreadRunCreateBody.Builder`	A builder for BetaThreadRunCreateBody.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`assistantId()`	The ID of the assistant to use to execute this run.
`final Optional<String>`	`additionalInstructions()`	Appends additional instructions at the end of the instructions for the run.
`final Optional<List<BetaThreadRunCreateParams.AdditionalMessage>>`	`additionalMessages()`	Adds additional messages to the thread before creating the run.
`final Optional<String>`	`instructions()`	Overrides the instructions of the assistant.
`final Optional<Long>`	`maxCompletionTokens()`	The maximum number of completion tokens that may be used over the course of the run.
`final Optional<Long>`	`maxPromptTokens()`	The maximum number of prompt tokens that may be used over the course of the run.
`final Optional<Metadata>`	`metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final Optional<ChatModel>`	`model()`	The ID of the Model to be used to execute this run.
`final Optional<Boolean>`	`parallelToolCalls()`	Whether to enable parallel function calling during tool use.
`final Optional<AssistantResponseFormatOption>`	`responseFormat()`	Specifies the format that the model must output.
`final Optional<Double>`	`temperature()`	What sampling temperature to use, between 0 and 2.
`final Optional<AssistantToolChoiceOption>`	`toolChoice()`	Controls which (if any) tool is called by the model.
`final Optional<List<AssistantTool>>`	`tools()`	Override the tools the assistant can use for this run.
`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.
`final Optional<BetaThreadRunCreateParams.TruncationStrategy>`	`truncationStrategy()`	Controls for how a thread will be truncated prior to the run.
`final JsonField<String>`	`_assistantId()`	The ID of the assistant to use to execute this run.
`final JsonField<String>`	`_additionalInstructions()`	Appends additional instructions at the end of the instructions for the run.
`final JsonField<List<BetaThreadRunCreateParams.AdditionalMessage>>`	`_additionalMessages()`	Adds additional messages to the thread before creating the run.
`final JsonField<String>`	`_instructions()`	Overrides the instructions of the assistant.
`final JsonField<Long>`	`_maxCompletionTokens()`	The maximum number of completion tokens that may be used over the course of the run.
`final JsonField<Long>`	`_maxPromptTokens()`	The maximum number of prompt tokens that may be used over the course of the run.
`final JsonField<Metadata>`	`_metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final JsonField<ChatModel>`	`_model()`	The ID of the Model to be used to execute this run.
`final JsonField<Boolean>`	`_parallelToolCalls()`	Whether to enable parallel function calling during tool use.
`final JsonField<AssistantResponseFormatOption>`	`_responseFormat()`	Specifies the format that the model must output.
`final JsonField<Double>`	`_temperature()`	What sampling temperature to use, between 0 and 2.
`final JsonField<AssistantToolChoiceOption>`	`_toolChoice()`	Controls which (if any) tool is called by the model.
`final JsonField<List<AssistantTool>>`	`_tools()`	Override the tools the assistant can use for this run.
`final 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.
`final JsonField<BetaThreadRunCreateParams.TruncationStrategy>`	`_truncationStrategy()`	Controls for how a thread will be truncated prior to the run.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final BetaThreadRunCreateParams.BetaThreadRunCreateBody`	`validate()`
`final BetaThreadRunCreateParams.BetaThreadRunCreateBody.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BetaThreadRunCreateParams.BetaThreadRunCreateBody.Builder`	`builder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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<BetaThreadRunCreateParams.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<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.
  - 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<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.
  - _assistantId
```
 final JsonField<String> _assistantId()
```
    The ID of the assistant to use to execute this run.
  - _additionalInstructions
```
 final 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 JsonField<List<BetaThreadRunCreateParams.AdditionalMessage>> _additionalMessages()
```
    Adds additional messages to the thread before creating the run.
  - _instructions
```
 final JsonField<String> _instructions()
```
    Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.
  - _maxCompletionTokens
```
 final 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 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 JsonField<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 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.
  - _parallelToolCalls
```
 final JsonField<Boolean> _parallelToolCalls()
```
    Whether to enable parallel function calling during tool use.
  - _responseFormat
```
 final 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.
  - _temperature
```
 final 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 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.
  - _tools
```
 final 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.
  - _topP
```
 final 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 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.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final BetaThreadRunCreateParams.BetaThreadRunCreateBody validate()
```
  - toBuilder
```
 final BetaThreadRunCreateParams.BetaThreadRunCreateBody.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BetaThreadRunCreateParams.BetaThreadRunCreateBody.Builder builder()
```

Class BetaThreadRunCreateParams.BetaThreadRunCreateBody

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

assistantId

additionalInstructions

additionalMessages

instructions

maxCompletionTokens

maxPromptTokens

metadata

model

parallelToolCalls

responseFormat

temperature

toolChoice

tools

topP

truncationStrategy

_assistantId

_additionalInstructions

_additionalMessages

_instructions

_maxCompletionTokens

_maxPromptTokens

_metadata

_model

_parallelToolCalls

_responseFormat

_temperature

_toolChoice

_tools

_topP

_truncationStrategy

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder