All Implemented Interfaces:: com.openai.core.Params

@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") 
public final class ThreadCreateAndRunParams
 implements Params

Create a thread and run it in one request.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ThreadCreateAndRunParams.Builder`	A builder for ThreadCreateAndRunParams.
`public final class`	`ThreadCreateAndRunParams.Body`
`public final class`	`ThreadCreateAndRunParams.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.
`public final class`	`ThreadCreateAndRunParams.Thread`	Options to create a new thread. If no thread is provided when running a request, an empty thread will be created.
`public final class`	`ThreadCreateAndRunParams.ToolResources`	A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.
`public final class`	`ThreadCreateAndRunParams.TruncationStrategy`	Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.

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>`	`instructions()`	Override the default system message 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<ThreadCreateAndRunParams.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<ThreadCreateAndRunParams.Thread>`	`thread()`	Options to create a new thread.
`final Optional<AssistantToolChoiceOption>`	`toolChoice()`	Controls which (if any) tool is called by the model.
`final Optional<ThreadCreateAndRunParams.ToolResources>`	`toolResources()`	A set of resources that are used by the assistant's tools.
`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<ThreadCreateAndRunParams.TruncationStrategy>`	`truncationStrategy()`	Controls for how a thread will be truncated prior to the run.
`final JsonField<String>`	`_assistantId()`	Returns the raw JSON value of assistantId.
`final JsonField<String>`	`_instructions()`	Returns the raw JSON value of instructions.
`final JsonField<Long>`	`_maxCompletionTokens()`	Returns the raw JSON value of maxCompletionTokens.
`final JsonField<Long>`	`_maxPromptTokens()`	Returns the raw JSON value of maxPromptTokens.
`final JsonField<ThreadCreateAndRunParams.Metadata>`	`_metadata()`	Returns the raw JSON value of metadata.
`final JsonField<ChatModel>`	`_model()`	Returns the raw JSON value of model.
`final JsonField<Boolean>`	`_parallelToolCalls()`	Returns the raw JSON value of parallelToolCalls.
`final JsonField<AssistantResponseFormatOption>`	`_responseFormat()`	Returns the raw JSON value of responseFormat.
`final JsonField<Double>`	`_temperature()`	Returns the raw JSON value of temperature.
`final JsonField<ThreadCreateAndRunParams.Thread>`	`_thread()`	Returns the raw JSON value of thread.
`final JsonField<AssistantToolChoiceOption>`	`_toolChoice()`	Returns the raw JSON value of toolChoice.
`final JsonField<ThreadCreateAndRunParams.ToolResources>`	`_toolResources()`	Returns the raw JSON value of toolResources.
`final JsonField<List<AssistantTool>>`	`_tools()`	Returns the raw JSON value of tools.
`final JsonField<Double>`	`_topP()`	Returns the raw JSON value of topP.
`final JsonField<ThreadCreateAndRunParams.TruncationStrategy>`	`_truncationStrategy()`	Returns the raw JSON value of truncationStrategy.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final ThreadCreateAndRunParams.Builder`	`toBuilder()`
`final ThreadCreateAndRunParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ThreadCreateAndRunParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ThreadCreateAndRunParams.

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.
  - instructions
```
 final Optional<String> instructions()
```
    Override the default system message 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<ThreadCreateAndRunParams.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.
  - thread
```
 final Optional<ThreadCreateAndRunParams.Thread> thread()
```
    Options to create a new thread. If no thread is provided when running a request, an empty thread will be created.
  - 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.
  - toolResources
```
 final Optional<ThreadCreateAndRunParams.ToolResources> toolResources()
```
    A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.
  - 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<ThreadCreateAndRunParams.TruncationStrategy> truncationStrategy()
```
    Controls for how a thread will be truncated prior to the run. Use this to control the initial 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.
  - _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<ThreadCreateAndRunParams.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.
  - _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.
  - _thread
```
 final JsonField<ThreadCreateAndRunParams.Thread> _thread()
```
    Returns the raw JSON value of thread.
    Unlike thread, 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.
  - _toolResources
```
 final JsonField<ThreadCreateAndRunParams.ToolResources> _toolResources()
```
    Returns the raw JSON value of toolResources.
    Unlike toolResources, 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<ThreadCreateAndRunParams.TruncationStrategy> _truncationStrategy()
```
    Returns the raw JSON value of truncationStrategy.
    Unlike truncationStrategy, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final ThreadCreateAndRunParams.Builder toBuilder()
```
  - _body
```
 final ThreadCreateAndRunParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ThreadCreateAndRunParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ThreadCreateAndRunParams.
    The following fields are required:
    .assistantId()

Class ThreadCreateAndRunParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

assistantId

instructions

maxCompletionTokens

maxPromptTokens

metadata

model

parallelToolCalls

responseFormat

temperature

thread

toolChoice

toolResources

tools

topP

truncationStrategy

_assistantId

_instructions

_maxCompletionTokens

_maxPromptTokens

_metadata

_model

_parallelToolCalls

_responseFormat

_temperature

_thread

_toolChoice

_toolResources

_tools

_topP

_truncationStrategy

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder