openai 7.12.1 → 7.13.0

package/src/resources/beta/threads/threads.ts

@@ -186,14 +186,14 @@ export class Threads extends APIResource {
 
 /**
  * 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`.
+ * [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+ * [GPT-4 Turbo](https://developers.openai.com/api/docs/models/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](https://platform.openai.com/docs/guides/structured-outputs).
+ * [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
  *
  * Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
  * message the model generates is valid JSON.
@@ -245,7 +245,7 @@ export type AssistantToolChoiceOption = 'none' | 'auto' | 'required' | Assistant
 
 /**
  * Represents a thread that contains
- * [messages](https://platform.openai.com/docs/api-reference/messages).
+ * [messages](https://developers.openai.com/api/docs/assistants/migration).
  */
 export interface Thread {
   /**
@@ -298,9 +298,9 @@ export namespace Thread {
   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.
+       * A list of [file](https://developers.openai.com/api/reference/resources/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>;
     }
@@ -308,7 +308,7 @@ export namespace Thread {
     export interface FileSearch {
       /**
        * The
-       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
        * attached to this thread. There can be a maximum of 1 vector store attached to
        * the thread.
        */
@@ -327,8 +327,9 @@ export interface ThreadDeleted {
 
 export interface ThreadCreateParams {
   /**
-   * A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
-   * start the thread with.
+   * A list of
+   * [messages](https://developers.openai.com/api/docs/assistants/migration) to start
+   * the thread with.
    */
   messages?: Array<ThreadCreateParams.Message>;
 
@@ -422,9 +423,9 @@ export namespace ThreadCreateParams {
   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.
+       * A list of [file](https://developers.openai.com/api/reference/resources/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>;
     }
@@ -432,7 +433,7 @@ export namespace ThreadCreateParams {
     export interface FileSearch {
       /**
        * The
-       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
        * attached to this thread. There can be a maximum of 1 vector store attached to
        * the thread.
        */
@@ -440,7 +441,7 @@ export namespace ThreadCreateParams {
 
       /**
        * A helper to create a
-       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
        * with file_ids and attach it to this thread. There can be a maximum of 1 vector
        * store attached to the thread.
        */
@@ -456,10 +457,10 @@ export namespace ThreadCreateParams {
         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. For vector stores created before Nov 2025, there can be
-         * a maximum of 10,000 files in a vector store. For vector stores created starting
-         * in Nov 2025, the limit is 100,000,000 files.
+         * A list of [file](https://developers.openai.com/api/reference/resources/files)
+         * IDs to add to the vector store. For vector stores created before Nov 2025, there
+         * can be a maximum of 10,000 files in a vector store. For vector stores created
+         * starting in Nov 2025, the limit is 100,000,000 files.
          */
         file_ids?: Array<string>;
 
@@ -552,9 +553,9 @@ export namespace ThreadUpdateParams {
   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.
+       * A list of [file](https://developers.openai.com/api/reference/resources/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>;
     }
@@ -562,7 +563,7 @@ export namespace ThreadUpdateParams {
     export interface FileSearch {
       /**
        * The
-       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
        * attached to this thread. There can be a maximum of 1 vector store attached to
        * the thread.
        */
@@ -578,8 +579,8 @@ export type ThreadCreateAndRunParams =
 export interface ThreadCreateAndRunParamsBase {
   /**
    * The ID of the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to
-   * execute this run.
+   * [assistant](https://developers.openai.com/api/docs/assistants/migration) to use
+   * to execute this run.
    */
   assistant_id: string;
 
@@ -618,30 +619,31 @@ export interface ThreadCreateAndRunParamsBase {
   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.
+   * The ID of the
+   * [Model](https://developers.openai.com/api/reference/resources/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)
+   * [parallel function calling](https://developers.openai.com/api/docs/guides/function-calling#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`.
+   * [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),
+   * [GPT-4 Turbo](https://developers.openai.com/api/docs/models/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](https://platform.openai.com/docs/guides/structured-outputs).
+   * [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
    *
    * Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
    * message the model generates is valid JSON.
@@ -724,8 +726,9 @@ export namespace ThreadCreateAndRunParams {
    */
   export interface Thread {
     /**
-     * A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
-     * start the thread with.
+     * A list of
+     * [messages](https://developers.openai.com/api/docs/assistants/migration) to start
+     * the thread with.
      */
     messages?: Array<Thread.Message>;
 
@@ -819,9 +822,9 @@ export namespace ThreadCreateAndRunParams {
     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.
+         * A list of [file](https://developers.openai.com/api/reference/resources/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>;
       }
@@ -829,7 +832,7 @@ export namespace ThreadCreateAndRunParams {
       export interface FileSearch {
         /**
          * The
-         * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+         * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
          * attached to this thread. There can be a maximum of 1 vector store attached to
          * the thread.
          */
@@ -837,7 +840,7 @@ export namespace ThreadCreateAndRunParams {
 
         /**
          * A helper to create a
-         * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+         * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
          * with file_ids and attach it to this thread. There can be a maximum of 1 vector
          * store attached to the thread.
          */
@@ -853,10 +856,10 @@ export namespace ThreadCreateAndRunParams {
           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. For vector stores created before Nov 2025, there can be
-           * a maximum of 10,000 files in a vector store. For vector stores created starting
-           * in Nov 2025, the limit is 100,000,000 files.
+           * A list of [file](https://developers.openai.com/api/reference/resources/files)
+           * IDs to add to the vector store. For vector stores created before Nov 2025, there
+           * can be a maximum of 10,000 files in a vector store. For vector stores created
+           * starting in Nov 2025, the limit is 100,000,000 files.
            */
           file_ids?: Array<string>;
 
@@ -928,9 +931,9 @@ export namespace ThreadCreateAndRunParams {
   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.
+       * A list of [file](https://developers.openai.com/api/reference/resources/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>;
     }
@@ -938,7 +941,7 @@ export namespace ThreadCreateAndRunParams {
     export interface FileSearch {
       /**
        * The ID of the
-       * [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
+       * [vector store](https://developers.openai.com/api/reference/resources/vector_stores)
        * attached to this assistant. There can be a maximum of 1 vector store attached to
        * the assistant.
        */