@ai-sdk/openai 2.0.13 → 2.0.15

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @ai-sdk/openai
 
+## 2.0.15
+
+### Patch Changes
+
+- a4bef93: feat(provider/openai): expose web search queries in responses api
+- 6ed34cb: refactor(openai): consolidate model config into `getResponsesModelConfig()`
+
+  https://github.com/vercel/ai/pull/8038
+
+## 2.0.14
+
+### Patch Changes
+
+- 7f47105: fix(provider/openai): support file_citation annotations in responses api
+
 ## 2.0.13
 
 ### Patch Changes

package/dist/index.js

@@ -2287,7 +2287,7 @@ var OpenAIResponsesLanguageModel = class {
         });
       }
     }
-    if ((openaiOptions == null ? void 0 : openaiOptions.serviceTier) === "flex" && !supportsFlexProcessing2(this.modelId)) {
+    if ((openaiOptions == null ? void 0 : openaiOptions.serviceTier) === "flex" && !modelConfig.supportsFlexProcessing) {
       warnings.push({
         type: "unsupported-setting",
         setting: "serviceTier",
@@ -2295,7 +2295,7 @@ var OpenAIResponsesLanguageModel = class {
       });
       delete baseArgs.service_tier;
     }
-    if ((openaiOptions == null ? void 0 : openaiOptions.serviceTier) === "priority" && !supportsPriorityProcessing2(this.modelId)) {
+    if ((openaiOptions == null ? void 0 : openaiOptions.serviceTier) === "priority" && !modelConfig.supportsPriorityProcessing) {
       warnings.push({
         type: "unsupported-setting",
         setting: "serviceTier",
@@ -2322,7 +2322,7 @@ var OpenAIResponsesLanguageModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q;
     const { args: body, warnings } = await this.getArgs(options);
     const url = this.config.url({
       path: "/responses",
@@ -2358,13 +2358,22 @@ var OpenAIResponsesLanguageModel = class {
                     text: import_v413.z.string(),
                     logprobs: LOGPROBS_SCHEMA.nullish(),
                     annotations: import_v413.z.array(
-                      import_v413.z.object({
-                        type: import_v413.z.literal("url_citation"),
-                        start_index: import_v413.z.number(),
-                        end_index: import_v413.z.number(),
-                        url: import_v413.z.string(),
-                        title: import_v413.z.string()
-                      })
+                      import_v413.z.discriminatedUnion("type", [
+                        import_v413.z.object({
+                          type: import_v413.z.literal("url_citation"),
+                          start_index: import_v413.z.number(),
+                          end_index: import_v413.z.number(),
+                          url: import_v413.z.string(),
+                          title: import_v413.z.string()
+                        }),
+                        import_v413.z.object({
+                          type: import_v413.z.literal("file_citation"),
+                          start_index: import_v413.z.number(),
+                          end_index: import_v413.z.number(),
+                          file_id: import_v413.z.string(),
+                          quote: import_v413.z.string()
+                        })
+                      ])
                     )
                   })
                 )
@@ -2379,7 +2388,11 @@ var OpenAIResponsesLanguageModel = class {
               import_v413.z.object({
                 type: import_v413.z.literal("web_search_call"),
                 id: import_v413.z.string(),
-                status: import_v413.z.string().optional()
+                status: import_v413.z.string().optional(),
+                action: import_v413.z.object({
+                  type: import_v413.z.literal("search"),
+                  query: import_v413.z.string().optional()
+                }).nullish()
               }),
               import_v413.z.object({
                 type: import_v413.z.literal("computer_call"),
@@ -2470,13 +2483,24 @@ var OpenAIResponsesLanguageModel = class {
               }
             });
             for (const annotation of contentPart.annotations) {
-              content.push({
-                type: "source",
-                sourceType: "url",
-                id: (_f = (_e = (_d = this.config).generateId) == null ? void 0 : _e.call(_d)) != null ? _f : (0, import_provider_utils12.generateId)(),
-                url: annotation.url,
-                title: annotation.title
-              });
+              if (annotation.type === "url_citation") {
+                content.push({
+                  type: "source",
+                  sourceType: "url",
+                  id: (_f = (_e = (_d = this.config).generateId) == null ? void 0 : _e.call(_d)) != null ? _f : (0, import_provider_utils12.generateId)(),
+                  url: annotation.url,
+                  title: annotation.title
+                });
+              } else if (annotation.type === "file_citation") {
+                content.push({
+                  type: "source",
+                  sourceType: "document",
+                  id: (_i = (_h = (_g = this.config).generateId) == null ? void 0 : _h.call(_g)) != null ? _i : (0, import_provider_utils12.generateId)(),
+                  mediaType: "text/plain",
+                  title: annotation.quote,
+                  filename: annotation.file_id
+                });
+              }
             }
           }
           break;
@@ -2500,14 +2524,17 @@ var OpenAIResponsesLanguageModel = class {
             type: "tool-call",
             toolCallId: part.id,
             toolName: "web_search_preview",
-            input: "",
+            input: (_k = (_j = part.action) == null ? void 0 : _j.query) != null ? _k : "",
             providerExecuted: true
           });
           content.push({
             type: "tool-result",
             toolCallId: part.id,
             toolName: "web_search_preview",
-            result: { status: part.status || "completed" },
+            result: {
+              status: part.status || "completed",
+              ...((_l = part.action) == null ? void 0 : _l.query) && { query: part.action.query }
+            },
             providerExecuted: true
           });
           break;
@@ -2565,15 +2592,15 @@ var OpenAIResponsesLanguageModel = class {
     return {
       content,
       finishReason: mapOpenAIResponseFinishReason({
-        finishReason: (_g = response.incomplete_details) == null ? void 0 : _g.reason,
+        finishReason: (_m = response.incomplete_details) == null ? void 0 : _m.reason,
         hasToolCalls: content.some((part) => part.type === "tool-call")
       }),
       usage: {
         inputTokens: response.usage.input_tokens,
         outputTokens: response.usage.output_tokens,
         totalTokens: response.usage.input_tokens + response.usage.output_tokens,
-        reasoningTokens: (_i = (_h = response.usage.output_tokens_details) == null ? void 0 : _h.reasoning_tokens) != null ? _i : void 0,
-        cachedInputTokens: (_k = (_j = response.usage.input_tokens_details) == null ? void 0 : _j.cached_tokens) != null ? _k : void 0
+        reasoningTokens: (_o = (_n = response.usage.output_tokens_details) == null ? void 0 : _n.reasoning_tokens) != null ? _o : void 0,
+        cachedInputTokens: (_q = (_p = response.usage.input_tokens_details) == null ? void 0 : _p.cached_tokens) != null ? _q : void 0
       },
       request: { body },
       response: {
@@ -2625,7 +2652,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;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -2732,7 +2759,7 @@ var OpenAIResponsesLanguageModel = class {
                   type: "tool-call",
                   toolCallId: value.item.id,
                   toolName: "web_search_preview",
-                  input: "",
+                  input: (_c = (_b = value.item.action) == null ? void 0 : _b.query) != null ? _c : "",
                   providerExecuted: true
                 });
                 controller.enqueue({
@@ -2741,7 +2768,10 @@ var OpenAIResponsesLanguageModel = class {
                   toolName: "web_search_preview",
                   result: {
                     type: "web_search_tool_result",
-                    status: value.item.status || "completed"
+                    status: value.item.status || "completed",
+                    ...((_d = value.item.action) == null ? void 0 : _d.query) && {
+                      query: value.item.action.query
+                    }
                   },
                   providerExecuted: true
                 });
@@ -2809,7 +2839,7 @@ var OpenAIResponsesLanguageModel = class {
                     providerMetadata: {
                       openai: {
                         itemId: value.item.id,
-                        reasoningEncryptedContent: (_b = value.item.encrypted_content) != null ? _b : null
+                        reasoningEncryptedContent: (_e = value.item.encrypted_content) != null ? _e : null
                       }
                     }
                   });
@@ -2844,7 +2874,7 @@ var OpenAIResponsesLanguageModel = class {
               }
             } else if (isResponseReasoningSummaryPartAddedChunk(value)) {
               if (value.summary_index > 0) {
-                (_c = activeReasoning[value.item_id]) == null ? void 0 : _c.summaryParts.push(
+                (_f = activeReasoning[value.item_id]) == null ? void 0 : _f.summaryParts.push(
                   value.summary_index
                 );
                 controller.enqueue({
@@ -2853,7 +2883,7 @@ var OpenAIResponsesLanguageModel = class {
                   providerMetadata: {
                     openai: {
                       itemId: value.item_id,
-                      reasoningEncryptedContent: (_e = (_d = activeReasoning[value.item_id]) == null ? void 0 : _d.encryptedContent) != null ? _e : null
+                      reasoningEncryptedContent: (_h = (_g = activeReasoning[value.item_id]) == null ? void 0 : _g.encryptedContent) != null ? _h : null
                     }
                   }
                 });
@@ -2871,22 +2901,33 @@ var OpenAIResponsesLanguageModel = class {
               });
             } else if (isResponseFinishedChunk(value)) {
               finishReason = mapOpenAIResponseFinishReason({
-                finishReason: (_f = value.response.incomplete_details) == null ? void 0 : _f.reason,
+                finishReason: (_i = value.response.incomplete_details) == null ? void 0 : _i.reason,
                 hasToolCalls
               });
               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 = (_h = (_g = value.response.usage.output_tokens_details) == null ? void 0 : _g.reasoning_tokens) != null ? _h : void 0;
-              usage.cachedInputTokens = (_j = (_i = value.response.usage.input_tokens_details) == null ? void 0 : _i.cached_tokens) != null ? _j : void 0;
+              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;
             } else if (isResponseAnnotationAddedChunk(value)) {
-              controller.enqueue({
-                type: "source",
-                sourceType: "url",
-                id: (_m = (_l = (_k = self.config).generateId) == null ? void 0 : _l.call(_k)) != null ? _m : (0, import_provider_utils12.generateId)(),
-                url: value.annotation.url,
-                title: value.annotation.title
-              });
+              if (value.annotation.type === "url_citation") {
+                controller.enqueue({
+                  type: "source",
+                  sourceType: "url",
+                  id: (_p = (_o = (_n = self.config).generateId) == null ? void 0 : _o.call(_n)) != null ? _p : (0, import_provider_utils12.generateId)(),
+                  url: value.annotation.url,
+                  title: value.annotation.title
+                });
+              } else if (value.annotation.type === "file_citation") {
+                controller.enqueue({
+                  type: "source",
+                  sourceType: "document",
+                  id: (_s = (_r = (_q = self.config).generateId) == null ? void 0 : _r.call(_q)) != null ? _s : (0, import_provider_utils12.generateId)(),
+                  mediaType: "text/plain",
+                  title: value.annotation.quote,
+                  filename: value.annotation.file_id
+                });
+              }
             } else if (isErrorChunk(value)) {
               controller.enqueue({ type: "error", error: value });
             }
@@ -2971,7 +3012,11 @@ var responseOutputItemAddedSchema = import_v413.z.object({
     import_v413.z.object({
       type: import_v413.z.literal("web_search_call"),
       id: import_v413.z.string(),
-      status: import_v413.z.string()
+      status: import_v413.z.string(),
+      action: import_v413.z.object({
+        type: import_v413.z.literal("search"),
+        query: import_v413.z.string().optional()
+      }).nullish()
     }),
     import_v413.z.object({
       type: import_v413.z.literal("computer_call"),
@@ -3020,7 +3065,11 @@ var responseOutputItemDoneSchema = import_v413.z.object({
     import_v413.z.object({
       type: import_v413.z.literal("web_search_call"),
       id: import_v413.z.string(),
-      status: import_v413.z.literal("completed")
+      status: import_v413.z.literal("completed"),
+      action: import_v413.z.object({
+        type: import_v413.z.literal("search"),
+        query: import_v413.z.string().optional()
+      }).nullish()
     }),
     import_v413.z.object({
       type: import_v413.z.literal("computer_call"),
@@ -3053,11 +3102,18 @@ var responseFunctionCallArgumentsDeltaSchema = import_v413.z.object({
 });
 var responseAnnotationAddedSchema = import_v413.z.object({
   type: import_v413.z.literal("response.output_text.annotation.added"),
-  annotation: import_v413.z.object({
-    type: import_v413.z.literal("url_citation"),
-    url: import_v413.z.string(),
-    title: import_v413.z.string()
-  })
+  annotation: import_v413.z.discriminatedUnion("type", [
+    import_v413.z.object({
+      type: import_v413.z.literal("url_citation"),
+      url: import_v413.z.string(),
+      title: import_v413.z.string()
+    }),
+    import_v413.z.object({
+      type: import_v413.z.literal("file_citation"),
+      file_id: import_v413.z.string(),
+      quote: import_v413.z.string()
+    })
+  ])
 });
 var responseReasoningSummaryPartAddedSchema = import_v413.z.object({
   type: import_v413.z.literal("response.reasoning_summary_part.added"),
@@ -3121,39 +3177,39 @@ function isErrorChunk(chunk) {
   return chunk.type === "error";
 }
 function getResponsesModelConfig(modelId) {
+  const supportsFlexProcessing2 = modelId.startsWith("o3") || modelId.startsWith("o4-mini") || modelId.startsWith("gpt-5") && !modelId.startsWith("gpt-5-chat");
+  const supportsPriorityProcessing2 = 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");
+  const defaults = {
+    requiredAutoTruncation: false,
+    systemMessageMode: "system",
+    supportsFlexProcessing: supportsFlexProcessing2,
+    supportsPriorityProcessing: supportsPriorityProcessing2
+  };
   if (modelId.startsWith("gpt-5-chat")) {
     return {
-      isReasoningModel: false,
-      systemMessageMode: "system",
-      requiredAutoTruncation: false
+      ...defaults,
+      isReasoningModel: 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 {
+        ...defaults,
         isReasoningModel: true,
-        systemMessageMode: "remove",
-        requiredAutoTruncation: false
+        systemMessageMode: "remove"
       };
     }
     return {
+      ...defaults,
       isReasoningModel: true,
-      systemMessageMode: "developer",
-      requiredAutoTruncation: false
+      systemMessageMode: "developer"
     };
   }
   return {
-    isReasoningModel: false,
-    systemMessageMode: "system",
-    requiredAutoTruncation: false
+    ...defaults,
+    isReasoningModel: false
   };
 }
-function supportsFlexProcessing2(modelId) {
-  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("gpt-5-chat") || modelId.startsWith("o3") || modelId.startsWith("o4-mini");
-}
 var openaiResponsesProviderOptionsSchema = import_v413.z.object({
   metadata: import_v413.z.any().nullish(),
   parallelToolCalls: import_v413.z.boolean().nullish(),