@ai-sdk/openai 3.0.33 → 3.0.34

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai
 
+## 3.0.34
+
+### Patch Changes
+
+- 66a374c: Support `phase` parameter on Responses API message items. The `phase` field (`'commentary'` or `'final_answer'`) is returned by models like `gpt-5.3-codex` on assistant message output items and must be preserved when sending follow-up requests. The phase value is available in `providerMetadata.openai.phase` on text parts and is automatically included on assistant messages sent back to the API.
+
 ## 3.0.33
 
 ### Patch Changes

package/dist/index.d.mts

@@ -220,6 +220,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     item: {
         type: "message";
         id: string;
+        phase?: "commentary" | "final_answer" | null | undefined;
     } | {
         type: "reasoning";
         id: string;
@@ -315,6 +316,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     item: {
         type: "message";
         id: string;
+        phase?: "commentary" | "final_answer" | null | undefined;
     } | {
         type: "reasoning";
         id: string;
@@ -1027,6 +1029,7 @@ type OpenaiResponsesProviderMetadata = {
 };
 type ResponsesTextProviderMetadata = {
     itemId: string;
+    phase?: 'commentary' | 'final_answer' | null;
     annotations?: Array<ResponsesOutputTextAnnotationProviderMetadata>;
 };
 type OpenaiResponsesTextProviderMetadata = {

package/dist/index.d.ts

@@ -220,6 +220,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     item: {
         type: "message";
         id: string;
+        phase?: "commentary" | "final_answer" | null | undefined;
     } | {
         type: "reasoning";
         id: string;
@@ -315,6 +316,7 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     item: {
         type: "message";
         id: string;
+        phase?: "commentary" | "final_answer" | null | undefined;
     } | {
         type: "reasoning";
         id: string;
@@ -1027,6 +1029,7 @@ type OpenaiResponsesProviderMetadata = {
 };
 type ResponsesTextProviderMetadata = {
     itemId: string;
+    phase?: 'commentary' | 'final_answer' | null;
     annotations?: Array<ResponsesOutputTextAnnotationProviderMetadata>;
 };
 type OpenaiResponsesTextProviderMetadata = {

package/dist/index.js

@@ -1753,6 +1753,7 @@ var modelMaxImagesPerCall = {
   "chatgpt-image-latest": 10
 };
 var defaultResponseFormatPrefixes = [
+  "chatgpt-image-",
   "gpt-image-1-mini",
   "gpt-image-1.5",
   "gpt-image-1"
@@ -2574,7 +2575,7 @@ async function convertToOpenAIResponsesInput({
   hasShellTool = false,
   hasApplyPatchTool = false
 }) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
   const input = [];
   const warnings = [];
   const processedApprovalIds = /* @__PURE__ */ new Set();
@@ -2655,7 +2656,9 @@ async function convertToOpenAIResponsesInput({
         for (const part of content) {
           switch (part.type) {
             case "text": {
-              const id = (_b = (_a = part.providerOptions) == null ? void 0 : _a[providerOptionsName]) == null ? void 0 : _b.itemId;
+              const providerOpts = (_a = part.providerOptions) == null ? void 0 : _a[providerOptionsName];
+              const id = providerOpts == null ? void 0 : providerOpts.itemId;
+              const phase = providerOpts == null ? void 0 : providerOpts.phase;
               if (hasConversation && id != null) {
                 break;
               }
@@ -2666,12 +2669,13 @@ async function convertToOpenAIResponsesInput({
               input.push({
                 role: "assistant",
                 content: [{ type: "output_text", text: part.text }],
-                id
+                id,
+                ...phase != null && { phase }
               });
               break;
             }
             case "tool-call": {
-              const id = (_g = (_d = (_c = part.providerOptions) == null ? void 0 : _c[providerOptionsName]) == null ? void 0 : _d.itemId) != null ? _g : (_f = (_e = part.providerMetadata) == null ? void 0 : _e[providerOptionsName]) == null ? void 0 : _f.itemId;
+              const id = (_f = (_c = (_b = part.providerOptions) == null ? void 0 : _b[providerOptionsName]) == null ? void 0 : _c.itemId) != null ? _f : (_e = (_d = part.providerMetadata) == null ? void 0 : _d[providerOptionsName]) == null ? void 0 : _e.itemId;
               if (hasConversation && id != null) {
                 break;
               }
@@ -2782,7 +2786,7 @@ async function convertToOpenAIResponsesInput({
                 break;
               }
               if (store) {
-                const itemId = (_j = (_i = (_h = part.providerOptions) == null ? void 0 : _h[providerOptionsName]) == null ? void 0 : _i.itemId) != null ? _j : part.toolCallId;
+                const itemId = (_i = (_h = (_g = part.providerOptions) == null ? void 0 : _g[providerOptionsName]) == null ? void 0 : _h.itemId) != null ? _i : part.toolCallId;
                 input.push({ type: "item_reference", id: itemId });
               } else {
                 warnings.push({
@@ -2876,7 +2880,7 @@ async function convertToOpenAIResponsesInput({
           }
           const output = part.output;
           if (output.type === "execution-denied") {
-            const approvalId = (_l = (_k = output.providerOptions) == null ? void 0 : _k.openai) == null ? void 0 : _l.approvalId;
+            const approvalId = (_k = (_j = output.providerOptions) == null ? void 0 : _j.openai) == null ? void 0 : _k.approvalId;
             if (approvalId) {
               continue;
             }
@@ -2935,7 +2939,7 @@ async function convertToOpenAIResponsesInput({
               contentValue = output.value;
               break;
             case "execution-denied":
-              contentValue = (_m = output.reason) != null ? _m : "Tool execution denied.";
+              contentValue = (_l = output.reason) != null ? _l : "Tool execution denied.";
               break;
             case "json":
             case "error-json":
@@ -3068,7 +3072,8 @@ var openaiResponsesChunkSchema = (0, import_provider_utils24.lazySchema)(
         item: import_v419.z.discriminatedUnion("type", [
           import_v419.z.object({
             type: import_v419.z.literal("message"),
-            id: import_v419.z.string()
+            id: import_v419.z.string(),
+            phase: import_v419.z.enum(["commentary", "final_answer"]).nullish()
           }),
           import_v419.z.object({
             type: import_v419.z.literal("reasoning"),
@@ -3185,7 +3190,8 @@ var openaiResponsesChunkSchema = (0, import_provider_utils24.lazySchema)(
         item: import_v419.z.discriminatedUnion("type", [
           import_v419.z.object({
             type: import_v419.z.literal("message"),
-            id: import_v419.z.string()
+            id: import_v419.z.string(),
+            phase: import_v419.z.enum(["commentary", "final_answer"]).nullish()
           }),
           import_v419.z.object({
             type: import_v419.z.literal("reasoning"),
@@ -3497,6 +3503,7 @@ var openaiResponsesResponseSchema = (0, import_provider_utils24.lazySchema)(
             type: import_v419.z.literal("message"),
             role: import_v419.z.literal("assistant"),
             id: import_v419.z.string(),
+            phase: import_v419.z.enum(["commentary", "final_answer"]).nullish(),
             content: import_v419.z.array(
               import_v419.z.object({
                 type: import_v419.z.literal("output_text"),
@@ -4629,6 +4636,7 @@ var OpenAIResponsesLanguageModel = class {
             }
             const providerMetadata2 = {
               itemId: part.id,
+              ...part.phase != null && { phase: part.phase },
               ...contentPart.annotations.length > 0 && {
                 annotations: contentPart.annotations
               }
@@ -4943,6 +4951,7 @@ var OpenAIResponsesLanguageModel = class {
     let responseId = null;
     const ongoingToolCalls = {};
     const ongoingAnnotations = [];
+    let activeMessagePhase;
     let hasFunctionCall = false;
     const activeReasoning = {};
     let serviceTier;
@@ -4953,7 +4962,7 @@ var OpenAIResponsesLanguageModel = class {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _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;
+            var _a, _b, _c, _d, _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;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -5094,12 +5103,16 @@ var OpenAIResponsesLanguageModel = class {
               } else if (value.item.type === "shell_call_output") {
               } else if (value.item.type === "message") {
                 ongoingAnnotations.splice(0, ongoingAnnotations.length);
+                activeMessagePhase = (_a = value.item.phase) != null ? _a : void 0;
                 controller.enqueue({
                   type: "text-start",
                   id: value.item.id,
                   providerMetadata: {
                     [providerOptionsName]: {
-                      itemId: value.item.id
+                      itemId: value.item.id,
+                      ...value.item.phase != null && {
+                        phase: value.item.phase
+                      }
                     }
                   }
                 });
@@ -5114,19 +5127,22 @@ var OpenAIResponsesLanguageModel = class {
                   providerMetadata: {
                     [providerOptionsName]: {
                       itemId: value.item.id,
-                      reasoningEncryptedContent: (_a = value.item.encrypted_content) != null ? _a : null
+                      reasoningEncryptedContent: (_b = value.item.encrypted_content) != null ? _b : null
                     }
                   }
                 });
               }
             } else if (isResponseOutputItemDoneChunk(value)) {
               if (value.item.type === "message") {
+                const phase = (_c = value.item.phase) != null ? _c : activeMessagePhase;
+                activeMessagePhase = void 0;
                 controller.enqueue({
                   type: "text-end",
                   id: value.item.id,
                   providerMetadata: {
                     [providerOptionsName]: {
                       itemId: value.item.id,
+                      ...phase != null && { phase },
                       ...ongoingAnnotations.length > 0 && {
                         annotations: ongoingAnnotations
                       }
@@ -5191,13 +5207,13 @@ var OpenAIResponsesLanguageModel = class {
                   toolName: toolNameMapping.toCustomToolName("file_search"),
                   result: {
                     queries: value.item.queries,
-                    results: (_c = (_b = value.item.results) == null ? void 0 : _b.map((result) => ({
+                    results: (_e = (_d = value.item.results) == null ? void 0 : _d.map((result) => ({
                       attributes: result.attributes,
                       fileId: result.file_id,
                       filename: result.filename,
                       score: result.score,
                       text: result.text
-                    }))) != null ? _c : null
+                    }))) != null ? _e : null
                   }
                 });
               } else if (value.item.type === "code_interpreter_call") {
@@ -5221,10 +5237,10 @@ var OpenAIResponsesLanguageModel = class {
                 });
               } else if (value.item.type === "mcp_call") {
                 ongoingToolCalls[value.output_index] = void 0;
-                const approvalRequestId = (_d = value.item.approval_request_id) != null ? _d : void 0;
-                const aliasedToolCallId = approvalRequestId != null ? (_f = (_e = approvalRequestIdToDummyToolCallIdFromStream.get(
+                const approvalRequestId = (_f = value.item.approval_request_id) != null ? _f : void 0;
+                const aliasedToolCallId = approvalRequestId != null ? (_h = (_g = approvalRequestIdToDummyToolCallIdFromStream.get(
                   approvalRequestId
-                )) != null ? _e : approvalRequestIdToDummyToolCallIdFromPrompt[approvalRequestId]) != null ? _f : value.item.id : value.item.id;
+                )) != null ? _g : approvalRequestIdToDummyToolCallIdFromPrompt[approvalRequestId]) != null ? _h : value.item.id : value.item.id;
                 const toolName = `mcp.${value.item.name}`;
                 controller.enqueue({
                   type: "tool-call",
@@ -5294,8 +5310,8 @@ var OpenAIResponsesLanguageModel = class {
                 ongoingToolCalls[value.output_index] = void 0;
               } else if (value.item.type === "mcp_approval_request") {
                 ongoingToolCalls[value.output_index] = void 0;
-                const dummyToolCallId = (_i = (_h = (_g = self.config).generateId) == null ? void 0 : _h.call(_g)) != null ? _i : (0, import_provider_utils27.generateId)();
-                const approvalRequestId = (_j = value.item.approval_request_id) != null ? _j : value.item.id;
+                const dummyToolCallId = (_k = (_j = (_i = self.config).generateId) == null ? void 0 : _j.call(_i)) != null ? _k : (0, import_provider_utils27.generateId)();
+                const approvalRequestId = (_l = value.item.approval_request_id) != null ? _l : value.item.id;
                 approvalRequestIdToDummyToolCallIdFromStream.set(
                   approvalRequestId,
                   dummyToolCallId
@@ -5384,7 +5400,7 @@ var OpenAIResponsesLanguageModel = class {
                     providerMetadata: {
                       [providerOptionsName]: {
                         itemId: value.item.id,
-                        reasoningEncryptedContent: (_k = value.item.encrypted_content) != null ? _k : null
+                        reasoningEncryptedContent: (_m = value.item.encrypted_content) != null ? _m : null
                       }
                     }
                   });
@@ -5488,7 +5504,7 @@ var OpenAIResponsesLanguageModel = class {
                 id: value.item_id,
                 delta: value.delta
               });
-              if (((_m = (_l = options.providerOptions) == null ? void 0 : _l[providerOptionsName]) == null ? void 0 : _m.logprobs) && value.logprobs) {
+              if (((_o = (_n = options.providerOptions) == null ? void 0 : _n[providerOptionsName]) == null ? void 0 : _o.logprobs) && value.logprobs) {
                 logprobs.push(value.logprobs);
               }
             } else if (value.type === "response.reasoning_summary_part.added") {
@@ -5517,7 +5533,7 @@ var OpenAIResponsesLanguageModel = class {
                   providerMetadata: {
                     [providerOptionsName]: {
                       itemId: value.item_id,
-                      reasoningEncryptedContent: (_o = (_n = activeReasoning[value.item_id]) == null ? void 0 : _n.encryptedContent) != null ? _o : null
+                      reasoningEncryptedContent: (_q = (_p = activeReasoning[value.item_id]) == null ? void 0 : _p.encryptedContent) != null ? _q : null
                     }
                   }
                 });
@@ -5551,10 +5567,10 @@ var OpenAIResponsesLanguageModel = class {
             } else if (isResponseFinishedChunk(value)) {
               finishReason = {
                 unified: mapOpenAIResponseFinishReason({
-                  finishReason: (_p = value.response.incomplete_details) == null ? void 0 : _p.reason,
+                  finishReason: (_r = value.response.incomplete_details) == null ? void 0 : _r.reason,
                   hasFunctionCall
                 }),
-                raw: (_r = (_q = value.response.incomplete_details) == null ? void 0 : _q.reason) != null ? _r : void 0
+                raw: (_t = (_s = value.response.incomplete_details) == null ? void 0 : _s.reason) != null ? _t : void 0
               };
               usage = value.response.usage;
               if (typeof value.response.service_tier === "string") {
@@ -5566,7 +5582,7 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "source",
                   sourceType: "url",
-                  id: (_u = (_t = (_s = self.config).generateId) == null ? void 0 : _t.call(_s)) != null ? _u : (0, import_provider_utils27.generateId)(),
+                  id: (_w = (_v = (_u = self.config).generateId) == null ? void 0 : _v.call(_u)) != null ? _w : (0, import_provider_utils27.generateId)(),
                   url: value.annotation.url,
                   title: value.annotation.title
                 });
@@ -5574,7 +5590,7 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_x = (_w = (_v = self.config).generateId) == null ? void 0 : _w.call(_v)) != null ? _x : (0, import_provider_utils27.generateId)(),
+                  id: (_z = (_y = (_x = self.config).generateId) == null ? void 0 : _y.call(_x)) != null ? _z : (0, import_provider_utils27.generateId)(),
                   mediaType: "text/plain",
                   title: value.annotation.filename,
                   filename: value.annotation.filename,
@@ -5590,7 +5606,7 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_A = (_z = (_y = self.config).generateId) == null ? void 0 : _z.call(_y)) != null ? _A : (0, import_provider_utils27.generateId)(),
+                  id: (_C = (_B = (_A = self.config).generateId) == null ? void 0 : _B.call(_A)) != null ? _C : (0, import_provider_utils27.generateId)(),
                   mediaType: "text/plain",
                   title: value.annotation.filename,
                   filename: value.annotation.filename,
@@ -5606,7 +5622,7 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_D = (_C = (_B = self.config).generateId) == null ? void 0 : _C.call(_B)) != null ? _D : (0, import_provider_utils27.generateId)(),
+                  id: (_F = (_E = (_D = self.config).generateId) == null ? void 0 : _E.call(_D)) != null ? _F : (0, import_provider_utils27.generateId)(),
                   mediaType: "application/octet-stream",
                   title: value.annotation.file_id,
                   filename: value.annotation.file_id,
@@ -6065,7 +6081,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.33" : "0.0.0-test";
+var VERSION = true ? "3.0.34" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {