@ai-sdk/openai 4.0.0-beta.2 → 4.0.0-beta.21

package/dist/index.d.mts

@@ -1,9 +1,9 @@
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { ProviderV3, LanguageModelV3, EmbeddingModelV3, ImageModelV3, TranscriptionModelV3, SpeechModelV3 } from '@ai-sdk/provider';
+import { JSONValue, ProviderV4, LanguageModelV4, EmbeddingModelV4, ImageModelV4, TranscriptionModelV4, SpeechModelV4, FilesV4 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { InferSchema, FetchFunction } from '@ai-sdk/provider-utils';
 
-type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'o4-mini' | 'o4-mini-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview' | 'gpt-4o-mini-search-preview-2025-03-11' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.4' | 'gpt-5.4-2026-03-05' | 'gpt-5.4-pro' | 'gpt-5.4-pro-2026-03-05' | (string & {});
+type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'o4-mini' | 'o4-mini-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-audio-preview-2025-06-03' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini-audio-preview' | 'gpt-4o-mini-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview' | 'gpt-4o-mini-search-preview-2025-03-11' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-5' | 'gpt-5-2025-08-07' | 'gpt-5-mini' | 'gpt-5-mini-2025-08-07' | 'gpt-5-nano' | 'gpt-5-nano-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-chat-latest' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.3-chat-latest' | 'gpt-5.4' | 'gpt-5.4-2026-03-05' | 'gpt-5.4-mini' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.4-pro' | 'gpt-5.4-pro-2026-03-05' | (string & {});
 declare const openaiLanguageModelChatOptions: _ai_sdk_provider_utils.LazySchema<{
     logitBias?: Record<number, number> | undefined;
     logprobs?: number | boolean | undefined;
@@ -141,7 +141,7 @@ declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWi
          */
         timezone?: string;
     };
-}>;
+}, {}>;
 
 /**
  * A filter used to compare a specified attribute key to a given value using a defined comparison operation.
@@ -206,6 +206,28 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         } | null | undefined;
         service_tier?: string | null | undefined;
     };
+} | {
+    type: "response.failed";
+    response: {
+        error?: {
+            message: string;
+            code?: string | null | undefined;
+        } | null | undefined;
+        incomplete_details?: {
+            reason: string;
+        } | null | undefined;
+        usage?: {
+            input_tokens: number;
+            output_tokens: number;
+            input_tokens_details?: {
+                cached_tokens?: number | null | undefined;
+            } | null | undefined;
+            output_tokens_details?: {
+                reasoning_tokens?: number | null | undefined;
+            } | null | undefined;
+        } | null | undefined;
+        service_tier?: string | null | undefined;
+    };
 } | {
     type: "response.created";
     response: {
@@ -300,6 +322,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         action: {
             commands: string[];
         };
+    } | {
+        type: "compaction";
+        id: string;
+        encrypted_content?: string | null | undefined;
     } | {
         type: "shell_call_output";
         id: string;
@@ -315,6 +341,20 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
                 exit_code: number;
             };
         }[];
+    } | {
+        type: "tool_search_call";
+        id: string;
+        execution: "server" | "client";
+        call_id: string | null;
+        status: "completed" | "in_progress" | "incomplete";
+        arguments: unknown;
+    } | {
+        type: "tool_search_output";
+        id: string;
+        execution: "server" | "client";
+        call_id: string | null;
+        status: "completed" | "in_progress" | "incomplete";
+        tools: Record<string, JSONValue | undefined>[];
     };
 } | {
     type: "response.output_item.done";
@@ -469,6 +509,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         action: {
             commands: string[];
         };
+    } | {
+        type: "compaction";
+        id: string;
+        encrypted_content: string;
     } | {
         type: "shell_call_output";
         id: string;
@@ -484,6 +528,20 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
                 exit_code: number;
             };
         }[];
+    } | {
+        type: "tool_search_call";
+        id: string;
+        execution: "server" | "client";
+        call_id: string | null;
+        status: "completed" | "in_progress" | "incomplete";
+        arguments: unknown;
+    } | {
+        type: "tool_search_output";
+        id: string;
+        execution: "server" | "client";
+        call_id: string | null;
+        status: "completed" | "in_progress" | "incomplete";
+        tools: Record<string, JSONValue | undefined>[];
     };
 } | {
     type: "response.function_call_arguments.delta";
@@ -575,10 +633,6 @@ type OpenAIResponsesLogprobs = NonNullable<(OpenAIResponsesChunk & {
 })['logprobs']> | null;
 
 declare const customToolFactory: _ai_sdk_provider_utils.ProviderToolFactory<string, {
-    /**
-     * The name of the custom tool, used to identify it in the API.
-     */
-    name: string;
     /**
      * An optional description of what the tool does.
      */
@@ -594,7 +648,7 @@ declare const customToolFactory: _ai_sdk_provider_utils.ProviderToolFactory<stri
     } | {
         type: "text";
     };
-}>;
+}, {}>;
 
 /**
  * Type definitions for the apply_patch operations.
@@ -641,17 +695,16 @@ declare const openaiTools: {
     }, {
         status: "completed" | "failed";
         output?: string;
-    }, {}>;
+    }, {}, {}>;
     /**
      * Custom tools let callers constrain model output to a grammar (regex or
      * Lark syntax). The model returns a `custom_tool_call` output item whose
      * `input` field is a string matching the specified grammar.
      *
-     * @param name - The name of the custom tool.
      * @param description - An optional description of the tool.
      * @param format - The output format constraint (grammar type, syntax, and definition).
      */
-    customTool: (args: Parameters<typeof customToolFactory>[0]) => _ai_sdk_provider_utils.Tool<string, unknown>;
+    customTool: (args: Parameters<typeof customToolFactory>[0]) => _ai_sdk_provider_utils.Tool<string, unknown, {}>;
     /**
      * The Code Interpreter tool allows models to write and run Python code in a
      * sandboxed environment to solve complex problems in domains like data analysis,
@@ -674,7 +727,7 @@ declare const openaiTools: {
             type: "image";
             url: string;
         }> | null;
-    }>;
+    }, {}>;
     /**
      * File search is a tool available in the Responses API. It enables models to
      * retrieve information in a knowledge base of previously uploaded files through
@@ -702,7 +755,7 @@ declare const openaiTools: {
             scoreThreshold?: number;
         };
         filters?: OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter;
-    }>;
+    }, {}>;
     /**
      * The image generation tool allows you to generate images using a text prompt,
      * and optionally image inputs. It leverages the GPT Image model,
@@ -735,7 +788,7 @@ declare const openaiTools: {
         size?: "auto" | "1024x1024" | "1024x1536" | "1536x1024";
     }) => _ai_sdk_provider_utils.Tool<{}, {
         result: string;
-    }>;
+    }, {}>;
     /**
      * Local shell is a tool that allows agents to run shell commands locally
      * on a machine you or the user provides.
@@ -753,7 +806,7 @@ declare const openaiTools: {
         };
     }, {
         output: string;
-    }, {}>;
+    }, {}, {}>;
     /**
      * The shell tool allows the model to interact with your local computer through
      * a controlled command-line interface. The model proposes shell commands; your
@@ -823,7 +876,7 @@ declare const openaiTools: {
                 path: string;
             }>;
         };
-    }>;
+    }, {}>;
     /**
      * Web search allows models to access up-to-date information from the internet
      * and provide answers with sourced citations.
@@ -852,7 +905,7 @@ declare const openaiTools: {
             region?: string;
             timezone?: string;
         };
-    }>;
+    }, {}>;
     /**
      * Web search allows models to access up-to-date information from the internet
      * and provide answers with sourced citations.
@@ -880,7 +933,7 @@ declare const openaiTools: {
             type: "api";
             name: string;
         }>;
-    }>;
+    }, {}>;
     /**
      * MCP (Model Context Protocol) allows models to call tools exposed by
      * remote MCP servers or service connectors.
@@ -917,10 +970,34 @@ declare const openaiTools: {
         arguments: string;
         output?: string | null;
         error?: _ai_sdk_provider.JSONValue;
-    }>;
+    }, {}>;
+    /**
+     * Tool search allows the model to dynamically search for and load deferred
+     * tools into the model's context as needed. This helps reduce overall token
+     * usage, cost, and latency by only loading tools when the model needs them.
+     *
+     * To use tool search, mark functions or namespaces with `defer_loading: true`
+     * in the tools array. The model will use tool search to load these tools
+     * when it determines they are needed.
+     */
+    toolSearch: (args?: Parameters<_ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{
+        arguments?: unknown;
+        call_id?: string | null;
+    }, {
+        tools: Array<_ai_sdk_provider.JSONObject>;
+    }, {
+        execution?: "server" | "client";
+        description?: string;
+        parameters?: Record<string, unknown>;
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{
+        arguments?: unknown;
+        call_id?: string | null;
+    }, {
+        tools: Array<_ai_sdk_provider.JSONObject>;
+    }, {}>;
 };
 
-type OpenAIResponsesModelId = 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini' | 'gpt-4o' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-chat-latest' | 'gpt-5.1-codex-mini' | 'gpt-5.1-codex' | 'gpt-5.1-codex-max' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.2-codex' | 'gpt-5.4' | 'gpt-5.4-2026-03-05' | 'gpt-5.4-pro' | 'gpt-5.4-pro-2026-03-05' | 'gpt-5.3-codex' | 'gpt-5-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5-codex' | 'gpt-5-mini-2025-08-07' | 'gpt-5-mini' | 'gpt-5-nano-2025-08-07' | 'gpt-5-nano' | 'gpt-5-pro-2025-10-06' | 'gpt-5-pro' | 'gpt-5' | 'o1-2024-12-17' | 'o1' | 'o3-2025-04-16' | 'o3-mini-2025-01-31' | 'o3-mini' | 'o3' | 'o4-mini' | 'o4-mini-2025-04-16' | (string & {});
+type OpenAIResponsesModelId = 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini' | 'gpt-4o' | 'gpt-5.1' | 'gpt-5.1-2025-11-13' | 'gpt-5.1-chat-latest' | 'gpt-5.1-codex-mini' | 'gpt-5.1-codex' | 'gpt-5.1-codex-max' | 'gpt-5.2' | 'gpt-5.2-2025-12-11' | 'gpt-5.2-chat-latest' | 'gpt-5.2-pro' | 'gpt-5.2-pro-2025-12-11' | 'gpt-5.2-codex' | 'gpt-5.3-chat-latest' | 'gpt-5.3-codex' | 'gpt-5.4' | 'gpt-5.4-2026-03-05' | 'gpt-5.4-mini' | 'gpt-5.4-mini-2026-03-17' | 'gpt-5.4-nano' | 'gpt-5.4-nano-2026-03-17' | 'gpt-5.4-pro' | 'gpt-5.4-pro-2026-03-05' | 'gpt-5-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5-codex' | 'gpt-5-mini-2025-08-07' | 'gpt-5-mini' | 'gpt-5-nano-2025-08-07' | 'gpt-5-nano' | 'gpt-5-pro-2025-10-06' | 'gpt-5-pro' | 'gpt-5' | 'o1-2024-12-17' | 'o1' | 'o3-2025-04-16' | 'o3-mini-2025-01-31' | 'o3-mini' | 'o3' | 'o4-mini' | 'o4-mini-2025-04-16' | (string & {});
 declare const openaiLanguageModelResponsesOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
     conversation?: string | null | undefined;
     include?: ("file_search_call.results" | "message.output_text.logprobs" | "reasoning.encrypted_content")[] | null | undefined;
@@ -943,6 +1020,10 @@ declare const openaiLanguageModelResponsesOptionsSchema: _ai_sdk_provider_utils.
     user?: string | null | undefined;
     systemMessageMode?: "remove" | "system" | "developer" | undefined;
     forceReasoning?: boolean | undefined;
+    contextManagement?: {
+        type: "compaction";
+        compactThreshold: number;
+    }[] | null | undefined;
 }>;
 type OpenAILanguageModelResponsesOptions = InferSchema<typeof openaiLanguageModelResponsesOptionsSchema>;
 
@@ -963,56 +1044,60 @@ declare const openAITranscriptionModelOptions: _ai_sdk_provider_utils.LazySchema
 }>;
 type OpenAITranscriptionModelOptions = InferSchema<typeof openAITranscriptionModelOptions>;
 
-interface OpenAIProvider extends ProviderV3 {
-    (modelId: OpenAIResponsesModelId): LanguageModelV3;
+interface OpenAIProvider extends ProviderV4 {
+    (modelId: OpenAIResponsesModelId): LanguageModelV4;
     /**
      * Creates an OpenAI model for text generation.
      */
-    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV3;
+    languageModel(modelId: OpenAIResponsesModelId): LanguageModelV4;
     /**
      * Creates an OpenAI chat model for text generation.
      */
-    chat(modelId: OpenAIChatModelId): LanguageModelV3;
+    chat(modelId: OpenAIChatModelId): LanguageModelV4;
     /**
      * Creates an OpenAI responses API model for text generation.
      */
-    responses(modelId: OpenAIResponsesModelId): LanguageModelV3;
+    responses(modelId: OpenAIResponsesModelId): LanguageModelV4;
     /**
      * Creates an OpenAI completion model for text generation.
      */
-    completion(modelId: OpenAICompletionModelId): LanguageModelV3;
+    completion(modelId: OpenAICompletionModelId): LanguageModelV4;
     /**
      * Creates a model for text embeddings.
      */
-    embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3;
+    embedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV4;
     /**
      * Creates a model for text embeddings.
      */
-    embeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3;
+    embeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV4;
     /**
      * @deprecated Use `embedding` instead.
      */
-    textEmbedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3;
+    textEmbedding(modelId: OpenAIEmbeddingModelId): EmbeddingModelV4;
     /**
      * @deprecated Use `embeddingModel` instead.
      */
-    textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV3;
+    textEmbeddingModel(modelId: OpenAIEmbeddingModelId): EmbeddingModelV4;
     /**
      * Creates a model for image generation.
      */
-    image(modelId: OpenAIImageModelId): ImageModelV3;
+    image(modelId: OpenAIImageModelId): ImageModelV4;
     /**
      * Creates a model for image generation.
      */
-    imageModel(modelId: OpenAIImageModelId): ImageModelV3;
+    imageModel(modelId: OpenAIImageModelId): ImageModelV4;
     /**
      * Creates a model for transcription.
      */
-    transcription(modelId: OpenAITranscriptionModelId): TranscriptionModelV3;
+    transcription(modelId: OpenAITranscriptionModelId): TranscriptionModelV4;
     /**
      * Creates a model for speech generation.
      */
-    speech(modelId: OpenAISpeechModelId): SpeechModelV3;
+    speech(modelId: OpenAISpeechModelId): SpeechModelV4;
+    /**
+     * Returns a FilesV4 interface for uploading files to OpenAI.
+     */
+    files(): FilesV4;
     /**
      * OpenAI-specific tools.
      */
@@ -1058,6 +1143,12 @@ declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
  */
 declare const openai: OpenAIProvider;
 
+declare const openaiFilesOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
+    purpose?: string | undefined;
+    expiresAfter?: number | undefined;
+}>;
+type OpenAIFilesOptions = InferSchema<typeof openaiFilesOptionsSchema>;
+
 type OpenaiResponsesChunk = InferSchema<typeof openaiResponsesChunkSchema>;
 type ResponsesOutputTextAnnotationProviderMetadata = Extract<OpenaiResponsesChunk, {
     type: 'response.output_text.annotation.added';
@@ -1077,6 +1168,14 @@ type OpenaiResponsesReasoningProviderMetadata = {
 type OpenaiResponsesProviderMetadata = {
     openai: ResponsesProviderMetadata;
 };
+type ResponsesCompactionProviderMetadata = {
+    type: 'compaction';
+    itemId: string;
+    encryptedContent?: string;
+};
+type OpenaiResponsesCompactionProviderMetadata = {
+    openai: ResponsesCompactionProviderMetadata;
+};
 type ResponsesTextProviderMetadata = {
     itemId: string;
     phase?: 'commentary' | 'final_answer' | null;
@@ -1104,4 +1203,4 @@ type OpenaiResponsesSourceDocumentProviderMetadata = {
 
 declare const VERSION: string;
 
-export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };
+export { type OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions, type OpenAIEmbeddingModelOptions, type OpenAIFilesOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, type OpenAILanguageModelResponsesOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions, type OpenAISpeechModelOptions, type OpenAITranscriptionModelOptions, type OpenaiResponsesCompactionProviderMetadata, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };