@ai-sdk/openai 2.0.10 → 2.0.12

package/dist/index.mjs

@@ -322,7 +322,20 @@ var openaiProviderOptions = z2.object({
    * Controls the verbosity of the model's responses.
    * Lower values will result in more concise responses, while higher values will result in more verbose responses.
    */
-  textVerbosity: z2.enum(["low", "medium", "high"]).optional()
+  textVerbosity: z2.enum(["low", "medium", "high"]).optional(),
+  /**
+   * A cache key for prompt caching. Allows manual control over prompt caching behavior.
+   * Useful for improving cache hit rates and working around automatic caching issues.
+   */
+  promptCacheKey: z2.string().optional(),
+  /**
+   * A stable identifier used to help detect users of your application
+   * that may be violating OpenAI's usage policies. The IDs should be a
+   * string that uniquely identifies each user. We recommend hashing their
+   * username or email address, in order to avoid sending us any identifying
+   * information.
+   */
+  safetyIdentifier: z2.string().optional()
 });
 
 // src/chat/openai-chat-prepare-tools.ts
@@ -595,6 +608,8 @@ var OpenAIChatLanguageModel = class {
       prediction: openaiOptions.prediction,
       reasoning_effort: openaiOptions.reasoningEffort,
       service_tier: openaiOptions.serviceTier,
+      prompt_cache_key: openaiOptions.promptCacheKey,
+      safety_identifier: openaiOptions.safetyIdentifier,
       // messages:
       messages
     };
@@ -1110,13 +1125,13 @@ var openaiChatChunkSchema = z5.union([
   openaiErrorDataSchema
 ]);
 function isReasoningModel(modelId) {
-  return modelId.startsWith("o") || modelId.startsWith("gpt-5");
+  return (modelId.startsWith("o") || modelId.startsWith("gpt-5")) && !modelId.startsWith("gpt-5-chat");
 }
 function supportsFlexProcessing(modelId) {
-  return modelId.startsWith("o3") || modelId.startsWith("o4-mini") || modelId.startsWith("gpt-5");
+  return modelId.startsWith("o3") || modelId.startsWith("o4-mini") || modelId.startsWith("gpt-5") && !modelId.startsWith("gpt-5-chat");
 }
 function supportsPriorityProcessing(modelId) {
-  return modelId.startsWith("gpt-4") || modelId.startsWith("gpt-5-mini") || modelId.startsWith("gpt-5") && !modelId.startsWith("gpt-5-nano") || modelId.startsWith("o3") || modelId.startsWith("o4-mini");
+  return modelId.startsWith("gpt-4") || modelId.startsWith("gpt-5-mini") || modelId.startsWith("gpt-5") && !modelId.startsWith("gpt-5-nano") && !modelId.startsWith("gpt-5-chat") || modelId.startsWith("o3") || modelId.startsWith("o4-mini");
 }
 function getSystemMessageMode(modelId) {
   var _a, _b;
@@ -1832,9 +1847,14 @@ import {
 import { parseProviderOptions as parseProviderOptions4 } from "@ai-sdk/provider-utils";
 import { z as z12 } from "zod/v4";
 import { convertToBase64 as convertToBase642 } from "@ai-sdk/provider-utils";
+function isFileId(data, prefixes) {
+  if (!prefixes) return false;
+  return prefixes.some((prefix) => data.startsWith(prefix));
+}
 async function convertToOpenAIResponsesMessages({
   prompt,
-  systemMessageMode
+  systemMessageMode,
+  fileIdPrefixes
 }) {
   var _a, _b, _c, _d, _e, _f;
   const messages = [];
@@ -1881,7 +1901,7 @@ async function convertToOpenAIResponsesMessages({
                   const mediaType = part.mediaType === "image/*" ? "image/jpeg" : part.mediaType;
                   return {
                     type: "input_image",
-                    ...part.data instanceof URL ? { image_url: part.data.toString() } : typeof part.data === "string" && part.data.startsWith("file-") ? { file_id: part.data } : {
+                    ...part.data instanceof URL ? { image_url: part.data.toString() } : typeof part.data === "string" && isFileId(part.data, fileIdPrefixes) ? { file_id: part.data } : {
                       image_url: `data:${mediaType};base64,${convertToBase642(part.data)}`
                     },
                     detail: (_b2 = (_a2 = part.providerOptions) == null ? void 0 : _a2.openai) == null ? void 0 : _b2.imageDetail
@@ -1894,7 +1914,7 @@ async function convertToOpenAIResponsesMessages({
                   }
                   return {
                     type: "input_file",
-                    ...typeof part.data === "string" && part.data.startsWith("file-") ? { file_id: part.data } : {
+                    ...typeof part.data === "string" && isFileId(part.data, fileIdPrefixes) ? { file_id: part.data } : {
                       filename: (_c2 = part.filename) != null ? _c2 : `part-${index}.pdf`,
                       file_data: `data:application/pdf;base64,${convertToBase642(part.data)}`
                     }
@@ -2183,7 +2203,8 @@ var OpenAIResponsesLanguageModel = class {
     }
     const { messages, warnings: messageWarnings } = await convertToOpenAIResponsesMessages({
       prompt,
-      systemMessageMode: modelConfig.systemMessageMode
+      systemMessageMode: modelConfig.systemMessageMode,
+      fileIdPrefixes: this.config.fileIdPrefixes
     });
     warnings.push(...messageWarnings);
     const openaiOptions = await parseProviderOptions5({
@@ -2223,6 +2244,8 @@ var OpenAIResponsesLanguageModel = class {
       instructions: openaiOptions == null ? void 0 : openaiOptions.instructions,
       service_tier: openaiOptions == null ? void 0 : openaiOptions.serviceTier,
       include: openaiOptions == null ? void 0 : openaiOptions.include,
+      prompt_cache_key: openaiOptions == null ? void 0 : openaiOptions.promptCacheKey,
+      safety_identifier: openaiOptions == null ? void 0 : openaiOptions.safetyIdentifier,
       // model-specific settings:
       ...modelConfig.isReasoningModel && ((openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningSummary) != null) && {
         reasoning: {
@@ -2372,7 +2395,18 @@ var OpenAIResponsesLanguageModel = class {
               z13.object({
                 type: z13.literal("file_search_call"),
                 id: z13.string(),
-                status: z13.string().optional()
+                status: z13.string().optional(),
+                queries: z13.array(z13.string()).nullish(),
+                results: z13.array(
+                  z13.object({
+                    attributes: z13.object({
+                      file_id: z13.string(),
+                      filename: z13.string(),
+                      score: z13.number(),
+                      text: z13.string()
+                    })
+                  })
+                ).nullish()
               }),
               z13.object({
                 type: z13.literal("reasoning"),
@@ -2514,7 +2548,9 @@ var OpenAIResponsesLanguageModel = class {
             toolName: "file_search",
             result: {
               type: "file_search_tool_result",
-              status: part.status || "completed"
+              status: part.status || "completed",
+              ...part.queries && { queries: part.queries },
+              ...part.results && { results: part.results }
             },
             providerExecuted: true
           });
@@ -2629,6 +2665,16 @@ var OpenAIResponsesLanguageModel = class {
                   id: value.item.id,
                   toolName: "computer_use"
                 });
+              } else if (value.item.type === "file_search_call") {
+                ongoingToolCalls[value.output_index] = {
+                  toolName: "file_search",
+                  toolCallId: value.item.id
+                };
+                controller.enqueue({
+                  type: "tool-input-start",
+                  id: value.item.id,
+                  toolName: "file_search"
+                });
               } else if (value.item.type === "message") {
                 controller.enqueue({
                   type: "text-start",
@@ -2722,6 +2768,32 @@ var OpenAIResponsesLanguageModel = class {
                   },
                   providerExecuted: true
                 });
+              } else if (value.item.type === "file_search_call") {
+                ongoingToolCalls[value.output_index] = void 0;
+                hasToolCalls = true;
+                controller.enqueue({
+                  type: "tool-input-end",
+                  id: value.item.id
+                });
+                controller.enqueue({
+                  type: "tool-call",
+                  toolCallId: value.item.id,
+                  toolName: "file_search",
+                  input: "",
+                  providerExecuted: true
+                });
+                controller.enqueue({
+                  type: "tool-result",
+                  toolCallId: value.item.id,
+                  toolName: "file_search",
+                  result: {
+                    type: "file_search_tool_result",
+                    status: value.item.status || "completed",
+                    ...value.item.queries && { queries: value.item.queries },
+                    ...value.item.results && { results: value.item.results }
+                  },
+                  providerExecuted: true
+                });
               } else if (value.item.type === "message") {
                 controller.enqueue({
                   type: "text-end",
@@ -2900,7 +2972,18 @@ var responseOutputItemAddedSchema = z13.object({
     z13.object({
       type: z13.literal("file_search_call"),
       id: z13.string(),
-      status: z13.string()
+      status: z13.string(),
+      queries: z13.array(z13.string()).nullish(),
+      results: z13.array(
+        z13.object({
+          attributes: z13.object({
+            file_id: z13.string(),
+            filename: z13.string(),
+            score: z13.number(),
+            text: z13.string()
+          })
+        })
+      ).optional()
     })
   ])
 });
@@ -2938,7 +3021,18 @@ var responseOutputItemDoneSchema = z13.object({
     z13.object({
       type: z13.literal("file_search_call"),
       id: z13.string(),
-      status: z13.literal("completed")
+      status: z13.literal("completed"),
+      queries: z13.array(z13.string()).nullish(),
+      results: z13.array(
+        z13.object({
+          attributes: z13.object({
+            file_id: z13.string(),
+            filename: z13.string(),
+            score: z13.number(),
+            text: z13.string()
+          })
+        })
+      ).nullish()
     })
   ])
 });
@@ -3018,6 +3112,13 @@ function isErrorChunk(chunk) {
   return chunk.type === "error";
 }
 function getResponsesModelConfig(modelId) {
+  if (modelId.startsWith("gpt-5-chat")) {
+    return {
+      isReasoningModel: false,
+      systemMessageMode: "system",
+      requiredAutoTruncation: false
+    };
+  }
   if (modelId.startsWith("o") || modelId.startsWith("gpt-5") || modelId.startsWith("codex-") || modelId.startsWith("computer-use")) {
     if (modelId.startsWith("o1-mini") || modelId.startsWith("o1-preview")) {
       return {
@@ -3039,10 +3140,10 @@ function getResponsesModelConfig(modelId) {
   };
 }
 function supportsFlexProcessing2(modelId) {
-  return modelId.startsWith("o3") || modelId.startsWith("o4-mini") || modelId.startsWith("gpt-5");
+  return modelId.startsWith("o3") || modelId.startsWith("o4-mini") || modelId.startsWith("gpt-5") && !modelId.startsWith("gpt-5-chat");
 }
 function supportsPriorityProcessing2(modelId) {
-  return modelId.startsWith("gpt-4") || modelId.startsWith("gpt-5-mini") || modelId.startsWith("gpt-5") && !modelId.startsWith("gpt-5-nano") || modelId.startsWith("o3") || modelId.startsWith("o4-mini");
+  return modelId.startsWith("gpt-4") || modelId.startsWith("gpt-5-mini") || modelId.startsWith("gpt-5") && !modelId.startsWith("gpt-5-nano") && !modelId.startsWith("gpt-5-chat") || modelId.startsWith("o3") || modelId.startsWith("o4-mini");
 }
 var openaiResponsesProviderOptionsSchema = z13.object({
   metadata: z13.any().nullish(),
@@ -3056,7 +3157,9 @@ var openaiResponsesProviderOptionsSchema = z13.object({
   reasoningSummary: z13.string().nullish(),
   serviceTier: z13.enum(["auto", "flex", "priority"]).nullish(),
   include: z13.array(z13.enum(["reasoning.encrypted_content", "file_search_call.results"])).nullish(),
-  textVerbosity: z13.enum(["low", "medium", "high"]).nullish()
+  textVerbosity: z13.enum(["low", "medium", "high"]).nullish(),
+  promptCacheKey: z13.string().nullish(),
+  safetyIdentifier: z13.string().nullish()
 });
 
 // src/speech/openai-speech-model.ts
@@ -3297,6 +3400,8 @@ var OpenAITranscriptionModel = class {
         include: openAIOptions.include,
         language: openAIOptions.language,
         prompt: openAIOptions.prompt,
+        response_format: "verbose_json",
+        // always use verbose_json to get segments
         temperature: openAIOptions.temperature,
         timestamp_granularities: openAIOptions.timestampGranularities
       };
@@ -3312,7 +3417,7 @@ var OpenAITranscriptionModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g, _h;
     const currentDate = (_c = (_b = (_a = this.config._internal) == null ? void 0 : _a.currentDate) == null ? void 0 : _b.call(_a)) != null ? _c : /* @__PURE__ */ new Date();
     const { formData, warnings } = await this.getArgs(options);
     const {
@@ -3336,13 +3441,17 @@ var OpenAITranscriptionModel = class {
     const language = response.language != null && response.language in languageMap ? languageMap[response.language] : void 0;
     return {
       text: response.text,
-      segments: (_e = (_d = response.words) == null ? void 0 : _d.map((word) => ({
+      segments: (_g = (_f = (_d = response.segments) == null ? void 0 : _d.map((segment) => ({
+        text: segment.text,
+        startSecond: segment.start,
+        endSecond: segment.end
+      }))) != null ? _f : (_e = response.words) == null ? void 0 : _e.map((word) => ({
         text: word.word,
         startSecond: word.start,
         endSecond: word.end
-      }))) != null ? _e : [],
+      }))) != null ? _g : [],
       language,
-      durationInSeconds: (_f = response.duration) != null ? _f : void 0,
+      durationInSeconds: (_h = response.duration) != null ? _h : void 0,
       warnings,
       response: {
         timestamp: currentDate,
@@ -3363,6 +3472,20 @@ var openaiTranscriptionResponseSchema = z16.object({
       start: z16.number(),
       end: z16.number()
     })
+  ).nullish(),
+  segments: z16.array(
+    z16.object({
+      id: z16.number(),
+      seek: z16.number(),
+      start: z16.number(),
+      end: z16.number(),
+      text: z16.string(),
+      tokens: z16.array(z16.number()),
+      temperature: z16.number(),
+      avg_logprob: z16.number(),
+      compression_ratio: z16.number(),
+      no_speech_prob: z16.number()
+    })
   ).nullish()
 });
 
@@ -3430,7 +3553,8 @@ function createOpenAI(options = {}) {
       provider: `${providerName}.responses`,
       url: ({ path }) => `${baseURL}${path}`,
       headers: getHeaders,
-      fetch: options.fetch
+      fetch: options.fetch,
+      fileIdPrefixes: ["file-"]
     });
   };
   const provider = function(modelId) {