@ai-sdk/google 3.0.67 → 3.0.68

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/google
 
+## 3.0.68
+
+### Patch Changes
+
+- e0f8c9e: feat(provider/google): add support for the Gemini Interactions API
+
 ## 3.0.67
 
 ### Patch Changes

package/dist/index.d.mts

@@ -254,6 +254,87 @@ type GoogleVideoModelOptions = {
     [key: string]: unknown;
 };
 
+/**
+ * Type-only union of Gemini model IDs that the Interactions API accepts via
+ * `model:`. Mirrors `Model` from `googleapis/js-genai`
+ * `src/interactions/resources/interactions.ts`.
+ *
+ * Kept as a separate type from `GoogleModelId` even though most IDs overlap;
+ * the two surfaces (`:generateContent` vs `/interactions`) are independent and
+ * may diverge over time.
+ */
+type GoogleInteractionsModelId = 'gemini-2.5-computer-use-preview-10-2025' | 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | 'gemini-3.1-flash-image-preview' | 'gemini-3.1-flash-lite-preview' | 'gemini-3.1-flash-tts-preview' | 'lyria-3-clip-preview' | 'lyria-3-pro-preview' | (string & {});
+/**
+ * Provider-options schema for `google.interactions(...)` calls. Read from the
+ * shared `providerOptions.google.*` namespace (per PRD); per-call options that
+ * the AI SDK doesn't natively expose live here.
+ *
+ * All fields are `.nullish()` per the existing google provider convention.
+ */
+declare const googleInteractionsLanguageModelOptions: _ai_sdk_provider_utils.LazySchema<{
+    previousInteractionId?: string | null | undefined;
+    store?: boolean | null | undefined;
+    agent?: string | null | undefined;
+    agentConfig?: {
+        [x: string]: unknown;
+        type: "dynamic";
+    } | {
+        type: "deep-research";
+        thinkingSummaries?: "auto" | "none" | null | undefined;
+        visualization?: "auto" | "off" | null | undefined;
+        collaborativePlanning?: boolean | null | undefined;
+    } | null | undefined;
+    thinkingLevel?: "minimal" | "low" | "medium" | "high" | null | undefined;
+    thinkingSummaries?: "auto" | "none" | null | undefined;
+    imageConfig?: {
+        aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | "1:8" | "8:1" | "1:4" | "4:1" | null | undefined;
+        imageSize?: "1K" | "2K" | "4K" | "512" | null | undefined;
+    } | null | undefined;
+    mediaResolution?: "low" | "medium" | "high" | "ultra_high" | null | undefined;
+    responseModalities?: ("text" | "image" | "document" | "video" | "audio")[] | null | undefined;
+    serviceTier?: "standard" | "flex" | "priority" | null | undefined;
+    systemInstruction?: string | null | undefined;
+    signature?: string | null | undefined;
+    interactionId?: string | null | undefined;
+    pollingTimeoutMs?: number | null | undefined;
+}>;
+type GoogleLanguageModelInteractionsOptions = InferSchema<typeof googleInteractionsLanguageModelOptions>;
+
+/**
+ * Provider-metadata shape that the Gemini Interactions language model writes
+ * onto `result.providerMetadata.google` (and reads back from input messages on
+ * the next turn for stateful chaining and signature round-trip).
+ */
+type GoogleInteractionsProviderMetadata = {
+    /**
+     * Gemini-server-side interaction id (`Interaction.id`). Pass back in
+     * `providerOptions.google.previousInteractionId` to chain stateful turns.
+     */
+    interactionId?: string;
+    /**
+     * Service tier used for this interaction (passthrough for observability).
+     */
+    serviceTier?: string;
+    /**
+     * Per-block signature hash for backend validation. Set by the SDK on output
+     * reasoning / tool-call parts and round-tripped on input parts.
+     */
+    signature?: string;
+};
+
+/**
+ * Type-only module: declares the union of supported Gemini Interactions agent
+ * names. Used by the `google.interactions({ agent })` factory branch.
+ *
+ * Sourced from `googleapis/js-genai` `src/interactions/resources/interactions.ts`
+ * (`Interaction.agent` enum). Subject to expansion as Google adds new agents.
+ *
+ * This is a strict string-literal union (no `string` escape hatch) so that
+ * passing an unknown agent name is a compile-time error. Add new agents here
+ * as Google publishes them.
+ */
+type GoogleInteractionsAgentName = 'deep-research-pro-preview-12-2025' | 'deep-research-preview-04-2026' | 'deep-research-max-preview-04-2026';
+
 declare const googleTools: {
     /**
      * Creates a Google search tool that gives Google direct access to real-time web content.
@@ -373,6 +454,14 @@ interface GoogleGenerativeAIProvider extends ProviderV3 {
      * Creates a model for video generation.
      */
     videoModel(modelId: GoogleGenerativeAIVideoModelId): Experimental_VideoModelV3;
+    /**
+     * Creates a language model targeting the Gemini Interactions API
+     * (`POST /v1beta/interactions`). Pass either a model ID (string) or
+     * `{ agent: <name> }` to use a Gemini agent preset.
+     */
+    interactions(modelIdOrAgent: GoogleInteractionsModelId | {
+        agent: GoogleInteractionsAgentName;
+    }): LanguageModelV3;
     tools: typeof googleTools;
 }
 interface GoogleGenerativeAIProviderSettings {
@@ -416,4 +505,4 @@ declare const google: GoogleGenerativeAIProvider;
 
 declare const VERSION: string;
 
-export { type GoogleEmbeddingModelOptions, type GoogleErrorData, type GoogleEmbeddingModelOptions as GoogleGenerativeAIEmbeddingProviderOptions, type GoogleImageModelOptions as GoogleGenerativeAIImageProviderOptions, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderMetadata, type GoogleLanguageModelOptions as GoogleGenerativeAIProviderOptions, type GoogleGenerativeAIProviderSettings, type GoogleGenerativeAIVideoModelId, type GoogleVideoModelOptions as GoogleGenerativeAIVideoProviderOptions, type GoogleImageModelOptions, type GoogleLanguageModelOptions, type GoogleVideoModelOptions, VERSION, createGoogleGenerativeAI, google };
+export { type GoogleEmbeddingModelOptions, type GoogleErrorData, type GoogleEmbeddingModelOptions as GoogleGenerativeAIEmbeddingProviderOptions, type GoogleImageModelOptions as GoogleGenerativeAIImageProviderOptions, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderMetadata, type GoogleLanguageModelOptions as GoogleGenerativeAIProviderOptions, type GoogleGenerativeAIProviderSettings, type GoogleGenerativeAIVideoModelId, type GoogleVideoModelOptions as GoogleGenerativeAIVideoProviderOptions, type GoogleImageModelOptions, type GoogleInteractionsAgentName, type GoogleInteractionsModelId, type GoogleInteractionsProviderMetadata, type GoogleLanguageModelInteractionsOptions, type GoogleLanguageModelOptions, type GoogleVideoModelOptions, VERSION, createGoogleGenerativeAI, google };

package/dist/index.d.ts

@@ -254,6 +254,87 @@ type GoogleVideoModelOptions = {
     [key: string]: unknown;
 };
 
+/**
+ * Type-only union of Gemini model IDs that the Interactions API accepts via
+ * `model:`. Mirrors `Model` from `googleapis/js-genai`
+ * `src/interactions/resources/interactions.ts`.
+ *
+ * Kept as a separate type from `GoogleModelId` even though most IDs overlap;
+ * the two surfaces (`:generateContent` vs `/interactions`) are independent and
+ * may diverge over time.
+ */
+type GoogleInteractionsModelId = 'gemini-2.5-computer-use-preview-10-2025' | 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | 'gemini-3.1-flash-image-preview' | 'gemini-3.1-flash-lite-preview' | 'gemini-3.1-flash-tts-preview' | 'lyria-3-clip-preview' | 'lyria-3-pro-preview' | (string & {});
+/**
+ * Provider-options schema for `google.interactions(...)` calls. Read from the
+ * shared `providerOptions.google.*` namespace (per PRD); per-call options that
+ * the AI SDK doesn't natively expose live here.
+ *
+ * All fields are `.nullish()` per the existing google provider convention.
+ */
+declare const googleInteractionsLanguageModelOptions: _ai_sdk_provider_utils.LazySchema<{
+    previousInteractionId?: string | null | undefined;
+    store?: boolean | null | undefined;
+    agent?: string | null | undefined;
+    agentConfig?: {
+        [x: string]: unknown;
+        type: "dynamic";
+    } | {
+        type: "deep-research";
+        thinkingSummaries?: "auto" | "none" | null | undefined;
+        visualization?: "auto" | "off" | null | undefined;
+        collaborativePlanning?: boolean | null | undefined;
+    } | null | undefined;
+    thinkingLevel?: "minimal" | "low" | "medium" | "high" | null | undefined;
+    thinkingSummaries?: "auto" | "none" | null | undefined;
+    imageConfig?: {
+        aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | "1:8" | "8:1" | "1:4" | "4:1" | null | undefined;
+        imageSize?: "1K" | "2K" | "4K" | "512" | null | undefined;
+    } | null | undefined;
+    mediaResolution?: "low" | "medium" | "high" | "ultra_high" | null | undefined;
+    responseModalities?: ("text" | "image" | "document" | "video" | "audio")[] | null | undefined;
+    serviceTier?: "standard" | "flex" | "priority" | null | undefined;
+    systemInstruction?: string | null | undefined;
+    signature?: string | null | undefined;
+    interactionId?: string | null | undefined;
+    pollingTimeoutMs?: number | null | undefined;
+}>;
+type GoogleLanguageModelInteractionsOptions = InferSchema<typeof googleInteractionsLanguageModelOptions>;
+
+/**
+ * Provider-metadata shape that the Gemini Interactions language model writes
+ * onto `result.providerMetadata.google` (and reads back from input messages on
+ * the next turn for stateful chaining and signature round-trip).
+ */
+type GoogleInteractionsProviderMetadata = {
+    /**
+     * Gemini-server-side interaction id (`Interaction.id`). Pass back in
+     * `providerOptions.google.previousInteractionId` to chain stateful turns.
+     */
+    interactionId?: string;
+    /**
+     * Service tier used for this interaction (passthrough for observability).
+     */
+    serviceTier?: string;
+    /**
+     * Per-block signature hash for backend validation. Set by the SDK on output
+     * reasoning / tool-call parts and round-tripped on input parts.
+     */
+    signature?: string;
+};
+
+/**
+ * Type-only module: declares the union of supported Gemini Interactions agent
+ * names. Used by the `google.interactions({ agent })` factory branch.
+ *
+ * Sourced from `googleapis/js-genai` `src/interactions/resources/interactions.ts`
+ * (`Interaction.agent` enum). Subject to expansion as Google adds new agents.
+ *
+ * This is a strict string-literal union (no `string` escape hatch) so that
+ * passing an unknown agent name is a compile-time error. Add new agents here
+ * as Google publishes them.
+ */
+type GoogleInteractionsAgentName = 'deep-research-pro-preview-12-2025' | 'deep-research-preview-04-2026' | 'deep-research-max-preview-04-2026';
+
 declare const googleTools: {
     /**
      * Creates a Google search tool that gives Google direct access to real-time web content.
@@ -373,6 +454,14 @@ interface GoogleGenerativeAIProvider extends ProviderV3 {
      * Creates a model for video generation.
      */
     videoModel(modelId: GoogleGenerativeAIVideoModelId): Experimental_VideoModelV3;
+    /**
+     * Creates a language model targeting the Gemini Interactions API
+     * (`POST /v1beta/interactions`). Pass either a model ID (string) or
+     * `{ agent: <name> }` to use a Gemini agent preset.
+     */
+    interactions(modelIdOrAgent: GoogleInteractionsModelId | {
+        agent: GoogleInteractionsAgentName;
+    }): LanguageModelV3;
     tools: typeof googleTools;
 }
 interface GoogleGenerativeAIProviderSettings {
@@ -416,4 +505,4 @@ declare const google: GoogleGenerativeAIProvider;
 
 declare const VERSION: string;
 
-export { type GoogleEmbeddingModelOptions, type GoogleErrorData, type GoogleEmbeddingModelOptions as GoogleGenerativeAIEmbeddingProviderOptions, type GoogleImageModelOptions as GoogleGenerativeAIImageProviderOptions, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderMetadata, type GoogleLanguageModelOptions as GoogleGenerativeAIProviderOptions, type GoogleGenerativeAIProviderSettings, type GoogleGenerativeAIVideoModelId, type GoogleVideoModelOptions as GoogleGenerativeAIVideoProviderOptions, type GoogleImageModelOptions, type GoogleLanguageModelOptions, type GoogleVideoModelOptions, VERSION, createGoogleGenerativeAI, google };
+export { type GoogleEmbeddingModelOptions, type GoogleErrorData, type GoogleEmbeddingModelOptions as GoogleGenerativeAIEmbeddingProviderOptions, type GoogleImageModelOptions as GoogleGenerativeAIImageProviderOptions, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderMetadata, type GoogleLanguageModelOptions as GoogleGenerativeAIProviderOptions, type GoogleGenerativeAIProviderSettings, type GoogleGenerativeAIVideoModelId, type GoogleVideoModelOptions as GoogleGenerativeAIVideoProviderOptions, type GoogleImageModelOptions, type GoogleInteractionsAgentName, type GoogleInteractionsModelId, type GoogleInteractionsProviderMetadata, type GoogleLanguageModelInteractionsOptions, type GoogleLanguageModelOptions, type GoogleVideoModelOptions, VERSION, createGoogleGenerativeAI, google };