@nocobase/plugin-ai 2.0.9 → 2.0.11

package/dist/node_modules/openai/src/resources/beta/threads/threads.ts

@@ -0,0 +1,1397 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ThreadsAPI from './threads';
+import * as Shared from '../../shared';
+import * as AssistantsAPI from '../assistants';
+import * as MessagesAPI from './messages';
+import {
+  Annotation,
+  AnnotationDelta,
+  FileCitationAnnotation,
+  FileCitationDeltaAnnotation,
+  FilePathAnnotation,
+  FilePathDeltaAnnotation,
+  ImageFile,
+  ImageFileContentBlock,
+  ImageFileDelta,
+  ImageFileDeltaBlock,
+  ImageURL,
+  ImageURLContentBlock,
+  ImageURLDelta,
+  ImageURLDeltaBlock,
+  Message as MessagesAPIMessage,
+  MessageContent,
+  MessageContentDelta,
+  MessageContentPartParam,
+  MessageCreateParams,
+  MessageDeleteParams,
+  MessageDeleted,
+  MessageDelta,
+  MessageDeltaEvent,
+  MessageListParams,
+  MessageRetrieveParams,
+  MessageUpdateParams,
+  Messages,
+  MessagesPage,
+  RefusalContentBlock,
+  RefusalDeltaBlock,
+  Text,
+  TextContentBlock,
+  TextContentBlockParam,
+  TextDelta,
+  TextDeltaBlock,
+} from './messages';
+import * as RunsAPI from './runs/runs';
+import {
+  RequiredActionFunctionToolCall,
+  Run,
+  RunCreateAndPollParams,
+  RunCreateAndStreamParams,
+  RunCancelParams,
+  RunCreateParams,
+  RunCreateParamsNonStreaming,
+  RunCreateParamsStreaming,
+  RunListParams,
+  RunRetrieveParams,
+  RunStatus,
+  RunStreamParams,
+  RunSubmitToolOutputsAndPollParams,
+  RunSubmitToolOutputsParams,
+  RunSubmitToolOutputsParamsNonStreaming,
+  RunSubmitToolOutputsParamsStreaming,
+  RunSubmitToolOutputsStreamParams,
+  RunUpdateParams,
+  Runs,
+  RunsPage,
+} from './runs/runs';
+import { APIPromise } from '../../../core/api-promise';
+import { Stream } from '../../../core/streaming';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { AssistantStream, ThreadCreateAndRunParamsBaseStream } from '../../../lib/AssistantStream';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * @deprecated The Assistants API is deprecated in favor of the Responses API
+ */
+export class Threads extends APIResource {
+  runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
+  messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
+
+  /**
+   * Create a thread.
+   *
+   * @deprecated The Assistants API is deprecated in favor of the Responses API
+   */
+  create(body: ThreadCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<Thread> {
+    return this._client.post('/threads', {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieves a thread.
+   *
+   * @deprecated The Assistants API is deprecated in favor of the Responses API
+   */
+  retrieve(threadID: string, options?: RequestOptions): APIPromise<Thread> {
+    return this._client.get(path`/threads/${threadID}`, {
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Modifies a thread.
+   *
+   * @deprecated The Assistants API is deprecated in favor of the Responses API
+   */
+  update(threadID: string, body: ThreadUpdateParams, options?: RequestOptions): APIPromise<Thread> {
+    return this._client.post(path`/threads/${threadID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Delete a thread.
+   *
+   * @deprecated The Assistants API is deprecated in favor of the Responses API
+   */
+  delete(threadID: string, options?: RequestOptions): APIPromise<ThreadDeleted> {
+    return this._client.delete(path`/threads/${threadID}`, {
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Create a thread and run it in one request.
+   *
+   * @deprecated The Assistants API is deprecated in favor of the Responses API
+   */
+  createAndRun(body: ThreadCreateAndRunParamsNonStreaming, options?: RequestOptions): APIPromise<RunsAPI.Run>;
+  createAndRun(
+    body: ThreadCreateAndRunParamsStreaming,
+    options?: RequestOptions,
+  ): APIPromise<Stream<AssistantsAPI.AssistantStreamEvent>>;
+  createAndRun(
+    body: ThreadCreateAndRunParamsBase,
+    options?: RequestOptions,
+  ): APIPromise<Stream<AssistantsAPI.AssistantStreamEvent> | RunsAPI.Run>;
+  createAndRun(
+    body: ThreadCreateAndRunParams,
+    options?: RequestOptions,
+  ): APIPromise<RunsAPI.Run> | APIPromise<Stream<AssistantsAPI.AssistantStreamEvent>> {
+    return this._client.post('/threads/runs', {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'OpenAI-Beta': 'assistants=v2' }, options?.headers]),
+      stream: body.stream ?? false,
+    }) as APIPromise<RunsAPI.Run> | APIPromise<Stream<AssistantsAPI.AssistantStreamEvent>>;
+  }
+
+  /**
+   * A helper to create a thread, start a run and then poll for a terminal state.
+   * More information on Run lifecycles can be found here:
+   * https://platform.openai.com/docs/assistants/how-it-works/runs-and-run-steps
+   */
+  async createAndRunPoll(
+    body: ThreadCreateAndRunParamsNonStreaming,
+    options?: RequestOptions & { pollIntervalMs?: number },
+  ): Promise<Threads.Run> {
+    const run = await this.createAndRun(body, options);
+    return await this.runs.poll(run.id, { thread_id: run.thread_id }, options);
+  }
+
+  /**
+   * Create a thread and stream the run back
+   */
+  createAndRunStream(body: ThreadCreateAndRunParamsBaseStream, options?: RequestOptions): AssistantStream {
+    return AssistantStream.createThreadAssistantStream(body, this._client.beta.threads, options);
+  }
+}
+
+/**
+ * Specifies the format that the model must output. Compatible with
+ * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+ * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
+ * 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](https://platform.openai.com/docs/guides/structured-outputs).
+ *
+ * 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.
+ */
+export type AssistantResponseFormatOption =
+  | 'auto'
+  | Shared.ResponseFormatText
+  | Shared.ResponseFormatJSONObject
+  | Shared.ResponseFormatJSONSchema;
+
+/**
+ * Specifies a tool the model should use. Use to force the model to call a specific
+ * tool.
+ */
+export interface AssistantToolChoice {
+  /**
+   * The type of the tool. If type is `function`, the function name must be set
+   */
+  type: 'function' | 'code_interpreter' | 'file_search';
+
+  function?: AssistantToolChoiceFunction;
+}
+
+export interface AssistantToolChoiceFunction {
+  /**
+   * The name of the function to call.
+   */
+  name: string;
+}
+
+/**
+ * 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.
+ */
+export type AssistantToolChoiceOption = 'none' | 'auto' | 'required' | AssistantToolChoice;
+
+/**
+ * Represents a thread that contains
+ * [messages](https://platform.openai.com/docs/api-reference/messages).
+ */
+export interface Thread {
+  /**
+   * The identifier, which can be referenced in API endpoints.
+   */
+  id: string;
+
+  /**
+   * The Unix timestamp (in seconds) for when the thread was created.
+   */
+  created_at: number;
+
+  /**
+   * 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.
+   */
+  metadata: Shared.Metadata | null;
+
+  /**
+   * The object type, which is always `thread`.
+   */
+  object: 'thread';
+
+  /**
+   * 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.
+   */
+  tool_resources: Thread.ToolResources | null;
+}
+
+export namespace Thread {
+  /**
+   * 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.
+   */
+  export interface ToolResources {
+    code_interpreter?: ToolResources.CodeInterpreter;
+
+    file_search?: ToolResources.FileSearch;
+  }
+
+  export namespace ToolResources {
+    export interface CodeInterpreter {
+      /**
+       * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+       * available to the `code_interpreter` tool. There can be a maximum of 20 files
+       * associated with the tool.
+       */
+      file_ids?: Array<string>;
+    }
+
+    export interface FileSearch {
+      /**
+       * The
+       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * attached to this thread. There can be a maximum of 1 vector store attached to
+       * the thread.
+       */
+      vector_store_ids?: Array<string>;
+    }
+  }
+}
+
+export interface ThreadDeleted {
+  id: string;
+
+  deleted: boolean;
+
+  object: 'thread.deleted';
+}
+
+export interface ThreadCreateParams {
+  /**
+   * A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
+   * start the thread with.
+   */
+  messages?: Array<ThreadCreateParams.Message>;
+
+  /**
+   * 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.
+   */
+  metadata?: Shared.Metadata | null;
+
+  /**
+   * 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.
+   */
+  tool_resources?: ThreadCreateParams.ToolResources | null;
+}
+
+export namespace ThreadCreateParams {
+  export interface Message {
+    /**
+     * The text contents of the message.
+     */
+    content: string | Array<MessagesAPI.MessageContentPartParam>;
+
+    /**
+     * The role of the entity that is creating the message. Allowed values include:
+     *
+     * - `user`: Indicates the message is sent by an actual user and should be used in
+     *   most cases to represent user-generated messages.
+     * - `assistant`: Indicates the message is generated by the assistant. Use this
+     *   value to insert messages from the assistant into the conversation.
+     */
+    role: 'user' | 'assistant';
+
+    /**
+     * A list of files attached to the message, and the tools they should be added to.
+     */
+    attachments?: Array<Message.Attachment> | null;
+
+    /**
+     * 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.
+     */
+    metadata?: Shared.Metadata | null;
+  }
+
+  export namespace Message {
+    export interface Attachment {
+      /**
+       * The ID of the file to attach to the message.
+       */
+      file_id?: string;
+
+      /**
+       * The tools to add this file to.
+       */
+      tools?: Array<AssistantsAPI.CodeInterpreterTool | Attachment.FileSearch>;
+    }
+
+    export namespace Attachment {
+      export interface FileSearch {
+        /**
+         * The type of tool being defined: `file_search`
+         */
+        type: 'file_search';
+      }
+    }
+  }
+
+  /**
+   * 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.
+   */
+  export interface ToolResources {
+    code_interpreter?: ToolResources.CodeInterpreter;
+
+    file_search?: ToolResources.FileSearch;
+  }
+
+  export namespace ToolResources {
+    export interface CodeInterpreter {
+      /**
+       * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+       * available to the `code_interpreter` tool. There can be a maximum of 20 files
+       * associated with the tool.
+       */
+      file_ids?: Array<string>;
+    }
+
+    export interface FileSearch {
+      /**
+       * The
+       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * attached to this thread. There can be a maximum of 1 vector store attached to
+       * the thread.
+       */
+      vector_store_ids?: Array<string>;
+
+      /**
+       * A helper to create a
+       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * with file_ids and attach it to this thread. There can be a maximum of 1 vector
+       * store attached to the thread.
+       */
+      vector_stores?: Array<FileSearch.VectorStore>;
+    }
+
+    export namespace FileSearch {
+      export interface VectorStore {
+        /**
+         * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+         * strategy.
+         */
+        chunking_strategy?: VectorStore.Auto | VectorStore.Static;
+
+        /**
+         * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
+         * add to the vector store. There can be a maximum of 10000 files in a vector
+         * store.
+         */
+        file_ids?: Array<string>;
+
+        /**
+         * 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.
+         */
+        metadata?: Shared.Metadata | null;
+      }
+
+      export namespace VectorStore {
+        /**
+         * The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
+         * `800` and `chunk_overlap_tokens` of `400`.
+         */
+        export interface Auto {
+          /**
+           * Always `auto`.
+           */
+          type: 'auto';
+        }
+
+        export interface Static {
+          static: Static.Static;
+
+          /**
+           * Always `static`.
+           */
+          type: 'static';
+        }
+
+        export namespace Static {
+          export interface Static {
+            /**
+             * The number of tokens that overlap between chunks. The default value is `400`.
+             *
+             * Note that the overlap must not exceed half of `max_chunk_size_tokens`.
+             */
+            chunk_overlap_tokens: number;
+
+            /**
+             * The maximum number of tokens in each chunk. The default value is `800`. The
+             * minimum value is `100` and the maximum value is `4096`.
+             */
+            max_chunk_size_tokens: number;
+          }
+        }
+      }
+    }
+  }
+}
+
+export interface ThreadUpdateParams {
+  /**
+   * 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.
+   */
+  metadata?: Shared.Metadata | null;
+
+  /**
+   * 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.
+   */
+  tool_resources?: ThreadUpdateParams.ToolResources | null;
+}
+
+export namespace ThreadUpdateParams {
+  /**
+   * 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.
+   */
+  export interface ToolResources {
+    code_interpreter?: ToolResources.CodeInterpreter;
+
+    file_search?: ToolResources.FileSearch;
+  }
+
+  export namespace ToolResources {
+    export interface CodeInterpreter {
+      /**
+       * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+       * available to the `code_interpreter` tool. There can be a maximum of 20 files
+       * associated with the tool.
+       */
+      file_ids?: Array<string>;
+    }
+
+    export interface FileSearch {
+      /**
+       * The
+       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * attached to this thread. There can be a maximum of 1 vector store attached to
+       * the thread.
+       */
+      vector_store_ids?: Array<string>;
+    }
+  }
+}
+
+export type ThreadCreateAndRunParams =
+  | ThreadCreateAndRunParamsNonStreaming
+  | ThreadCreateAndRunParamsStreaming;
+
+export interface ThreadCreateAndRunParamsBase {
+  /**
+   * The ID of the
+   * [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to
+   * execute this run.
+   */
+  assistant_id: string;
+
+  /**
+   * Override the default system message of the assistant. This is useful for
+   * modifying the behavior on a per-run basis.
+   */
+  instructions?: string | null;
+
+  /**
+   * 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.
+   */
+  max_completion_tokens?: number | null;
+
+  /**
+   * 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.
+   */
+  max_prompt_tokens?: number | null;
+
+  /**
+   * 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.
+   */
+  metadata?: Shared.Metadata | null;
+
+  /**
+   * The ID of the [Model](https://platform.openai.com/docs/api-reference/models) 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.
+   */
+  model?: (string & {}) | Shared.ChatModel | null;
+
+  /**
+   * Whether to enable
+   * [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling)
+   * during tool use.
+   */
+  parallel_tool_calls?: boolean;
+
+  /**
+   * Specifies the format that the model must output. Compatible with
+   * [GPT-4o](https://platform.openai.com/docs/models#gpt-4o),
+   * [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4),
+   * 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](https://platform.openai.com/docs/guides/structured-outputs).
+   *
+   * 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.
+   */
+  response_format?: AssistantResponseFormatOption | null;
+
+  /**
+   * If `true`, returns a stream of events that happen during the Run as server-sent
+   * events, terminating when the Run enters a terminal state with a `data: [DONE]`
+   * message.
+   */
+  stream?: boolean | null;
+
+  /**
+   * 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.
+   */
+  temperature?: number | null;
+
+  /**
+   * Options to create a new thread. If no thread is provided when running a request,
+   * an empty thread will be created.
+   */
+  thread?: ThreadCreateAndRunParams.Thread;
+
+  /**
+   * 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.
+   */
+  tool_choice?: AssistantToolChoiceOption | null;
+
+  /**
+   * 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.
+   */
+  tool_resources?: ThreadCreateAndRunParams.ToolResources | null;
+
+  /**
+   * Override the tools the assistant can use for this run. This is useful for
+   * modifying the behavior on a per-run basis.
+   */
+  tools?: Array<AssistantsAPI.AssistantTool> | null;
+
+  /**
+   * 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.
+   */
+  top_p?: number | null;
+
+  /**
+   * Controls for how a thread will be truncated prior to the run. Use this to
+   * control the initial context window of the run.
+   */
+  truncation_strategy?: ThreadCreateAndRunParams.TruncationStrategy | null;
+}
+
+export namespace ThreadCreateAndRunParams {
+  /**
+   * Options to create a new thread. If no thread is provided when running a request,
+   * an empty thread will be created.
+   */
+  export interface Thread {
+    /**
+     * A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
+     * start the thread with.
+     */
+    messages?: Array<Thread.Message>;
+
+    /**
+     * 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.
+     */
+    metadata?: Shared.Metadata | null;
+
+    /**
+     * 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.
+     */
+    tool_resources?: Thread.ToolResources | null;
+  }
+
+  export namespace Thread {
+    export interface Message {
+      /**
+       * The text contents of the message.
+       */
+      content: string | Array<MessagesAPI.MessageContentPartParam>;
+
+      /**
+       * The role of the entity that is creating the message. Allowed values include:
+       *
+       * - `user`: Indicates the message is sent by an actual user and should be used in
+       *   most cases to represent user-generated messages.
+       * - `assistant`: Indicates the message is generated by the assistant. Use this
+       *   value to insert messages from the assistant into the conversation.
+       */
+      role: 'user' | 'assistant';
+
+      /**
+       * A list of files attached to the message, and the tools they should be added to.
+       */
+      attachments?: Array<Message.Attachment> | null;
+
+      /**
+       * 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.
+       */
+      metadata?: Shared.Metadata | null;
+    }
+
+    export namespace Message {
+      export interface Attachment {
+        /**
+         * The ID of the file to attach to the message.
+         */
+        file_id?: string;
+
+        /**
+         * The tools to add this file to.
+         */
+        tools?: Array<AssistantsAPI.CodeInterpreterTool | Attachment.FileSearch>;
+      }
+
+      export namespace Attachment {
+        export interface FileSearch {
+          /**
+           * The type of tool being defined: `file_search`
+           */
+          type: 'file_search';
+        }
+      }
+    }
+
+    /**
+     * 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.
+     */
+    export interface ToolResources {
+      code_interpreter?: ToolResources.CodeInterpreter;
+
+      file_search?: ToolResources.FileSearch;
+    }
+
+    export namespace ToolResources {
+      export interface CodeInterpreter {
+        /**
+         * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+         * available to the `code_interpreter` tool. There can be a maximum of 20 files
+         * associated with the tool.
+         */
+        file_ids?: Array<string>;
+      }
+
+      export interface FileSearch {
+        /**
+         * The
+         * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+         * attached to this thread. There can be a maximum of 1 vector store attached to
+         * the thread.
+         */
+        vector_store_ids?: Array<string>;
+
+        /**
+         * A helper to create a
+         * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+         * with file_ids and attach it to this thread. There can be a maximum of 1 vector
+         * store attached to the thread.
+         */
+        vector_stores?: Array<FileSearch.VectorStore>;
+      }
+
+      export namespace FileSearch {
+        export interface VectorStore {
+          /**
+           * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+           * strategy.
+           */
+          chunking_strategy?: VectorStore.Auto | VectorStore.Static;
+
+          /**
+           * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
+           * add to the vector store. There can be a maximum of 10000 files in a vector
+           * store.
+           */
+          file_ids?: Array<string>;
+
+          /**
+           * 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.
+           */
+          metadata?: Shared.Metadata | null;
+        }
+
+        export namespace VectorStore {
+          /**
+           * The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
+           * `800` and `chunk_overlap_tokens` of `400`.
+           */
+          export interface Auto {
+            /**
+             * Always `auto`.
+             */
+            type: 'auto';
+          }
+
+          export interface Static {
+            static: Static.Static;
+
+            /**
+             * Always `static`.
+             */
+            type: 'static';
+          }
+
+          export namespace Static {
+            export interface Static {
+              /**
+               * The number of tokens that overlap between chunks. The default value is `400`.
+               *
+               * Note that the overlap must not exceed half of `max_chunk_size_tokens`.
+               */
+              chunk_overlap_tokens: number;
+
+              /**
+               * The maximum number of tokens in each chunk. The default value is `800`. The
+               * minimum value is `100` and the maximum value is `4096`.
+               */
+              max_chunk_size_tokens: number;
+            }
+          }
+        }
+      }
+    }
+  }
+
+  /**
+   * 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.
+   */
+  export interface ToolResources {
+    code_interpreter?: ToolResources.CodeInterpreter;
+
+    file_search?: ToolResources.FileSearch;
+  }
+
+  export namespace ToolResources {
+    export interface CodeInterpreter {
+      /**
+       * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+       * available to the `code_interpreter` tool. There can be a maximum of 20 files
+       * associated with the tool.
+       */
+      file_ids?: Array<string>;
+    }
+
+    export interface FileSearch {
+      /**
+       * The ID of the
+       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * attached to this assistant. There can be a maximum of 1 vector store attached to
+       * the assistant.
+       */
+      vector_store_ids?: Array<string>;
+    }
+  }
+
+  /**
+   * Controls for how a thread will be truncated prior to the run. Use this to
+   * control the initial context window of the run.
+   */
+  export interface TruncationStrategy {
+    /**
+     * The truncation strategy to use for the thread. The default is `auto`. If set to
+     * `last_messages`, the thread will be truncated to the n most recent messages in
+     * the thread. When set to `auto`, messages in the middle of the thread will be
+     * dropped to fit the context length of the model, `max_prompt_tokens`.
+     */
+    type: 'auto' | 'last_messages';
+
+    /**
+     * The number of most recent messages from the thread when constructing the context
+     * for the run.
+     */
+    last_messages?: number | null;
+  }
+
+  export type ThreadCreateAndRunParamsNonStreaming = ThreadsAPI.ThreadCreateAndRunParamsNonStreaming;
+  export type ThreadCreateAndRunParamsStreaming = ThreadsAPI.ThreadCreateAndRunParamsStreaming;
+}
+
+export interface ThreadCreateAndRunParamsNonStreaming extends ThreadCreateAndRunParamsBase {
+  /**
+   * If `true`, returns a stream of events that happen during the Run as server-sent
+   * events, terminating when the Run enters a terminal state with a `data: [DONE]`
+   * message.
+   */
+  stream?: false | null;
+}
+
+export interface ThreadCreateAndRunParamsStreaming extends ThreadCreateAndRunParamsBase {
+  /**
+   * If `true`, returns a stream of events that happen during the Run as server-sent
+   * events, terminating when the Run enters a terminal state with a `data: [DONE]`
+   * message.
+   */
+  stream: true;
+}
+
+export interface ThreadCreateAndRunPollParams {
+  /**
+   * The ID of the
+   * [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to
+   * execute this run.
+   */
+  assistant_id: string;
+
+  /**
+   * Override the default system message of the assistant. This is useful for
+   * modifying the behavior on a per-run basis.
+   */
+  instructions?: string | null;
+
+  /**
+   * 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.
+   */
+  max_completion_tokens?: number | null;
+
+  /**
+   * 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.
+   */
+  max_prompt_tokens?: number | null;
+
+  /**
+   * 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. Keys
+   * can be a maximum of 64 characters long and values can be a maxium of 512
+   * characters long.
+   */
+  metadata?: unknown | null;
+
+  /**
+   * The ID of the [Model](https://platform.openai.com/docs/api-reference/models) 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.
+   */
+  model?:
+    | (string & {})
+    | 'gpt-4o'
+    | 'gpt-4o-2024-05-13'
+    | 'gpt-4-turbo'
+    | 'gpt-4-turbo-2024-04-09'
+    | 'gpt-4-0125-preview'
+    | 'gpt-4-turbo-preview'
+    | 'gpt-4-1106-preview'
+    | 'gpt-4-vision-preview'
+    | 'gpt-4'
+    | 'gpt-4-0314'
+    | 'gpt-4-0613'
+    | 'gpt-4-32k'
+    | 'gpt-4-32k-0314'
+    | 'gpt-4-32k-0613'
+    | 'gpt-3.5-turbo'
+    | 'gpt-3.5-turbo-16k'
+    | 'gpt-3.5-turbo-0613'
+    | 'gpt-3.5-turbo-1106'
+    | 'gpt-3.5-turbo-0125'
+    | 'gpt-3.5-turbo-16k-0613'
+    | null;
+
+  /**
+   * Specifies the format that the model must output. Compatible with
+   * [GPT-4o](https://platform.openai.com/docs/models/gpt-4o),
+   * [GPT-4 Turbo](https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4),
+   * and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+   *
+   * Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees 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.
+   */
+  response_format?: AssistantResponseFormatOption | null;
+
+  /**
+   * 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.
+   */
+  temperature?: number | null;
+
+  /**
+   * If no thread is provided, an empty thread will be created.
+   */
+  thread?: ThreadCreateAndRunPollParams.Thread;
+
+  /**
+   * 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.
+   */
+  tool_choice?: AssistantToolChoiceOption | null;
+
+  /**
+   * 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.
+   */
+  tool_resources?: ThreadCreateAndRunPollParams.ToolResources | null;
+
+  /**
+   * Override the tools the assistant can use for this run. This is useful for
+   * modifying the behavior on a per-run basis.
+   */
+  tools?: Array<
+    AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool | AssistantsAPI.FunctionTool
+  > | null;
+
+  /**
+   * 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.
+   */
+  top_p?: number | null;
+
+  /**
+   * Controls for how a thread will be truncated prior to the run. Use this to
+   * control the intial context window of the run.
+   */
+  truncation_strategy?: ThreadCreateAndRunPollParams.TruncationStrategy | null;
+}
+
+export namespace ThreadCreateAndRunPollParams {
+  /**
+   * If no thread is provided, an empty thread will be created.
+   */
+  export interface Thread {
+    /**
+     * A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
+     * start the thread with.
+     */
+    messages?: Array<Thread.Message>;
+
+    /**
+     * 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. Keys
+     * can be a maximum of 64 characters long and values can be a maxium of 512
+     * characters long.
+     */
+    metadata?: unknown | null;
+
+    /**
+     * 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.
+     */
+    tool_resources?: Thread.ToolResources | null;
+  }
+
+  export namespace Thread {
+    export interface Message {
+      /**
+       * The text contents of the message.
+       */
+      content: string | Array<MessagesAPI.MessageContentPartParam>;
+
+      /**
+       * The role of the entity that is creating the message. Allowed values include:
+       *
+       * - `user`: Indicates the message is sent by an actual user and should be used in
+       *   most cases to represent user-generated messages.
+       * - `assistant`: Indicates the message is generated by the assistant. Use this
+       *   value to insert messages from the assistant into the conversation.
+       */
+      role: 'user' | 'assistant';
+
+      /**
+       * A list of files attached to the message, and the tools they should be added to.
+       */
+      attachments?: Array<Message.Attachment> | null;
+
+      /**
+       * 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. Keys
+       * can be a maximum of 64 characters long and values can be a maxium of 512
+       * characters long.
+       */
+      metadata?: unknown | null;
+    }
+
+    export namespace Message {
+      export interface Attachment {
+        /**
+         * The ID of the file to attach to the message.
+         */
+        file_id?: string;
+
+        /**
+         * The tools to add this file to.
+         */
+        tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
+      }
+    }
+
+    /**
+     * 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.
+     */
+    export interface ToolResources {
+      code_interpreter?: ToolResources.CodeInterpreter;
+
+      file_search?: ToolResources.FileSearch;
+    }
+
+    export namespace ToolResources {
+      export interface CodeInterpreter {
+        /**
+         * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+         * available to the `code_interpreter` tool. There can be a maximum of 20 files
+         * associated with the tool.
+         */
+        file_ids?: Array<string>;
+      }
+
+      export interface FileSearch {
+        /**
+         * The
+         * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+         * attached to this thread. There can be a maximum of 1 vector store attached to
+         * the thread.
+         */
+        vector_store_ids?: Array<string>;
+
+        /**
+         * A helper to create a
+         * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+         * with file_ids and attach it to this thread. There can be a maximum of 1 vector
+         * store attached to the thread.
+         */
+        vector_stores?: Array<FileSearch.VectorStore>;
+      }
+
+      export namespace FileSearch {
+        export interface VectorStore {
+          /**
+           * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
+           * add to the vector store. There can be a maximum of 10000 files in a vector
+           * store.
+           */
+          file_ids?: Array<string>;
+
+          /**
+           * Set of 16 key-value pairs that can be attached to a vector store. This can be
+           * useful for storing additional information about the vector store in a structured
+           * format. Keys can be a maximum of 64 characters long and values can be a maxium
+           * of 512 characters long.
+           */
+          metadata?: unknown;
+        }
+      }
+    }
+  }
+
+  /**
+   * 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.
+   */
+  export interface ToolResources {
+    code_interpreter?: ToolResources.CodeInterpreter;
+
+    file_search?: ToolResources.FileSearch;
+  }
+
+  export namespace ToolResources {
+    export interface CodeInterpreter {
+      /**
+       * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
+       * available to the `code_interpreter` tool. There can be a maximum of 20 files
+       * associated with the tool.
+       */
+      file_ids?: Array<string>;
+    }
+
+    export interface FileSearch {
+      /**
+       * The ID of the
+       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * attached to this assistant. There can be a maximum of 1 vector store attached to
+       * the assistant.
+       */
+      vector_store_ids?: Array<string>;
+    }
+  }
+
+  /**
+   * Controls for how a thread will be truncated prior to the run. Use this to
+   * control the intial context window of the run.
+   */
+  export interface TruncationStrategy {
+    /**
+     * The truncation strategy to use for the thread. The default is `auto`. If set to
+     * `last_messages`, the thread will be truncated to the n most recent messages in
+     * the thread. When set to `auto`, messages in the middle of the thread will be
+     * dropped to fit the context length of the model, `max_prompt_tokens`.
+     */
+    type: 'auto' | 'last_messages';
+
+    /**
+     * The number of most recent messages from the thread when constructing the context
+     * for the run.
+     */
+    last_messages?: number | null;
+  }
+}
+
+export type ThreadCreateAndRunStreamParams = ThreadCreateAndRunParamsBaseStream;
+
+Threads.Runs = Runs;
+Threads.Messages = Messages;
+
+export declare namespace Threads {
+  export {
+    type AssistantResponseFormatOption as AssistantResponseFormatOption,
+    type AssistantToolChoice as AssistantToolChoice,
+    type AssistantToolChoiceFunction as AssistantToolChoiceFunction,
+    type AssistantToolChoiceOption as AssistantToolChoiceOption,
+    type Thread as Thread,
+    type ThreadDeleted as ThreadDeleted,
+    type ThreadCreateParams as ThreadCreateParams,
+    type ThreadUpdateParams as ThreadUpdateParams,
+    type ThreadCreateAndRunParams as ThreadCreateAndRunParams,
+    type ThreadCreateAndRunParamsNonStreaming as ThreadCreateAndRunParamsNonStreaming,
+    type ThreadCreateAndRunParamsStreaming as ThreadCreateAndRunParamsStreaming,
+    type ThreadCreateAndRunPollParams,
+    type ThreadCreateAndRunStreamParams,
+  };
+
+  export {
+    Runs as Runs,
+    type RequiredActionFunctionToolCall as RequiredActionFunctionToolCall,
+    type Run as Run,
+    type RunStatus as RunStatus,
+    type RunsPage as RunsPage,
+    type RunCreateParams as RunCreateParams,
+    type RunCreateParamsNonStreaming as RunCreateParamsNonStreaming,
+    type RunCreateParamsStreaming as RunCreateParamsStreaming,
+    type RunRetrieveParams as RunRetrieveParams,
+    type RunUpdateParams as RunUpdateParams,
+    type RunListParams as RunListParams,
+    type RunCancelParams as RunCancelParams,
+    type RunCreateAndPollParams,
+    type RunCreateAndStreamParams,
+    type RunStreamParams,
+    type RunSubmitToolOutputsParams as RunSubmitToolOutputsParams,
+    type RunSubmitToolOutputsParamsNonStreaming as RunSubmitToolOutputsParamsNonStreaming,
+    type RunSubmitToolOutputsParamsStreaming as RunSubmitToolOutputsParamsStreaming,
+    type RunSubmitToolOutputsAndPollParams,
+    type RunSubmitToolOutputsStreamParams,
+  };
+
+  export {
+    Messages as Messages,
+    type Annotation as Annotation,
+    type AnnotationDelta as AnnotationDelta,
+    type FileCitationAnnotation as FileCitationAnnotation,
+    type FileCitationDeltaAnnotation as FileCitationDeltaAnnotation,
+    type FilePathAnnotation as FilePathAnnotation,
+    type FilePathDeltaAnnotation as FilePathDeltaAnnotation,
+    type ImageFile as ImageFile,
+    type ImageFileContentBlock as ImageFileContentBlock,
+    type ImageFileDelta as ImageFileDelta,
+    type ImageFileDeltaBlock as ImageFileDeltaBlock,
+    type ImageURL as ImageURL,
+    type ImageURLContentBlock as ImageURLContentBlock,
+    type ImageURLDelta as ImageURLDelta,
+    type ImageURLDeltaBlock as ImageURLDeltaBlock,
+    type MessagesAPIMessage as Message,
+    type MessageContent as MessageContent,
+    type MessageContentDelta as MessageContentDelta,
+    type MessageContentPartParam as MessageContentPartParam,
+    type MessageDeleted as MessageDeleted,
+    type MessageDelta as MessageDelta,
+    type MessageDeltaEvent as MessageDeltaEvent,
+    type RefusalContentBlock as RefusalContentBlock,
+    type RefusalDeltaBlock as RefusalDeltaBlock,
+    type Text as Text,
+    type TextContentBlock as TextContentBlock,
+    type TextContentBlockParam as TextContentBlockParam,
+    type TextDelta as TextDelta,
+    type TextDeltaBlock as TextDeltaBlock,
+    type MessagesPage as MessagesPage,
+    type MessageCreateParams as MessageCreateParams,
+    type MessageRetrieveParams as MessageRetrieveParams,
+    type MessageUpdateParams as MessageUpdateParams,
+    type MessageListParams as MessageListParams,
+    type MessageDeleteParams as MessageDeleteParams,
+  };
+
+  export { AssistantStream };
+}