@ai-sdk/google 2.0.45 → 2.0.47

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/google
 
+## 2.0.47
+
+### Patch Changes
+
+- 0e182c5: Add Google Maps grounding tool support for location-aware Gemini responses
+
+## 2.0.46
+
+### Patch Changes
+
+- Updated dependencies [ef6d784]
+  - @ai-sdk/provider-utils@3.0.19
+
 ## 2.0.45
 
 ### Patch Changes

package/dist/index.d.mts

@@ -33,6 +33,12 @@ declare const googleGenerativeAIProviderOptions: _ai_sdk_provider_utils.LazySche
         aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | undefined;
         imageSize?: "1K" | "2K" | "4K" | undefined;
     } | undefined;
+    retrievalConfig?: {
+        latLng?: {
+            latitude: number;
+            longitude: number;
+        } | undefined;
+    } | undefined;
 }>;
 type GoogleGenerativeAIProviderOptions = InferValidator<typeof googleGenerativeAIProviderOptions>;
 
@@ -90,6 +96,12 @@ declare const responseSchema: _ai_sdk_provider_utils.LazySchema<{
                     text?: string | null | undefined;
                     fileSearchStore?: string | null | undefined;
                 } | null | undefined;
+                maps?: {
+                    uri?: string | null | undefined;
+                    title?: string | null | undefined;
+                    text?: string | null | undefined;
+                    placeId?: string | null | undefined;
+                } | null | undefined;
             }[] | null | undefined;
             groundingSupports?: {
                 segment: {
@@ -177,6 +189,14 @@ declare const googleTools: {
         mode?: "MODE_DYNAMIC" | "MODE_UNSPECIFIED";
         dynamicThreshold?: number;
     }>;
+    /**
+     * Creates a Google Maps grounding tool that gives the model access to Google Maps data.
+     * Must have name "google_maps".
+     *
+     * @see https://ai.google.dev/gemini-api/docs/maps-grounding
+     * @see https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-maps
+     */
+    googleMaps: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {}>;
     /**
      * Creates a URL context tool that gives Google direct access to real-time web content.
      * Must have name "url_context".

package/dist/index.d.ts

@@ -33,6 +33,12 @@ declare const googleGenerativeAIProviderOptions: _ai_sdk_provider_utils.LazySche
         aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | undefined;
         imageSize?: "1K" | "2K" | "4K" | undefined;
     } | undefined;
+    retrievalConfig?: {
+        latLng?: {
+            latitude: number;
+            longitude: number;
+        } | undefined;
+    } | undefined;
 }>;
 type GoogleGenerativeAIProviderOptions = InferValidator<typeof googleGenerativeAIProviderOptions>;
 
@@ -90,6 +96,12 @@ declare const responseSchema: _ai_sdk_provider_utils.LazySchema<{
                     text?: string | null | undefined;
                     fileSearchStore?: string | null | undefined;
                 } | null | undefined;
+                maps?: {
+                    uri?: string | null | undefined;
+                    title?: string | null | undefined;
+                    text?: string | null | undefined;
+                    placeId?: string | null | undefined;
+                } | null | undefined;
             }[] | null | undefined;
             groundingSupports?: {
                 segment: {
@@ -177,6 +189,14 @@ declare const googleTools: {
         mode?: "MODE_DYNAMIC" | "MODE_UNSPECIFIED";
         dynamicThreshold?: number;
     }>;
+    /**
+     * Creates a Google Maps grounding tool that gives the model access to Google Maps data.
+     * Must have name "google_maps".
+     *
+     * @see https://ai.google.dev/gemini-api/docs/maps-grounding
+     * @see https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-maps
+     */
+    googleMaps: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {}>;
     /**
      * Creates a URL context tool that gives Google direct access to real-time web content.
      * Must have name "url_context".

package/dist/index.js

@@ -27,10 +27,10 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/google-provider.ts
-var import_provider_utils13 = require("@ai-sdk/provider-utils");
+var import_provider_utils14 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "2.0.45" : "0.0.0-test";
+var VERSION = true ? "2.0.47" : "0.0.0-test";
 
 // src/google-generative-ai-embedding-model.ts
 var import_provider = require("@ai-sdk/provider");
@@ -578,6 +578,18 @@ var googleGenerativeAIProviderOptions = (0, import_provider_utils5.lazySchema)(
           "21:9"
         ]).optional(),
         imageSize: import_v44.z.enum(["1K", "2K", "4K"]).optional()
+      }).optional(),
+      /**
+       * Optional. Configuration for grounding retrieval.
+       * Used to provide location context for Google Maps and Google Search grounding.
+       *
+       * https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-maps
+       */
+      retrievalConfig: import_v44.z.object({
+        latLng: import_v44.z.object({
+          latitude: import_v44.z.number(),
+          longitude: import_v44.z.number()
+        }).optional()
       }).optional()
     })
   )
@@ -692,6 +704,17 @@ function prepareTools({
             });
           }
           break;
+        case "google.google_maps":
+          if (isGemini2orNewer) {
+            googleTools2.push({ googleMaps: {} });
+          } else {
+            toolWarnings.push({
+              type: "unsupported-tool",
+              tool,
+              details: "The Google Maps grounding tool is not supported with Gemini models other than Gemini 2 or newer."
+            });
+          }
+          break;
         default:
           toolWarnings.push({ type: "unsupported-tool", tool });
           break;
@@ -887,7 +910,10 @@ var GoogleGenerativeAILanguageModel = class {
         systemInstruction: isGemmaModel ? void 0 : systemInstruction,
         safetySettings: googleOptions == null ? void 0 : googleOptions.safetySettings,
         tools: googleTools2,
-        toolConfig: googleToolConfig,
+        toolConfig: (googleOptions == null ? void 0 : googleOptions.retrievalConfig) ? {
+          ...googleToolConfig,
+          retrievalConfig: googleOptions.retrievalConfig
+        } : googleToolConfig,
         cachedContent: googleOptions == null ? void 0 : googleOptions.cachedContent,
         labels: googleOptions == null ? void 0 : googleOptions.labels
       },
@@ -1272,7 +1298,7 @@ function extractSources({
   groundingMetadata,
   generateId: generateId3
 }) {
-  var _a, _b, _c, _d;
+  var _a, _b, _c, _d, _e;
   if (!(groundingMetadata == null ? void 0 : groundingMetadata.groundingChunks)) {
     return void 0;
   }
@@ -1338,6 +1364,16 @@ function extractSources({
           filename: fileSearchStore.split("/").pop()
         });
       }
+    } else if (chunk.maps != null) {
+      if (chunk.maps.uri) {
+        sources.push({
+          type: "source",
+          sourceType: "url",
+          id: generateId3(),
+          url: chunk.maps.uri,
+          title: (_e = chunk.maps.title) != null ? _e : void 0
+        });
+      }
     }
   }
   return sources.length > 0 ? sources : void 0;
@@ -1354,6 +1390,12 @@ var getGroundingMetadataSchema = () => import_v45.z.object({
         title: import_v45.z.string().nullish(),
         text: import_v45.z.string().nullish(),
         fileSearchStore: import_v45.z.string().nullish()
+      }).nullish(),
+      maps: import_v45.z.object({
+        uri: import_v45.z.string().nullish(),
+        title: import_v45.z.string().nullish(),
+        text: import_v45.z.string().nullish(),
+        placeId: import_v45.z.string().nullish()
       }).nullish()
     })
   ).nullish(),
@@ -1521,40 +1563,49 @@ var fileSearch = (0, import_provider_utils8.createProviderDefinedToolFactory)({
   inputSchema: fileSearchArgsSchema
 });
 
-// src/tool/google-search.ts
+// src/tool/google-maps.ts
 var import_provider_utils9 = require("@ai-sdk/provider-utils");
 var import_v48 = require("zod/v4");
