@ai-sdk/openai 3.0.0-beta.61 → 3.0.0-beta.63

package/dist/internal/index.d.mts

@@ -481,4 +481,87 @@ declare const imageGeneration: (args?: ImageGenerationArgs) => _ai_sdk_provider_
     result: string;
 }>;
 
-export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiSpeechProviderOptionsSchema };
+declare const webSearchPreviewArgsSchema: _ai_sdk_provider_utils.LazySchema<{
+    searchContextSize?: "low" | "medium" | "high" | undefined;
+    userLocation?: {
+        type: "approximate";
+        country?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        timezone?: string | undefined;
+    } | undefined;
+}>;
+declare const webSearchPreviewInputSchema: _ai_sdk_provider_utils.LazySchema<Record<string, never>>;
+declare const webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+    /**
+     * An object describing the specific action taken in this web search call.
+     * Includes details on how the model used the web (search, open_page, find).
+     */
+    action: {
+        /**
+         * Action type "search" - Performs a web search query.
+         */
+        type: "search";
+        /**
+         * The search query.
+         */
+        query?: string;
+    } | {
+        /**
+         * Action type "openPage" - Opens a specific URL from search results.
+         */
+        type: "openPage";
+        /**
+         * The URL opened by the model.
+         */
+        url: string;
+    } | {
+        /**
+         * Action type "find": Searches for a pattern within a loaded page.
+         */
+        type: "find";
+        /**
+         * The URL of the page searched for the pattern.
+         */
+        url: string;
+        /**
+         * The pattern or text to search for within the page.
+         */
+        pattern: string;
+    };
+}, {
+    /**
+     * Search context size to use for the web search.
+     * - high: Most comprehensive context, highest cost, slower response
+     * - medium: Balanced context, cost, and latency (default)
+     * - low: Least context, lowest cost, fastest response
+     */
+    searchContextSize?: "low" | "medium" | "high";
+    /**
+     * User location information to provide geographically relevant search results.
+     */
+    userLocation?: {
+        /**
+         * Type of location (always 'approximate')
+         */
+        type: "approximate";
+        /**
+         * Two-letter ISO country code (e.g., 'US', 'GB')
+         */
+        country?: string;
+        /**
+         * City name (free text, e.g., 'Minneapolis')
+         */
+        city?: string;
+        /**
+         * Region name (free text, e.g., 'Minnesota')
+         */
+        region?: string;
+        /**
+         * IANA timezone (e.g., 'America/Chicago')
+         */
+        timezone?: string;
+    };
+}>;
+
+export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiSpeechProviderOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };

package/dist/internal/index.d.ts

@@ -481,4 +481,87 @@ declare const imageGeneration: (args?: ImageGenerationArgs) => _ai_sdk_provider_
     result: string;
 }>;
 
-export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiSpeechProviderOptionsSchema };
+declare const webSearchPreviewArgsSchema: _ai_sdk_provider_utils.LazySchema<{
+    searchContextSize?: "low" | "medium" | "high" | undefined;
+    userLocation?: {
+        type: "approximate";
+        country?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        timezone?: string | undefined;
+    } | undefined;
+}>;
+declare const webSearchPreviewInputSchema: _ai_sdk_provider_utils.LazySchema<Record<string, never>>;
+declare const webSearchPreview: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{}, {
+    /**
+     * An object describing the specific action taken in this web search call.
+     * Includes details on how the model used the web (search, open_page, find).
+     */
+    action: {
+        /**
+         * Action type "search" - Performs a web search query.
+         */
+        type: "search";
+        /**
+         * The search query.
+         */
+        query?: string;
+    } | {
+        /**
+         * Action type "openPage" - Opens a specific URL from search results.
+         */
+        type: "openPage";
+        /**
+         * The URL opened by the model.
+         */
+        url: string;
+    } | {
+        /**
+         * Action type "find": Searches for a pattern within a loaded page.
+         */
+        type: "find";
+        /**
+         * The URL of the page searched for the pattern.
+         */
+        url: string;
+        /**
+         * The pattern or text to search for within the page.
+         */
+        pattern: string;
+    };
+}, {
+    /**
+     * Search context size to use for the web search.
+     * - high: Most comprehensive context, highest cost, slower response
+     * - medium: Balanced context, cost, and latency (default)
+     * - low: Least context, lowest cost, fastest response
+     */
+    searchContextSize?: "low" | "medium" | "high";
+    /**
+     * User location information to provide geographically relevant search results.
+     */
+    userLocation?: {
+        /**
+         * Type of location (always 'approximate')
+         */
+        type: "approximate";
+        /**
+         * Two-letter ISO country code (e.g., 'US', 'GB')
+         */
+        country?: string;
+        /**
+         * City name (free text, e.g., 'Minneapolis')
+         */
+        city?: string;
+        /**
+         * Region name (free text, e.g., 'Minnesota')
+         */
+        region?: string;
+        /**
+         * IANA timezone (e.g., 'America/Chicago')
+         */
+        timezone?: string;
+    };
+}>;
+
+export { OpenAIChatLanguageModel, type OpenAIChatLanguageModelOptions, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, OpenAIResponsesLanguageModel, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiChatLanguageModelOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiSpeechProviderOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };

package/dist/internal/index.js

@@ -44,7 +44,10 @@ __export(internal_exports, {
   openaiChatLanguageModelOptions: () => openaiChatLanguageModelOptions,
   openaiCompletionProviderOptions: () => openaiCompletionProviderOptions,
   openaiEmbeddingProviderOptions: () => openaiEmbeddingProviderOptions,
-  openaiSpeechProviderOptionsSchema: () => openaiSpeechProviderOptionsSchema
+  openaiSpeechProviderOptionsSchema: () => openaiSpeechProviderOptionsSchema,
+  webSearchPreview: () => webSearchPreview,
+  webSearchPreviewArgsSchema: () => webSearchPreviewArgsSchema,
+  webSearchPreviewInputSchema: () => webSearchPreviewInputSchema
 });
 module.exports = __toCommonJS(internal_exports);
 
@@ -2759,6 +2762,8 @@ var openaiResponsesChunkSchema = (0, import_provider_utils21.lazySchema)(
         annotation: import_v414.z.discriminatedUnion("type", [
           import_v414.z.object({
             type: import_v414.z.literal("url_citation"),
+            start_index: import_v414.z.number(),
+            end_index: import_v414.z.number(),
             url: import_v414.z.string(),
             title: import_v414.z.string()
           }),
@@ -4304,6 +4309,7 @@ var OpenAIResponsesLanguageModel = class {
     const logprobs = [];
     let responseId = null;
     const ongoingToolCalls = {};
+    const ongoingAnnotations = [];
     let hasFunctionCall = false;
     const activeReasoning = {};
     let serviceTier;
@@ -4353,7 +4359,7 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "tool-call",
                   toolCallId: value.item.id,
-                  toolName: "web_search",
+                  toolName: webSearchToolName != null ? webSearchToolName : "web_search",
                   input: JSON.stringify({}),
                   providerExecuted: true
                 });
@@ -4412,6 +4418,7 @@ var OpenAIResponsesLanguageModel = class {
                   providerExecuted: true
                 });
               } else if (value.item.type === "message") {
+                ongoingAnnotations.splice(0, ongoingAnnotations.length);
                 controller.enqueue({
                   type: "text-start",
                   id: value.item.id,
@@ -4437,7 +4444,7 @@ var OpenAIResponsesLanguageModel = class {
                   }
                 });
               }
-            } else if (isResponseOutputItemDoneChunk(value)) {
+            } else if (isResponseOutputItemDoneChunk(value) && value.item.type !== "message") {
               if (value.item.type === "function_call") {
                 ongoingToolCalls[value.output_index] = void 0;
                 hasFunctionCall = true;
@@ -4461,7 +4468,7 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "tool-result",
                   toolCallId: value.item.id,
-                  toolName: "web_search",
+                  toolName: webSearchToolName != null ? webSearchToolName : "web_search",
                   result: mapWebSearchOutput(value.item.action)
                 });
               } else if (value.item.type === "computer_call") {
@@ -4592,11 +4599,6 @@ var OpenAIResponsesLanguageModel = class {
                     openai: { itemId: value.item.id }
                   }
                 });
-              } else if (value.item.type === "message") {
-                controller.enqueue({
-                  type: "text-end",
-                  id: value.item.id
-                });
               } else if (value.item.type === "reasoning") {
                 const activeReasoningPart = activeReasoning[value.item.id];
                 const summaryPartIndices = Object.entries(
@@ -4753,6 +4755,7 @@ var OpenAIResponsesLanguageModel = class {
                 serviceTier = value.response.service_tier;
               }
             } else if (isResponseAnnotationAddedChunk(value)) {
+              ongoingAnnotations.push(value.annotation);
               if (value.annotation.type === "url_citation") {
                 controller.enqueue({
                   type: "source",
@@ -4809,6 +4812,19 @@ var OpenAIResponsesLanguageModel = class {
                   }
                 });
               }
+            } else if (isResponseOutputItemDoneChunk(value) && value.item.type === "message") {
+              controller.enqueue({
+                type: "text-end",
+                id: value.item.id,
+                providerMetadata: {
+                  openai: {
+                    itemId: value.item.id,
+                    ...ongoingAnnotations.length > 0 && {
+                      annotations: ongoingAnnotations
+                    }
+                  }
+                }
+              });
             } else if (isErrorChunk(value)) {
               controller.enqueue({ type: "error", error: value });
             }
@@ -4927,6 +4943,9 @@ function mapWebSearchOutput(action) {
   openaiChatLanguageModelOptions,
   openaiCompletionProviderOptions,
   openaiEmbeddingProviderOptions,
-  openaiSpeechProviderOptionsSchema
+  openaiSpeechProviderOptionsSchema,
+  webSearchPreview,
+  webSearchPreviewArgsSchema,
+  webSearchPreviewInputSchema
 });
 //# sourceMappingURL=index.js.map