@ai-sdk/openai 2.0.95 → 2.0.97

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/openai
 
+## 2.0.97
+
+### Patch Changes
+
+- Updated dependencies [6a2f01b]
+- Updated dependencies [17d64e3]
+  - @ai-sdk/provider-utils@3.0.22
+
+## 2.0.96
+
+### Patch Changes
+
+- e867b5c: 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.
+
 ## 2.0.95
 
 ### Patch Changes

package/dist/index.js

@@ -2145,7 +2145,7 @@ async function convertToOpenAIResponsesInput({
   store,
   hasLocalShellTool = false
 }) {
-  var _a, _b, _c, _d;
+  var _a, _b, _c, _d, _e, _f;
   const input = [];
   const warnings = [];
   for (const { role, content } of prompt) {
@@ -2227,6 +2227,7 @@ async function convertToOpenAIResponsesInput({
           switch (part.type) {
             case "text": {
               const id = (_b = (_a = part.providerOptions) == null ? void 0 : _a.openai) == null ? void 0 : _b.itemId;
+              const phase = (_d = (_c = part.providerOptions) == null ? void 0 : _c.openai) == null ? void 0 : _d.phase;
               if (store && id != null) {
                 input.push({ type: "item_reference", id });
                 break;
@@ -2234,7 +2235,8 @@ async function convertToOpenAIResponsesInput({
               input.push({
                 role: "assistant",
                 content: [{ type: "output_text", text: part.text }],
-                id
+                id,
+                ...phase != null && { phase }
               });
               break;
             }
@@ -2243,7 +2245,7 @@ async function convertToOpenAIResponsesInput({
               if (part.providerExecuted) {
                 break;
               }
-              const id = (_d = (_c = part.providerOptions) == null ? void 0 : _c.openai) == null ? void 0 : _d.itemId;
+              const id = (_f = (_e = part.providerOptions) == null ? void 0 : _e.openai) == null ? void 0 : _f.itemId;
               if (store && id != null) {
                 input.push({ type: "item_reference", id });
                 break;
@@ -2482,7 +2484,8 @@ var openaiResponsesChunkSchema = (0, import_provider_utils21.lazyValidator)(
         item: import_v416.z.discriminatedUnion("type", [
           import_v416.z.object({
             type: import_v416.z.literal("message"),
-            id: import_v416.z.string()
+            id: import_v416.z.string(),
+            phase: import_v416.z.enum(["commentary", "final_answer"]).nullish()
           }),
           import_v416.z.object({
             type: import_v416.z.literal("reasoning"),
@@ -2535,7 +2538,8 @@ var openaiResponsesChunkSchema = (0, import_provider_utils21.lazyValidator)(
         item: import_v416.z.discriminatedUnion("type", [
           import_v416.z.object({
             type: import_v416.z.literal("message"),
-            id: import_v416.z.string()
+            id: import_v416.z.string(),
+            phase: import_v416.z.enum(["commentary", "final_answer"]).nullish()
           }),
           import_v416.z.object({
             type: import_v416.z.literal("reasoning"),
@@ -2724,6 +2728,7 @@ var openaiResponsesResponseSchema = (0, import_provider_utils21.lazyValidator)(
             type: import_v416.z.literal("message"),
             role: import_v416.z.literal("assistant"),
             id: import_v416.z.string(),
+            phase: import_v416.z.enum(["commentary", "final_answer"]).nullish(),
             content: import_v416.z.array(
               import_v416.z.object({
                 type: import_v416.z.literal("output_text"),
@@ -3505,7 +3510,8 @@ var OpenAIResponsesLanguageModel = class {
               text: contentPart.text,
               providerMetadata: {
                 [providerKey]: {
-                  itemId: part.id
+                  itemId: part.id,
+                  ...part.phase != null && { phase: part.phase }
                 }
               }
             });
@@ -3745,6 +3751,7 @@ var OpenAIResponsesLanguageModel = class {
     let responseId = null;
     const ongoingToolCalls = {};
     const ongoingAnnotations = [];
+    let activeMessagePhase;
     let hasFunctionCall = false;
     const activeReasoning = {};
     let serviceTier;
@@ -3755,7 +3762,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;
+            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;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -3846,12 +3853,16 @@ var OpenAIResponsesLanguageModel = class {
                 });
               } 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: {
                     [providerKey]: {
-                      itemId: value.item.id
+                      itemId: value.item.id,
+                      ...value.item.phase != null && {
+                        phase: value.item.phase
+                      }
                     }
                   }
                 });
@@ -3866,19 +3877,22 @@ var OpenAIResponsesLanguageModel = class {
                   providerMetadata: {
                     [providerKey]: {
                       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: {
                     [providerKey]: {
                       itemId: value.item.id,
+                      ...phase != null && { phase },
                       ...ongoingAnnotations.length > 0 && {
                         annotations: ongoingAnnotations
                       }
@@ -3943,13 +3957,13 @@ var OpenAIResponsesLanguageModel = class {
                   toolName: "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
                   },
                   providerExecuted: true
                 });
@@ -4008,7 +4022,7 @@ var OpenAIResponsesLanguageModel = class {
                     providerMetadata: {
                       [providerKey]: {
                         itemId: value.item.id,
-                        reasoningEncryptedContent: (_d = value.item.encrypted_content) != null ? _d : null
+                        reasoningEncryptedContent: (_f = value.item.encrypted_content) != null ? _f : null
                       }
                     }
                   });
@@ -4072,7 +4086,7 @@ var OpenAIResponsesLanguageModel = class {
                 id: value.item_id,
                 delta: value.delta
               });
-              if (((_f = (_e = options.providerOptions) == null ? void 0 : _e.openai) == null ? void 0 : _f.logprobs) && value.logprobs) {
+              if (((_h = (_g = options.providerOptions) == null ? void 0 : _g.openai) == null ? void 0 : _h.logprobs) && value.logprobs) {
                 logprobs.push(value.logprobs);
               }
             } else if (value.type === "response.reasoning_summary_part.added") {
@@ -4099,7 +4113,7 @@ var OpenAIResponsesLanguageModel = class {
                   providerMetadata: {
                     [providerKey]: {
                       itemId: value.item_id,
-                      reasoningEncryptedContent: (_h = (_g = activeReasoning[value.item_id]) == null ? void 0 : _g.encryptedContent) != null ? _h : null
+                      reasoningEncryptedContent: (_j = (_i = activeReasoning[value.item_id]) == null ? void 0 : _i.encryptedContent) != null ? _j : null
                     }
                   }
                 });
@@ -4130,14 +4144,14 @@ var OpenAIResponsesLanguageModel = class {
               }
             } else if (isResponseFinishedChunk(value)) {
               finishReason = mapOpenAIResponseFinishReason({
-                finishReason: (_i = value.response.incomplete_details) == null ? void 0 : _i.reason,
+                finishReason: (_k = value.response.incomplete_details) == null ? void 0 : _k.reason,
                 hasFunctionCall
               });
               usage.inputTokens = value.response.usage.input_tokens;
               usage.outputTokens = value.response.usage.output_tokens;
               usage.totalTokens = value.response.usage.input_tokens + value.response.usage.output_tokens;
-              usage.reasoningTokens = (_k = (_j = value.response.usage.output_tokens_details) == null ? void 0 : _j.reasoning_tokens) != null ? _k : void 0;
-              usage.cachedInputTokens = (_m = (_l = value.response.usage.input_tokens_details) == null ? void 0 : _l.cached_tokens) != null ? _m : void 0;
+              usage.reasoningTokens = (_m = (_l = value.response.usage.output_tokens_details) == null ? void 0 : _l.reasoning_tokens) != null ? _m : void 0;
+              usage.cachedInputTokens = (_o = (_n = value.response.usage.input_tokens_details) == null ? void 0 : _n.cached_tokens) != null ? _o : void 0;
               if (typeof value.response.service_tier === "string") {
                 serviceTier = value.response.service_tier;
               }
@@ -4147,7 +4161,7 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "source",
                   sourceType: "url",
-                  id: (_p = (_o = (_n = self.config).generateId) == null ? void 0 : _o.call(_n)) != null ? _p : (0, import_provider_utils24.generateId)(),
+                  id: (_r = (_q = (_p = self.config).generateId) == null ? void 0 : _q.call(_p)) != null ? _r : (0, import_provider_utils24.generateId)(),
                   url: value.annotation.url,
                   title: value.annotation.title
                 });
@@ -4155,10 +4169,10 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_s = (_r = (_q = self.config).generateId) == null ? void 0 : _r.call(_q)) != null ? _s : (0, import_provider_utils24.generateId)(),
+                  id: (_u = (_t = (_s = self.config).generateId) == null ? void 0 : _t.call(_s)) != null ? _u : (0, import_provider_utils24.generateId)(),
                   mediaType: "text/plain",
-                  title: (_u = (_t = value.annotation.quote) != null ? _t : value.annotation.filename) != null ? _u : "Document",
-                  filename: (_v = value.annotation.filename) != null ? _v : value.annotation.file_id,
+                  title: (_w = (_v = value.annotation.quote) != null ? _v : value.annotation.filename) != null ? _w : "Document",
+                  filename: (_x = value.annotation.filename) != null ? _x : value.annotation.file_id,
                   ...value.annotation.file_id ? {
                     providerMetadata: {
                       [providerKey]: {
@@ -4606,7 +4620,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "2.0.95" : "0.0.0-test";
+var VERSION = true ? "2.0.97" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {