@ai-sdk/openai 3.0.137 → 3.0.138

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @ai-sdk/openai
 
+## 3.0.138
+
+### Patch Changes
+
+- c6d995a: fix(openai): surface Chat Completions refusals as text content
+
+  The Chat Completions model ignored `message.refusal` (non-streaming) and `delta.refusal` (streaming). When the model refused to answer, `content` was `null`, so the AI SDK returned empty text with a `stop` finish reason and silently dropped the refusal. Refusal text is now emitted as text content in both `generateText` and `streamText` results, and it is emitted in addition to content when the API returns both. A refusal with a `stop` finish reason is now reported as a `content-filter` finish reason, matching the Anthropic provider and the Responses API.
+
+- 98eb47b: fix(openai,openai-compatible): surface refusal logprobs and openai-compatible refusals
+
+  `@ai-sdk/openai`: Chat Completions responses that contain a refusal can return `logprobs.refusal` next to `logprobs.content`. The provider previously read only `logprobs.content`, so `providerMetadata.openai.logprobs` was empty or missing for refusals. Refusal logprobs are now included in emission order (content logprobs followed by refusal logprobs) in both `generateText` and `streamText`.
+
+  Streaming logprobs are now collected across all chunks in `streamText`: previously only the logprobs of the last streamed chunk were reported. This applies to content logprobs as well, so `providerMetadata.openai.logprobs` now contains the logprobs of every streamed token instead of only the last chunk's tokens. Explicitly empty logprobs (`logprobs: { content: [], refusal: null }`) are reported as an empty array, as before.
+
+  A refusal that arrives in the same streamed chunk as the `finish_reason` is now taken into account: such a response is reported with a `content-filter` finish reason instead of `stop`.
+
+  `@ai-sdk/openai-compatible`: Chat Completions responses that carry `message.refusal` (non-streaming) or `delta.refusal` (streaming) were ignored, so providers such as OpenAI served through `createOpenAICompatible` lost the refusal text and reported an empty `stop` response. Refusals are now returned as text content after any content text, and a non-empty refusal with a `stop` finish reason is reported as a `content-filter` finish reason. This also applies when the refusal and the finish reason arrive in the same streamed chunk. Non-string refusals (for example `refusal: false` from servers that use booleans) are ignored instead of failing the response.
+
+- c21fadf: fix(openai): handle refusal content parts in the Responses API
+
+  The Responses API returns a `refusal` content part instead of `output_text` when the model declines a request. The response schema rejected these parts, so non-streaming calls failed with an `APICallError` ("Invalid JSON response"), and streamed `response.refusal.delta` / `response.refusal.done` events were dropped, producing empty text. Refusal content parts and stream events are now parsed: the refusal explanation is surfaced as text and the finish reason is mapped to `content-filter`. When the response also contains a client-side function call, the finish reason stays `tool-calls` so the tools are still executed.
+
 ## 3.0.137
 
 ### Patch Changes

package/dist/index.d.mts

@@ -241,6 +241,18 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
             logprob: number;
         }[];
     }[] | null | undefined;
+} | {
+    type: "response.refusal.delta";
+    item_id: string;
+    delta: string;
+    output_index?: number | null | undefined;
+    content_index?: number | null | undefined;
+} | {
+    type: "response.refusal.done";
+    item_id: string;
+    refusal: string;
+    output_index?: number | null | undefined;
+    content_index?: number | null | undefined;
 } | {
     type: "response.completed" | "response.incomplete";
     response: {

package/dist/index.d.ts

@@ -241,6 +241,18 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
             logprob: number;
         }[];
     }[] | null | undefined;
+} | {
+    type: "response.refusal.delta";
+    item_id: string;
+    delta: string;
+    output_index?: number | null | undefined;
+    content_index?: number | null | undefined;
+} | {
+    type: "response.refusal.done";
+    item_id: string;
+    refusal: string;
+    output_index?: number | null | undefined;
+    content_index?: number | null | undefined;
 } | {
     type: "response.completed" | "response.incomplete";
     response: {

package/dist/index.js

@@ -658,10 +658,13 @@ function getResponseMetadata({
 }
 
 // src/chat/map-openai-finish-reason.ts
-function mapOpenAIFinishReason(finishReason) {
+function mapOpenAIFinishReason({
+  finishReason,
+  hasRefusal = false
+}) {
   switch (finishReason) {
     case "stop":
-      return "stop";
+      return hasRefusal ? "content-filter" : "stop";
     case "length":
       return "length";
     case "content_filter":
@@ -688,6 +691,8 @@ var openaiChatResponseSchema = (0, import_provider_utils3.lazySchema)(
           message: import_v42.z.object({
             role: import_v42.z.literal("assistant").nullish(),
             content: import_v42.z.string().nullish(),
+            // set instead of `content` when the model refuses to answer:
+            refusal: import_v42.z.string().nullish(),
             audio: import_v42.z.object({
               transcript: import_v42.z.string().nullish()
             }).nullish(),
@@ -726,6 +731,20 @@ var openaiChatResponseSchema = (0, import_provider_utils3.lazySchema)(
                   })
                 )
               })
+            ).nullish(),
+            // logprobs of the refusal tokens (set instead of `content` when
+            // the model refuses to answer):
+            refusal: import_v42.z.array(
+              import_v42.z.object({
+                token: import_v42.z.string(),
+                logprob: import_v42.z.number(),
+                top_logprobs: import_v42.z.array(
+                  import_v42.z.object({
+                    token: import_v42.z.string(),
+                    logprob: import_v42.z.number()
+                  })
+                )
+              })
             ).nullish()
           }).nullish(),
           finish_reason: import_v42.z.string().nullish()
@@ -760,6 +779,8 @@ var openaiChatChunkSchema = (0, import_provider_utils3.lazySchema)(
             delta: import_v42.z.object({
               role: import_v42.z.enum(["assistant"]).nullish(),
               content: import_v42.z.string().nullish(),
+              // set instead of `content` when the model refuses to answer:
+              refusal: import_v42.z.string().nullish(),
               tool_calls: import_v42.z.array(
                 import_v42.z.object({
                   index: import_v42.z.number(),
@@ -795,6 +816,20 @@ var openaiChatChunkSchema = (0, import_provider_utils3.lazySchema)(
                     })
                   )
                 })
+              ).nullish(),
+              // logprobs of the refusal tokens (set instead of `content` when
+              // the model refuses to answer):
+              refusal: import_v42.z.array(
+                import_v42.z.object({
+                  token: import_v42.z.string(),
+                  logprob: import_v42.z.number(),
+                  top_logprobs: import_v42.z.array(
+                    import_v42.z.object({
+                      token: import_v42.z.string(),
+                      logprob: import_v42.z.number()
+                    })
+                  )
+                })
               ).nullish()
             }).nullish(),
             finish_reason: import_v42.z.string().nullish(),
@@ -1231,7 +1266,7 @@ var OpenAIChatLanguageModel = class {
     };
   }
   async doGenerate(options) {
-    var _a2, _b, _c, _d, _e, _f, _g, _h;
+    var _a2, _b, _c, _d, _e, _f, _g, _h, _i;
     const { args: body, warnings } = await this.getArgs(options);
     const {
       responseHeaders,
@@ -1263,6 +1298,11 @@ var OpenAIChatLanguageModel = class {
     if (text != null && text.length > 0) {
       content.push({ type: "text", text });
     }
+    const refusal = choice.message.refusal;
+    const hasRefusal = refusal != null && refusal.length > 0;
+    if (hasRefusal) {
+      content.push({ type: "text", text: refusal });
+    }
     for (const toolCall of (_b = choice.message.tool_calls) != null ? _b : []) {
       content.push({
         type: "tool-call",
@@ -1289,14 +1329,22 @@ var OpenAIChatLanguageModel = class {
     if ((completionTokenDetails == null ? void 0 : completionTokenDetails.rejected_prediction_tokens) != null) {
       providerMetadata.openai.rejectedPredictionTokens = completionTokenDetails == null ? void 0 : completionTokenDetails.rejected_prediction_tokens;
     }
-    if (((_g = choice.logprobs) == null ? void 0 : _g.content) != null) {
-      providerMetadata.openai.logprobs = choice.logprobs.content;
+    const contentLogprobs = (_g = choice.logprobs) == null ? void 0 : _g.content;
+    const refusalLogprobs = (_h = choice.logprobs) == null ? void 0 : _h.refusal;
+    if (contentLogprobs != null || refusalLogprobs != null) {
+      providerMetadata.openai.logprobs = [
+        ...contentLogprobs != null ? contentLogprobs : [],
+        ...refusalLogprobs != null ? refusalLogprobs : []
+      ];
     }
     return {
       content,
       finishReason: {
-        unified: mapOpenAIFinishReason(choice.finish_reason),
-        raw: (_h = choice.finish_reason) != null ? _h : void 0
+        unified: mapOpenAIFinishReason({
+          finishReason: choice.finish_reason,
+          hasRefusal
+        }),
+        raw: (_i = choice.finish_reason) != null ? _i : void 0
       },
       usage: convertOpenAIChatUsage(response.usage),
       request: { body },
@@ -1349,6 +1397,10 @@ var OpenAIChatLanguageModel = class {
     let usage = void 0;
     let metadataExtracted = false;
     let isActiveText = false;
+    let hasRefusal = false;
+    let rawFinishReason = void 0;
+    let hasLogprobs = false;
+    const streamedLogprobs = [];
     const providerMetadata = { openai: {} };
     const result = {
       stream: checkedResponse.pipeThrough(
@@ -1361,18 +1413,20 @@ var OpenAIChatLanguageModel = class {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a2, _b, _c, _d, _e;
+            var _a2, _b, _c, _d;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
             if (!chunk.success) {
               finishReason = { unified: "error", raw: void 0 };
+              rawFinishReason = void 0;
               controller.enqueue({ type: "error", error: chunk.error });
               return;
             }
             const value = chunk.value;
             if ("error" in value) {
               finishReason = { unified: "error", raw: void 0 };
+              rawFinishReason = void 0;
               controller.enqueue({ type: "error", error: value.error });
               return;
             }
@@ -1397,19 +1451,35 @@ var OpenAIChatLanguageModel = class {
             }
             const choice = value.choices[0];
             if ((choice == null ? void 0 : choice.finish_reason) != null) {
-              finishReason = {
-                unified: mapOpenAIFinishReason(choice.finish_reason),
-                raw: choice.finish_reason
-              };
+              rawFinishReason = choice.finish_reason;
             }
-            if (((_e = choice == null ? void 0 : choice.logprobs) == null ? void 0 : _e.content) != null) {
-              providerMetadata.openai.logprobs = choice.logprobs.content;
+            if ((choice == null ? void 0 : choice.logprobs) != null) {
+              const contentLogprobs = choice.logprobs.content;
+              const refusalLogprobs = choice.logprobs.refusal;
+              if (contentLogprobs != null || refusalLogprobs != null) {
+                hasLogprobs = true;
+                streamedLogprobs.push(
+                  ...contentLogprobs != null ? contentLogprobs : [],
+                  ...refusalLogprobs != null ? refusalLogprobs : []
+                );
+              }
             }
             if ((choice == null ? void 0 : choice.delta) == null) {
               return;
             }
             const delta = choice.delta;
-            if (delta.content != null) {
+            const textDeltas = [];
+            if (delta.content != null && delta.content.length > 0) {
+              textDeltas.push(delta.content);
+            }
+            if (delta.refusal != null && delta.refusal.length > 0) {
+              hasRefusal = true;
+              textDeltas.push(delta.refusal);
+            }
+            if (textDeltas.length === 0 && delta.content === "") {
+              textDeltas.push(delta.content);
+            }
+            for (const textDelta of textDeltas) {
               if (!isActiveText) {
                 controller.enqueue({ type: "text-start", id: "0" });
                 isActiveText = true;
@@ -1417,7 +1487,7 @@ var OpenAIChatLanguageModel = class {
               controller.enqueue({
                 type: "text-delta",
                 id: "0",
-                delta: delta.content
+                delta: textDelta
               });
             }
             if (delta.tool_calls != null) {
@@ -1442,6 +1512,18 @@ var OpenAIChatLanguageModel = class {
               controller.enqueue({ type: "text-end", id: "0" });
             }
             toolCallTracker.flush();
+            if (rawFinishReason != null) {
+              finishReason = {
+                unified: mapOpenAIFinishReason({
+                  finishReason: rawFinishReason,
+                  hasRefusal
+                }),
+                raw: rawFinishReason
+              };
+            }
+            if (hasLogprobs) {
+              providerMetadata.openai.logprobs = streamedLogprobs;
+            }
             controller.enqueue({
               type: "finish",
               finishReason,
@@ -1463,7 +1545,7 @@ function isOpenAIChatOutputChunk(chunk) {
   }
   return chunk.choices.some((choice) => {
     const delta = choice.delta;
-    return (delta == null ? void 0 : delta.content) != null && delta.content.length > 0 || (delta == null ? void 0 : delta.tool_calls) != null && delta.tool_calls.length > 0 || (delta == null ? void 0 : delta.annotations) != null && delta.annotations.length > 0;
+    return (delta == null ? void 0 : delta.content) != null && delta.content.length > 0 || (delta == null ? void 0 : delta.refusal) != null && delta.refusal.length > 0 || (delta == null ? void 0 : delta.tool_calls) != null && delta.tool_calls.length > 0 || (delta == null ? void 0 : delta.annotations) != null && delta.annotations.length > 0;
   });
 }
 
@@ -4593,12 +4675,14 @@ var openaiResponsesReasoningProviderOptionsSchema = (0, import_provider_utils28.
 // src/responses/map-openai-responses-finish-reason.ts
 function mapOpenAIResponseFinishReason({
   finishReason,
-  hasFunctionCall
+  hasFunctionCall,
+  hasRefusal = false
 }) {
   switch (finishReason) {
     case void 0:
     case null:
-      return hasFunctionCall ? "tool-calls" : "stop";
+      if (hasFunctionCall) return "tool-calls";
+      return hasRefusal ? "content-filter" : "stop";
     case "max_output_tokens":
       return "length";
     case "content_filter":
@@ -4705,6 +4789,8 @@ var openaiResponsesModeledChunkTypes = /* @__PURE__ */ new Set([
   "response.output_item.done",
   "response.output_text.annotation.added",
   "response.output_text.delta",
+  "response.refusal.delta",
+  "response.refusal.done",
   "response.reasoning_summary_part.added",
   "response.reasoning_summary_part.done",
   "response.reasoning_summary_text.delta"
@@ -4761,6 +4847,20 @@ var openaiResponsesChunkSchema = (0, import_provider_utils29.lazySchema)(
           })
         ).nullish()
       }),
+      import_v423.z.object({
+        type: import_v423.z.literal("response.refusal.delta"),
+        item_id: import_v423.z.string(),
+        output_index: import_v423.z.number().nullish(),
+        content_index: import_v423.z.number().nullish(),
+        delta: import_v423.z.string()
+      }),
+      import_v423.z.object({
+        type: import_v423.z.literal("response.refusal.done"),
+        item_id: import_v423.z.string(),
+        output_index: import_v423.z.number().nullish(),
+        content_index: import_v423.z.number().nullish(),
+        refusal: import_v423.z.string()
+      }),
       import_v423.z.object({
         type: import_v423.z.enum(["response.completed", "response.incomplete"]),
         response: import_v423.z.object({
@@ -5286,53 +5386,60 @@ var openaiResponsesResponseSchema = (0, import_provider_utils29.lazySchema)(
             role: import_v423.z.literal("assistant"),
             id: import_v423.z.string(),
             phase: import_v423.z.enum(["commentary", "final_answer"]).nullish(),
+            // the API returns either text or a refusal as content parts:
             content: import_v423.z.array(
-              import_v423.z.object({
-                type: import_v423.z.literal("output_text"),
-                text: import_v423.z.string(),
-                logprobs: import_v423.z.array(
-                  import_v423.z.object({
-                    token: import_v423.z.string(),
-                    logprob: import_v423.z.number(),
-                    top_logprobs: import_v423.z.array(
-                      import_v423.z.object({
-                        token: import_v423.z.string(),
-                        logprob: import_v423.z.number()
-                      })
-                    )
-                  })
-                ).nullish(),
-                annotations: import_v423.z.array(
-                  import_v423.z.discriminatedUnion("type", [
-                    import_v423.z.object({
-                      type: import_v423.z.literal("url_citation"),
-                      start_index: import_v423.z.number(),
-                      end_index: import_v423.z.number(),
-                      url: import_v423.z.string(),
-                      title: import_v423.z.string()
-                    }),
-                    import_v423.z.object({
-                      type: import_v423.z.literal("file_citation"),
-                      file_id: import_v423.z.string(),
-                      filename: import_v423.z.string(),
-                      index: import_v423.z.number()
-                    }),
-                    import_v423.z.object({
-                      type: import_v423.z.literal("container_file_citation"),
-                      container_id: import_v423.z.string(),
-                      file_id: import_v423.z.string(),
-                      filename: import_v423.z.string(),
-                      start_index: import_v423.z.number(),
-                      end_index: import_v423.z.number()
-                    }),
+              import_v423.z.discriminatedUnion("type", [
+                import_v423.z.object({
+                  type: import_v423.z.literal("output_text"),
+                  text: import_v423.z.string(),
+                  logprobs: import_v423.z.array(
                     import_v423.z.object({
-                      type: import_v423.z.literal("file_path"),
-                      file_id: import_v423.z.string(),
-                      index: import_v423.z.number()
+                      token: import_v423.z.string(),
+                      logprob: import_v423.z.number(),
+                      top_logprobs: import_v423.z.array(
+                        import_v423.z.object({
+                          token: import_v423.z.string(),
+                          logprob: import_v423.z.number()
+                        })
+                      )
                     })
-                  ])
-                )
-              })
+                  ).nullish(),
+                  annotations: import_v423.z.array(
+                    import_v423.z.discriminatedUnion("type", [
+                      import_v423.z.object({
+                        type: import_v423.z.literal("url_citation"),
+                        start_index: import_v423.z.number(),
+                        end_index: import_v423.z.number(),
+                        url: import_v423.z.string(),
+                        title: import_v423.z.string()
+                      }),
+                      import_v423.z.object({
+                        type: import_v423.z.literal("file_citation"),
+                        file_id: import_v423.z.string(),
+                        filename: import_v423.z.string(),
+                        index: import_v423.z.number()
+                      }),
+                      import_v423.z.object({
+                        type: import_v423.z.literal("container_file_citation"),
+                        container_id: import_v423.z.string(),
+                        file_id: import_v423.z.string(),
+                        filename: import_v423.z.string(),
+                        start_index: import_v423.z.number(),
+                        end_index: import_v423.z.number()
+                      }),
+                      import_v423.z.object({
+                        type: import_v423.z.literal("file_path"),
+                        file_id: import_v423.z.string(),
+                        index: import_v423.z.number()
+                      })
+                    ])
+                  )
+                }),
+                import_v423.z.object({
+                  type: import_v423.z.literal("refusal"),
+                  refusal: import_v423.z.string()
+                })
+              ])
             )
           }),
           import_v423.z.object({
@@ -6467,6 +6574,7 @@ var OpenAIResponsesLanguageModel = class {
     )) != null ? _b : [];
     let hasFunctionCall = false;
     const hostedToolSearchCallIds = [];
+    let hasRefusal = false;
     for (const part of response.output) {
       switch (part.type) {
         case "reasoning": {
@@ -6600,6 +6708,20 @@ var OpenAIResponsesLanguageModel = class {
         }
         case "message": {
           for (const contentPart of part.content) {
+            if (contentPart.type === "refusal") {
+              hasRefusal = true;
+              content.push({
+                type: "text",
+                text: contentPart.refusal,
+                providerMetadata: {
+                  [providerOptionsName]: {
+                    itemId: part.id,
+                    ...part.phase != null && { phase: part.phase }
+                  }
+                }
+              });
+              continue;
+            }
             if (((_h = (_g = options.providerOptions) == null ? void 0 : _g[providerOptionsName]) == null ? void 0 : _h.logprobs) && contentPart.logprobs) {
               logprobs.push(contentPart.logprobs);
             }
@@ -6899,7 +7021,8 @@ var OpenAIResponsesLanguageModel = class {
       finishReason: {
         unified: mapOpenAIResponseFinishReason({
           finishReason: (_C = response.incomplete_details) == null ? void 0 : _C.reason,
-          hasFunctionCall
+          hasFunctionCall,
+          hasRefusal
         }),
         raw: (_E = (_D = response.incomplete_details) == null ? void 0 : _D.reason) != null ? _E : void 0
       },
@@ -6970,6 +7093,7 @@ var OpenAIResponsesLanguageModel = class {
     const ongoingAnnotations = [];
     let activeMessagePhase;
     let hasFunctionCall = false;
+    let hasRefusal = false;
     const activeReasoning = {};
     let serviceTier;
     let reasoningContext;
@@ -7743,6 +7867,15 @@ var OpenAIResponsesLanguageModel = class {
               if (((_u = (_t = options.providerOptions) == null ? void 0 : _t[providerOptionsName]) == null ? void 0 : _u.logprobs) && value.logprobs) {
                 logprobs.push(value.logprobs);
               }
+            } else if (isRefusalDeltaChunk(value)) {
+              hasRefusal = true;
+              controller.enqueue({
+                type: "text-delta",
+                id: value.item_id,
+                delta: value.delta
+              });
+            } else if (isRefusalDoneChunk(value)) {
+              hasRefusal = true;
             } else if (value.type === "response.reasoning_summary_part.added") {
               if (value.summary_index > 0) {
                 const activeReasoningPart = activeReasoning[value.item_id];
@@ -7805,7 +7938,8 @@ var OpenAIResponsesLanguageModel = class {
                 finishReason = {
                   unified: mapOpenAIResponseFinishReason({
                     finishReason: (_x = value.response.incomplete_details) == null ? void 0 : _x.reason,
-                    hasFunctionCall
+                    hasFunctionCall,
+                    hasRefusal
                   }),
                   raw: (_z = (_y = value.response.incomplete_details) == null ? void 0 : _y.reason) != null ? _z : void 0
                 };
@@ -7959,6 +8093,12 @@ var OpenAIResponsesLanguageModel = class {
 function isTextDeltaChunk(chunk) {
   return chunk.type === "response.output_text.delta";
 }
+function isRefusalDeltaChunk(chunk) {
+  return chunk.type === "response.refusal.delta";
+}
+function isRefusalDoneChunk(chunk) {
+  return chunk.type === "response.refusal.done";
+}
 function isOpenAIChatCompletionChunk(value) {
   const chunk = asRecord2(value);
   return chunk != null && Array.isArray(chunk.choices) && typeof chunk.type !== "string";
@@ -8438,7 +8578,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.137" : "0.0.0-test";
+var VERSION = true ? "3.0.138" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {