@ai-sdk/openai 2.0.27 → 2.0.29

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/openai
 
+## 2.0.29
+
+### Patch Changes
+
+- 4235eb3: feat(provider/openai): code interpreter tool calls and results
+
+## 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

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.
      */
@@ -67,34 +67,21 @@ declare const openaiTools: {
      *
      * Must have name `code_interpreter`.
      */
-    codeInterpreter: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    codeInterpreter: (args?: {
         container?: 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[];
+            fileIds?: string[];
         };
+    }) => _ai_sdk_provider_utils.Tool<{
+        code?: string | null;
+        containerId: string;
+    }, {
+        outputs?: Array<{
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        }> | null;
     }>;
     /**
      * File search is a tool available in the Responses API. It enables models to
@@ -156,7 +143,7 @@ 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 factory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    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 & {});
@@ -272,9 +259,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.
      */
@@ -67,34 +67,21 @@ declare const openaiTools: {
      *
      * Must have name `code_interpreter`.
      */
-    codeInterpreter: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {
+    codeInterpreter: (args?: {
         container?: 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[];
+            fileIds?: string[];
         };
+    }) => _ai_sdk_provider_utils.Tool<{
+        code?: string | null;
+        containerId: string;
+    }, {
+        outputs?: Array<{
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        }> | null;
     }>;
     /**
      * File search is a tool available in the Responses API. It enables models to
@@ -156,7 +143,7 @@ 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 factory>[0]) => _ai_sdk_provider_utils.Tool<{}, unknown>;
+    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 & {});
@@ -272,9 +259,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

@@ -1799,6 +1799,18 @@ var openaiImageResponseSchema = import_v410.z.object({
 // src/tool/code-interpreter.ts
 var import_provider_utils9 = require("@ai-sdk/provider-utils");
 var import_v411 = require("zod/v4");
+var codeInterpreterInputSchema = import_v411.z.object({
+  code: import_v411.z.string().nullish(),
+  containerId: import_v411.z.string()
+});
+var codeInterpreterOutputSchema = import_v411.z.object({
+  outputs: import_v411.z.array(
+    import_v411.z.discriminatedUnion("type", [
+      import_v411.z.object({ type: import_v411.z.literal("logs"), logs: import_v411.z.string() }),
+      import_v411.z.object({ type: import_v411.z.literal("image"), url: import_v411.z.string() })
+    ])
+  ).nullish()
+});
 var codeInterpreterArgsSchema = import_v411.z.object({
   container: import_v411.z.union([
     import_v411.z.string(),
@@ -1807,11 +1819,15 @@ var codeInterpreterArgsSchema = import_v411.z.object({
     })
   ]).optional()
 });
-var codeInterpreter = (0, import_provider_utils9.createProviderDefinedToolFactory)({
+var codeInterpreterToolFactory = (0, import_provider_utils9.createProviderDefinedToolFactoryWithOutputSchema)({
   id: "openai.code_interpreter",
   name: "code_interpreter",
-  inputSchema: import_v411.z.object({})
+  inputSchema: codeInterpreterInputSchema,
+  outputSchema: codeInterpreterOutputSchema
 });
+var codeInterpreter = (args = {}) => {
+  return codeInterpreterToolFactory(args);
+};
 
 // src/tool/web-search.ts
 var import_provider_utils10 = require("@ai-sdk/provider-utils");
@@ -1829,7 +1845,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({
@@ -1851,7 +1867,7 @@ var factory = (0, import_provider_utils10.createProviderDefinedToolFactory)({
   })
 });
 var webSearch = (args = {}) => {
-  return factory(args);
+  return webSearchToolFactory(args);
 };
 
 // src/openai-tools.ts
@@ -2246,6 +2262,18 @@ var webSearchCallItem = import_v414.z.object({
     })
   ]).nullish()
 });
+var codeInterpreterCallItem = import_v414.z.object({
+  type: import_v414.z.literal("code_interpreter_call"),
+  id: import_v414.z.string(),
+  code: import_v414.z.string().nullable(),
+  container_id: import_v414.z.string(),
+  outputs: import_v414.z.array(
+    import_v414.z.discriminatedUnion("type", [
+      import_v414.z.object({ type: import_v414.z.literal("logs"), logs: import_v414.z.string() }),
+      import_v414.z.object({ type: import_v414.z.literal("image"), url: import_v414.z.string() })
+    ])
+  ).nullable()
+});
 var TOP_LOGPROBS_MAX = 20;
 var LOGPROBS_SCHEMA = import_v414.z.array(
   import_v414.z.object({
@@ -2287,7 +2315,7 @@ var OpenAIResponsesLanguageModel = class {
     toolChoice,
     responseFormat
   }) {
-    var _a, _b;
+    var _a, _b, _c, _d;
     const warnings = [];
     const modelConfig = getResponsesModelConfig(this.modelId);
     if (topK != null) {
@@ -2323,8 +2351,17 @@ 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 codeInterpreterToolName = (_c = tools == null ? void 0 : tools.find(
+      (tool) => tool.type === "provider-defined" && tool.id === "openai.code_interpreter"
+    )) == null ? void 0 : _c.name;
+    include = codeInterpreterToolName ? Array.isArray(include) ? [...include, "code_interpreter_call.outputs"] : ["code_interpreter_call.outputs"] : include;
     const baseArgs = {
       model: this.modelId,
       input: messages,
@@ -2337,7 +2374,7 @@ var OpenAIResponsesLanguageModel = class {
             format: responseFormat.schema != null ? {
               type: "json_schema",
               strict: strictJsonSchema,
-              name: (_b = responseFormat.name) != null ? _b : "response",
+              name: (_d = responseFormat.name) != null ? _d : "response",
               description: responseFormat.description,
               schema: responseFormat.schema
             } : { type: "json_object" }
@@ -2355,7 +2392,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,
@@ -2433,6 +2470,7 @@ var OpenAIResponsesLanguageModel = class {
       strictJsonSchema
     });
     return {
+      webSearchToolName,
       args: {
         ...baseArgs,
         tools: openaiTools2,
@@ -2443,7 +2481,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
@@ -2494,12 +2536,16 @@ 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")
                         })
                       ])
                     )
                   })
                 )
               }),
+              codeInterpreterCallItem,
               import_v414.z.object({
                 type: import_v414.z.literal("function_call"),
                 call_id: import_v414.z.string(),
@@ -2640,14 +2686,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
           });
@@ -2695,6 +2741,28 @@ var OpenAIResponsesLanguageModel = class {
           });
           break;
         }
+        case "code_interpreter_call": {
+          content.push({
+            type: "tool-call",
+            toolCallId: part.id,
+            toolName: "code_interpreter",
+            input: JSON.stringify({
+              code: part.code,
+              containerId: part.container_id
+            }),
+            providerExecuted: true
+          });
+          content.push({
+            type: "tool-result",
+            toolCallId: part.id,
+            toolName: "code_interpreter",
+            result: {
+              outputs: part.outputs
+            },
+            providerExecuted: true
+          });
+          break;
+        }
       }
     }
     const providerMetadata = {
@@ -2732,7 +2800,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",
@@ -2793,13 +2865,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] = {
@@ -2934,6 +3006,26 @@ var OpenAIResponsesLanguageModel = class {
                   },
                   providerExecuted: true
                 });
+              } else if (value.item.type === "code_interpreter_call") {
+                controller.enqueue({
+                  type: "tool-call",
+                  toolCallId: value.item.id,
+                  toolName: "code_interpreter",
+                  input: JSON.stringify({
+                    code: value.item.code,
+                    containerId: value.item.container_id
+                  }),
+                  providerExecuted: true
+                });
+                controller.enqueue({
+                  type: "tool-result",
+                  toolCallId: value.item.id,
+                  toolName: "code_interpreter",
+                  result: {
+                    outputs: value.item.outputs
+                  },
+                  providerExecuted: true
+                });
               } else if (value.item.type === "message") {
                 controller.enqueue({
                   type: "text-end",
@@ -3179,6 +3271,7 @@ var responseOutputItemDoneSchema = import_v414.z.object({
       arguments: import_v414.z.string(),
       status: import_v414.z.literal("completed")
     }),
+    codeInterpreterCallItem,
     webSearchCallItem,
     import_v414.z.object({
       type: import_v414.z.literal("computer_call"),