@ai-sdk/openai 4.0.51 → 4.0.53

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @ai-sdk/openai
 
+## 4.0.53
+
+### Patch Changes
+
+- 7439d7a: Fix workflow deserialization for OpenAI Responses models.
+
+## 4.0.52
+
+### Patch Changes
+
+- 1c68540: Preserve explicit prompt cache breakpoints on scalar Responses tool results.
+- Updated dependencies [aa45741]
+  - @ai-sdk/provider@4.0.9
+  - @ai-sdk/provider-utils@5.0.34
+
 ## 4.0.51
 
 ### Patch Changes

package/dist/index.d.ts

@@ -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) {
@@ -4607,26 +4629,38 @@ async function convertFunctionToolResultOutput({
   output,
   toolName,
   outputSchemaToolNames,
+  promptCacheBreakpoint,
   providerOptionsName,
   warnings
 }) {
   var _a2;
   const hasOutputSchema = outputSchemaToolNames == null ? void 0 : outputSchemaToolNames.has(toolName);
+  const convertScalarOutput = (value) => promptCacheBreakpoint == null ? value : [
+    {
+      type: "input_text",
+      text: value,
+      prompt_cache_breakpoint: promptCacheBreakpoint
+    }
+  ];
   switch (output.type) {
     case "text":
     case "error-text":
-      return hasOutputSchema ? JSON.stringify(output.value) : output.value;
+      return convertScalarOutput(
+        hasOutputSchema ? JSON.stringify(output.value) : output.value
+      );
     case "execution-denied": {
       const reason = (_a2 = output.reason) != null ? _a2 : "Tool call execution denied.";
-      return hasOutputSchema ? JSON.stringify(reason) : reason;
+      return convertScalarOutput(
+        hasOutputSchema ? JSON.stringify(reason) : reason
+      );
     }
     case "json":
     case "error-json":
-      return JSON.stringify(output.value);
+      return convertScalarOutput(JSON.stringify(output.value));
     case "content":
       return output.value.map((item) => {
         var _a3, _b, _c;
-        const promptCacheBreakpoint = getPromptCacheBreakpoint2(
+        const promptCacheBreakpoint2 = getPromptCacheBreakpoint2(
           item.providerOptions,
           providerOptionsName
         );
@@ -4635,8 +4669,8 @@ async function convertFunctionToolResultOutput({
             return {
               type: "input_text",
               text: item.text,
-              ...promptCacheBreakpoint != null && {
-                prompt_cache_breakpoint: promptCacheBreakpoint
+              ...promptCacheBreakpoint2 != null && {
+                prompt_cache_breakpoint: promptCacheBreakpoint2
               }
             };
           }
@@ -4650,8 +4684,8 @@ async function convertFunctionToolResultOutput({
                   type: "input_image",
                   image_url: `data:${fullMediaType};base64,${convertToBase642(item.data.data)}`,
                   detail: imageDetail,
-                  ...promptCacheBreakpoint != null && {
-                    prompt_cache_breakpoint: promptCacheBreakpoint
+                  ...promptCacheBreakpoint2 != null && {
+                    prompt_cache_breakpoint: promptCacheBreakpoint2
                   }
                 };
               }
@@ -4659,8 +4693,8 @@ async function convertFunctionToolResultOutput({
                 type: "input_file",
                 filename: (_c = item.filename) != null ? _c : "data",
                 file_data: `data:${fullMediaType};base64,${convertToBase642(item.data.data)}`,
-                ...promptCacheBreakpoint != null && {
-                  prompt_cache_breakpoint: promptCacheBreakpoint
+                ...promptCacheBreakpoint2 != null && {
+                  prompt_cache_breakpoint: promptCacheBreakpoint2
                 }
               };
             }
@@ -4670,16 +4704,16 @@ async function convertFunctionToolResultOutput({
                   type: "input_image",
                   image_url: item.data.url.toString(),
                   detail: imageDetail,
-                  ...promptCacheBreakpoint != null && {
-                    prompt_cache_breakpoint: promptCacheBreakpoint
+                  ...promptCacheBreakpoint2 != null && {
+                    prompt_cache_breakpoint: promptCacheBreakpoint2
                   }
                 };
               }
               return {
                 type: "input_file",
                 file_url: item.data.url.toString(),
-                ...promptCacheBreakpoint != null && {
-                  prompt_cache_breakpoint: promptCacheBreakpoint
+                ...promptCacheBreakpoint2 != null && {
+                  prompt_cache_breakpoint: promptCacheBreakpoint2
                 }
               };
             }
@@ -4761,6 +4795,17 @@ function getPromptCacheBreakpoint2(providerOptions, providerOptionsName) {
   var _a2;
   return (_a2 = providerOptions == null ? void 0 : providerOptions[providerOptionsName]) == null ? void 0 : _a2.promptCacheBreakpoint;
 }
+function getScalarToolResultPromptCacheBreakpoint({
+  output,
+  toolResultProviderOptions,
+  providerOptionsName
+}) {
+  var _a2;
+  return output.type === "content" ? void 0 : (_a2 = getPromptCacheBreakpoint2(output.providerOptions, providerOptionsName)) != null ? _a2 : getPromptCacheBreakpoint2(
+    toolResultProviderOptions,
+    providerOptionsName
+  );
+}
 function isFileId(data, prefixes) {
   if (!prefixes) return false;
   return prefixes.some((prefix) => data.startsWith(prefix));
@@ -5408,24 +5453,43 @@ async function convertToOpenAIResponsesInput({
                 parallelToolResultGroup.metadata.toolCallId
               );
               const toolOutputs = await Promise.all(
-                parallelToolResultGroup.results.map(
-                  async (result) => convertFunctionToolResultOutput({
+                parallelToolResultGroup.results.map(async (result) => {
+                  const promptCacheBreakpoint = getScalarToolResultPromptCacheBreakpoint({
                     output: result.output,
-                    toolName: result.toolName,
-                    outputSchemaToolNames,
-                    providerOptionsName,
-                    warnings
-                  })
-                )
+                    toolResultProviderOptions: result.providerOptions,
+                    providerOptionsName
+                  });
+                  return {
+                    output: await convertFunctionToolResultOutput({
+                      output: result.output,
+                      toolName: result.toolName,
+                      outputSchemaToolNames,
+                      providerOptionsName,
+                      warnings
+                    }),
+                    promptCacheBreakpoint
+                  };
+                })
+              );
+              const serializedToolOutputs = toolOutputs.map(
+                ({ output: output2 }) => typeof output2 === "string" ? output2 : JSON.stringify(output2)
+              );
+              const hasPromptCacheBreakpoint = toolOutputs.some(
+                ({ promptCacheBreakpoint }) => promptCacheBreakpoint != null
               );
               input.push({
                 type: "function_call_output",
                 call_id: parallelToolResultGroup.metadata.toolCallId,
                 // The internal wrapper returns one output containing the child
                 // results in the same order as the original tool_uses array.
-                output: toolOutputs.map(
-                  (output2) => typeof output2 === "string" ? output2 : JSON.stringify(output2)
-                ).join("\n")
+                output: hasPromptCacheBreakpoint ? serializedToolOutputs.map((text, index) => ({
+                  type: "input_text",
+                  text: index === 0 ? text : `
+${text}`,
+                  ...toolOutputs[index].promptCacheBreakpoint != null && {
+                    prompt_cache_breakpoint: toolOutputs[index].promptCacheBreakpoint
+                  }
+                })) : serializedToolOutputs.join("\n")
               });
             }
             continue;
@@ -5521,23 +5585,37 @@ async function convertToOpenAIResponsesInput({
             continue;
           }
           if (customProviderToolNames == null ? void 0 : customProviderToolNames.has(resolvedToolName)) {
+            const promptCacheBreakpoint = getScalarToolResultPromptCacheBreakpoint({
+              output,
+              toolResultProviderOptions: part.providerOptions,
+              providerOptionsName
+            });
+            const convertScalarOutput = (value) => promptCacheBreakpoint == null ? value : [
+              {
+                type: "input_text",
+                text: value,
+                prompt_cache_breakpoint: promptCacheBreakpoint
+              }
+            ];
             let outputValue;
             switch (output.type) {
               case "text":
               case "error-text":
-                outputValue = output.value;
+                outputValue = convertScalarOutput(output.value);
                 break;
               case "execution-denied":
-                outputValue = (_I = output.reason) != null ? _I : "Tool call execution denied.";
+                outputValue = convertScalarOutput(
+                  (_I = output.reason) != null ? _I : "Tool call execution denied."
+                );
                 break;
               case "json":
               case "error-json":
-                outputValue = JSON.stringify(output.value);
+                outputValue = convertScalarOutput(JSON.stringify(output.value));
                 break;
               case "content":
                 outputValue = output.value.map((item) => {
                   var _a3, _b2, _c2;
-                  const promptCacheBreakpoint = getPromptCacheBreakpoint2(
+                  const promptCacheBreakpoint2 = getPromptCacheBreakpoint2(
                     item.providerOptions,
                     providerOptionsName
                   );
@@ -5546,8 +5624,8 @@ async function convertToOpenAIResponsesInput({
                       return {
                         type: "input_text",
                         text: item.text,
-                        ...promptCacheBreakpoint != null && {
-                          prompt_cache_breakpoint: promptCacheBreakpoint
+                        ...promptCacheBreakpoint2 != null && {
+                          prompt_cache_breakpoint: promptCacheBreakpoint2
                         }
                       };
                     case "file": {
@@ -5562,8 +5640,8 @@ async function convertToOpenAIResponsesInput({
                             type: "input_image",
                             image_url: `data:${fullMediaType};base64,${convertToBase642(item.data.data)}`,
                             detail: imageDetail,
-                            ...promptCacheBreakpoint != null && {
-                              prompt_cache_breakpoint: promptCacheBreakpoint
+                            ...promptCacheBreakpoint2 != null && {
+                              prompt_cache_breakpoint: promptCacheBreakpoint2
                             }
                           };
                         }
@@ -5571,8 +5649,8 @@ async function convertToOpenAIResponsesInput({
                           type: "input_file",
                           filename: (_c2 = item.filename) != null ? _c2 : "data",
                           file_data: `data:${fullMediaType};base64,${convertToBase642(item.data.data)}`,
-                          ...promptCacheBreakpoint != null && {
-                            prompt_cache_breakpoint: promptCacheBreakpoint
+                          ...promptCacheBreakpoint2 != null && {
+                            prompt_cache_breakpoint: promptCacheBreakpoint2
                           }
                         };
                       }
@@ -5582,16 +5660,16 @@ async function convertToOpenAIResponsesInput({
                             type: "input_image",
                             image_url: item.data.url.toString(),
                             detail: imageDetail,
-                            ...promptCacheBreakpoint != null && {
-                              prompt_cache_breakpoint: promptCacheBreakpoint
+                            ...promptCacheBreakpoint2 != null && {
+                              prompt_cache_breakpoint: promptCacheBreakpoint2
                             }
                           };
                         }
                         return {
                           type: "input_file",
                           file_url: item.data.url.toString(),
-                          ...promptCacheBreakpoint != null && {
-                            prompt_cache_breakpoint: promptCacheBreakpoint
+                          ...promptCacheBreakpoint2 != null && {
+                            prompt_cache_breakpoint: promptCacheBreakpoint2
                           }
                         };
                       }
@@ -5624,6 +5702,11 @@ async function convertToOpenAIResponsesInput({
             output,
             toolName: part.toolName,
             outputSchemaToolNames,
+            promptCacheBreakpoint: getScalarToolResultPromptCacheBreakpoint({
+              output,
+              toolResultProviderOptions: part.providerOptions,
+              providerOptionsName
+            }),
             providerOptionsName,
             warnings
           });
@@ -6533,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;
@@ -8936,7 +9022,7 @@ var OpenAIResponsesBatchLanguageModel = class _OpenAIResponsesBatchLanguageModel
   static [WORKFLOW_DESERIALIZE6](options) {
     return new _OpenAIResponsesBatchLanguageModel(
       options.modelId,
-      options.config
+      prepareOpenAIConfigForWorkflowDeserialize(options.config)
     );
   }
   constructor(modelId, config) {
@@ -10612,7 +10698,7 @@ var OpenAISkills = class {
 };
 
 // src/version.ts
-var VERSION = true ? "4.0.51" : "0.0.0-test";
+var VERSION = true ? "4.0.53" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {
@@ -10706,6 +10792,7 @@ function createOpenAI(options = {}) {
   const createResponsesModel = (modelId) => {
     return new OpenAIResponsesBatchLanguageModel(modelId, {
       provider: `${providerName}.responses`,
+      baseURL,
       url: ({ path }) => `${baseURL}${path}`,
       headers: getHeaders,
       fetch: options.fetch,