@ai-sdk/google 2.0.0-beta.6 → 2.0.0-beta.8

package/dist/internal/index.mjs

@@ -3,11 +3,12 @@ import {
   combineHeaders,
   createEventSourceResponseHandler,
   createJsonResponseHandler,
+  generateId,
   parseProviderOptions,
   postJsonToApi,
   resolve
 } from "@ai-sdk/provider-utils";
-import { z as z3 } from "zod/v4";
+import { z as z5 } from "zod/v4";
 
 // src/convert-json-schema-to-openapi-schema.ts
 function convertJSONSchemaToOpenAPISchema(jsonSchema) {
@@ -249,17 +250,6 @@ var googleFailedResponseHandler = createJsonErrorResponseHandler({
 
 // src/google-generative-ai-options.ts
 import { z as z2 } from "zod/v4";
-var dynamicRetrievalConfig = z2.object({
-  /**
-   * The mode of the predictor to be used in dynamic retrieval.
-   */
-  mode: z2.enum(["MODE_UNSPECIFIED", "MODE_DYNAMIC"]).optional(),
-  /**
-   * The threshold to be used in dynamic retrieval. If not set, a system default
-   * value is used.
-   */
-  dynamicThreshold: z2.number().optional()
-});
 var googleGenerativeAIProviderOptions = z2.object({
   responseModalities: z2.array(z2.enum(["TEXT", "IMAGE"])).optional(),
   thinkingConfig: z2.object({
@@ -317,21 +307,7 @@ var googleGenerativeAIProviderOptions = z2.object({
    *
    * https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/audio-understanding
    */
-  audioTimestamp: z2.boolean().optional(),
-  /**
-  Optional. When enabled, the model will use Google search to ground the response.
-  
-  @see https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/overview
-   */
-  useSearchGrounding: z2.boolean().optional(),
-  /**
-  Optional. Specifies the dynamic retrieval configuration.
-  
-  @note Dynamic retrieval is only compatible with Gemini 1.5 Flash.
-  
-  @see https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/ground-with-google-search#dynamic-retrieval
-   */
-  dynamicRetrievalConfig: dynamicRetrievalConfig.optional()
+  audioTimestamp: z2.boolean().optional()
 });
 
 // src/google-prepare-tools.ts
@@ -341,8 +317,6 @@ import {
 function prepareTools({
   tools,
   toolChoice,
-  useSearchGrounding,
-  dynamicRetrievalConfig: dynamicRetrievalConfig2,
   modelId
 }) {
   var _a;
@@ -350,28 +324,76 @@ function prepareTools({
   const toolWarnings = [];
   const isGemini2 = modelId.includes("gemini-2");
   const supportsDynamicRetrieval = modelId.includes("gemini-1.5-flash") && !modelId.includes("-8b");
-  if (useSearchGrounding) {
+  if (tools == null) {
+    return { tools: void 0, toolConfig: void 0, toolWarnings };
+  }
+  const hasFunctionTools = tools.some((tool) => tool.type === "function");
+  const hasProviderDefinedTools = tools.some(
+    (tool) => tool.type === "provider-defined"
+  );
+  if (hasFunctionTools && hasProviderDefinedTools) {
+    toolWarnings.push({
+      type: "unsupported-tool",
+      tool: tools.find((tool) => tool.type === "function"),
+      details: "Cannot mix function tools with provider-defined tools in the same request. Please use either function tools or provider-defined tools, but not both."
+    });
+  }
+  if (hasProviderDefinedTools) {
+    const googleTools2 = {};
+    const providerDefinedTools = tools.filter(
+      (tool) => tool.type === "provider-defined"
+    );
+    providerDefinedTools.forEach((tool) => {
+      switch (tool.id) {
+        case "google.google_search":
+          if (isGemini2) {
+            googleTools2.googleSearch = {};
+          } else if (supportsDynamicRetrieval) {
+            googleTools2.googleSearchRetrieval = {
+              dynamicRetrievalConfig: {
+                mode: tool.args.mode,
+                dynamicThreshold: tool.args.dynamicThreshold
+              }
+            };
+          } else {
+            googleTools2.googleSearchRetrieval = {};
+          }
+          break;
+        case "google.url_context":
+          if (isGemini2) {
+            googleTools2.urlContext = {};
+          } else {
+            toolWarnings.push({
+              type: "unsupported-tool",
+              tool,
+              details: "The URL context tool is not supported with other Gemini models than Gemini 2."
+            });
+          }
+          break;
+        default:
+          toolWarnings.push({ type: "unsupported-tool", tool });
+          break;
+      }
+    });
     return {
-      tools: isGemini2 ? { googleSearch: {} } : {
-        googleSearchRetrieval: !supportsDynamicRetrieval || !dynamicRetrievalConfig2 ? {} : { dynamicRetrievalConfig: dynamicRetrievalConfig2 }
-      },
+      tools: Object.keys(googleTools2).length > 0 ? googleTools2 : void 0,
       toolConfig: void 0,
       toolWarnings
     };
   }
-  if (tools == null) {
-    return { tools: void 0, toolConfig: void 0, toolWarnings };
-  }
   const functionDeclarations = [];
   for (const tool of tools) {
-    if (tool.type === "provider-defined") {
-      toolWarnings.push({ type: "unsupported-tool", tool });
-    } else {
-      functionDeclarations.push({
-        name: tool.name,
-        description: (_a = tool.description) != null ? _a : "",
-        parameters: convertJSONSchemaToOpenAPISchema(tool.inputSchema)
-      });
+    switch (tool.type) {
+      case "function":
+        functionDeclarations.push({
+          name: tool.name,
+          description: (_a = tool.description) != null ? _a : "",
+          parameters: convertJSONSchemaToOpenAPISchema(tool.inputSchema)
+        });
+        break;
+      default:
+        toolWarnings.push({ type: "unsupported-tool", tool });
+        break;
     }
   }
   if (toolChoice == null) {
@@ -448,12 +470,72 @@ function mapGoogleGenerativeAIFinishReason({
   }
 }
 
+// src/tool/google-search.ts
+import { createProviderDefinedToolFactory } from "@ai-sdk/provider-utils";
+import { z as z3 } from "zod/v4";
+var groundingChunkSchema = z3.object({
+  web: z3.object({ uri: z3.string(), title: z3.string() }).nullish(),
+  retrievedContext: z3.object({ uri: z3.string(), title: z3.string() }).nullish()
+});
+var groundingMetadataSchema = z3.object({
+  webSearchQueries: z3.array(z3.string()).nullish(),
+  retrievalQueries: z3.array(z3.string()).nullish(),
+  searchEntryPoint: z3.object({ renderedContent: z3.string() }).nullish(),
+  groundingChunks: z3.array(groundingChunkSchema).nullish(),
+  groundingSupports: z3.array(
+    z3.object({
+      segment: z3.object({
+        startIndex: z3.number().nullish(),
+        endIndex: z3.number().nullish(),
+        text: z3.string().nullish()
+      }),
+      segment_text: z3.string().nullish(),
+      groundingChunkIndices: z3.array(z3.number()).nullish(),
+      supportChunkIndices: z3.array(z3.number()).nullish(),
+      confidenceScores: z3.array(z3.number()).nullish(),
+      confidenceScore: z3.array(z3.number()).nullish()
+    })
+  ).nullish(),
+  retrievalMetadata: z3.union([
+    z3.object({
+      webDynamicRetrievalScore: z3.number()
+    }),
+    z3.object({})
+  ]).nullish()
+});
+var googleSearch = createProviderDefinedToolFactory({
+  id: "google.google_search",
+  name: "google_search",
+  inputSchema: z3.object({
+    mode: z3.enum(["MODE_DYNAMIC", "MODE_UNSPECIFIED"]).default("MODE_UNSPECIFIED"),
+    dynamicThreshold: z3.number().default(1)
+  })
+});
+
+// src/tool/url-context.ts
+import { createProviderDefinedToolFactory as createProviderDefinedToolFactory2 } from "@ai-sdk/provider-utils";
+import { z as z4 } from "zod/v4";
+var urlMetadataSchema = z4.object({
+  retrievedUrl: z4.string(),
+  urlRetrievalStatus: z4.string()
+});
+var urlContextMetadataSchema = z4.object({
+  urlMetadata: z4.array(urlMetadataSchema)
+});
+var urlContext = createProviderDefinedToolFactory2({
+  id: "google.url_context",
+  name: "url_context",
+  inputSchema: z4.object({})
+});
+
 // src/google-generative-ai-language-model.ts
 var GoogleGenerativeAILanguageModel = class {
   constructor(modelId, config) {
     this.specificationVersion = "v2";
+    var _a;
     this.modelId = modelId;
     this.config = config;
+    this.generateId = (_a = config.generateId) != null ? _a : generateId;
   }
   get provider() {
     return this.config.provider;
@@ -477,7 +559,7 @@ var GoogleGenerativeAILanguageModel = class {
     toolChoice,
     providerOptions
   }) {
-    var _a, _b, _c;
+    var _a, _b;
     const warnings = [];
     const googleOptions = await parseProviderOptions({
       provider: "google",
@@ -496,14 +578,12 @@ var GoogleGenerativeAILanguageModel = class {
       { isGemmaModel }
     );
     const {
-      tools: googleTools,
+      tools: googleTools2,
       toolConfig: googleToolConfig,
       toolWarnings
     } = prepareTools({
       tools,
       toolChoice,
-      useSearchGrounding: (_b = googleOptions == null ? void 0 : googleOptions.useSearchGrounding) != null ? _b : false,
-      dynamicRetrievalConfig: googleOptions == null ? void 0 : googleOptions.dynamicRetrievalConfig,
       modelId: this.modelId
     });
     return {
@@ -523,7 +603,7 @@ var GoogleGenerativeAILanguageModel = class {
           responseSchema: (responseFormat == null ? void 0 : responseFormat.type) === "json" && responseFormat.schema != null && // Google GenAI does not support all OpenAPI Schema features,
           // so this is needed as an escape hatch:
           // TODO convert into provider option
-          ((_c = googleOptions == null ? void 0 : googleOptions.structuredOutputs) != null ? _c : true) ? convertJSONSchemaToOpenAPISchema(responseFormat.schema) : void 0,
+          ((_b = googleOptions == null ? void 0 : googleOptions.structuredOutputs) != null ? _b : true) ? convertJSONSchemaToOpenAPISchema(responseFormat.schema) : void 0,
           ...(googleOptions == null ? void 0 : googleOptions.audioTimestamp) && {
             audioTimestamp: googleOptions.audioTimestamp
           },
@@ -534,7 +614,7 @@ var GoogleGenerativeAILanguageModel = class {
         contents,
         systemInstruction: isGemmaModel ? void 0 : systemInstruction,
         safetySettings: googleOptions == null ? void 0 : googleOptions.safetySettings,
-        tools: googleTools,
+        tools: googleTools2,
         toolConfig: googleToolConfig,
         cachedContent: googleOptions == null ? void 0 : googleOptions.cachedContent
       },
@@ -542,7 +622,7 @@ var GoogleGenerativeAILanguageModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
     const { args, warnings } = await this.getArgs(options);
     const body = JSON.stringify(args);
     const mergedHeaders = combineHeaders(
@@ -614,7 +694,9 @@ var GoogleGenerativeAILanguageModel = class {
       providerMetadata: {
         google: {
           groundingMetadata: (_h = candidate.groundingMetadata) != null ? _h : null,
-          safetyRatings: (_i = candidate.safetyRatings) != null ? _i : null
+          urlContextMetadata: (_i = candidate.urlContextMetadata) != null ? _i : null,
+          safetyRatings: (_j = candidate.safetyRatings) != null ? _j : null,
+          usageMetadata: usageMetadata != null ? usageMetadata : null
         }
       },
       request: { body },
@@ -650,7 +732,7 @@ var GoogleGenerativeAILanguageModel = class {
       totalTokens: void 0
     };
     let providerMetadata = void 0;
-    const generateId = this.config.generateId;
+    const generateId2 = this.config.generateId;
     let hasToolCalls = false;
     let currentTextBlockId = null;
     let currentReasoningBlockId = null;
@@ -662,7 +744,7 @@ var GoogleGenerativeAILanguageModel = class {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -743,7 +825,7 @@ var GoogleGenerativeAILanguageModel = class {
               }
               const toolCallDeltas = getToolCallsFromParts({
                 parts: content.parts,
-                generateId
+                generateId: generateId2
               });
               if (toolCallDeltas != null) {
                 for (const toolCall of toolCallDeltas) {
@@ -778,7 +860,7 @@ var GoogleGenerativeAILanguageModel = class {
               });
               const sources = (_h = extractSources({
                 groundingMetadata: candidate.groundingMetadata,
-                generateId
+                generateId: generateId2
               })) != null ? _h : [];
               for (const source of sources) {
                 controller.enqueue(source);
@@ -786,9 +868,13 @@ var GoogleGenerativeAILanguageModel = class {
               providerMetadata = {
                 google: {
                   groundingMetadata: (_i = candidate.groundingMetadata) != null ? _i : null,
-                  safetyRatings: (_j = candidate.safetyRatings) != null ? _j : null
+                  urlContextMetadata: (_j = candidate.urlContextMetadata) != null ? _j : null,
+                  safetyRatings: (_k = candidate.safetyRatings) != null ? _k : null
                 }
               };
+              if (usageMetadata != null) {
+                providerMetadata.google.usageMetadata = usageMetadata;
+              }
             }
           },
           flush(controller) {
@@ -820,14 +906,14 @@ var GoogleGenerativeAILanguageModel = class {
 };
 function getToolCallsFromParts({
   parts,
-  generateId
+  generateId: generateId2
 }) {
   const functionCallParts = parts == null ? void 0 : parts.filter(
     (part) => "functionCall" in part
   );
   return functionCallParts == null || functionCallParts.length === 0 ? void 0 : functionCallParts.map((part) => ({
     type: "tool-call",
-    toolCallId: generateId(),
+    toolCallId: generateId2(),
     toolName: part.functionCall.name,
     args: JSON.stringify(part.functionCall.args)
   }));
@@ -839,7 +925,7 @@ function getInlineDataParts(parts) {
 }
 function extractSources({
   groundingMetadata,
-  generateId
+  generateId: generateId2
 }) {
   var _a;
   return (_a = groundingMetadata == null ? void 0 : groundingMetadata.groundingChunks) == null ? void 0 : _a.filter(
@@ -847,104 +933,90 @@ function extractSources({
   ).map((chunk) => ({
     type: "source",
     sourceType: "url",
-    id: generateId(),
+    id: generateId2(),
     url: chunk.web.uri,
     title: chunk.web.title
   }));
 }
-var contentSchema = z3.object({
-  parts: z3.array(
-    z3.union([
+var contentSchema = z5.object({
+  parts: z5.array(
+    z5.union([
       // note: order matters since text can be fully empty
-      z3.object({
-        functionCall: z3.object({
-          name: z3.string(),
-          args: z3.unknown()
+      z5.object({
+        functionCall: z5.object({
+          name: z5.string(),
+          args: z5.unknown()
         })
       }),
-      z3.object({
-        inlineData: z3.object({
-          mimeType: z3.string(),
-          data: z3.string()
+      z5.object({
+        inlineData: z5.object({
+          mimeType: z5.string(),
+          data: z5.string()
         })
       }),
-      z3.object({
-        text: z3.string().nullish(),
-        thought: z3.boolean().nullish()
+      z5.object({
+        text: z5.string().nullish(),
+        thought: z5.boolean().nullish()
       })
     ])
   ).nullish()
 });
-var groundingChunkSchema = z3.object({
-  web: z3.object({ uri: z3.string(), title: z3.string() }).nullish(),
-  retrievedContext: z3.object({ uri: z3.string(), title: z3.string() }).nullish()
+var safetyRatingSchema = z5.object({
+  category: z5.string().nullish(),
+  probability: z5.string().nullish(),
+  probabilityScore: z5.number().nullish(),
+  severity: z5.string().nullish(),
+  severityScore: z5.number().nullish(),
+  blocked: z5.boolean().nullish()
 });
-var groundingMetadataSchema = z3.object({
-  webSearchQueries: z3.array(z3.string()).nullish(),
-  retrievalQueries: z3.array(z3.string()).nullish(),
-  searchEntryPoint: z3.object({ renderedContent: z3.string() }).nullish(),
-  groundingChunks: z3.array(groundingChunkSchema).nullish(),
-  groundingSupports: z3.array(
-    z3.object({
-      segment: z3.object({
-        startIndex: z3.number().nullish(),
-        endIndex: z3.number().nullish(),
-        text: z3.string().nullish()
-      }),
-      segment_text: z3.string().nullish(),
-      groundingChunkIndices: z3.array(z3.number()).nullish(),
-      supportChunkIndices: z3.array(z3.number()).nullish(),
-      confidenceScores: z3.array(z3.number()).nullish(),
-      confidenceScore: z3.array(z3.number()).nullish()
-    })
-  ).nullish(),
-  retrievalMetadata: z3.union([
-    z3.object({
-      webDynamicRetrievalScore: z3.number()
-    }),
-    z3.object({})
-  ]).nullish()
-});
-var safetyRatingSchema = z3.object({
-  category: z3.string().nullish(),
-  probability: z3.string().nullish(),
-  probabilityScore: z3.number().nullish(),
-  severity: z3.string().nullish(),
-  severityScore: z3.number().nullish(),
-  blocked: z3.boolean().nullish()
+var usageSchema = z5.object({
+  cachedContentTokenCount: z5.number().nullish(),
+  thoughtsTokenCount: z5.number().nullish(),
+  promptTokenCount: z5.number().nullish(),
+  candidatesTokenCount: z5.number().nullish(),
+  totalTokenCount: z5.number().nullish()
 });
-var usageSchema = z3.object({
-  cachedContentTokenCount: z3.number().nullish(),
-  thoughtsTokenCount: z3.number().nullish(),
-  promptTokenCount: z3.number().nullish(),
-  candidatesTokenCount: z3.number().nullish(),
-  totalTokenCount: z3.number().nullish()
-});
-var responseSchema = z3.object({
-  candidates: z3.array(
-    z3.object({
-      content: contentSchema.nullish().or(z3.object({}).strict()),
-      finishReason: z3.string().nullish(),
-      safetyRatings: z3.array(safetyRatingSchema).nullish(),
-      groundingMetadata: groundingMetadataSchema.nullish()
+var responseSchema = z5.object({
+  candidates: z5.array(
+    z5.object({
+      content: contentSchema.nullish().or(z5.object({}).strict()),
+      finishReason: z5.string().nullish(),
+      safetyRatings: z5.array(safetyRatingSchema).nullish(),
+      groundingMetadata: groundingMetadataSchema.nullish(),
+      urlContextMetadata: urlContextMetadataSchema.nullish()
     })
   ),
   usageMetadata: usageSchema.nullish()
 });
-var chunkSchema = z3.object({
-  candidates: z3.array(
-    z3.object({
+var chunkSchema = z5.object({
+  candidates: z5.array(
+    z5.object({
       content: contentSchema.nullish(),
-      finishReason: z3.string().nullish(),
-      safetyRatings: z3.array(safetyRatingSchema).nullish(),
-      groundingMetadata: groundingMetadataSchema.nullish()
+      finishReason: z5.string().nullish(),
+      safetyRatings: z5.array(safetyRatingSchema).nullish(),
+      groundingMetadata: groundingMetadataSchema.nullish(),
+      urlContextMetadata: urlContextMetadataSchema.nullish()
     })
   ).nullish(),
   usageMetadata: usageSchema.nullish()
 });
+
+// src/google-tools.ts
+var googleTools = {
+  /**
+   * Creates a Google search tool that gives Google direct access to real-time web content.
+   * Must have name "google_search".
+   */
+  googleSearch,
+  /**
+   * Creates a URL context tool that gives Google direct access to real-time web content.
+   * Must have name "url_context".
+   */
+  urlContext
+};
 export {
   GoogleGenerativeAILanguageModel,
-  groundingMetadataSchema,
+  googleTools,
   safetyRatingSchema
 };
 //# sourceMappingURL=index.mjs.map