-var googleSearch = (0, import_provider_utils9.createProviderDefinedToolFactory)({
+var googleMaps = (0, import_provider_utils9.createProviderDefinedToolFactory)({
+  id: "google.google_maps",
+  name: "google_maps",
+  inputSchema: (0, import_provider_utils9.lazySchema)(() => (0, import_provider_utils9.zodSchema)(import_v48.z.object({})))
+});
+
+// src/tool/google-search.ts
+var import_provider_utils10 = require("@ai-sdk/provider-utils");
+var import_v49 = require("zod/v4");
+var googleSearch = (0, import_provider_utils10.createProviderDefinedToolFactory)({
   id: "google.google_search",
   name: "google_search",
-  inputSchema: (0, import_provider_utils9.lazySchema)(
-    () => (0, import_provider_utils9.zodSchema)(
-      import_v48.z.object({
-        mode: import_v48.z.enum(["MODE_DYNAMIC", "MODE_UNSPECIFIED"]).default("MODE_UNSPECIFIED"),
-        dynamicThreshold: import_v48.z.number().default(1)
+  inputSchema: (0, import_provider_utils10.lazySchema)(
+    () => (0, import_provider_utils10.zodSchema)(
+      import_v49.z.object({
+        mode: import_v49.z.enum(["MODE_DYNAMIC", "MODE_UNSPECIFIED"]).default("MODE_UNSPECIFIED"),
+        dynamicThreshold: import_v49.z.number().default(1)
       })
     )
   )
 });
 
 // src/tool/url-context.ts
-var import_provider_utils10 = require("@ai-sdk/provider-utils");
-var import_v49 = require("zod/v4");
-var urlContext = (0, import_provider_utils10.createProviderDefinedToolFactory)({
+var import_provider_utils11 = require("@ai-sdk/provider-utils");
+var import_v410 = require("zod/v4");
+var urlContext = (0, import_provider_utils11.createProviderDefinedToolFactory)({
   id: "google.url_context",
   name: "url_context",
-  inputSchema: (0, import_provider_utils10.lazySchema)(() => (0, import_provider_utils10.zodSchema)(import_v49.z.object({})))
+  inputSchema: (0, import_provider_utils11.lazySchema)(() => (0, import_provider_utils11.zodSchema)(import_v410.z.object({})))
 });
 
 // src/tool/vertex-rag-store.ts
-var import_provider_utils11 = require("@ai-sdk/provider-utils");
-var import_v410 = require("zod/v4");
-var vertexRagStore = (0, import_provider_utils11.createProviderDefinedToolFactory)({
+var import_provider_utils12 = require("@ai-sdk/provider-utils");
+var import_v411 = require("zod/v4");
+var vertexRagStore = (0, import_provider_utils12.createProviderDefinedToolFactory)({
   id: "google.vertex_rag_store",
   name: "vertex_rag_store",
-  inputSchema: import_v410.z.object({
-    ragCorpus: import_v410.z.string(),
-    topK: import_v410.z.number().optional()
+  inputSchema: import_v411.z.object({
+    ragCorpus: import_v411.z.string(),
+    topK: import_v411.z.number().optional()
   })
 });
 
@@ -1565,6 +1616,14 @@ var googleTools = {
    * Must have name "google_search".
    */
   googleSearch,
+  /**
+   * Creates a Google Maps grounding tool that gives the model access to Google Maps data.
+   * Must have name "google_maps".
+   *
+   * @see https://ai.google.dev/gemini-api/docs/maps-grounding
+   * @see https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/grounding-with-google-maps
+   */
+  googleMaps,
   /**
    * Creates a URL context tool that gives Google direct access to real-time web content.
    * Must have name "url_context".
@@ -1600,8 +1659,8 @@ var googleTools = {
 };
 
 // src/google-generative-ai-image-model.ts
-var import_provider_utils12 = require("@ai-sdk/provider-utils");
-var import_v411 = require("zod/v4");
+var import_provider_utils13 = require("@ai-sdk/provider-utils");
+var import_v412 = require("zod/v4");
 var GoogleGenerativeAIImageModel = class {
   constructor(modelId, settings, config) {
     this.modelId = modelId;
@@ -1643,7 +1702,7 @@ var GoogleGenerativeAIImageModel = class {
         details: "This model does not support the `seed` option through this provider."
       });
     }
-    const googleOptions = await (0, import_provider_utils12.parseProviderOptions)({
+    const googleOptions = await (0, import_provider_utils13.parseProviderOptions)({
       provider: "google",
       providerOptions,
       schema: googleImageProviderOptionsSchema
@@ -1662,12 +1721,12 @@ var GoogleGenerativeAIImageModel = class {
       instances: [{ prompt }],
       parameters
     };
-    const { responseHeaders, value: response } = await (0, import_provider_utils12.postJsonToApi)({
+    const { responseHeaders, value: response } = await (0, import_provider_utils13.postJsonToApi)({
       url: `${this.config.baseURL}/models/${this.modelId}:predict`,
-      headers: (0, import_provider_utils12.combineHeaders)(await (0, import_provider_utils12.resolve)(this.config.headers), headers),
+      headers: (0, import_provider_utils13.combineHeaders)(await (0, import_provider_utils13.resolve)(this.config.headers), headers),
       body,
       failedResponseHandler: googleFailedResponseHandler,
-      successfulResponseHandler: (0, import_provider_utils12.createJsonResponseHandler)(
+      successfulResponseHandler: (0, import_provider_utils13.createJsonResponseHandler)(
         googleImageResponseSchema
       ),
       abortSignal,
@@ -1693,18 +1752,18 @@ var GoogleGenerativeAIImageModel = class {
     };
   }
 };
-var googleImageResponseSchema = (0, import_provider_utils12.lazySchema)(
-  () => (0, import_provider_utils12.zodSchema)(
-    import_v411.z.object({
-      predictions: import_v411.z.array(import_v411.z.object({ bytesBase64Encoded: import_v411.z.string() })).default([])
+var googleImageResponseSchema = (0, import_provider_utils13.lazySchema)(
+  () => (0, import_provider_utils13.zodSchema)(
+    import_v412.z.object({
+      predictions: import_v412.z.array(import_v412.z.object({ bytesBase64Encoded: import_v412.z.string() })).default([])
     })
   )
 );
-var googleImageProviderOptionsSchema = (0, import_provider_utils12.lazySchema)(
-  () => (0, import_provider_utils12.zodSchema)(
-    import_v411.z.object({
-      personGeneration: import_v411.z.enum(["dont_allow", "allow_adult", "allow_all"]).nullish(),
-      aspectRatio: import_v411.z.enum(["1:1", "3:4", "4:3", "9:16", "16:9"]).nullish()
+var googleImageProviderOptionsSchema = (0, import_provider_utils13.lazySchema)(
+  () => (0, import_provider_utils13.zodSchema)(
+    import_v412.z.object({
+      personGeneration: import_v412.z.enum(["dont_allow", "allow_adult", "allow_all"]).nullish(),
+      aspectRatio: import_v412.z.enum(["1:1", "3:4", "4:3", "9:16", "16:9"]).nullish()
     })
   )
 );
@@ -1712,11 +1771,11 @@ var googleImageProviderOptionsSchema = (0, import_provider_utils12.lazySchema)(
 // src/google-provider.ts
 function createGoogleGenerativeAI(options = {}) {
   var _a, _b;
-  const baseURL = (_a = (0, import_provider_utils13.withoutTrailingSlash)(options.baseURL)) != null ? _a : "https://generativelanguage.googleapis.com/v1beta";
+  const baseURL = (_a = (0, import_provider_utils14.withoutTrailingSlash)(options.baseURL)) != null ? _a : "https://generativelanguage.googleapis.com/v1beta";
   const providerName = (_b = options.name) != null ? _b : "google.generative-ai";
-  const getHeaders = () => (0, import_provider_utils13.withUserAgentSuffix)(
+  const getHeaders = () => (0, import_provider_utils14.withUserAgentSuffix)(
     {
-      "x-goog-api-key": (0, import_provider_utils13.loadApiKey)({
+      "x-goog-api-key": (0, import_provider_utils14.loadApiKey)({
         apiKey: options.apiKey,
         environmentVariableName: "GOOGLE_GENERATIVE_AI_API_KEY",
         description: "Google Generative AI"
@@ -1731,7 +1790,7 @@ function createGoogleGenerativeAI(options = {}) {
       provider: providerName,
       baseURL,
       headers: getHeaders,
-      generateId: (_a2 = options.generateId) != null ? _a2 : import_provider_utils13.generateId,
+      generateId: (_a2 = options.generateId) != null ? _a2 : import_provider_utils14.generateId,
       supportedUrls: () => ({
         "*": [
           // Google Generative Language "files" endpoint