@ai-sdk/openai 3.0.0-beta.27 → 3.0.0-beta.28

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai
 
+## 3.0.0-beta.28
+
+### Patch Changes
+
+- 401f561: fix(provider/openai): fix web search tool input types
+
 ## 3.0.0-beta.27
 
 ### Patch Changes

package/dist/index.d.mts

@@ -28,7 +28,44 @@ type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large
 
 type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | (string & {});
 
-declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+    /**
+     * An object describing the specific action taken in this web search call.
+     * Includes details on how the model used the web (search, open_page, find).
+     */
+    action: {
+        /**
+         * Action type "search" - Performs a web search query.
+         */
+        type: "search";
+        /**
+         * The search query.
+         */
+        query?: string;
+    } | {
+        /**
+         * Action type "openPage" - Opens a specific URL from search results.
+         */
+        type: "openPage";
+        /**
+         * The URL opened by the model.
+         */
+        url: string;
+    } | {
+        /**
+         * Action type "find": Searches for a pattern within a loaded page.
+         */
+        type: "find";
+        /**
+         * The URL of the page searched for the pattern.
+         */
+        url: string;
+        /**
+         * The pattern or text to search for within the page.
+         */
+        pattern: string;
+    };
+}, {
     /**
      * Filters for the search.
      */
@@ -227,7 +264,19 @@ declare const openaiTools: {
      *
      * @deprecated Use `webSearch` instead.
      */
-    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+        action: {
+            type: "search";
+            query?: string;
+        } | {
+            type: "openPage";
+            url: string;
+        } | {
+            type: "find";
+            url: string;
+            pattern: string;
+        };
+    }, {
         searchContextSize?: "low" | "medium" | "high";
         userLocation?: {
             type: "approximate";
@@ -247,7 +296,19 @@ declare const openaiTools: {
      * @param searchContextSize - The search context size to use for the web search.
      * @param userLocation - The user location to use for the web search.
      */
-    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+        action: {
+            type: "search";
+            query?: string;
+        } | {
+            type: "openPage";
+            url: string;
+        } | {
+            type: "find";
+            url: string;
+            pattern: string;
+        };
+    }>;
 };
 
 type OpenAIResponsesModelId = 'chatgpt-4o-latest' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo' | 'gpt-4-0613' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-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-4' | '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-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' | (string & {});

package/dist/index.d.ts

@@ -28,7 +28,44 @@ type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large
 
 type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | (string & {});
 
-declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+    /**
+     * An object describing the specific action taken in this web search call.
+     * Includes details on how the model used the web (search, open_page, find).
+     */
+    action: {
+        /**
+         * Action type "search" - Performs a web search query.
+         */
+        type: "search";
+        /**
+         * The search query.
+         */
+        query?: string;
+    } | {
+        /**
+         * Action type "openPage" - Opens a specific URL from search results.
+         */
+        type: "openPage";
+        /**
+         * The URL opened by the model.
+         */
+        url: string;
+    } | {
+        /**
+         * Action type "find": Searches for a pattern within a loaded page.
+         */
+        type: "find";
+        /**
+         * The URL of the page searched for the pattern.
+         */
+        url: string;
+        /**
+         * The pattern or text to search for within the page.
+         */
+        pattern: string;
+    };
+}, {
     /**
      * Filters for the search.
      */
@@ -227,7 +264,19 @@ declare const openaiTools: {
      *
      * @deprecated Use `webSearch` instead.
      */
-    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+        action: {
+            type: "search";
+            query?: string;
+        } | {
+            type: "openPage";
+            url: string;
+        } | {
+            type: "find";
+            url: string;
+            pattern: string;
+        };
+    }, {
         searchContextSize?: "low" | "medium" | "high";
         userLocation?: {
             type: "approximate";
@@ -247,7 +296,19 @@ declare const openaiTools: {
      * @param searchContextSize - The search context size to use for the web search.
      * @param userLocation - The user location to use for the web search.
      */
-    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+        action: {
+            type: "search";
+            query?: string;
+        } | {
+            type: "openPage";
+            url: string;
+        } | {
+            type: "find";
+            url: string;
+            pattern: string;
+        };
+    }>;
 };
 
 type OpenAIResponsesModelId = 'chatgpt-4o-latest' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo' | 'gpt-4-0613' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-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-4' | '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-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' | (string & {});

package/dist/index.js

@@ -1920,9 +1920,7 @@ var import_v413 = require("zod/v4");
 var webSearchArgsSchema = (0, import_provider_utils18.lazySchema)(
   () => (0, import_provider_utils18.zodSchema)(
     import_v413.z.object({
-      filters: import_v413.z.object({
-        allowedDomains: import_v413.z.array(import_v413.z.string()).optional()
-      }).optional(),
+      filters: import_v413.z.object({ allowedDomains: import_v413.z.array(import_v413.z.string()).optional() }).optional(),
       searchContextSize: import_v413.z.enum(["low", "medium", "high"]).optional(),
       userLocation: import_v413.z.object({
         type: import_v413.z.literal("approximate"),
@@ -1934,16 +1932,17 @@ var webSearchArgsSchema = (0, import_provider_utils18.lazySchema)(
     })
   )
 );
-var webSearchInputSchema = (0, import_provider_utils18.lazySchema)(
+var webSearchInputSchema = (0, import_provider_utils18.lazySchema)(() => (0, import_provider_utils18.zodSchema)(import_v413.z.object({})));
+var webSearchOutputSchema = (0, import_provider_utils18.lazySchema)(
   () => (0, import_provider_utils18.zodSchema)(
     import_v413.z.object({
       action: import_v413.z.discriminatedUnion("type", [
         import_v413.z.object({
           type: import_v413.z.literal("search"),
-          query: import_v413.z.string().nullish()
+          query: import_v413.z.string().optional()
         }),
         import_v413.z.object({
-          type: import_v413.z.literal("open_page"),
+          type: import_v413.z.literal("openPage"),
           url: import_v413.z.string()
         }),
         import_v413.z.object({
@@ -1951,18 +1950,17 @@ var webSearchInputSchema = (0, import_provider_utils18.lazySchema)(
           url: import_v413.z.string(),
           pattern: import_v413.z.string()
         })
-      ]).nullish()
+      ])
     })
   )
 );
-var webSearchToolFactory = (0, import_provider_utils18.createProviderDefinedToolFactory)({
+var webSearchToolFactory = (0, import_provider_utils18.createProviderDefinedToolFactoryWithOutputSchema)({
   id: "openai.web_search",
   name: "web_search",
-  inputSchema: webSearchInputSchema
+  inputSchema: webSearchInputSchema,
+  outputSchema: webSearchOutputSchema
 });
-var webSearch = (args = {}) => {
-  return webSearchToolFactory(args);
-};
+var webSearch = (args = {}) => webSearchToolFactory(args);
 
 // src/tool/web-search-preview.ts
 var import_provider_utils19 = require("@ai-sdk/provider-utils");
@@ -1970,51 +1968,30 @@ var import_v414 = require("zod/v4");
 var webSearchPreviewArgsSchema = (0, import_provider_utils19.lazySchema)(
   () => (0, import_provider_utils19.zodSchema)(
     import_v414.z.object({
-      /**
-       * Search context size to use for the web search.
-       * - high: Most comprehensive context, highest cost, slower response
-       * - medium: Balanced context, cost, and latency (default)
-       * - low: Least context, lowest cost, fastest response
-       */
       searchContextSize: import_v414.z.enum(["low", "medium", "high"]).optional(),
-      /**
-       * User location information to provide geographically relevant search results.
-       */
       userLocation: import_v414.z.object({
-        /**
-         * Type of location (always 'approximate')
-         */
         type: import_v414.z.literal("approximate"),
-        /**
-         * Two-letter ISO country code (e.g., 'US', 'GB')
-         */
         country: import_v414.z.string().optional(),
-        /**
-         * City name (free text, e.g., 'Minneapolis')
-         */
         city: import_v414.z.string().optional(),
-        /**
-         * Region name (free text, e.g., 'Minnesota')
-         */
         region: import_v414.z.string().optional(),
-        /**
-         * IANA timezone (e.g., 'America/Chicago')
-         */
         timezone: import_v414.z.string().optional()
       }).optional()
     })
   )
 );
 var webSearchPreviewInputSchema = (0, import_provider_utils19.lazySchema)(
+  () => (0, import_provider_utils19.zodSchema)(import_v414.z.object({}))
+);
+var webSearchPreviewOutputSchema = (0, import_provider_utils19.lazySchema)(
   () => (0, import_provider_utils19.zodSchema)(
     import_v414.z.object({
       action: import_v414.z.discriminatedUnion("type", [
         import_v414.z.object({
           type: import_v414.z.literal("search"),
-          query: import_v414.z.string().nullish()
+          query: import_v414.z.string().optional()
         }),
         import_v414.z.object({
-          type: import_v414.z.literal("open_page"),
+          type: import_v414.z.literal("openPage"),
           url: import_v414.z.string()
         }),
         import_v414.z.object({
@@ -2022,14 +1999,15 @@ var webSearchPreviewInputSchema = (0, import_provider_utils19.lazySchema)(
           url: import_v414.z.string(),
           pattern: import_v414.z.string()
         })
-      ]).nullish()
+      ])
     })
   )
 );
-var webSearchPreview = (0, import_provider_utils19.createProviderDefinedToolFactory)({
+var webSearchPreview = (0, import_provider_utils19.createProviderDefinedToolFactoryWithOutputSchema)({
   id: "openai.web_search_preview",
   name: "web_search_preview",
-  inputSchema: webSearchPreviewInputSchema
+  inputSchema: webSearchPreviewInputSchema,
+  outputSchema: webSearchPreviewOutputSchema
 });
 
 // src/openai-tools.ts
@@ -2483,11 +2461,7 @@ var openaiResponsesChunkSchema = (0, import_provider_utils21.lazySchema)(
           import_v416.z.object({
             type: import_v416.z.literal("web_search_call"),
             id: import_v416.z.string(),
-            status: import_v416.z.string(),
-            action: import_v416.z.object({
-              type: import_v416.z.literal("search"),
-              query: import_v416.z.string().optional()
-            }).nullish()
+            status: import_v416.z.string()
           }),
           import_v416.z.object({
             type: import_v416.z.literal("computer_call"),
@@ -2573,7 +2547,7 @@ var openaiResponsesChunkSchema = (0, import_provider_utils21.lazySchema)(
                 url: import_v416.z.string(),
                 pattern: import_v416.z.string()
               })
-            ]).nullish()
+            ])
           }),
           import_v416.z.object({
             type: import_v416.z.literal("file_search_call"),
@@ -2754,7 +2728,7 @@ var openaiResponsesResponseSchema = (0, import_provider_utils21.lazySchema)(
                 url: import_v416.z.string(),
                 pattern: import_v416.z.string()
               })
-            ]).nullish()
+            ])
           }),
           import_v416.z.object({
             type: import_v416.z.literal("file_search_call"),
@@ -3453,14 +3427,14 @@ var OpenAIResponsesLanguageModel = class {
             type: "tool-call",
             toolCallId: part.id,
             toolName: webSearchToolName != null ? webSearchToolName : "web_search",
-            input: JSON.stringify({ action: part.action }),
+            input: JSON.stringify({}),
             providerExecuted: true
           });
           content.push({
             type: "tool-result",
             toolCallId: part.id,
             toolName: webSearchToolName != null ? webSearchToolName : "web_search",
-            result: { status: part.status },
+            result: mapWebSearchOutput(part.action),
             providerExecuted: true
           });
           break;
@@ -3644,6 +3618,17 @@ var OpenAIResponsesLanguageModel = class {
                   toolName: webSearchToolName != null ? webSearchToolName : "web_search",
                   providerExecuted: true
                 });
