Interface Thread

Options to create a new thread. If no thread is provided when running a request, an empty thread will be created.

interface Thread {
    messages?: OpenAIClient.Beta.Threads.ThreadCreateAndRunParams.Thread.Message[];
    metadata?: null | Metadata;
    tool_resources?: null | OpenAIClient.Beta.Threads.ThreadCreateAndRunParams.Thread.ToolResources;
}

Properties

messages? metadata? tool_resources?

Properties

Optionalmessages

messages?: OpenAIClient.Beta.Threads.ThreadCreateAndRunParams.Thread.Message[]

A list of messages to start the thread with.

Optionalmetadata

metadata?: null | 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.

Optionaltool_resources

tool_resources?: null | OpenAIClient.Beta.Threads.ThreadCreateAndRunParams.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 the file_search tool requires a list of vector store IDs.

Settings

Member Visibility

On This Page

Properties