@ai-sdk/openai 2.0.124 → 2.0.126

package/dist/index.mjs

@@ -46,14 +46,18 @@ function getOpenAILanguageModelCapabilities(modelId) {
   const gptVersion = getGptVersion(modelId);
   const isGptChatModel = (gptVersion == null ? void 0 : gptVersion.minor) == null && ((_b = (_a2 = gptVersion == null ? void 0 : gptVersion.variant) == null ? void 0 : _a2.startsWith("chat")) != null ? _b : false);
   const isGptNanoModel = (_d = (_c = gptVersion == null ? void 0 : gptVersion.variant) == null ? void 0 : _c.startsWith("nano")) != null ? _d : false;
+  const isGpt6OrLaterModel = gptVersion != null && gptVersion.major >= 6;
   const supportsFlexProcessing = oSeriesVersion != null && oSeriesVersion >= 3 || gptVersion != null && gptVersion.major >= 5 && !isGptChatModel;
   const supportsPriorityProcessing = modelId.startsWith("gpt-4") || gptVersion != null && gptVersion.major >= 5 && !isGptNanoModel && !isGptChatModel || oSeriesVersion != null && oSeriesVersion >= 3;
   const isReasoningModel = oSeriesVersion != null || gptVersion != null && gptVersion.major >= 5 && !isGptChatModel || modelId === "codex-mini-latest" || modelId === "computer-use-preview";
-  const supportsNonReasoningParameters = gptVersion != null && (gptVersion.major > 5 || gptVersion.major === 5 && ((_e = gptVersion.minor) != null ? _e : 0) >= 1);
+  const supportsNonReasoningParameters = !isGpt6OrLaterModel && gptVersion != null && (gptVersion.major > 5 || gptVersion.major === 5 && ((_e = gptVersion.minor) != null ? _e : 0) >= 1);
   const systemMessageMode = isReasoningModel ? "developer" : "system";
   return {
     supportsFlexProcessing,
     supportsPriorityProcessing,
+    supportsConfigurationUpdate: isGpt6OrLaterModel,
+    supportsAsyncToolCalling: isGpt6OrLaterModel,
+    supportedReasoningEfforts: isGpt6OrLaterModel ? ["low", "medium", "high", "xhigh", "max"] : void 0,
     isReasoningModel,
     systemMessageMode,
     supportsNonReasoningParameters
@@ -748,6 +752,17 @@ var OpenAIChatLanguageModel = class {
     );
     warnings.push(...messageWarnings);
     const strictJsonSchema = (_c = openaiOptions.strictJsonSchema) != null ? _c : false;
+    let resolvedReasoningEffort = openaiOptions.reasoningEffort;
+    if (resolvedReasoningEffort != null && modelCapabilities.supportedReasoningEfforts != null && !modelCapabilities.supportedReasoningEfforts.includes(
+      resolvedReasoningEffort
+    )) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "reasoningEffort",
+        details: `${this.modelId} only supports the following reasoning efforts: ${modelCapabilities.supportedReasoningEfforts.join(", ")}`
+      });
+      resolvedReasoningEffort = void 0;
+    }
     const baseArgs = {
       // model id:
       model: this.modelId,
@@ -781,7 +796,7 @@ var OpenAIChatLanguageModel = class {
       store: openaiOptions.store,
       metadata: openaiOptions.metadata,
       prediction: openaiOptions.prediction,
-      reasoning_effort: openaiOptions.reasoningEffort,
+      reasoning_effort: resolvedReasoningEffort,
       service_tier: openaiOptions.serviceTier,
       prompt_cache_key: openaiOptions.promptCacheKey,
       prompt_cache_options: openaiOptions.promptCacheOptions,
@@ -790,6 +805,14 @@ var OpenAIChatLanguageModel = class {
       // messages:
       messages
     };
+    if (modelCapabilities.supportedReasoningEfforts != null && baseArgs.prompt_cache_retention != null) {
+      baseArgs.prompt_cache_retention = void 0;
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "promptCacheRetention",
+        details: "promptCacheRetention is not supported by GPT-6 and later models; use promptCacheOptions instead"
+      });
+    }
     if (modelCapabilities.isReasoningModel) {
       if (openaiOptions.reasoningEffort !== "none" || !modelCapabilities.supportsNonReasoningParameters) {
         if (baseArgs.temperature != null) {
@@ -2407,11 +2430,12 @@ function isFileId(data, prefixes) {
 async function convertToOpenAIResponsesInput({
   prompt,
   systemMessageMode,
+  explicitMessageItemType = false,
   fileIdPrefixes,
   store,
   hasLocalShellTool = false
 }) {
-  var _a2, _b, _c, _d, _e, _f;
+  var _a2, _b, _c, _d, _e, _f, _g, _h;
   let input = [];
   const warnings = [];
   for (const { role, content, providerOptions } of prompt) {
@@ -2421,6 +2445,7 @@ async function convertToOpenAIResponsesInput({
           case "system": {
             const promptCacheBreakpoint = getPromptCacheBreakpoint2(providerOptions);
             input.push({
+              ...explicitMessageItemType && { type: "message" },
               role: "system",
               content: promptCacheBreakpoint == null ? content : [
                 {
@@ -2435,6 +2460,7 @@ async function convertToOpenAIResponsesInput({
           case "developer": {
             const promptCacheBreakpoint = getPromptCacheBreakpoint2(providerOptions);
             input.push({
+              ...explicitMessageItemType && { type: "message" },
               role: "developer",
               content: promptCacheBreakpoint == null ? content : [
                 {
@@ -2464,6 +2490,7 @@ async function convertToOpenAIResponsesInput({
       }
       case "user": {
         input.push({
+          ...explicitMessageItemType && { type: "message" },
           role: "user",
           content: content.map((part, index) => {
             var _a3, _b2, _c2;
@@ -2540,6 +2567,7 @@ async function convertToOpenAIResponsesInput({
                 break;
               }
               input.push({
+                ...explicitMessageItemType && { type: "message" },
                 role: "assistant",
                 content: [{ type: "output_text", text: part.text }],
                 id,
@@ -2553,6 +2581,7 @@ async function convertToOpenAIResponsesInput({
                 break;
               }
               const id = (_f = (_e = part.providerOptions) == null ? void 0 : _e.openai) == null ? void 0 : _f.itemId;
+              const isAsync = (_h = (_g = part.providerOptions) == null ? void 0 : _g.openai) == null ? void 0 : _h.async;
               if (store && id != null) {
                 input.push({ type: "item_reference", id });
                 break;
@@ -2582,6 +2611,7 @@ async function convertToOpenAIResponsesInput({
                 call_id: part.toolCallId,
                 name: part.toolName,
                 arguments: JSON.stringify(part.input),
+                ...isAsync != null && { async: isAsync },
                 id
               });
               break;
@@ -2857,7 +2887,8 @@ var openaiResponsesChunkSchema = lazyValidator9(
             id: z17.string(),
             call_id: z17.string(),
             name: z17.string(),
-            arguments: z17.string()
+            arguments: z17.string(),
+            async: z17.boolean().nullish()
           }),
           z17.object({
             type: z17.literal("web_search_call"),
@@ -2912,6 +2943,7 @@ var openaiResponsesChunkSchema = lazyValidator9(
             call_id: z17.string(),
             name: z17.string(),
             arguments: z17.string(),
+            async: z17.boolean().nullish(),
             status: z17.literal("completed")
           }),
           z17.object({
@@ -3223,7 +3255,8 @@ var openaiResponsesResponseSchema = lazyValidator9(
             call_id: z17.string(),
             name: z17.string(),
             arguments: z17.string(),
-            id: z17.string()
+            id: z17.string(),
+            async: z17.boolean().nullish()
           }),
           z17.object({
             type: z17.literal("computer_call"),
@@ -3421,6 +3454,15 @@ var openaiResponsesProviderOptionsSchema = lazyValidator10(
        * Supported values vary by model.
        */
       reasoningEffort: z18.string().nullish(),
+      /**
+       * Updates the reasoning effort for GPT-6 and later models starting with this response
+       * without changing the request-level reasoning effort. This preserves the
+       * request prefix for prompt caching.
+       *
+       * Only supported by GPT-6 and later models in standard, single-agent mode. Cannot be
+       * combined with automatic truncation.
+       */
+      reasoningEffortUpdate: z18.enum(["low", "medium", "high", "xhigh", "max"]).optional(),
       /**
        * Controls how much model work GPT-5.6 performs before returning a final answer.
        * `standard` is the default. `pro` increases quality, latency, and token usage.
@@ -3452,8 +3494,10 @@ import { validateTypes as validateTypes2 } from "@ai-sdk/provider-utils";
 async function prepareResponsesTools({
   tools,
   toolChoice,
-  strictJsonSchema
+  strictJsonSchema,
+  supportsAsyncToolCalling = true
 }) {
+  var _a2;
   tools = (tools == null ? void 0 : tools.length) ? tools : void 0;
   const toolWarnings = [];
   if (tools == null) {
@@ -3462,15 +3506,24 @@ async function prepareResponsesTools({
   const openaiTools2 = [];
   for (const tool of tools) {
     switch (tool.type) {
-      case "function":
+      case "function": {
+        const openaiOptions = (_a2 = tool.providerOptions) == null ? void 0 : _a2.openai;
+        const async = resolveAsyncToolOption({
+          value: openaiOptions == null ? void 0 : openaiOptions.async,
+          supportsAsyncToolCalling,
+          tool,
+          toolWarnings
+        });
         openaiTools2.push({
           type: "function",
           name: tool.name,
           description: tool.description,
           parameters: tool.inputSchema,
-          strict: strictJsonSchema
+          strict: strictJsonSchema,
+          ...async != null ? { async } : {}
         });
         break;
+      }
       case "provider-defined": {
         switch (tool.id) {
           case "openai.file_search": {
@@ -3589,6 +3642,22 @@ async function prepareResponsesTools({
     }
   }
 }
+function resolveAsyncToolOption({
+  value,
+  supportsAsyncToolCalling,
+  tool,
+  toolWarnings
+}) {
+  if (value !== true || supportsAsyncToolCalling) {
+    return value;
+  }
+  toolWarnings.push({
+    type: "unsupported-tool",
+    tool,
+    details: "Async tool calling is only supported by GPT-6 and later models."
+  });
+  return void 0;
+}
 
 // src/responses/openai-responses-language-model.ts
 var OpenAIResponsesLanguageModel = class {
@@ -3619,7 +3688,7 @@ var OpenAIResponsesLanguageModel = class {
     toolChoice,
     responseFormat
   }) {
-    var _a2, _b, _c, _d;
+    var _a2, _b, _c, _d, _e, _f;
     const warnings = [];
     const modelCapabilities = getOpenAILanguageModelCapabilities(this.modelId);
     if (topK != null) {
@@ -3658,11 +3727,37 @@ var OpenAIResponsesLanguageModel = class {
     const { input, warnings: inputWarnings } = await convertToOpenAIResponsesInput({
       prompt,
       systemMessageMode: modelCapabilities.systemMessageMode,
+      explicitMessageItemType: this.config.explicitMessageItemType,
       fileIdPrefixes: this.config.fileIdPrefixes,
       store: (_a2 = openaiOptions == null ? void 0 : openaiOptions.store) != null ? _a2 : true,
       hasLocalShellTool: hasOpenAITool("openai.local_shell")
     });
     warnings.push(...inputWarnings);
+    let resolvedReasoningEffort = openaiOptions == null ? void 0 : openaiOptions.reasoningEffort;
+    if (resolvedReasoningEffort != null && modelCapabilities.supportedReasoningEfforts != null && !modelCapabilities.supportedReasoningEfforts.includes(
+      resolvedReasoningEffort
+    )) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "reasoningEffort",
+        details: `${this.modelId} only supports the following reasoning efforts: ${modelCapabilities.supportedReasoningEfforts.join(", ")}`
+      });
+      resolvedReasoningEffort = void 0;
+    }
+    const reasoningEffortUpdate = openaiOptions == null ? void 0 : openaiOptions.reasoningEffortUpdate;
+    const configurationUpdateIsSupported = reasoningEffortUpdate == null || modelCapabilities.supportsConfigurationUpdate && (openaiOptions == null ? void 0 : openaiOptions.reasoningMode) !== "pro" && (openaiOptions == null ? void 0 : openaiOptions.truncation) !== "auto";
+    if (reasoningEffortUpdate != null && !configurationUpdateIsSupported) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "reasoningEffortUpdate",
+        details: !modelCapabilities.supportsConfigurationUpdate ? "reasoningEffortUpdate is only supported by GPT-6 and later models" : "reasoningEffortUpdate requires standard reasoning mode without automatic truncation"
+      });
+    } else if (reasoningEffortUpdate != null) {
+      input.unshift({
+        type: "configuration_update",
+        reasoning: { effort: reasoningEffortUpdate }
+      });
+    }
     const strictJsonSchema = (_b = openaiOptions == null ? void 0 : openaiOptions.strictJsonSchema) != null ? _b : false;
     let include = openaiOptions == null ? void 0 : openaiOptions.include;
     function addInclude(key) {
@@ -3734,10 +3829,10 @@ var OpenAIResponsesLanguageModel = class {
       top_logprobs: topLogprobs,
       truncation: openaiOptions == null ? void 0 : openaiOptions.truncation,
       // model-specific settings:
-      ...modelCapabilities.isReasoningModel && ((openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningSummary) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningMode) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningContext) != null) && {
+      ...modelCapabilities.isReasoningModel && (resolvedReasoningEffort != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningSummary) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningMode) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningContext) != null) && {
         reasoning: {
-          ...(openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null && {
-            effort: openaiOptions.reasoningEffort
+          ...resolvedReasoningEffort != null && {
+            effort: resolvedReasoningEffort
           },
           ...(openaiOptions == null ? void 0 : openaiOptions.reasoningSummary) != null && {
             summary: openaiOptions.reasoningSummary
@@ -3751,6 +3846,14 @@ var OpenAIResponsesLanguageModel = class {
         }
       }
     };
+    if (modelCapabilities.supportsConfigurationUpdate && baseArgs.prompt_cache_retention != null) {
+      baseArgs.prompt_cache_retention = void 0;
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "promptCacheRetention",
+        details: "promptCacheRetention is not supported by GPT-6 and later models; use promptCacheOptions instead"
+      });
+    }
     if (modelCapabilities.isReasoningModel) {
       if (!((openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) === "none" && modelCapabilities.supportsNonReasoningParameters)) {
         if (baseArgs.temperature != null) {
@@ -3769,6 +3872,18 @@ var OpenAIResponsesLanguageModel = class {
             details: "topP is not supported for reasoning models"
           });
         }
+        if (modelCapabilities.supportedReasoningEfforts != null && (baseArgs.top_logprobs != null || ((_e = baseArgs.include) == null ? void 0 : _e.includes("message.output_text.logprobs")))) {
+          baseArgs.top_logprobs = void 0;
+          const filteredInclude = (_f = baseArgs.include) == null ? void 0 : _f.filter(
+            (value) => value !== "message.output_text.logprobs"
+          );
+          baseArgs.include = filteredInclude != null && filteredInclude.length > 0 ? filteredInclude : void 0;
+          warnings.push({
+            type: "unsupported-setting",
+            setting: "logprobs",
+            details: "logprobs is not supported for reasoning models"
+          });
+        }
       }
     } else {
       if ((openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null) {
@@ -3823,7 +3938,8 @@ var OpenAIResponsesLanguageModel = class {
     } = await prepareResponsesTools({
       tools,
       toolChoice,
-      strictJsonSchema
+      strictJsonSchema,
+      supportsAsyncToolCalling: modelCapabilities.supportsAsyncToolCalling
     });
     return {
       webSearchToolName,
@@ -4017,7 +4133,8 @@ var OpenAIResponsesLanguageModel = class {
             input: part.arguments,
             providerMetadata: {
               [providerKey]: {
-                itemId: part.id
+                itemId: part.id,
+                ...part.async != null && { async: part.async }
               }
             }
           });
@@ -4217,7 +4334,8 @@ var OpenAIResponsesLanguageModel = class {
               if (value.item.type === "function_call") {
                 ongoingToolCalls[value.output_index] = {
                   toolName: value.item.name,
-                  toolCallId: value.item.call_id
+                  toolCallId: value.item.call_id,
+                  async: value.item.async
                 };
                 controller.enqueue({
                   type: "tool-input-start",
@@ -4341,6 +4459,7 @@ var OpenAIResponsesLanguageModel = class {
                   }
                 });
               } else if (value.item.type === "function_call") {
+                const ongoingToolCall = ongoingToolCalls[value.output_index];
                 ongoingToolCalls[value.output_index] = void 0;
                 hasFunctionCall = true;
                 controller.enqueue({
@@ -4354,7 +4473,8 @@ var OpenAIResponsesLanguageModel = class {
                   input: value.item.arguments,
                   providerMetadata: {
                     [providerKey]: {
-                      itemId: value.item.id
+                      itemId: value.item.id,
+                      ...value.item.async != null ? { async: value.item.async } : (ongoingToolCall == null ? void 0 : ongoingToolCall.async) != null ? { async: ongoingToolCall.async } : {}
                     }
                   }
                 });
@@ -5107,7 +5227,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "2.0.124" : "0.0.0-test";
+var VERSION = true ? "2.0.126" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {