Class Thread
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
Thread.Builder
A builder for Thread.
public final class
Thread.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
Thread.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 thefile_search
tool requires a list of vector store IDs.
-
Method Summary
Modifier and Type Method Description final String
id()
The identifier, which can be referenced in API endpoints. final Long
createdAt()
The Unix timestamp (in seconds) for when the thread was created. final Optional<Thread.Metadata>
metadata()
Set of 16 key-value pairs that can be attached to an object. final JsonValue
_object_()
The object type, which is always thread
.final Optional<Thread.ToolResources>
toolResources()
A set of resources that are made available to the assistant's tools in this thread. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<Long>
_createdAt()
Returns the raw JSON value of createdAt. final JsonField<Thread.Metadata>
_metadata()
Returns the raw JSON value of metadata. final JsonField<Thread.ToolResources>
_toolResources()
Returns the raw JSON value of toolResources. final Map<String, JsonValue>
_additionalProperties()
final Thread.Builder
toBuilder()
final Thread
validate()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static Thread.Builder
builder()
Returns a mutable builder for constructing an instance of Thread. -
-
Method Detail
-
metadata
final Optional<Thread.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.
-
_object_
final JsonValue _object_()
The object type, which is always
thread
.Expected to always return the following:
JsonValue.from("thread")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
toolResources
final Optional<Thread.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 thefile_search
tool requires a list of vector store IDs.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<Thread.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<Thread.ToolResources> _toolResources()
Returns the raw JSON value of toolResources.
Unlike toolResources, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Thread.Builder toBuilder()
-
builder
final static Thread.Builder builder()
Returns a mutable builder for constructing an instance of Thread.
The following fields are required:
.id() .createdAt() .metadata() .toolResources()
-
-
-
-