@ai-sdk/openai 2.0.115 → 2.0.117

package/dist/internal/index.d.mts

@@ -500,6 +500,195 @@ 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;
+        blockedDomains?: 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;
+    } | {
+        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.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, findInPage).
+     */
+    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 | 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.
+         * Omit the HTTP or HTTPS prefix. Maximum 100 domains.
+         */
+        allowedDomains?: string[];
+        /**
+         * Blocked domains for the search.
+         * Subdomains of the provided domains are blocked as well.
+         * Omit the HTTP or HTTPS prefix. Maximum 100 domains.
+         */
+        blockedDomains?: 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, findInPage).
+     */
+    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 | 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?: {
@@ -583,4 +772,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactor
     };
 }>;
 
-export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, getMaxImagesPerCall, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiSpeechProviderOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
+export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, getMaxImagesPerCall, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiSpeechProviderOptionsSchema, webSearch, webSearchArgsSchema, webSearchOutputSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema, webSearchToolFactory };

package/dist/internal/index.d.ts

@@ -500,6 +500,195 @@ 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;
+        blockedDomains?: 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;
+    } | {
+        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.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, findInPage).
+     */
+    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 | 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.
+         * Omit the HTTP or HTTPS prefix. Maximum 100 domains.
+         */
+        allowedDomains?: string[];
+        /**
+         * Blocked domains for the search.
+         * Subdomains of the provided domains are blocked as well.
+         * Omit the HTTP or HTTPS prefix. Maximum 100 domains.
+         */
+        blockedDomains?: 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, findInPage).
+     */
+    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 | 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?: {
@@ -583,4 +772,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactor
     };
 }>;
 
-export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, getMaxImagesPerCall, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiSpeechProviderOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
+export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, getMaxImagesPerCall, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiSpeechProviderOptionsSchema, webSearch, webSearchArgsSchema, webSearchOutputSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema, webSearchToolFactory };

package/dist/internal/index.js

@@ -48,9 +48,13 @@ __export(index_exports, {
   openaiImageModelGenerationOptions: () => openaiImageModelGenerationOptions,
   openaiImageModelOptions: () => openaiImageModelOptions,
   openaiSpeechProviderOptionsSchema: () => openaiSpeechProviderOptionsSchema,
+  webSearch: () => webSearch,
+  webSearchArgsSchema: () => webSearchArgsSchema,
+  webSearchOutputSchema: () => webSearchOutputSchema,
   webSearchPreview: () => webSearchPreview,
   webSearchPreviewArgsSchema: () => webSearchPreviewArgsSchema,
-  webSearchPreviewInputSchema: () => webSearchPreviewInputSchema
+  webSearchPreviewInputSchema: () => webSearchPreviewInputSchema,
+  webSearchToolFactory: () => webSearchToolFactory
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -3533,7 +3537,10 @@ var webSearchArgsSchema = (0, import_provider_utils26.lazySchema)(
   () => (0, import_provider_utils26.zodSchema)(
     import_v419.z.object({
       externalWebAccess: import_v419.z.boolean().optional(),
-      filters: import_v419.z.object({ allowedDomains: import_v419.z.array(import_v419.z.string()).optional() }).optional(),
+      filters: import_v419.z.object({
+        allowedDomains: import_v419.z.array(import_v419.z.string()).optional(),
+        blockedDomains: import_v419.z.array(import_v419.z.string()).optional()
+      }).optional(),
       searchContextSize: import_v419.z.enum(["low", "medium", "high"]).optional(),
       userLocation: import_v419.z.object({
         type: import_v419.z.literal("approximate"),
@@ -3579,6 +3586,7 @@ var webSearchToolFactory = (0, import_provider_utils26.createProviderDefinedTool
   inputSchema: webSearchInputSchema,
   outputSchema: webSearchOutputSchema
 });
+var webSearch = (args = {}) => webSearchToolFactory(args);
 
 // src/tool/web-search-preview.ts
 var import_provider_utils27 = require("@ai-sdk/provider-utils");
@@ -3732,7 +3740,10 @@ async function prepareResponsesTools({
             });
             openaiTools.push({
               type: "web_search",
-              filters: args.filters != null ? { allowed_domains: args.filters.allowedDomains } : void 0,
+              filters: args.filters != null ? {
+                allowed_domains: args.filters.allowedDomains,
+                blocked_domains: args.filters.blockedDomains
+              } : void 0,
               external_web_access: args.externalWebAccess,
               search_context_size: args.searchContextSize,
               user_location: args.userLocation
@@ -4979,8 +4990,12 @@ function getResponsesUsageMetadata(usage) {
   openaiImageModelGenerationOptions,
   openaiImageModelOptions,
   openaiSpeechProviderOptionsSchema,
+  webSearch,
+  webSearchArgsSchema,
+  webSearchOutputSchema,
   webSearchPreview,
   webSearchPreviewArgsSchema,
-  webSearchPreviewInputSchema
+  webSearchPreviewInputSchema,
+  webSearchToolFactory
 });
 //# sourceMappingURL=index.js.map