@ai-sdk/google 3.0.77 → 3.0.79

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @ai-sdk/google
 
+## 3.0.79
+
+### Patch Changes
+
+- cfa0cb2: feat(provider/google): support Google search grounding when using `generateImage` with Gemini
+
+## 3.0.78
+
+### Patch Changes
+
+- cf63828: fix(google): read `serviceTier` from `usageMetadata.serviceTier` in both generate and stream paths
+
+  The previous implementation read `serviceTier` from the `x-gemini-service-tier`
+  response header, which is only populated on non-streaming responses. Gemini
+  streaming includes the value in `usageMetadata.serviceTier` on every chunk, so
+  `providerMetadata.google.serviceTier` was always `null` for streams. Read from
+  `usageMetadata` for both paths instead.
+
 ## 3.0.77
 
 ### Patch Changes

package/dist/index.d.mts

@@ -171,6 +171,7 @@ declare const responseSchema: _ai_sdk_provider_utils.LazySchema<{
         candidatesTokenCount?: number | null | undefined;
         totalTokenCount?: number | null | undefined;
         trafficType?: string | null | undefined;
+        serviceTier?: string | null | undefined;
         promptTokensDetails?: {
             modality: string;
             tokenCount: number;
@@ -224,6 +225,17 @@ interface GoogleGenerativeAIImageSettings {
 declare const googleImageModelOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
     personGeneration?: "dont_allow" | "allow_adult" | "allow_all" | null | undefined;
     aspectRatio?: "1:1" | "3:4" | "4:3" | "9:16" | "16:9" | null | undefined;
+    googleSearch?: {
+        [x: string]: unknown;
+        searchTypes?: {
+            webSearch?: Record<string, never> | undefined;
+            imageSearch?: Record<string, never> | undefined;
+        } | undefined;
+        timeRangeFilter?: {
+            startTime: string;
+            endTime: string;
+        } | undefined;
+    } | undefined;
 }>;
 type GoogleImageModelOptions = InferSchema<typeof googleImageModelOptionsSchema>;
 

package/dist/index.d.ts

@@ -171,6 +171,7 @@ declare const responseSchema: _ai_sdk_provider_utils.LazySchema<{
         candidatesTokenCount?: number | null | undefined;
         totalTokenCount?: number | null | undefined;
         trafficType?: string | null | undefined;
+        serviceTier?: string | null | undefined;
         promptTokensDetails?: {
             modality: string;
             tokenCount: number;
@@ -224,6 +225,17 @@ interface GoogleGenerativeAIImageSettings {
 declare const googleImageModelOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
     personGeneration?: "dont_allow" | "allow_adult" | "allow_all" | null | undefined;
     aspectRatio?: "1:1" | "3:4" | "4:3" | "9:16" | "16:9" | null | undefined;
+    googleSearch?: {
+        [x: string]: unknown;
+        searchTypes?: {
+            webSearch?: Record<string, never> | undefined;
+            imageSearch?: Record<string, never> | undefined;
+        } | undefined;
+        timeRangeFilter?: {
+            startTime: string;
+            endTime: string;
+        } | undefined;
+    } | undefined;
 }>;
 type GoogleImageModelOptions = InferSchema<typeof googleImageModelOptionsSchema>;
 

package/dist/index.js

@@ -30,7 +30,7 @@ module.exports = __toCommonJS(index_exports);
 var import_provider_utils23 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "3.0.77" : "0.0.0-test";
+var VERSION = true ? "3.0.79" : "0.0.0-test";
 
 // src/google-generative-ai-embedding-model.ts
 var import_provider = require("@ai-sdk/provider");
@@ -1711,7 +1711,7 @@ var GoogleGenerativeAILanguageModel = class {
           safetyRatings: (_p = candidate.safetyRatings) != null ? _p : null,
           usageMetadata: usageMetadata != null ? usageMetadata : null,
           finishMessage: (_q = candidate.finishMessage) != null ? _q : null,
-          serviceTier: (_r = responseHeaders == null ? void 0 : responseHeaders["x-gemini-service-tier"]) != null ? _r : null
+          serviceTier: (_r = usageMetadata == null ? void 0 : usageMetadata.serviceTier) != null ? _r : null
         }
       },
       request: { body: args },
@@ -1723,7 +1723,6 @@ var GoogleGenerativeAILanguageModel = class {
     };
   }
   async doStream(options) {
-    var _a;
     const { args, warnings, providerOptionsName, extraHeaders } = await this.getArgs(options, { isStreaming: true });
     const headers = (0, import_provider_utils6.combineHeaders)(
       await (0, import_provider_utils6.resolve)(this.config.headers),
@@ -1749,7 +1748,6 @@ var GoogleGenerativeAILanguageModel = class {
     let providerMetadata = void 0;
     let lastGroundingMetadata = null;
     let lastUrlContextMetadata = null;
-    const serviceTier = (_a = responseHeaders == null ? void 0 : responseHeaders["x-gemini-service-tier"]) != null ? _a : null;
     const generateId3 = this.config.generateId;
     let hasToolCalls = false;
     let currentTextBlockId = null;
@@ -1794,7 +1792,7 @@ var GoogleGenerativeAILanguageModel = class {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a2, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -1807,7 +1805,7 @@ var GoogleGenerativeAILanguageModel = class {
             if (usageMetadata != null) {
               usage = usageMetadata;
             }
-            const candidate = (_a2 = value.candidates) == null ? void 0 : _a2[0];
+            const candidate = (_a = value.candidates) == null ? void 0 : _a[0];
             if (candidate == null) {
               return;
             }
@@ -2114,7 +2112,7 @@ var GoogleGenerativeAILanguageModel = class {
                   safetyRatings: (_n = candidate.safetyRatings) != null ? _n : null,
                   usageMetadata: usageMetadata != null ? usageMetadata : null,
                   finishMessage: (_o = candidate.finishMessage) != null ? _o : null,
-                  serviceTier
+                  serviceTier: (_p = usage == null ? void 0 : usage.serviceTier) != null ? _p : null
                 }
               };
             }
@@ -2373,6 +2371,7 @@ var usageSchema = import_v45.z.object({
   totalTokenCount: import_v45.z.number().nullish(),
   // https://cloud.google.com/vertex-ai/generative-ai/docs/reference/rest/v1/GenerateContentResponse#TrafficType
   trafficType: import_v45.z.string().nullish(),
+  serviceTier: import_v45.z.string().nullish(),
   // https://ai.google.dev/api/generate-content#Modality
   promptTokensDetails: tokenDetailsSchema,
   candidatesTokensDetails: tokenDetailsSchema
@@ -2668,7 +2667,15 @@ var GoogleGenerativeAIImageModel = class {
       parameters.aspectRatio = aspectRatio;
     }
     if (googleOptions) {
-      Object.assign(parameters, googleOptions);
+      const { googleSearch: imagenGoogleSearch, ...imagenOptions } = googleOptions;
+      if (imagenGoogleSearch != null) {
+        warnings.push({
+          type: "unsupported",
+          feature: "googleSearch",
+          details: "Google Search grounding is only supported on Gemini image models."
+        });
+      }
+      Object.assign(parameters, imagenOptions);
     }
     const body = {
       instances: [{ prompt }],
@@ -2705,7 +2712,7 @@ var GoogleGenerativeAIImageModel = class {
     };
   }
   async doGenerateGemini(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
     const {
       prompt,
       n,
@@ -2760,12 +2767,18 @@ var GoogleGenerativeAIImageModel = class {
     const languageModelPrompt = [
       { role: "user", content: userContent }
     ];
+    const googleImageOptions = await (0, import_provider_utils14.parseProviderOptions)({
+      provider: "google",
+      providerOptions,
+      schema: googleImageModelOptionsSchema
+    });
+    const { googleSearch: _strippedGoogleSearch, ...passthroughGoogleOptions } = (_a = providerOptions == null ? void 0 : providerOptions.google) != null ? _a : {};
     const languageModel = new GoogleGenerativeAILanguageModel(this.modelId, {
       provider: this.config.provider,
       baseURL: this.config.baseURL,
-      headers: (_a = this.config.headers) != null ? _a : {},
+      headers: (_b = this.config.headers) != null ? _b : {},
       fetch: this.config.fetch,
-      generateId: (_b = this.config.generateId) != null ? _b : import_provider_utils14.generateId
+      generateId: (_c = this.config.generateId) != null ? _c : import_provider_utils14.generateId
     });
     const result = await languageModel.doGenerate({
       prompt: languageModelPrompt,
@@ -2776,9 +2789,17 @@ var GoogleGenerativeAIImageModel = class {
           imageConfig: aspectRatio ? {
             aspectRatio
           } : void 0,
-          ...(_c = providerOptions == null ? void 0 : providerOptions.google) != null ? _c : {}
+          ...passthroughGoogleOptions
         }
       },
+      tools: (googleImageOptions == null ? void 0 : googleImageOptions.googleSearch) != null ? [
+        {
+          type: "provider",
+          id: "google.google_search",
+          name: "google_search",
+          args: googleImageOptions.googleSearch
+        }
+      ] : void 0,
       headers,
       abortSignal
     });
@@ -2789,23 +2810,25 @@ var GoogleGenerativeAIImageModel = class {
         images.push((0, import_provider_utils14.convertToBase64)(part.data));
       }
     }
+    const languageModelGoogleMetadata = (_h = (_g = result.providerMetadata) == null ? void 0 : _g.google) != null ? _h : {};
     return {
       images,
       warnings,
       providerMetadata: {
         google: {
+          ...languageModelGoogleMetadata,
           images: images.map(() => ({}))
         }
       },
       response: {
         timestamp: currentDate,
         modelId: this.modelId,
-        headers: (_g = result.response) == null ? void 0 : _g.headers
+        headers: (_i = result.response) == null ? void 0 : _i.headers
       },
       usage: result.usage ? {
         inputTokens: result.usage.inputTokens.total,
         outputTokens: result.usage.outputTokens.total,
-        totalTokens: ((_h = result.usage.inputTokens.total) != null ? _h : 0) + ((_i = result.usage.outputTokens.total) != null ? _i : 0)
+        totalTokens: ((_j = result.usage.inputTokens.total) != null ? _j : 0) + ((_k = result.usage.outputTokens.total) != null ? _k : 0)
       } : void 0
     };
   }
@@ -2824,7 +2847,17 @@ var googleImageModelOptionsSchema = (0, import_provider_utils14.lazySchema)(
   () => (0, import_provider_utils14.zodSchema)(
     import_v413.z.object({
       personGeneration: import_v413.z.enum(["dont_allow", "allow_adult", "allow_all"]).nullish(),
-      aspectRatio: import_v413.z.enum(["1:1", "3:4", "4:3", "9:16", "16:9"]).nullish()
+      aspectRatio: import_v413.z.enum(["1:1", "3:4", "4:3", "9:16", "16:9"]).nullish(),
+      /**
+       * Enable Google Search grounding for Gemini image models. The value is
+       * forwarded as the args of the `google.tools.googleSearch` provider
+       * tool on the underlying language-model call. Pass `{}` for defaults.
+       *
+       * `generateImage` does not accept a `tools` parameter, so this is the
+       * dedicated escape hatch for grounding image generation the same way
+       * `generateText` does.
+       */
+      googleSearch: googleSearchToolArgsBaseSchema.optional()
     })
   )
 );