@ai-sdk/google 2.0.0-beta.16 → 2.0.0-beta.18

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @ai-sdk/google
 
+## 2.0.0-beta.18
+
+### Patch Changes
+
+- 78e7fa9: Add code execution provider defined tool
+- 0f05690: Add gemini-embedding-001 model, add embedding provider options type export
+- Updated dependencies [27deb4d]
+  - @ai-sdk/provider@2.0.0-beta.2
+  - @ai-sdk/provider-utils@3.0.0-beta.9
+
+## 2.0.0-beta.17
+
+### Patch Changes
+
+- eb173f1: chore (providers): remove model shorthand deprecation warnings
+- Updated dependencies [dd5fd43]
+  - @ai-sdk/provider-utils@3.0.0-beta.8
+
 ## 2.0.0-beta.16
 
 ### Patch Changes

package/dist/index.d.mts

@@ -136,7 +136,21 @@ declare const googleImageProviderOptionsSchema: z.ZodObject<{
 }, z.core.$strip>;
 type GoogleGenerativeAIImageProviderOptions = z.infer<typeof googleImageProviderOptionsSchema>;
 
-type GoogleGenerativeAIEmbeddingModelId = 'text-embedding-004' | (string & {});
+type GoogleGenerativeAIEmbeddingModelId = 'gemini-embedding-001' | 'text-embedding-004' | (string & {});
+declare const googleGenerativeAIEmbeddingProviderOptions: z.ZodObject<{
+    outputDimensionality: z.ZodOptional<z.ZodNumber>;
+    taskType: z.ZodOptional<z.ZodEnum<{
+        SEMANTIC_SIMILARITY: "SEMANTIC_SIMILARITY";
+        CLASSIFICATION: "CLASSIFICATION";
+        CLUSTERING: "CLUSTERING";
+        RETRIEVAL_DOCUMENT: "RETRIEVAL_DOCUMENT";
+        RETRIEVAL_QUERY: "RETRIEVAL_QUERY";
+        QUESTION_ANSWERING: "QUESTION_ANSWERING";
+        FACT_VERIFICATION: "FACT_VERIFICATION";
+        CODE_RETRIEVAL_QUERY: "CODE_RETRIEVAL_QUERY";
+    }>>;
+}, z.core.$strip>;
+type GoogleGenerativeAIEmbeddingProviderOptions = z.infer<typeof googleGenerativeAIEmbeddingProviderOptions>;
 
 declare const googleTools: {
     /**
@@ -152,6 +166,23 @@ declare const googleTools: {
      * Must have name "url_context".
      */
     urlContext: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {}>;
+    /**
+     * A tool that enables the model to generate and run Python code.
+     * Must have name "code_execution".
+     *
+     * @note Ensure the selected model supports Code Execution.
+     * Multi-tool usage with the code execution tool is typically compatible with Gemini >=2 models.
+     *
+     * @see https://ai.google.dev/gemini-api/docs/code-execution (Google AI)
+     * @see https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/code-execution-api (Vertex AI)
+     */
+    codeExecution: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+        language: string;
+        code: string;
+    }, {
+        outcome: string;
+        output: string;
+    }, {}>;
 };
 
 interface GoogleGenerativeAIProvider extends ProviderV2 {
@@ -167,12 +198,9 @@ interface GoogleGenerativeAIProvider extends ProviderV2 {
      */
     generativeAI(modelId: GoogleGenerativeAIModelId): LanguageModelV2;
     /**
-  @deprecated Use `textEmbeddingModel()` instead.
+  @deprecated Use `textEmbedding()` instead.
      */
     embedding(modelId: GoogleGenerativeAIEmbeddingModelId): EmbeddingModelV2<string>;
-    /**
-  @deprecated Use `textEmbeddingModel()` instead.
-   */
     textEmbedding(modelId: GoogleGenerativeAIEmbeddingModelId): EmbeddingModelV2<string>;
     textEmbeddingModel(modelId: GoogleGenerativeAIEmbeddingModelId): EmbeddingModelV2<string>;
     tools: typeof googleTools;
@@ -211,4 +239,4 @@ Default Google Generative AI provider instance.
  */
 declare const google: GoogleGenerativeAIProvider;
 
-export { type GoogleErrorData, type GoogleGenerativeAIImageProviderOptions, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderMetadata, type GoogleGenerativeAIProviderOptions, type GoogleGenerativeAIProviderSettings, createGoogleGenerativeAI, google };
+export { type GoogleErrorData, type GoogleGenerativeAIEmbeddingProviderOptions, type GoogleGenerativeAIImageProviderOptions, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderMetadata, type GoogleGenerativeAIProviderOptions, type GoogleGenerativeAIProviderSettings, createGoogleGenerativeAI, google };

package/dist/index.d.ts

@@ -136,7 +136,21 @@ declare const googleImageProviderOptionsSchema: z.ZodObject<{
 }, z.core.$strip>;
 type GoogleGenerativeAIImageProviderOptions = z.infer<typeof googleImageProviderOptionsSchema>;
 
-type GoogleGenerativeAIEmbeddingModelId = 'text-embedding-004' | (string & {});
+type GoogleGenerativeAIEmbeddingModelId = 'gemini-embedding-001' | 'text-embedding-004' | (string & {});
+declare const googleGenerativeAIEmbeddingProviderOptions: z.ZodObject<{
+    outputDimensionality: z.ZodOptional<z.ZodNumber>;
+    taskType: z.ZodOptional<z.ZodEnum<{
+        SEMANTIC_SIMILARITY: "SEMANTIC_SIMILARITY";
+        CLASSIFICATION: "CLASSIFICATION";
+        CLUSTERING: "CLUSTERING";
+        RETRIEVAL_DOCUMENT: "RETRIEVAL_DOCUMENT";
+        RETRIEVAL_QUERY: "RETRIEVAL_QUERY";
+        QUESTION_ANSWERING: "QUESTION_ANSWERING";
+        FACT_VERIFICATION: "FACT_VERIFICATION";
+        CODE_RETRIEVAL_QUERY: "CODE_RETRIEVAL_QUERY";
+    }>>;
+}, z.core.$strip>;
+type GoogleGenerativeAIEmbeddingProviderOptions = z.infer<typeof googleGenerativeAIEmbeddingProviderOptions>;
 
 declare const googleTools: {
     /**
@@ -152,6 +166,23 @@ declare const googleTools: {
      * Must have name "url_context".
      */
     urlContext: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{}, {}>;
+    /**
+     * A tool that enables the model to generate and run Python code.
+     * Must have name "code_execution".
+     *
+     * @note Ensure the selected model supports Code Execution.
+     * Multi-tool usage with the code execution tool is typically compatible with Gemini >=2 models.
+     *
+     * @see https://ai.google.dev/gemini-api/docs/code-execution (Google AI)
+     * @see https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/code-execution-api (Vertex AI)
+     */
+    codeExecution: _ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+        language: string;
+        code: string;
+    }, {
+        outcome: string;
+        output: string;
+    }, {}>;
 };
 
 interface GoogleGenerativeAIProvider extends ProviderV2 {
@@ -167,12 +198,9 @@ interface GoogleGenerativeAIProvider extends ProviderV2 {
      */
     generativeAI(modelId: GoogleGenerativeAIModelId): LanguageModelV2;
     /**
-  @deprecated Use `textEmbeddingModel()` instead.
+  @deprecated Use `textEmbedding()` instead.
      */
     embedding(modelId: GoogleGenerativeAIEmbeddingModelId): EmbeddingModelV2<string>;
-    /**
-  @deprecated Use `textEmbeddingModel()` instead.
-   */
     textEmbedding(modelId: GoogleGenerativeAIEmbeddingModelId): EmbeddingModelV2<string>;
     textEmbeddingModel(modelId: GoogleGenerativeAIEmbeddingModelId): EmbeddingModelV2<string>;
     tools: typeof googleTools;
@@ -211,4 +239,4 @@ Default Google Generative AI provider instance.
  */
 declare const google: GoogleGenerativeAIProvider;
 
-export { type GoogleErrorData, type GoogleGenerativeAIImageProviderOptions, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderMetadata, type GoogleGenerativeAIProviderOptions, type GoogleGenerativeAIProviderSettings, createGoogleGenerativeAI, google };
+export { type GoogleErrorData, type GoogleGenerativeAIEmbeddingProviderOptions, type GoogleGenerativeAIImageProviderOptions, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderMetadata, type GoogleGenerativeAIProviderOptions, type GoogleGenerativeAIProviderSettings, createGoogleGenerativeAI, google };

package/dist/index.js

@@ -26,7 +26,7 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/google-provider.ts
-var import_provider_utils8 = require("@ai-sdk/provider-utils");
+var import_provider_utils9 = require("@ai-sdk/provider-utils");
 
 // src/google-generative-ai-embedding-model.ts
 var import_provider = require("@ai-sdk/provider");
@@ -525,6 +525,17 @@ function prepareTools({
             });
           }
           break;
+        case "google.code_execution":
+          if (isGemini2) {
+            googleTools2.codeExecution = {};
+          } else {
+            toolWarnings.push({
+              type: "unsupported-tool",
+              tool,
+              details: "The code execution tools is not supported with other Gemini models than Gemini 2."
+            });
+          }
+          break;
         default:
           toolWarnings.push({ type: "unsupported-tool", tool });
           break;
@@ -777,7 +788,7 @@ var GoogleGenerativeAILanguageModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
     const { args, warnings } = await this.getArgs(options);
     const body = JSON.stringify(args);
     const mergedHeaders = (0, import_provider_utils6.combineHeaders)(
@@ -801,10 +812,34 @@ var GoogleGenerativeAILanguageModel = class {
     });
     const candidate = response.candidates[0];
     const content = [];
-    const parts = candidate.content == null || typeof candidate.content !== "object" || !("parts" in candidate.content) ? [] : (_a = candidate.content.parts) != null ? _a : [];
+    const parts = (_b = (_a = candidate.content) == null ? void 0 : _a.parts) != null ? _b : [];
     const usageMetadata = response.usageMetadata;
+    let lastCodeExecutionToolCallId;
     for (const part of parts) {
-      if ("text" in part && part.text != null && part.text.length > 0) {
+      if ("executableCode" in part && ((_c = part.executableCode) == null ? void 0 : _c.code)) {
+        const toolCallId = this.config.generateId();
+        lastCodeExecutionToolCallId = toolCallId;
+        content.push({
+          type: "tool-call",
+          toolCallId,
+          toolName: "code_execution",
+          input: JSON.stringify(part.executableCode),
+          providerExecuted: true
+        });
+      } else if ("codeExecutionResult" in part && part.codeExecutionResult) {
+        content.push({
+          type: "tool-result",
+          // Assumes a result directly follows its corresponding call part.
+          toolCallId: lastCodeExecutionToolCallId,
+          toolName: "code_execution",
+          result: {
+            outcome: part.codeExecutionResult.outcome,
+            output: part.codeExecutionResult.output
+          },
+          providerExecuted: true
+        });
+        lastCodeExecutionToolCallId = void 0;
+      } else if ("text" in part && part.text != null && part.text.length > 0) {
         if (part.thought === true) {
           content.push({ type: "reasoning", text: part.text });
         } else {
@@ -825,10 +860,10 @@ var GoogleGenerativeAILanguageModel = class {
         });
       }
     }
-    const sources = (_b = extractSources({
+    const sources = (_d = extractSources({
       groundingMetadata: candidate.groundingMetadata,
       generateId: this.config.generateId
-    })) != null ? _b : [];
+    })) != null ? _d : [];
     for (const source of sources) {
       content.push(source);
     }
@@ -839,18 +874,18 @@ var GoogleGenerativeAILanguageModel = class {
         hasToolCalls: content.some((part) => part.type === "tool-call")
       }),
       usage: {
-        inputTokens: (_c = usageMetadata == null ? void 0 : usageMetadata.promptTokenCount) != null ? _c : void 0,
-        outputTokens: (_d = usageMetadata == null ? void 0 : usageMetadata.candidatesTokenCount) != null ? _d : void 0,
-        totalTokens: (_e = usageMetadata == null ? void 0 : usageMetadata.totalTokenCount) != null ? _e : void 0,
-        reasoningTokens: (_f = usageMetadata == null ? void 0 : usageMetadata.thoughtsTokenCount) != null ? _f : void 0,
-        cachedInputTokens: (_g = usageMetadata == null ? void 0 : usageMetadata.cachedContentTokenCount) != null ? _g : void 0
+        inputTokens: (_e = usageMetadata == null ? void 0 : usageMetadata.promptTokenCount) != null ? _e : void 0,
+        outputTokens: (_f = usageMetadata == null ? void 0 : usageMetadata.candidatesTokenCount) != null ? _f : void 0,
+        totalTokens: (_g = usageMetadata == null ? void 0 : usageMetadata.totalTokenCount) != null ? _g : void 0,
+        reasoningTokens: (_h = usageMetadata == null ? void 0 : usageMetadata.thoughtsTokenCount) != null ? _h : void 0,
+        cachedInputTokens: (_i = usageMetadata == null ? void 0 : usageMetadata.cachedContentTokenCount) != null ? _i : void 0
       },
       warnings,
       providerMetadata: {
         google: {
-          groundingMetadata: (_h = candidate.groundingMetadata) != null ? _h : null,
-          urlContextMetadata: (_i = candidate.urlContextMetadata) != null ? _i : null,
-          safetyRatings: (_j = candidate.safetyRatings) != null ? _j : null,
+          groundingMetadata: (_j = candidate.groundingMetadata) != null ? _j : null,
+          urlContextMetadata: (_k = candidate.urlContextMetadata) != null ? _k : null,
+          safetyRatings: (_l = candidate.safetyRatings) != null ? _l : null,
           usageMetadata: usageMetadata != null ? usageMetadata : null
         }
       },
@@ -893,6 +928,7 @@ var GoogleGenerativeAILanguageModel = class {
     let currentReasoningBlockId = null;
     let blockCounter = 0;
     const emittedSourceUrls = /* @__PURE__ */ new Set();
+    let lastCodeExecutionToolCallId;
     return {
       stream: response.pipeThrough(
         new TransformStream({
@@ -900,7 +936,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 });
             }
@@ -937,7 +973,33 @@ var GoogleGenerativeAILanguageModel = class {
             if (content != null) {
               const parts = (_g = content.parts) != null ? _g : [];
               for (const part of parts) {
-                if ("text" in part && part.text != null && part.text.length > 0) {
+                if ("executableCode" in part && ((_h = part.executableCode) == null ? void 0 : _h.code)) {
+                  const toolCallId = generateId3();
+                  lastCodeExecutionToolCallId = toolCallId;
+                  controller.enqueue({
+                    type: "tool-call",
+                    toolCallId,
+                    toolName: "code_execution",
+                    input: JSON.stringify(part.executableCode),
+                    providerExecuted: true
+                  });
+                  hasToolCalls = true;
+                } else if ("codeExecutionResult" in part && part.codeExecutionResult) {
+                  const toolCallId = lastCodeExecutionToolCallId;
+                  if (toolCallId) {
+                    controller.enqueue({
+                      type: "tool-result",
+                      toolCallId,
+                      toolName: "code_execution",
+                      result: {
+                        outcome: part.codeExecutionResult.outcome,
+                        output: part.codeExecutionResult.output
+                      },
+                      providerExecuted: true
+                    });
+                    lastCodeExecutionToolCallId = void 0;
+                  }
+                } else if ("text" in part && part.text != null && part.text.length > 0) {
                   if (part.thought === true) {
                     if (currentTextBlockId !== null) {
                       controller.enqueue({
@@ -1028,9 +1090,9 @@ var GoogleGenerativeAILanguageModel = class {
               });
               providerMetadata = {
                 google: {
-                  groundingMetadata: (_h = candidate.groundingMetadata) != null ? _h : null,
-                  urlContextMetadata: (_i = candidate.urlContextMetadata) != null ? _i : null,
-                  safetyRatings: (_j = candidate.safetyRatings) != null ? _j : null
+                  groundingMetadata: (_i = candidate.groundingMetadata) != null ? _i : null,
+                  urlContextMetadata: (_j = candidate.urlContextMetadata) != null ? _j : null,
+                  safetyRatings: (_k = candidate.safetyRatings) != null ? _k : null
                 }
               };
               if (usageMetadata != null) {
@@ -1116,6 +1178,14 @@ var contentSchema = import_v47.z.object({
         })
       }),
       import_v47.z.object({
+        executableCode: import_v47.z.object({
+          language: import_v47.z.string(),
+          code: import_v47.z.string()
+        }).nullish(),
+        codeExecutionResult: import_v47.z.object({
+          outcome: import_v47.z.string(),
+          output: import_v47.z.string()
+        }).nullish(),
         text: import_v47.z.string().nullish(),
         thought: import_v47.z.boolean().nullish()
       })
@@ -1162,6 +1232,22 @@ var chunkSchema = import_v47.z.object({
   usageMetadata: usageSchema.nullish()
 });
 
+// src/tool/code-execution.ts
+var import_provider_utils7 = require("@ai-sdk/provider-utils");
+var import_v48 = require("zod/v4");
+var codeExecution = (0, import_provider_utils7.createProviderDefinedToolFactoryWithOutputSchema)({
+  id: "google.code_execution",
+  name: "code_execution",
+  inputSchema: import_v48.z.object({
+    language: import_v48.z.string().describe("The programming language of the code."),
+    code: import_v48.z.string().describe("The code to be executed.")
+  }),
+  outputSchema: import_v48.z.object({
+    outcome: import_v48.z.string().describe('The outcome of the execution (e.g., "OUTCOME_OK").'),
+    output: import_v48.z.string().describe("The output from the code execution.")
+  })
+});
+
 // src/google-tools.ts
 var googleTools = {
   /**
@@ -1173,12 +1259,23 @@ var googleTools = {
    * Creates a URL context tool that gives Google direct access to real-time web content.
    * Must have name "url_context".
    */
-  urlContext
+  urlContext,
+  /**
+   * A tool that enables the model to generate and run Python code.
+   * Must have name "code_execution".
+   *
+   * @note Ensure the selected model supports Code Execution.
+   * Multi-tool usage with the code execution tool is typically compatible with Gemini >=2 models.
+   *
+   * @see https://ai.google.dev/gemini-api/docs/code-execution (Google AI)
+   * @see https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/code-execution-api (Vertex AI)
+   */
+  codeExecution
 };
 
 // src/google-generative-ai-image-model.ts
-var import_provider_utils7 = require("@ai-sdk/provider-utils");
-var import_v48 = require("zod/v4");
+var import_provider_utils8 = require("@ai-sdk/provider-utils");
+var import_v49 = require("zod/v4");
 var GoogleGenerativeAIImageModel = class {
   constructor(modelId, settings, config) {
     this.modelId = modelId;
@@ -1220,7 +1317,7 @@ var GoogleGenerativeAIImageModel = class {
         details: "This model does not support the `seed` option through this provider."
       });
     }
-    const googleOptions = await (0, import_provider_utils7.parseProviderOptions)({
+    const googleOptions = await (0, import_provider_utils8.parseProviderOptions)({
       provider: "google",
       providerOptions,
       schema: googleImageProviderOptionsSchema
@@ -1239,12 +1336,12 @@ var GoogleGenerativeAIImageModel = class {
       instances: [{ prompt }],
       parameters
     };
-    const { responseHeaders, value: response } = await (0, import_provider_utils7.postJsonToApi)({
+    const { responseHeaders, value: response } = await (0, import_provider_utils8.postJsonToApi)({
       url: `${this.config.baseURL}/models/${this.modelId}:predict`,
-      headers: (0, import_provider_utils7.combineHeaders)(await (0, import_provider_utils7.resolve)(this.config.headers), headers),
+      headers: (0, import_provider_utils8.combineHeaders)(await (0, import_provider_utils8.resolve)(this.config.headers), headers),
       body,
       failedResponseHandler: googleFailedResponseHandler,
-      successfulResponseHandler: (0, import_provider_utils7.createJsonResponseHandler)(
+      successfulResponseHandler: (0, import_provider_utils8.createJsonResponseHandler)(
         googleImageResponseSchema
       ),
       abortSignal,
@@ -1270,20 +1367,20 @@ var GoogleGenerativeAIImageModel = class {
     };
   }
 };
-var googleImageResponseSchema = import_v48.z.object({
-  predictions: import_v48.z.array(import_v48.z.object({ bytesBase64Encoded: import_v48.z.string() })).default([])
+var googleImageResponseSchema = import_v49.z.object({
+  predictions: import_v49.z.array(import_v49.z.object({ bytesBase64Encoded: import_v49.z.string() })).default([])
 });
-var googleImageProviderOptionsSchema = import_v48.z.object({
-  personGeneration: import_v48.z.enum(["dont_allow", "allow_adult", "allow_all"]).nullish(),
-  aspectRatio: import_v48.z.enum(["1:1", "3:4", "4:3", "9:16", "16:9"]).nullish()
+var googleImageProviderOptionsSchema = import_v49.z.object({
+  personGeneration: import_v49.z.enum(["dont_allow", "allow_adult", "allow_all"]).nullish(),
+  aspectRatio: import_v49.z.enum(["1:1", "3:4", "4:3", "9:16", "16:9"]).nullish()
 });
 
 // src/google-provider.ts
 function createGoogleGenerativeAI(options = {}) {
   var _a;
-  const baseURL = (_a = (0, import_provider_utils8.withoutTrailingSlash)(options.baseURL)) != null ? _a : "https://generativelanguage.googleapis.com/v1beta";
+  const baseURL = (_a = (0, import_provider_utils9.withoutTrailingSlash)(options.baseURL)) != null ? _a : "https://generativelanguage.googleapis.com/v1beta";
   const getHeaders = () => ({
-    "x-goog-api-key": (0, import_provider_utils8.loadApiKey)({
+    "x-goog-api-key": (0, import_provider_utils9.loadApiKey)({
       apiKey: options.apiKey,
       environmentVariableName: "GOOGLE_GENERATIVE_AI_API_KEY",
       description: "Google Generative AI"
@@ -1296,7 +1393,7 @@ function createGoogleGenerativeAI(options = {}) {
       provider: "google.generative-ai",
       baseURL,
       headers: getHeaders,
-      generateId: (_a2 = options.generateId) != null ? _a2 : import_provider_utils8.generateId,
+      generateId: (_a2 = options.generateId) != null ? _a2 : import_provider_utils9.generateId,
       supportedUrls: () => ({
         "*": [
           // Only allow requests to the Google Generative Language "files" endpoint