@ai-sdk/openai 3.0.136 → 3.0.138

package/dist/internal/index.mjs

@@ -647,10 +647,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":
@@ -680,6 +683,8 @@ var openaiChatResponseSchema = lazySchema2(
           message: z2.object({
             role: z2.literal("assistant").nullish(),
             content: z2.string().nullish(),
+            // set instead of `content` when the model refuses to answer:
+            refusal: z2.string().nullish(),
             audio: z2.object({
               transcript: z2.string().nullish()
             }).nullish(),
@@ -718,6 +723,20 @@ var openaiChatResponseSchema = lazySchema2(
                   })
                 )
               })
+            ).nullish(),
+            // logprobs of the refusal tokens (set instead of `content` when
+            // the model refuses to answer):
+            refusal: z2.array(
+              z2.object({
+                token: z2.string(),
+                logprob: z2.number(),
+                top_logprobs: z2.array(
+                  z2.object({
+                    token: z2.string(),
+                    logprob: z2.number()
+                  })
+                )
+              })
             ).nullish()
           }).nullish(),
           finish_reason: z2.string().nullish()
@@ -752,6 +771,8 @@ var openaiChatChunkSchema = lazySchema2(
             delta: z2.object({
               role: z2.enum(["assistant"]).nullish(),
               content: z2.string().nullish(),
+              // set instead of `content` when the model refuses to answer:
+              refusal: z2.string().nullish(),
               tool_calls: z2.array(
                 z2.object({
                   index: z2.number(),
@@ -787,6 +808,20 @@ var openaiChatChunkSchema = lazySchema2(
                     })
                   )
                 })
+              ).nullish(),
+              // logprobs of the refusal tokens (set instead of `content` when
+              // the model refuses to answer):
+              refusal: z2.array(
+                z2.object({
+                  token: z2.string(),
+                  logprob: z2.number(),
+                  top_logprobs: z2.array(
+                    z2.object({
+                      token: z2.string(),
+                      logprob: z2.number()
+                    })
+                  )
+                })
               ).nullish()
             }).nullish(),
             finish_reason: z2.string().nullish(),
@@ -1228,7 +1263,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,
@@ -1260,6 +1295,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",
@@ -1286,14 +1326,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 },
@@ -1346,6 +1394,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(
@@ -1358,18 +1410,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;
             }
@@ -1394,19 +1448,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;
@@ -1414,7 +1484,7 @@ var OpenAIChatLanguageModel = class {
               controller.enqueue({
                 type: "text-delta",
                 id: "0",
-                delta: delta.content
+                delta: textDelta
               });
             }
             if (delta.tool_calls != null) {
@@ -1439,6 +1509,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,
@@ -1460,7 +1542,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;
   });
 }
 
@@ -2088,6 +2170,9 @@ var OpenAIEmbeddingModel = class {
 };
 
 // src/image/openai-image-model.ts
+import {
+  InvalidArgumentError
+} from "@ai-sdk/provider";
 import {
   combineHeaders as combineHeaders4,
   convertBase64ToUint8Array,
@@ -2142,6 +2227,8 @@ var modelMaxImagesPerCall = {
   "gpt-image-1-mini": 10,
   "gpt-image-1.5": 10,
   "gpt-image-2": 10,
+  "gpt-image-2.6-flare": 10,
+  "gpt-image-2.6-sunburst": 10,
   "gpt-image-2.5-flare": 10,
   "gpt-image-2.5-flare-2026-09-08": 10,
   "gpt-image-2.5-sunburst": 10,
@@ -2177,6 +2264,11 @@ var baseImageModelOptionsObject = () => z9.object({
    * Format in which the generated image(s) are returned.
    */
   outputFormat: z9.enum(["png", "jpeg", "webp"]).optional(),
+  /**
+   * How much detail the model puts into the image. Supported by GPT Image
+   * 2.6 models. The API defaults to `high`.
+   */
+  complexity: z9.enum(["low", "medium", "high"]).optional(),
   /**
    * Compression level (0-100) for the generated image(s). Applies to the
    * `jpeg` and `webp` output formats.
@@ -2186,7 +2278,13 @@ var baseImageModelOptionsObject = () => z9.object({
    * A unique identifier representing your end-user, which can help OpenAI
    * to monitor and detect abuse.
    */
-  user: z9.string().optional()
+  user: z9.string().optional(),
+  /**
+   * A stable identifier used to help detect users of your application that
+   * may be violating OpenAI's usage policies. Should be a hashed username
+   * or email address.
+   */
+  safetyIdentifier: z9.string().max(128).optional()
 });
 var openaiImageModelOptions = lazySchema9(
   () => zodSchema9(baseImageModelOptionsObject())
@@ -2200,6 +2298,22 @@ var openaiImageModelGenerationOptions = lazySchema9(
        * looking images.
        */
       style: z9.enum(["vivid", "natural"]).optional(),
+      /**
+       * Format in which the generated image(s) are returned. `gif` produces
+       * an animated GIF and is supported by GPT Image 2.6 models.
+       */
+      outputFormat: z9.enum(["png", "jpeg", "webp", "gif"]).optional(),
+      /**
+       * Number of frames (2-64) of an animated GIF. Only applies to the `gif`
+       * output format. The API defaults to 9.
+       */
+      frameCount: z9.number().int().min(2).max(64).optional(),
+      /**
+       * Duration of each frame in milliseconds (20-2000) of an animated GIF.
+       * The API rounds it to the nearest 10 ms. Only applies to the `gif`
+       * output format. The API defaults to 200.
+       */
+      frameDurationMs: z9.number().int().min(20).max(2e3).optional(),
       /**
        * Content moderation level for the generated image(s). `low` applies
        * less restrictive filtering.
@@ -2214,7 +2328,14 @@ var openaiImageModelEditOptions = lazySchema9(
       /**
        * Fidelity of the output image(s) to the input image(s).
        */
-      inputFidelity: z9.enum(["high", "low"]).optional()
+      inputFidelity: z9.enum(["high", "low"]).optional(),
+      /**
+       * A transparent PNG overlaid on the first input image to mark up the
+       * regions to change, as an HTTPS URL or a base64 data URL. It must match
+       * the dimensions of the first image. Supported by GPT Image 2.5 and 2.6
+       * models. Cannot be combined with a `mask`.
+       */
+      markup: z9.string().optional()
     })
   )
 );
@@ -2263,6 +2384,12 @@ var OpenAIImageModel = class {
         providerOptions,
         schema: openaiImageModelEditOptions
       })) != null ? _d : {};
+      if (mask != null && openaiOptions2.markup != null) {
+        throw new InvalidArgumentError({
+          argument: "providerOptions.openai.markup",
+          message: "`markup` cannot be combined with `mask`."
+        });
+      }
       const { value: response2, responseHeaders: responseHeaders2 } = await postFormDataToApi({
         url: this.config.url({
           path: "/images/edits",
@@ -2287,14 +2414,17 @@ var OpenAIImageModel = class {
             )
           ),
           mask: mask != null ? await fileToBlob(mask) : void 0,
+          markup: openaiOptions2.markup != null ? await markupToBlob(openaiOptions2.markup) : void 0,
           n,
           size,
           quality: openaiOptions2.quality,
           background: openaiOptions2.background,
           output_format: openaiOptions2.outputFormat,
           output_compression: openaiOptions2.outputCompression,
+          complexity: openaiOptions2.complexity,
           input_fidelity: openaiOptions2.inputFidelity,
-          user: openaiOptions2.user
+          user: openaiOptions2.user,
+          safety_identifier: openaiOptions2.safetyIdentifier
         }),
         failedResponseHandler: openaiFailedResponseHandler,
         successfulResponseHandler: createJsonResponseHandler4(
@@ -2360,7 +2490,11 @@ var OpenAIImageModel = class {
         moderation: openaiOptions.moderation,
         output_format: openaiOptions.outputFormat,
         output_compression: openaiOptions.outputCompression,
+        complexity: openaiOptions.complexity,
+        frame_count: openaiOptions.frameCount,
+        frame_duration_ms: openaiOptions.frameDurationMs,
         user: openaiOptions.user,
+        safety_identifier: openaiOptions.safetyIdentifier,
         ...!hasDefaultResponseFormat(this.modelId) ? { response_format: "b64_json" } : {}
       },
       failedResponseHandler: openaiFailedResponseHandler,
@@ -2423,6 +2557,21 @@ function distributeTokenDetails(details, index, total) {
   }
   return result;
 }
+async function markupToBlob(markup) {
+  const dataUrl = /^data:([^;,]*)(;base64)?,(.*)$/s.exec(markup);
+  if (dataUrl == null) {
+    return downloadBlob(markup);
+  }
+  if (dataUrl[2] == null) {
+    throw new InvalidArgumentError({
+      argument: "providerOptions.openai.markup",
+      message: "`markup` data URLs must be base64 encoded."
+    });
+  }
+  return new Blob([convertBase64ToUint8Array(dataUrl[3])], {
+    type: dataUrl[1] || "image/png"
+  });
+}
 async function fileToBlob(file) {
   if (!file) return void 0;
   if (file.type === "url") {
@@ -4612,12 +4761,14 @@ var openaiResponsesReasoningProviderOptionsSchema = lazySchema19(
 // 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":
@@ -4727,6 +4878,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"
@@ -4783,6 +4936,20 @@ var openaiResponsesChunkSchema = lazySchema20(
           })
         ).nullish()
       }),
+      z20.object({
+        type: z20.literal("response.refusal.delta"),
+        item_id: z20.string(),
+        output_index: z20.number().nullish(),
+        content_index: z20.number().nullish(),
+        delta: z20.string()
+      }),
+      z20.object({
+        type: z20.literal("response.refusal.done"),
+        item_id: z20.string(),
+        output_index: z20.number().nullish(),
+        content_index: z20.number().nullish(),
+        refusal: z20.string()
+      }),
       z20.object({
         type: z20.enum(["response.completed", "response.incomplete"]),
         response: z20.object({
@@ -5308,53 +5475,60 @@ var openaiResponsesResponseSchema = lazySchema20(
             role: z20.literal("assistant"),
             id: z20.string(),
             phase: z20.enum(["commentary", "final_answer"]).nullish(),
+            // the API returns either text or a refusal as content parts:
             content: z20.array(
-              z20.object({
-                type: z20.literal("output_text"),
-                text: z20.string(),
-                logprobs: z20.array(
-                  z20.object({
-                    token: z20.string(),
-                    logprob: z20.number(),
-                    top_logprobs: z20.array(
-                      z20.object({
-                        token: z20.string(),
-                        logprob: z20.number()
-                      })
-                    )
-                  })
-                ).nullish(),
-                annotations: z20.array(
-                  z20.discriminatedUnion("type", [
-                    z20.object({
-                      type: z20.literal("url_citation"),
-                      start_index: z20.number(),
-                      end_index: z20.number(),
-                      url: z20.string(),
-                      title: z20.string()
-                    }),
-                    z20.object({
-                      type: z20.literal("file_citation"),
-                      file_id: z20.string(),
-                      filename: z20.string(),
-                      index: z20.number()
-                    }),
-                    z20.object({
-                      type: z20.literal("container_file_citation"),
-                      container_id: z20.string(),
-                      file_id: z20.string(),
-                      filename: z20.string(),
-                      start_index: z20.number(),
-                      end_index: z20.number()
-                    }),
+              z20.discriminatedUnion("type", [
+                z20.object({
+                  type: z20.literal("output_text"),
+                  text: z20.string(),
+                  logprobs: z20.array(
                     z20.object({
-                      type: z20.literal("file_path"),
-                      file_id: z20.string(),
-                      index: z20.number()
+                      token: z20.string(),
+                      logprob: z20.number(),
+                      top_logprobs: z20.array(
+                        z20.object({
+                          token: z20.string(),
+                          logprob: z20.number()
+                        })
+                      )
                     })
-                  ])
-                )
-              })
+                  ).nullish(),
+                  annotations: z20.array(
+                    z20.discriminatedUnion("type", [
+                      z20.object({
+                        type: z20.literal("url_citation"),
+                        start_index: z20.number(),
+                        end_index: z20.number(),
+                        url: z20.string(),
+                        title: z20.string()
+                      }),
+                      z20.object({
+                        type: z20.literal("file_citation"),
+                        file_id: z20.string(),
+                        filename: z20.string(),
+                        index: z20.number()
+                      }),
+                      z20.object({
+                        type: z20.literal("container_file_citation"),
+                        container_id: z20.string(),
+                        file_id: z20.string(),
+                        filename: z20.string(),
+                        start_index: z20.number(),
+                        end_index: z20.number()
+                      }),
+                      z20.object({
+                        type: z20.literal("file_path"),
+                        file_id: z20.string(),
+                        index: z20.number()
+                      })
+                    ])
+                  )
+                }),
+                z20.object({
+                  type: z20.literal("refusal"),
+                  refusal: z20.string()
+                })
+              ])
             )
           }),
           z20.object({
@@ -6784,6 +6958,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": {
@@ -6917,6 +7092,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);
             }
@@ -7216,7 +7405,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
       },
@@ -7287,6 +7477,7 @@ var OpenAIResponsesLanguageModel = class {
     const ongoingAnnotations = [];
     let activeMessagePhase;
     let hasFunctionCall = false;
+    let hasRefusal = false;
     const activeReasoning = {};
     let serviceTier;
     let reasoningContext;
@@ -8060,6 +8251,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];
@@ -8122,7 +8322,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
                 };
@@ -8276,6 +8477,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";