@ai-sdk/openai 2.0.25 → 2.0.27

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/openai
 
+## 2.0.27
+
+### Patch Changes
+
+- 2338c79: feat (provider/openai): add jsdoc for openai tools
+
+## 2.0.26
+
+### Patch Changes
+
+- 5819aec: fix (provider/openai): only send tool calls finish reason for tools that are not provider-executed
+- af8c6bb: feat (provider/openai): add web_search tool
+
 ## 2.0.25
 
 ### Patch Changes

package/dist/index.d.mts

@@ -11,12 +11,103 @@ type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large
 
 type OpenAIImageModelId = 'gpt-image-1' | 'dall-e-3' | 'dall-e-2' | (string & {});
 
+declare const factory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    /**
+     * 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 openaiTools: {
+    /**
+     * 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,
+     * coding, and math.
+     *
+     * @param container - The container to use for the code interpreter.
+     *
+     * Must have name `code_interpreter`.
+     */
     codeInterpreter: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
         container?: string | {
-            fileIds?: string[];
+            fileIds
+            /**
+             * 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
+             * semantic and keyword search.
+             *
+             * Must have name `file_search`.
+             *
+             * @param vectorStoreIds - The vector store IDs to use for the file search.
+             * @param maxNumResults - The maximum number of results to return.
+             * @param ranking - The ranking options to use for the file search.
+             * @param filters - The filters to use for the file search.
+             */
+            ? /**
+             * 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
+             * semantic and keyword search.
+             *
+             * Must have name `file_search`.
+             *
+             * @param vectorStoreIds - The vector store IDs to use for the file search.
+             * @param maxNumResults - The maximum number of results to return.
+             * @param ranking - The ranking options to use for the file search.
+             * @param filters - The filters to use for the file search.
+             */: string[];
         };
     }>;
+    /**
+     * 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
+     * semantic and keyword search.
+     *
+     * Must have name `file_search`.
+     *
+     * @param vectorStoreIds - The vector store IDs to use for the file search.
+     * @param maxNumResults - The maximum number of results to return.
+     * @param ranking - The ranking options to use for the file search.
+     * @param filters - The filters to use for the file search.
+     */
     fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         query: string;
     }, {
@@ -34,6 +125,17 @@ declare const openaiTools: {
             filters: any[];
         };
     }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search_preview`.
+     *
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     *
+     * @deprecated Use `webSearch` instead.
+     */
     webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
         searchContextSize?: "low" | "medium" | "high";
         userLocation?: {
@@ -44,6 +146,17 @@ declare const openaiTools: {
             timezone?: string;
         };
     }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search`.
+     *
+     * @param filters - The filters to use for the web search.
+     * @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 factory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 
 type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | '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-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-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});

package/dist/index.d.ts

@@ -11,12 +11,103 @@ type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large
 
 type OpenAIImageModelId = 'gpt-image-1' | 'dall-e-3' | 'dall-e-2' | (string & {});
 
+declare const factory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    /**
+     * 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 openaiTools: {
+    /**
+     * 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,
+     * coding, and math.
+     *
+     * @param container - The container to use for the code interpreter.
+     *
+     * Must have name `code_interpreter`.
+     */
     codeInterpreter: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
         container?: string | {
-            fileIds?: string[];
+            fileIds
+            /**
+             * 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
+             * semantic and keyword search.
+             *
+             * Must have name `file_search`.
+             *
+             * @param vectorStoreIds - The vector store IDs to use for the file search.
+             * @param maxNumResults - The maximum number of results to return.
+             * @param ranking - The ranking options to use for the file search.
+             * @param filters - The filters to use for the file search.
+             */
+            ? /**
+             * 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
+             * semantic and keyword search.
+             *
+             * Must have name `file_search`.
+             *
+             * @param vectorStoreIds - The vector store IDs to use for the file search.
+             * @param maxNumResults - The maximum number of results to return.
+             * @param ranking - The ranking options to use for the file search.
+             * @param filters - The filters to use for the file search.
+             */: string[];
         };
     }>;
+    /**
+     * 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
+     * semantic and keyword search.
+     *
+     * Must have name `file_search`.
+     *
+     * @param vectorStoreIds - The vector store IDs to use for the file search.
+     * @param maxNumResults - The maximum number of results to return.
+     * @param ranking - The ranking options to use for the file search.
+     * @param filters - The filters to use for the file search.
+     */
     fileSearch: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         query: string;
     }, {
@@ -34,6 +125,17 @@ declare const openaiTools: {
             filters: any[];
         };
     }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search_preview`.
+     *
+     * @param searchContextSize - The search context size to use for the web search.
+     * @param userLocation - The user location to use for the web search.
+     *
+     * @deprecated Use `webSearch` instead.
+     */
     webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
         searchContextSize?: "low" | "medium" | "high";
         userLocation?: {
@@ -44,6 +146,17 @@ declare const openaiTools: {
             timezone?: string;
         };
     }>;
+    /**
+     * Web search allows models to access up-to-date information from the internet
+     * and provide answers with sourced citations.
+     *
+     * Must have name `web_search`.
+     *
+     * @param filters - The filters to use for the web search.
+     * @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 factory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
 };
 
 type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | '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-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-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});