@ai-sdk/openai 2.0.26 → 2.0.28

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/openai
 
+## 2.0.28
+
+### Patch Changes
+
+- 4c2bb77: fix (provider/openai): send sources action as include
+- 561e8b0: fix (provider/openai): fix code interpreter tool in doGenerate
+
+## 2.0.27
+
+### Patch Changes
+
+- 2338c79: feat (provider/openai): add jsdoc for openai tools
+
 ## 2.0.26
 
 ### Patch Changes

package/dist/index.d.mts

@@ -11,7 +11,7 @@ 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<{}, {
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
     /**
      * Filters for the search.
      */
@@ -57,12 +57,40 @@ declare const factory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
     };
 }>;
 
+declare const codeInterpreterToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    /**
+     * The code interpreter container.
+     * Can be a container ID
+     * or an object that specifies uploaded file IDs to make available to your code.
+     */
+    container?: string | {
+        fileIds?: string[];
+    };
+}>;
+
 declare const openaiTools: {
-    codeInterpreter: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
-        container?: string | {
-            fileIds?: string[];
-        };
-    }>;
+    /**
+     * 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: (args?: Parameters<typeof codeInterpreterToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    /**
+     * 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;
     }, {
@@ -80,6 +108,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?: {
@@ -90,7 +129,17 @@ declare const openaiTools: {
             timezone?: string;
         };
     }>;
-    webSearch: (args?: Parameters<typeof factory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    /**
+     * 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 webSearchToolFactory>[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 & {});
@@ -206,9 +255,9 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
         priority: "priority";
     }>>>;
     include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
-        "reasoning.encrypted_content": "reasoning.encrypted_content";
         "file_search_call.results": "file_search_call.results";
         "message.output_text.logprobs": "message.output_text.logprobs";
+        "reasoning.encrypted_content": "reasoning.encrypted_content";
     }>>>>;
     textVerbosity: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         low: "low";

package/dist/index.d.ts

@@ -11,7 +11,7 @@ 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<{}, {
+declare const webSearchToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
     /**
      * Filters for the search.
      */
@@ -57,12 +57,40 @@ declare const factory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
     };
 }>;
 
+declare const codeInterpreterToolFactory: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    /**
+     * The code interpreter container.
+     * Can be a container ID
+     * or an object that specifies uploaded file IDs to make available to your code.
+     */
+    container?: string | {
+        fileIds?: string[];
+    };
+}>;
+
 declare const openaiTools: {
-    codeInterpreter: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
-        container?: string | {
-            fileIds?: string[];
-        };
-    }>;
+    /**
+     * 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: (args?: Parameters<typeof codeInterpreterToolFactory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    /**
+     * 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;
     }, {
@@ -80,6 +108,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?: {
@@ -90,7 +129,17 @@ declare const openaiTools: {
             timezone?: string;
         };
     }>;
-    webSearch: (args?: Parameters<typeof factory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    /**
+     * 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 webSearchToolFactory>[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 & {});
@@ -206,9 +255,9 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
         priority: "priority";
     }>>>;
     include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<{
-        "reasoning.encrypted_content": "reasoning.encrypted_content";
         "file_search_call.results": "file_search_call.results";
         "message.output_text.logprobs": "message.output_text.logprobs";
+        "reasoning.encrypted_content": "reasoning.encrypted_content";
     }>>>>;
     textVerbosity: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
         low: "low";

package/dist/index.js

@@ -369,23 +369,11 @@ var compoundFilterSchema = import_v43.z.object({
 });
 var filtersSchema = import_v43.z.union([comparisonFilterSchema, compoundFilterSchema]);
 var fileSearchArgsSchema = import_v43.z.object({
-  /**
-   * List of vector store IDs to search through. If not provided, searches all available vector stores.
-   */
   vectorStoreIds: import_v43.z.array(import_v43.z.string()).optional(),
-  /**
-   * Maximum number of search results to return. Defaults to 10.
-   */
   maxNumResults: import_v43.z.number().optional(),
-  /**
-   * Ranking options for the search.
-   */
   ranking: import_v43.z.object({
     ranker: import_v43.z.enum(["auto", "default-2024-08-21"]).optional()
   }).optional(),
-  /**
-   * A filter to apply based on file attributes.
-   */
   filters: filtersSchema.optional()
 });
 var fileSearch = (0, import_provider_utils3.createProviderDefinedToolFactory)({
@@ -1819,11 +1807,14 @@ var codeInterpreterArgsSchema = import_v411.z.object({
     })
   ]).optional()
 });
-var codeInterpreter = (0, import_provider_utils9.createProviderDefinedToolFactory)({
+var codeInterpreterToolFactory = (0, import_provider_utils9.createProviderDefinedToolFactory)({
   id: "openai.code_interpreter",
   name: "code_interpreter",
   inputSchema: import_v411.z.object({})
 });
+var codeInterpreter = (args = {}) => {
+  return codeInterpreterToolFactory(args);
+};
 
 // src/tool/web-search.ts
 var import_provider_utils10 = require("@ai-sdk/provider-utils");
@@ -1841,7 +1832,7 @@ var webSearchArgsSchema = import_v412.z.object({
     timezone: import_v412.z.string().optional()
   }).optional()
 });
-var factory = (0, import_provider_utils10.createProviderDefinedToolFactory)({
+var webSearchToolFactory = (0, import_provider_utils10.createProviderDefinedToolFactory)({
   id: "openai.web_search",
   name: "web_search",
   inputSchema: import_v412.z.object({
@@ -1863,14 +1854,56 @@ var factory = (0, import_provider_utils10.createProviderDefinedToolFactory)({
   })
 });
 var webSearch = (args = {}) => {
-  return factory(args);
+  return webSearchToolFactory(args);
 };
 
 // src/openai-tools.ts
 var 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,
+  /**
+   * 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,
+  /**
+   * 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,
+  /**
+   * 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
 };
 
@@ -2257,7 +2290,7 @@ var OpenAIResponsesLanguageModel = class {
     toolChoice,
     responseFormat
   }) {
-    var _a, _b;
+    var _a, _b, _c;
     const warnings = [];
     const modelConfig = getResponsesModelConfig(this.modelId);
     if (topK != null) {
@@ -2293,8 +2326,13 @@ var OpenAIResponsesLanguageModel = class {
       schema: openaiResponsesProviderOptionsSchema
     });
     const strictJsonSchema = (_a = openaiOptions == null ? void 0 : openaiOptions.strictJsonSchema) != null ? _a : false;
+    let include = openaiOptions == null ? void 0 : openaiOptions.include;
     const topLogprobs = typeof (openaiOptions == null ? void 0 : openaiOptions.logprobs) === "number" ? openaiOptions == null ? void 0 : openaiOptions.logprobs : (openaiOptions == null ? void 0 : openaiOptions.logprobs) === true ? TOP_LOGPROBS_MAX : void 0;
-    const openaiOptionsInclude = topLogprobs ? Array.isArray(openaiOptions == null ? void 0 : openaiOptions.include) ? [...openaiOptions == null ? void 0 : openaiOptions.include, "message.output_text.logprobs"] : ["message.output_text.logprobs"] : openaiOptions == null ? void 0 : openaiOptions.include;
+    include = topLogprobs ? Array.isArray(include) ? [...include, "message.output_text.logprobs"] : ["message.output_text.logprobs"] : include;
+    const webSearchToolName = (_b = tools == null ? void 0 : tools.find(
+      (tool) => tool.type === "provider-defined" && (tool.id === "openai.web_search" || tool.id === "openai.web_search_preview")
+    )) == null ? void 0 : _b.name;
+    include = webSearchToolName ? Array.isArray(include) ? [...include, "web_search_call.action.sources"] : ["web_search_call.action.sources"] : include;
     const baseArgs = {
       model: this.modelId,
       input: messages,
@@ -2307,7 +2345,7 @@ var OpenAIResponsesLanguageModel = class {
             format: responseFormat.schema != null ? {
               type: "json_schema",
               strict: strictJsonSchema,
-              name: (_b = responseFormat.name) != null ? _b : "response",
+              name: (_c = responseFormat.name) != null ? _c : "response",
               description: responseFormat.description,
               schema: responseFormat.schema
             } : { type: "json_object" }
@@ -2325,7 +2363,7 @@ var OpenAIResponsesLanguageModel = class {
       user: openaiOptions == null ? void 0 : openaiOptions.user,
       instructions: openaiOptions == null ? void 0 : openaiOptions.instructions,
       service_tier: openaiOptions == null ? void 0 : openaiOptions.serviceTier,
-      include: openaiOptionsInclude,
+      include,
       prompt_cache_key: openaiOptions == null ? void 0 : openaiOptions.promptCacheKey,
       safety_identifier: openaiOptions == null ? void 0 : openaiOptions.safetyIdentifier,
       top_logprobs: topLogprobs,
@@ -2403,6 +2441,7 @@ var OpenAIResponsesLanguageModel = class {
       strictJsonSchema
     });
     return {
+      webSearchToolName,
       args: {
         ...baseArgs,
         tools: openaiTools2,
@@ -2413,7 +2452,11 @@ var OpenAIResponsesLanguageModel = class {
   }
   async doGenerate(options) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q;
-    const { args: body, warnings } = await this.getArgs(options);
+    const {
+      args: body,
+      warnings,
+      webSearchToolName
+    } = await this.getArgs(options);
     const url = this.config.url({
       path: "/responses",
       modelId: this.modelId
@@ -2464,12 +2507,18 @@ var OpenAIResponsesLanguageModel = class {
                           start_index: import_v414.z.number().nullish(),
                           end_index: import_v414.z.number().nullish(),
                           quote: import_v414.z.string().nullish()
+                        }),
+                        import_v414.z.object({
+                          type: import_v414.z.literal("container_file_citation")
                         })
                       ])
                     )
                   })
                 )
               }),
+              import_v414.z.object({
+                type: import_v414.z.literal("code_interpreter_call")
+              }),
               import_v414.z.object({
                 type: import_v414.z.literal("function_call"),
                 call_id: import_v414.z.string(),
@@ -2610,14 +2659,14 @@ var OpenAIResponsesLanguageModel = class {
           content.push({
             type: "tool-call",
             toolCallId: part.id,
-            toolName: "web_search_preview",
+            toolName: webSearchToolName != null ? webSearchToolName : "web_search",
             input: JSON.stringify({ action: part.action }),
             providerExecuted: true
           });
           content.push({
             type: "tool-result",
             toolCallId: part.id,
-            toolName: "web_search_preview",
+            toolName: webSearchToolName != null ? webSearchToolName : "web_search",
             result: { status: part.status },
             providerExecuted: true
           });
@@ -2702,7 +2751,11 @@ var OpenAIResponsesLanguageModel = class {
     };
   }
   async doStream(options) {
-    const { args: body, warnings } = await this.getArgs(options);
+    const {
+      args: body,
+      warnings,
+      webSearchToolName
+    } = await this.getArgs(options);
     const { responseHeaders, value: response } = await (0, import_provider_utils13.postJsonToApi)({
       url: this.config.url({
         path: "/responses",
@@ -2763,13 +2816,13 @@ var OpenAIResponsesLanguageModel = class {
                 });
               } else if (value.item.type === "web_search_call") {
                 ongoingToolCalls[value.output_index] = {
-                  toolName: "web_search_preview",
+                  toolName: webSearchToolName != null ? webSearchToolName : "web_search",
                   toolCallId: value.item.id
                 };
                 controller.enqueue({
                   type: "tool-input-start",
                   id: value.item.id,
-                  toolName: "web_search_preview"
+                  toolName: webSearchToolName != null ? webSearchToolName : "web_search"
                 });
               } else if (value.item.type === "computer_call") {
                 ongoingToolCalls[value.output_index] = {