+                controller.enqueue({
+                  type: "tool-input-end",
+                  id: value.item.id
+                });
+                controller.enqueue({
+                  type: "tool-call",
+                  toolCallId: value.item.id,
+                  toolName: "web_search",
+                  input: JSON.stringify({}),
+                  providerExecuted: true
+                });
               } else if (value.item.type === "computer_call") {
                 ongoingToolCalls[value.output_index] = {
                   toolName: "computer_use",
@@ -3737,22 +3722,11 @@ var OpenAIResponsesLanguageModel = class {
                 });
               } else if (value.item.type === "web_search_call") {
                 ongoingToolCalls[value.output_index] = void 0;
-                controller.enqueue({
-                  type: "tool-input-end",
-                  id: value.item.id
-                });
-                controller.enqueue({
-                  type: "tool-call",
-                  toolCallId: value.item.id,
-                  toolName: "web_search",
-                  input: JSON.stringify({ action: value.item.action }),
-                  providerExecuted: true
-                });
                 controller.enqueue({
                   type: "tool-result",
                   toolCallId: value.item.id,
                   toolName: "web_search",
-                  result: { status: value.item.status },
+                  result: mapWebSearchOutput(value.item.action),
                   providerExecuted: true
                 });
               } else if (value.item.type === "computer_call") {
@@ -4097,6 +4071,19 @@ function getResponsesModelConfig(modelId) {
     isReasoningModel: false
   };
 }
+function mapWebSearchOutput(action) {
+  var _a;
+  switch (action.type) {
+    case "search":
+      return { action: { type: "search", query: (_a = action.query) != null ? _a : void 0 } };
+    case "open_page":
+      return { action: { type: "openPage", url: action.url } };
+    case "find":
+      return {
+        action: { type: "find", url: action.url, pattern: action.pattern }
+      };
+  }
+}
 
 // src/speech/openai-speech-model.ts
 var import_provider_utils26 = require("@ai-sdk/provider-utils");
@@ -4451,7 +4438,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.0-beta.27" : "0.0.0-test";
+var VERSION = true ? "3.0.0-beta.28" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {