@ai-sdk/openai 4.0.52 → 4.0.54

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/openai
 
+## 4.0.54
+
+### Patch Changes
+
+- f6fac50: fix(openai): handle null usage in responses
+- e07b577: feat: add tool calling support to batch
+
+## 4.0.53
+
+### Patch Changes
+
+- 7439d7a: Fix workflow deserialization for OpenAI Responses models.
+
 ## 4.0.52
 
 ### Patch Changes

package/dist/index.d.ts

@@ -252,7 +252,10 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
 } | {
     type: "response.completed" | "response.incomplete";
     response: {
-        usage: {
+        incomplete_details?: {
+            reason: string;
+        } | null | undefined;
+        usage?: {
             input_tokens: number;
             output_tokens: number;
             input_tokens_details?: {
@@ -265,9 +268,6 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
                 reasoning_tokens?: number | null | undefined;
                 orchestration_output_tokens?: number | null | undefined;
             } | null | undefined;
-        };
-        incomplete_details?: {
-            reason: string;
         } | null | undefined;
         reasoning?: {
             context?: string | null | undefined;
@@ -1585,13 +1585,15 @@ type OpenAIToolOptions = {
     };
 };
 
+type OpenAIHeaders = Record<string, string | undefined>;
 type OpenAIConfig = {
     provider: string;
+    baseURL?: string;
     url: (options: {
         modelId: string;
         path: string;
     }) => string;
-    headers?: () => Record<string, string | undefined>;
+    headers?: () => OpenAIHeaders;
     fetch?: FetchFunction;
     webSocket?: WebSocketConstructor;
     generateId?: () => string;

package/dist/index.js

@@ -3375,6 +3375,28 @@ import {
 } from "@ai-sdk/provider-utils";
 import { z as z28 } from "zod/v4";
 
+// src/openai-config.ts
+function prepareOpenAIConfigForWorkflowDeserialize(config) {
+  if (config.provider == null) {
+    throw new Error(
+      "OpenAI model is missing provider after workflow deserialization."
+    );
+  }
+  return {
+    ...config,
+    provider: config.provider,
+    url: typeof config.url === "function" ? config.url : ({ path }) => {
+      if (config.baseURL == null) {
+        throw new Error(
+          "OpenAI model is missing baseURL after workflow deserialization."
+        );
+      }
+      return `${config.baseURL}${path}`;
+    },
+    headers: typeof config.headers === "function" ? config.headers : config.headers == null ? void 0 : () => config.headers
+  };
+}
+
 // src/responses/convert-openai-responses-usage.ts
 import { createNullLanguageModelUsage as createNullLanguageModelUsage3 } from "@ai-sdk/provider-utils";
 function convertOpenAIResponsesUsage(usage) {
@@ -3647,7 +3669,7 @@ var openaiResponsesChunkSchema = lazySchema24(
               reasoning_tokens: z25.number().nullish(),
               orchestration_output_tokens: z25.number().nullish()
             }).nullish()
-          }),
+          }).nullish(),
           reasoning: z25.object({
             context: z25.string().nullish()
           }).nullish(),
@@ -4479,7 +4501,7 @@ var openaiResponsesResponseSchema = lazySchema24(
           reasoning_tokens: z25.number().nullish(),
           orchestration_output_tokens: z25.number().nullish()
         }).nullish()
-      }).optional()
+      }).nullish()
     })
   )
 );
@@ -6594,7 +6616,10 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
     });
   }
   static [WORKFLOW_DESERIALIZE5](options) {
-    return new _OpenAIResponsesLanguageModel(options.modelId, options.config);
+    return new _OpenAIResponsesLanguageModel(
+      options.modelId,
+      prepareOpenAIConfigForWorkflowDeserialize(options.config)
+    );
   }
   get provider() {
     return this.config.provider;
@@ -7545,7 +7570,7 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a3, _b2, _c2, _d2, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C, _D, _E, _F, _G, _H, _I, _J, _K, _L, _M, _N, _O, _P, _Q, _R;
+            var _a3, _b2, _c2, _d2, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C, _D, _E, _F, _G, _H, _I, _J, _K, _L, _M, _N, _O, _P, _Q, _R, _S;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -8480,15 +8505,15 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
                   raw: (_z = (_y = value.response.incomplete_details) == null ? void 0 : _y.reason) != null ? _z : void 0
                 };
               }
-              usage = value.response.usage;
+              usage = (_A = value.response.usage) != null ? _A : void 0;
               if (typeof value.response.service_tier === "string") {
                 serviceTier = value.response.service_tier;
               }
-              if (((_A = value.response.reasoning) == null ? void 0 : _A.context) != null) {
+              if (((_B = value.response.reasoning) == null ? void 0 : _B.context) != null) {
                 reasoningContext = value.response.reasoning.context;
               }
             } else if (isResponseFailedChunk(value)) {
-              const incompleteReason = (_B = value.response.incomplete_details) == null ? void 0 : _B.reason;
+              const incompleteReason = (_C = value.response.incomplete_details) == null ? void 0 : _C.reason;
               finishReason = {
                 unified: incompleteReason ? mapOpenAIResponseFinishReason({
                   finishReason: incompleteReason,
@@ -8496,8 +8521,8 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
                 }) : "error",
                 raw: incompleteReason != null ? incompleteReason : "error"
               };
-              usage = (_C = value.response.usage) != null ? _C : void 0;
-              if (((_D = value.response.reasoning) == null ? void 0 : _D.context) != null) {
+              usage = (_D = value.response.usage) != null ? _D : void 0;
+              if (((_E = value.response.reasoning) == null ? void 0 : _E.context) != null) {
                 reasoningContext = value.response.reasoning.context;
               }
               if (!encounteredStreamError && value.response.error != null) {
@@ -8513,7 +8538,7 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
                 };
                 controller.enqueue({
                   type: "error",
-                  error: (_E = createOpenAIProviderStreamError(error)) != null ? _E : error
+                  error: (_F = createOpenAIProviderStreamError(error)) != null ? _F : error
                 });
               }
             } else if (isResponseAnnotationAddedChunk(value)) {
@@ -8522,7 +8547,7 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
                 controller.enqueue({
                   type: "source",
                   sourceType: "url",
-                  id: (_H = (_G = (_F = self.config).generateId) == null ? void 0 : _G.call(_F)) != null ? _H : generateId2(),
+                  id: (_I = (_H = (_G = self.config).generateId) == null ? void 0 : _H.call(_G)) != null ? _I : generateId2(),
                   url: value.annotation.url,
                   title: value.annotation.title
                 });
@@ -8530,7 +8555,7 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_K = (_J = (_I = self.config).generateId) == null ? void 0 : _J.call(_I)) != null ? _K : generateId2(),
+                  id: (_L = (_K = (_J = self.config).generateId) == null ? void 0 : _K.call(_J)) != null ? _L : generateId2(),
                   mediaType: "text/plain",
                   title: value.annotation.filename,
                   filename: value.annotation.filename,
@@ -8546,7 +8571,7 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_N = (_M = (_L = self.config).generateId) == null ? void 0 : _M.call(_L)) != null ? _N : generateId2(),
+                  id: (_O = (_N = (_M = self.config).generateId) == null ? void 0 : _N.call(_M)) != null ? _O : generateId2(),
                   mediaType: "text/plain",
                   title: value.annotation.filename,
                   filename: value.annotation.filename,
@@ -8562,7 +8587,7 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_Q = (_P = (_O = self.config).generateId) == null ? void 0 : _P.call(_O)) != null ? _Q : generateId2(),
+                  id: (_R = (_Q = (_P = self.config).generateId) == null ? void 0 : _Q.call(_P)) != null ? _R : generateId2(),
                   mediaType: "application/octet-stream",
                   title: value.annotation.file_id,
                   filename: value.annotation.file_id,
@@ -8580,7 +8605,7 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
               finishReason = { unified: "error", raw: "error" };
               controller.enqueue({
                 type: "error",
-                error: (_R = createOpenAIProviderStreamError(value)) != null ? _R : value
+                error: (_S = createOpenAIProviderStreamError(value)) != null ? _S : value
               });
             }
           },
@@ -8783,7 +8808,7 @@ var OpenAIResponsesBatch = class {
     this.options = options;
   }
   async startBatch(options) {
-    var _a2, _b, _c, _d;
+    var _a2, _b, _c, _d, _e;
     const fileParts = [];
     const warnings = options.webhookUrl == null ? [] : [
       {
@@ -8808,6 +8833,18 @@ var OpenAIResponsesBatch = class {
       for (const warning of preparedRequest.warnings) {
         warnings.push({ requestId: request.id, warning });
       }
+      for (const tool of (_a2 = request.options.tools) != null ? _a2 : []) {
+        if (tool.type === "provider" && !openAIBatchConvertibleProviderToolIds.has(tool.id)) {
+          warnings.push({
+            requestId: request.id,
+            warning: {
+              type: "unsupported",
+              feature: `batch result conversion for tool "${tool.name}"`,
+              details: "OpenAI may return output for this tool that AI SDK text batches cannot currently convert."
+            }
+          });
+        }
+      }
     }
     const filename = "batch.jsonl";
     const file = new Blob(fileParts, {
@@ -8824,7 +8861,7 @@ var OpenAIResponsesBatch = class {
     );
     const { value: uploadedFile } = await postToApi({
       url: this.getUrl("/files"),
-      headers: combineHeaders7((_b = (_a2 = this.options.config).headers) == null ? void 0 : _b.call(_a2), options.headers),
+      headers: combineHeaders7((_c = (_b = this.options.config).headers) == null ? void 0 : _c.call(_b), options.headers),
       body: {
         content: formData,
         values: {
@@ -8849,7 +8886,7 @@ var OpenAIResponsesBatch = class {
     });
     const { value: batch } = await postJsonToApi6({
       url: this.getUrl("/batches"),
-      headers: combineHeaders7((_d = (_c = this.options.config).headers) == null ? void 0 : _d.call(_c), options.headers),
+      headers: combineHeaders7((_e = (_d = this.options.config).headers) == null ? void 0 : _e.call(_d), options.headers),
       body: {
         input_file_id: uploadedFile.id,
         endpoint: openaiBatchEndpoint,
@@ -8990,6 +9027,13 @@ var OpenAIResponsesBatch = class {
     });
   }
 };
+var openAIBatchConvertibleProviderToolIds = /* @__PURE__ */ new Set([
+  "openai.code_interpreter",
+  "openai.custom",
+  "openai.file_search",
+  "openai.web_search",
+  "openai.web_search_preview"
+]);
 var OpenAIResponsesBatchLanguageModel = class _OpenAIResponsesBatchLanguageModel extends OpenAIResponsesLanguageModel {
   static [WORKFLOW_SERIALIZE6](model) {
     return OpenAIResponsesLanguageModel[WORKFLOW_SERIALIZE6](model);
@@ -8997,7 +9041,7 @@ var OpenAIResponsesBatchLanguageModel = class _OpenAIResponsesBatchLanguageModel
   static [WORKFLOW_DESERIALIZE6](options) {
     return new _OpenAIResponsesBatchLanguageModel(
       options.modelId,
-      options.config
+      prepareOpenAIConfigForWorkflowDeserialize(options.config)
     );
   }
   constructor(modelId, config) {
@@ -9099,7 +9143,7 @@ async function convertOpenAIErrorResponse({
   };
 }
 async function convertOpenAIResponsesBatchResponse(body) {
-  var _a2, _b, _c, _d, _e, _f;
+  var _a2, _b, _c, _d, _e, _f, _g, _h;
   const validation = await safeValidateTypes({
     value: body,
     schema: openaiResponsesResponseSchema
@@ -9136,6 +9180,7 @@ async function convertOpenAIResponsesBatchResponse(body) {
   }
   const content = [];
   const logprobs = [];
+  let hasFunctionCall = false;
   for (const part of response.output) {
     switch (part.type) {
       case "reasoning": {
@@ -9164,14 +9209,96 @@ async function convertOpenAIResponsesBatchResponse(body) {
         break;
       }
       case "function_call":
-      case "custom_tool_call":
-        return {
-          success: false,
-          error: {
-            message: "OpenAI returned a tool call, but tool calls are not supported in AI SDK text batches.",
-            code: "unsupported_content"
+        hasFunctionCall = true;
+        content.push({
+          type: "tool-call",
+          toolCallId: part.call_id,
+          toolName: part.name,
+          input: part.arguments,
+          providerMetadata: {
+            openai: {
+              itemId: part.id,
+              ...part.namespace != null && { namespace: part.namespace },
+              ...part.caller != null && {
+                caller: part.caller.type === "program" ? { type: "program", callerId: part.caller.caller_id } : part.caller
+              }
+            }
           }
-        };
+        });
+        break;
+      case "custom_tool_call":
+        hasFunctionCall = true;
+        content.push({
+          type: "tool-call",
+          toolCallId: part.call_id,
+          toolName: part.name,
+          input: JSON.stringify(part.input),
+          providerMetadata: { openai: { itemId: part.id } }
+        });
+        break;
+      case "web_search_call":
+        content.push({
+          type: "tool-call",
+          toolCallId: part.id,
+          toolName: "web_search",
+          input: "{}",
+          providerExecuted: true,
+          dynamic: true
+        });
+        content.push({
+          type: "tool-result",
+          toolCallId: part.id,
+          toolName: "web_search",
+          result: mapWebSearchOutput(part.action),
+          dynamic: true
+        });
+        break;
+      case "file_search_call":
+        content.push({
+          type: "tool-call",
+          toolCallId: part.id,
+          toolName: "file_search",
+          input: "{}",
+          providerExecuted: true,
+          dynamic: true
+        });
+        content.push({
+          type: "tool-result",
+          toolCallId: part.id,
+          toolName: "file_search",
+          result: {
+            queries: part.queries,
+            results: (_d = (_c = part.results) == null ? void 0 : _c.map((result) => ({
+              attributes: result.attributes,
+              fileId: result.file_id,
+              filename: result.filename,
+              score: result.score,
+              text: result.text
+            }))) != null ? _d : null
+          },
+          dynamic: true
+        });
+        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,
+          dynamic: true
+        });
+        content.push({
+          type: "tool-result",
+          toolCallId: part.id,
+          toolName: "code_interpreter",
+          result: { outputs: part.outputs },
+          dynamic: true
+        });
+        break;
       default:
         return {
           success: false,
@@ -9187,7 +9314,7 @@ async function convertOpenAIResponsesBatchResponse(body) {
       responseId: response.id,
       ...logprobs.length > 0 ? { logprobs } : {},
       ...typeof response.service_tier === "string" ? { serviceTier: response.service_tier } : {},
-      ...((_c = response.reasoning) == null ? void 0 : _c.context) != null ? { reasoningContext: response.reasoning.context } : {}
+      ...((_e = response.reasoning) == null ? void 0 : _e.context) != null ? { reasoningContext: response.reasoning.context } : {}
     }
   };
   return {
@@ -9196,10 +9323,10 @@ async function convertOpenAIResponsesBatchResponse(body) {
       content,
       finishReason: {
         unified: mapOpenAIResponseFinishReason({
-          finishReason: (_d = response.incomplete_details) == null ? void 0 : _d.reason,
-          hasFunctionCall: false
+          finishReason: (_f = response.incomplete_details) == null ? void 0 : _f.reason,
+          hasFunctionCall
         }),
-        raw: (_f = (_e = response.incomplete_details) == null ? void 0 : _e.reason) != null ? _f : void 0
+        raw: (_h = (_g = response.incomplete_details) == null ? void 0 : _g.reason) != null ? _h : void 0
       },
       usage: convertOpenAIResponsesUsage(response.usage),
       response: {
@@ -10673,7 +10800,7 @@ var OpenAISkills = class {
 };
 
 // src/version.ts
-var VERSION = true ? "4.0.52" : "0.0.0-test";
+var VERSION = true ? "4.0.54" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {
@@ -10767,6 +10894,7 @@ function createOpenAI(options = {}) {
   const createResponsesModel = (modelId) => {
     return new OpenAIResponsesBatchLanguageModel(modelId, {
       provider: `${providerName}.responses`,
+      baseURL,
       url: ({ path }) => `${baseURL}${path}`,
       headers: getHeaders,
       fetch: options.fetch,