@ai-sdk/openai 3.0.65 → 3.0.67

package/dist/internal/index.d.mts

@@ -488,6 +488,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         action?: {
             type: "search";
             query?: string | null | undefined;
+            queries?: string[] | null | undefined;
             sources?: ({
                 type: "url";
                 url: string;
@@ -1130,6 +1131,200 @@ declare const imageGeneration: (args?: ImageGenerationArgs) => _ai_sdk_provider_
     result: string;
 }>;
 
+declare const webSearchArgsSchema: _ai_sdk_provider_utils.LazySchema<{
+    externalWebAccess?: boolean | undefined;
+    filters?: {
+        allowedDomains?: string[] | undefined;
+    } | undefined;
+    searchContextSize?: "low" | "medium" | "high" | undefined;
+    userLocation?: {
+        type: "approximate";
+        country?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        timezone?: string | undefined;
+    } | undefined;
+}>;
+declare const webSearchOutputSchema: _ai_sdk_provider_utils.LazySchema<{
+    action?: {
+        type: "search";
+        query?: string | undefined;
+        queries?: string[] | undefined;
+    } | {
+        type: "openPage";
+        url?: string | null | undefined;
+    } | {
+        type: "findInPage";
+        url?: string | null | undefined;
+        pattern?: string | null | undefined;
+    } | undefined;
+    sources?: ({
+        type: "url";
+        url: string;
+    } | {
+        type: "api";
+        name: string;
+    })[] | undefined;
+}>;
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
+    /**
+     * 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_in_page).
+     */
+    action?: {
+        /**
+         * Action type "search" - Performs a web search query.
+         */
+        type: "search";
+        /**
+         * The search query.
+         *
+         * @deprecated Use `queries` instead.
+         */
+        query?: string;
+        /**
+         * The search queries the model used.
+         */
+        queries?: string[];
+    } | {
+        /**
+         * Action type "openPage" - Opens a specific URL from search results.
+         */
+        type: "openPage";
+        /**
+         * The URL opened by the model.
+         */
+        url?: string | null;
+    } | {
+        /**
+         * Action type "findInPage": Searches for a pattern within a loaded page.
+         */
+        type: "findInPage";
+        /**
+         * The URL of the page searched for the pattern.
+         */
+        url?: string | null;
+        /**
+         * The pattern or text to search for within the page.
+         */
+        pattern?: string | null;
+    };
+    /**
+     * Optional sources cited by the model for the web search call.
+     */
+    sources?: Array<{
+        type: "url";
+        url: string;
+    } | {
+        type: "api";
+        name: string;
+    }>;
+}, {
+    /**
+     * Whether to use external web access for fetching live content.
+     * - true: Fetch live web content (default)
+     * - false: Use cached/indexed results
+     */
+    externalWebAccess?: boolean;
+    /**
+     * Filters for the search.
+     */
+    filters?: {
+        /**
+         * Allowed domains for the search.
+         * If not provided, all domains are allowed.
+         * Subdomains of the provided domains are allowed as well.
+         */
+        allowedDomains?: string[];
+    };
+    /**
+     * 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?: "low" | "medium" | "high";
+    /**
+     * User location information to provide geographically relevant search results.
+     */
+    userLocation?: {
+        /**
+         * Type of location (always 'approximate')
+         */
+        type: "approximate";
+        /**
+         * Two-letter ISO country code (e.g., 'US', 'GB')
+         */
+        country?: string;
+        /**
+         * City name (free text, e.g., 'Minneapolis')
+         */
+        city?: string;
+        /**
+         * Region name (free text, e.g., 'Minnesota')
+         */
+        region?: string;
+        /**
+         * IANA timezone (e.g., 'America/Chicago')
+         */
+        timezone?: string;
+    };
+}>;
+declare const webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    /**
+     * 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_in_page).
+     */
+    action?: {
+        /**
+         * Action type "search" - Performs a web search query.
+         */
+        type: "search";
+        /**
+         * The search query.
+         *
+         * @deprecated Use `queries` instead.
+         */
+        query?: string;
+        /**
+         * The search queries the model used.
+         */
+        queries?: string[];
+    } | {
+        /**
+         * Action type "openPage" - Opens a specific URL from search results.
+         */
+        type: "openPage";
+        /**
+         * The URL opened by the model.
+         */
+        url?: string | null;
+    } | {
+        /**
+         * Action type "findInPage": Searches for a pattern within a loaded page.
+         */
+        type: "findInPage";
+        /**
+         * The URL of the page searched for the pattern.
+         */
+        url?: string | null;
+        /**
+         * The pattern or text to search for within the page.
+         */
+        pattern?: string | null;
+    };
+    /**
+     * Optional sources cited by the model for the web search call.
+     */
+    sources?: Array<{
+        type: "url";
+        url: string;
+    } | {
+        type: "api";
+        name: string;
+    }>;
+}>;
+
 declare const webSearchPreviewArgsSchema: _ai_sdk_provider_utils.LazySchema<{
     searchContextSize?: "low" | "medium" | "high" | undefined;
     userLocation?: {
@@ -1213,4 +1408,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOu
     };
 }>;
 
-export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
+export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearch, webSearchArgsSchema, webSearchOutputSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema, webSearchToolFactory };

package/dist/internal/index.d.ts

@@ -488,6 +488,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         action?: {
             type: "search";
             query?: string | null | undefined;
+            queries?: string[] | null | undefined;
             sources?: ({
                 type: "url";
                 url: string;
@@ -1130,6 +1131,200 @@ declare const imageGeneration: (args?: ImageGenerationArgs) => _ai_sdk_provider_
     result: string;
 }>;
 
+declare const webSearchArgsSchema: _ai_sdk_provider_utils.LazySchema<{
+    externalWebAccess?: boolean | undefined;
+    filters?: {
+        allowedDomains?: string[] | undefined;
+    } | undefined;
+    searchContextSize?: "low" | "medium" | "high" | undefined;
+    userLocation?: {
+        type: "approximate";
+        country?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        timezone?: string | undefined;
+    } | undefined;
+}>;
+declare const webSearchOutputSchema: _ai_sdk_provider_utils.LazySchema<{
+    action?: {
+        type: "search";
+        query?: string | undefined;
+        queries?: string[] | undefined;
+    } | {
+        type: "openPage";
+        url?: string | null | undefined;
+    } | {
+        type: "findInPage";
+        url?: string | null | undefined;
+        pattern?: string | null | undefined;
+    } | undefined;
+    sources?: ({
+        type: "url";
+        url: string;
+    } | {
+        type: "api";
+        name: string;
+    })[] | undefined;
+}>;
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<{}, {
+    /**
+     * 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_in_page).
+     */
+    action?: {
+        /**
+         * Action type "search" - Performs a web search query.
+         */
+        type: "search";
+        /**
+         * The search query.
+         *
+         * @deprecated Use `queries` instead.
+         */
+        query?: string;
+        /**
+         * The search queries the model used.
+         */
+        queries?: string[];
+    } | {
+        /**
+         * Action type "openPage" - Opens a specific URL from search results.
+         */
+        type: "openPage";
+        /**
+         * The URL opened by the model.
+         */
+        url?: string | null;
+    } | {
+        /**
+         * Action type "findInPage": Searches for a pattern within a loaded page.
+         */
+        type: "findInPage";
+        /**
+         * The URL of the page searched for the pattern.
+         */
+        url?: string | null;
+        /**
+         * The pattern or text to search for within the page.
+         */
+        pattern?: string | null;
+    };
+    /**
+     * Optional sources cited by the model for the web search call.
+     */
+    sources?: Array<{
+        type: "url";
+        url: string;
+    } | {
+        type: "api";
+        name: string;
+    }>;
+}, {
+    /**
+     * Whether to use external web access for fetching live content.
+     * - true: Fetch live web content (default)
+     * - false: Use cached/indexed results
+     */
+    externalWebAccess?: boolean;
+    /**
+     * Filters for the search.
+     */
+    filters?: {
+        /**
+         * Allowed domains for the search.
+         * If not provided, all domains are allowed.
+         * Subdomains of the provided domains are allowed as well.
+         */
+        allowedDomains?: string[];
+    };
+    /**
+     * 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?: "low" | "medium" | "high";
+    /**
+     * User location information to provide geographically relevant search results.
+     */
+    userLocation?: {
+        /**
+         * Type of location (always 'approximate')
+         */
+        type: "approximate";
+        /**
+         * Two-letter ISO country code (e.g., 'US', 'GB')
+         */
+        country?: string;
+        /**
+         * City name (free text, e.g., 'Minneapolis')
+         */
+        city?: string;
+        /**
+         * Region name (free text, e.g., 'Minnesota')
+         */
+        region?: string;
+        /**
+         * IANA timezone (e.g., 'America/Chicago')
+         */
+        timezone?: string;
+    };
+}>;
+declare const webSearch: (args?: Parameters<typeof webSearchToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, {
+    /**
+     * 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_in_page).
+     */
+    action?: {
+        /**
+         * Action type "search" - Performs a web search query.
+         */
+        type: "search";
+        /**
+         * The search query.
+         *
+         * @deprecated Use `queries` instead.
+         */
+        query?: string;
+        /**
+         * The search queries the model used.
+         */
+        queries?: string[];
+    } | {
+        /**
+         * Action type "openPage" - Opens a specific URL from search results.
+         */
+        type: "openPage";
+        /**
+         * The URL opened by the model.
+         */
+        url?: string | null;
+    } | {
+        /**
+         * Action type "findInPage": Searches for a pattern within a loaded page.
+         */
+        type: "findInPage";
+        /**
+         * The URL of the page searched for the pattern.
+         */
+        url?: string | null;
+        /**
+         * The pattern or text to search for within the page.
+         */
+        pattern?: string | null;
+    };
+    /**
+     * Optional sources cited by the model for the web search call.
+     */
+    sources?: Array<{
+        type: "url";
+        url: string;
+    } | {
+        type: "api";
+        name: string;
+    }>;
+}>;
+
 declare const webSearchPreviewArgsSchema: _ai_sdk_provider_utils.LazySchema<{
     searchContextSize?: "low" | "medium" | "high" | undefined;
     userLocation?: {
@@ -1213,4 +1408,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOu
     };
 }>;
 
-export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
+export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearch, webSearchArgsSchema, webSearchOutputSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema, webSearchToolFactory };

package/dist/internal/index.js

@@ -53,9 +53,13 @@ __export(index_exports, {
   openaiLanguageModelChatOptions: () => openaiLanguageModelChatOptions,
   openaiLanguageModelCompletionOptions: () => openaiLanguageModelCompletionOptions,
   openaiSpeechModelOptionsSchema: () => openaiSpeechModelOptionsSchema,
+  webSearch: () => webSearch,
+  webSearchArgsSchema: () => webSearchArgsSchema,
+  webSearchOutputSchema: () => webSearchOutputSchema,
   webSearchPreview: () => webSearchPreview,
   webSearchPreviewArgsSchema: () => webSearchPreviewArgsSchema,
-  webSearchPreviewInputSchema: () => webSearchPreviewInputSchema
+  webSearchPreviewInputSchema: () => webSearchPreviewInputSchema,
+  webSearchToolFactory: () => webSearchToolFactory
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -3578,6 +3582,7 @@ var openaiResponsesChunkSchema = (0, import_provider_utils25.lazySchema)(
               import_v418.z.object({
                 type: import_v418.z.literal("search"),
                 query: import_v418.z.string().nullish(),
+                queries: import_v418.z.array(import_v418.z.string()).nullish(),
                 sources: import_v418.z.array(
                   import_v418.z.discriminatedUnion("type", [
                     import_v418.z.object({ type: import_v418.z.literal("url"), url: import_v418.z.string() }),
@@ -3930,6 +3935,7 @@ var openaiResponsesResponseSchema = (0, import_provider_utils25.lazySchema)(
               import_v418.z.object({
                 type: import_v418.z.literal("search"),
                 query: import_v418.z.string().nullish(),
+                queries: import_v418.z.array(import_v418.z.string()).nullish(),
                 sources: import_v418.z.array(
                   import_v418.z.discriminatedUnion("type", [
                     import_v418.z.object({ type: import_v418.z.literal("url"), url: import_v418.z.string() }),
@@ -4649,7 +4655,8 @@ var webSearchOutputSchema = (0, import_provider_utils32.lazySchema)(
       action: import_v425.z.discriminatedUnion("type", [
         import_v425.z.object({
           type: import_v425.z.literal("search"),
-          query: import_v425.z.string().optional()
+          query: import_v425.z.string().optional(),
+          queries: import_v425.z.array(import_v425.z.string()).optional()
         }),
         import_v425.z.object({
           type: import_v425.z.literal("openPage"),
@@ -4675,6 +4682,7 @@ var webSearchToolFactory = (0, import_provider_utils32.createProviderToolFactory
   inputSchema: webSearchInputSchema,
   outputSchema: webSearchOutputSchema
 });
+var webSearch = (args = {}) => webSearchToolFactory(args);
 
 // src/tool/web-search-preview.ts
 var import_provider_utils33 = require("@ai-sdk/provider-utils");
@@ -6696,7 +6704,11 @@ function mapWebSearchOutput(action) {
   switch (action.type) {
     case "search":
       return {
-        action: { type: "search", query: (_a = action.query) != null ? _a : void 0 },
+        action: {
+          type: "search",
+          query: (_a = action.query) != null ? _a : void 0,
+          ...action.queries != null && { queries: action.queries }
+        },
         // include sources when provided by the Responses API (behind include flag)
         ...action.sources != null && { sources: action.sources }
       };
@@ -6750,8 +6762,12 @@ function escapeJSONDelta(delta) {
   openaiLanguageModelChatOptions,
   openaiLanguageModelCompletionOptions,
   openaiSpeechModelOptionsSchema,
+  webSearch,
+  webSearchArgsSchema,
+  webSearchOutputSchema,
   webSearchPreview,
   webSearchPreviewArgsSchema,
-  webSearchPreviewInputSchema
+  webSearchPreviewInputSchema,
+  webSearchToolFactory
 });
 //# sourceMappingURL=index.js.map