@ai-sdk/openai 4.0.0-beta.8 → 4.0.0-beta.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai
 
+## 4.0.0-beta.9
+
+### Patch Changes
+
+- 156cdf0: feat(openai): add new tool search tool
+
 ## 4.0.0-beta.8
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { ProviderV4, LanguageModelV4, EmbeddingModelV4, ImageModelV4, TranscriptionModelV4, SpeechModelV4 } from '@ai-sdk/provider';
+import { JSONValue, ProviderV4, LanguageModelV4, EmbeddingModelV4, ImageModelV4, TranscriptionModelV4, SpeechModelV4 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { InferSchema, FetchFunction } from '@ai-sdk/provider-utils';
 
@@ -315,6 +315,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";
@@ -484,6 +498,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";
@@ -849,7 +877,19 @@ declare const openaiTools: {
             type: "approximate";
             country?: string;
             city?: string;
-            region?: string;
+            region
+            /**
+             * Local shell is a tool that allows agents to run shell commands locally
+             * on a machine you or the user provides.
+             *
+             * Supported models: `gpt-5-codex`
+             */
+            ? /**
+             * Local shell is a tool that allows agents to run shell commands locally
+             * on a machine you or the user provides.
+             *
+             * Supported models: `gpt-5-codex`
+             */: string;
             timezone?: string;
         };
     }>;
@@ -918,6 +958,30 @@ declare const openaiTools: {
         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.3-chat-latest' | 'gpt-5.3-codex' | 'gpt-5.4' | 'gpt-5.4-2026-03-05' | '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 & {});

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { ProviderV4, LanguageModelV4, EmbeddingModelV4, ImageModelV4, TranscriptionModelV4, SpeechModelV4 } from '@ai-sdk/provider';
+import { JSONValue, ProviderV4, LanguageModelV4, EmbeddingModelV4, ImageModelV4, TranscriptionModelV4, SpeechModelV4 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { InferSchema, FetchFunction } from '@ai-sdk/provider-utils';
 
@@ -315,6 +315,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";
@@ -484,6 +498,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";
@@ -849,7 +877,19 @@ declare const openaiTools: {
             type: "approximate";
             country?: string;
             city?: string;
-            region?: string;
+            region
+            /**
+             * Local shell is a tool that allows agents to run shell commands locally
+             * on a machine you or the user provides.
+             *
+             * Supported models: `gpt-5-codex`
+             */
+            ? /**
+             * Local shell is a tool that allows agents to run shell commands locally
+             * on a machine you or the user provides.
+             *
+             * Supported models: `gpt-5-codex`
+             */: string;
             timezone?: string;
         };
     }>;
@@ -918,6 +958,30 @@ declare const openaiTools: {
         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.3-chat-latest' | 'gpt-5.3-codex' | 'gpt-5.4' | 'gpt-5.4-2026-03-05' | '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 & {});