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


public final class ThreadCreateParams
 implements Params

Create a thread.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ThreadCreateParams.Builder`	A builder for ThreadCreateParams.
`public final class`	`ThreadCreateParams.Body`	Options to create a new thread. If no thread is provided when running a request, an empty thread will be created.
`public final class`	`ThreadCreateParams.Message`
`public final class`	`ThreadCreateParams.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`	`ThreadCreateParams.ToolResources`	A set of resources that are made available to the assistant's tools in this thread. 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.

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 Optional<List<ThreadCreateParams.Message>>`	`messages()`	A list of messages to start the thread with.
`final Optional<ThreadCreateParams.Metadata>`	`metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final Optional<ThreadCreateParams.ToolResources>`	`toolResources()`	A set of resources that are made available to the assistant's tools in this thread.
`final JsonField<List<ThreadCreateParams.Message>>`	`_messages()`	Returns the raw JSON value of messages.
`final JsonField<ThreadCreateParams.Metadata>`	`_metadata()`	Returns the raw JSON value of metadata.
`final JsonField<ThreadCreateParams.ToolResources>`	`_toolResources()`	Returns the raw JSON value of toolResources.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final ThreadCreateParams.Builder`	`toBuilder()`
`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 ThreadCreateParams`	`none()`
`final static ThreadCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ThreadCreateParams.

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

- Constructor Detail
- Method Detail
  - messages
```
 final Optional<List<ThreadCreateParams.Message>> messages()
```
    A list of messages to start the thread with.
  - metadata
```
 final Optional<ThreadCreateParams.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.
  - toolResources
```
 final Optional<ThreadCreateParams.ToolResources> toolResources()
```
    A set of resources that are made available to the assistant's tools in this thread. 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.
  - _messages
```
 final JsonField<List<ThreadCreateParams.Message>> _messages()
```
    Returns the raw JSON value of messages.
    Unlike messages, this method doesn't throw if the JSON field has an unexpected type.
  - _metadata
```
 final JsonField<ThreadCreateParams.Metadata> _metadata()
```
    Returns the raw JSON value of metadata.
    Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
  - _toolResources
```
 final JsonField<ThreadCreateParams.ToolResources> _toolResources()
```
    Returns the raw JSON value of toolResources.
    Unlike toolResources, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final ThreadCreateParams.Builder toBuilder()
```
  - _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()
```
  - none
```
 final static ThreadCreateParams none()
```
  - builder
```
 final static ThreadCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ThreadCreateParams.

Class ThreadCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

messages

metadata

toolResources

_messages

_metadata

_toolResources

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_headers

_queryParams

equals

hashCode

toString

none

builder