@ai-sdk/google 4.0.63 → 4.0.65

package/docs/15-google.mdx

@@ -1081,27 +1081,37 @@ import { google } from '@ai-sdk/google';
 import {
   experimental_getBatchResults as getBatchResults,
   experimental_getBatchStatus as getBatchStatus,
-  experimental_startTextBatch as startTextBatch,
+  experimental_startBatch as startBatch,
 } from 'ai';
 import { setTimeout } from 'node:timers/promises';
 
-const model = google('gemini-3.6-flash');
+const model = 'gemini-3.6-flash';
 
-const batch = await startTextBatch({
-  model,
+const batch = await startBatch({
+  provider: google,
   requests: [
-    { id: 'capital-france', prompt: 'What is the capital of France?' },
-    { id: 'capital-germany', prompt: 'What is the capital of Germany?' },
+    {
+      id: 'capital-france',
+      type: 'text',
+      model,
+      prompt: 'What is the capital of France?',
+    },
+    {
+      id: 'capital-germany',
+      type: 'text',
+      model,
+      prompt: 'What is the capital of Germany?',
+    },
   ],
 });
 
 let status = batch.status;
 while (status === 'pending') {
   await setTimeout(60_000);
-  ({ status } = await getBatchStatus({ model, batch }));
+  ({ status } = await getBatchStatus({ provider: google, batch }));
 }
 
-for await (const item of getBatchResults({ model, batch })) {
+for await (const item of getBatchResults({ provider: google, batch })) {
   if (item.status === 'succeeded') {
     console.log(item.id, item.text);
   } else {
@@ -1110,21 +1120,35 @@ for await (const item of getBatchResults({ model, batch })) {
 }
 ```
 
-`startTextBatch` returns a serializable batch reference. Persist this reference
+`startBatch` returns a serializable batch reference. Persist this reference
 to check the batch status or retrieve its results from another process. Results
 can arrive in a different order from the input requests, so match each result by
 its `id`.
 
+Each request specifies its `type` and `model`. Google requires every text
+request in a batch to use the same model and throws before submission when the
+models differ.
+
 #### Webhooks
 
 You can pass a `webhookUrl` to receive a notification when the batch reaches a terminal state:
 
 ```ts
-const batch = await startTextBatch({
-  model,
+const batch = await startBatch({
+  provider: google,
   requests: [
-    { id: 'capital-france', prompt: 'What is the capital of France?' },
-    { id: 'capital-germany', prompt: 'What is the capital of Germany?' },
+    {
+      id: 'capital-france',
+      type: 'text',
+      model,
+      prompt: 'What is the capital of France?',
+    },
+    {
+      id: 'capital-germany',
+      type: 'text',
+      model,
+      prompt: 'What is the capital of Germany?',
+    },
   ],
   webhookUrl: 'https://example.com/api/google-batch-webhook',
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/google",
-  "version": "4.0.63",
+  "version": "4.0.65",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -35,8 +35,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "4.0.10",
-    "@ai-sdk/provider-utils": "5.0.36"
+    "@ai-sdk/provider": "4.0.11",
+    "@ai-sdk/provider-utils": "5.0.37"
   },
   "devDependencies": {
     "@ai-sdk/test-server": "2.0.1",

package/src/convert-json-schema-to-openapi-schema.ts

@@ -91,6 +91,8 @@ function convertJSONSchemaDefinition(
     format,
     const: constValue,
     minLength,
+    minItems,
+    maxItems,
     enum: enumValues,
   } = jsonSchema;
 
@@ -196,6 +198,14 @@ function convertJSONSchemaDefinition(
     result.minLength = minLength;
   }
 
+  if (minItems !== undefined) {
+    result.minItems = minItems;
+  }
+
+  if (maxItems !== undefined) {
+    result.maxItems = maxItems;
+  }
+
   return result;
 }
 

package/src/google-batch.ts

@@ -1,13 +1,14 @@
 import {
   InvalidArgumentError,
   InvalidResponseDataError,
-  type Experimental_BatchLanguageModelV4 as BatchLanguageModelV4,
+  type Experimental_BatchV4 as BatchV4,
   type Experimental_BatchV4Error as BatchV4Error,
   type Experimental_BatchV4ItemResult as BatchV4ItemResult,
   type Experimental_BatchV4OperationOptions as BatchV4OperationOptions,
-  type Experimental_BatchV4StartOptions as BatchV4StartOptions,
   type Experimental_BatchV4StartResult as BatchV4StartResult,
   type Experimental_BatchV4Status as BatchV4Status,
+  type Experimental_TextBatchV4Request as TextBatchV4Request,
+  type Experimental_BatchV4StartOptions as BatchV4StartOptions,
   type LanguageModelV4GenerateResult,
 } from '@ai-sdk/provider';
 import {
@@ -23,8 +24,6 @@ import {
   postToApi,
   resolve,
   safeValidateTypes,
-  WORKFLOW_DESERIALIZE,
-  WORKFLOW_SERIALIZE,
   zodSchema,
   type InferSchema,
   type ResponseHandler,
@@ -45,9 +44,7 @@ const supportedGoogleBatchContentTypes = new Set<
   LanguageModelV4GenerateResult['content'][number]['type']
 >(['text', 'reasoning', 'source', 'tool-call', 'tool-result']);
 
-type GoogleBatchRequest = Parameters<
-  BatchLanguageModelV4['experimental_doStartBatch']
->[0]['requests'][number];
+type GoogleBatchRequest = TextBatchV4Request<GoogleModelId>;
 
 const googleRpcStatusSchema = z.object({
   code: z.union([z.number(), z.string()]).nullish(),
@@ -136,33 +133,28 @@ const googleBatchResponsePreviewSchema = lazySchema(() =>
   ),
 );
 
-export class GoogleBatchLanguageModel
-  extends GoogleLanguageModel
-  implements BatchLanguageModelV4
-{
+export class GoogleBatch implements BatchV4<{ readonly text: GoogleModelId }> {
+  readonly specificationVersion = 'v4' as const;
+  readonly provider: string;
+  readonly supportedUrls: Record<string, RegExp[]>;
   private readonly batchConfig: GoogleLanguageModelConfig;
   private readonly batchGenerateId: () => string;
 
-  static [WORKFLOW_SERIALIZE](model: GoogleLanguageModel) {
-    return GoogleLanguageModel[WORKFLOW_SERIALIZE](model);
-  }
-
-  static [WORKFLOW_DESERIALIZE](options: {
-    modelId: string;
+  constructor(options: {
+    provider: string;
     config: GoogleLanguageModelConfig;
+    supportedUrls: Record<string, RegExp[]>;
   }) {
-    return new GoogleBatchLanguageModel(options.modelId, options.config);
-  }
-
-  constructor(modelId: GoogleModelId, config: GoogleLanguageModelConfig) {
-    super(modelId, config);
-    this.batchConfig = config;
-    this.batchGenerateId = config.generateId ?? generateId;
+    this.provider = options.provider;
+    this.batchConfig = options.config;
+    this.supportedUrls = options.supportedUrls;
+    this.batchGenerateId = options.config.generateId ?? generateId;
   }
 
-  async experimental_doStartBatch(
-    options: BatchV4StartOptions<GoogleBatchRequest>,
+  async doStartBatch(
+    options: BatchV4StartOptions<{ text: GoogleModelId }>,
   ): Promise<BatchV4StartResult> {
+    const modelId = getGoogleBatchModelId(options.requests);
     const warnings: BatchV4StartResult['warnings'] = [];
     const displayName = `ai-sdk-batch-${this.batchGenerateId()}`;
     const inlinedRequests: Array<{
@@ -187,7 +179,11 @@ export class GoogleBatchLanguageModel
     let fileParts: string[] | undefined;
 
     for (const request of options.requests) {
-      const preparedRequest = await this.getArgs(request.options);
+      const preparedRequest = await GoogleLanguageModel.prepareRequest({
+        modelId: request.modelId,
+        config: this.batchConfig,
+        options: request.options,
+      });
       const inlinedRequest = {
         request: preparedRequest.args,
         metadata: { key: request.id },
@@ -242,7 +238,7 @@ export class GoogleBatchLanguageModel
 
     const headers = await this.getHeaders(options.headers);
     const createUrl = `${this.batchConfig.baseURL}/${getModelPath(
-      this.modelId,
+      modelId,
     )}:batchGenerateContent`;
 
     if (fileParts == null) {
@@ -353,15 +349,15 @@ export class GoogleBatchLanguageModel
     };
   }
 
-  async experimental_doGetBatchStatus(
+  async doGetBatchStatus(
     options: BatchV4OperationOptions,
   ): Promise<BatchV4Status> {
     return convertGoogleBatchStatus(await this.retrieveBatch(options));
   }
 
-  async experimental_doGetBatchResults(
+  async doGetBatchResults(
     options: BatchV4OperationOptions,
-  ): Promise<ReadableStream<BatchV4ItemResult<LanguageModelV4GenerateResult>>> {
+  ): Promise<ReadableStream<BatchV4ItemResult>> {
     const operation = await this.retrieveBatch(options);
     const batchStatus = convertGoogleBatchStatus(operation);
 
@@ -450,7 +446,7 @@ export class GoogleBatchLanguageModel
     results:
       | Iterable<GoogleBatchResultLine>
       | AsyncIterable<GoogleBatchResultLine>,
-  ): AsyncGenerator<BatchV4ItemResult<LanguageModelV4GenerateResult>> {
+  ): AsyncGenerator<BatchV4ItemResult> {
     for await (const line of results) {
       if (line.error != null) {
         const error = convertGoogleRpcError(
@@ -462,12 +458,13 @@ export class GoogleBatchLanguageModel
             ? 'cancelled'
             : 'failed';
 
-        yield { id: line.key, status, error };
+        yield { type: 'text', id: line.key, status, error };
         continue;
       }
 
       if (line.response == null) {
         yield {
+          type: 'text',
           id: line.key,
           status: 'failed',
           error: {
@@ -491,6 +488,7 @@ export class GoogleBatchLanguageModel
         const promptFeedback = preview.value.promptFeedback ?? undefined;
         const blockReason = promptFeedback?.blockReason ?? undefined;
         yield {
+          type: 'text',
           id: line.key,
           status: 'failed',
           error: {
@@ -522,6 +520,7 @@ export class GoogleBatchLanguageModel
       });
       if (!response.success) {
         yield {
+          type: 'text',
           id: line.key,
           status: 'failed',
           error: {
@@ -532,7 +531,8 @@ export class GoogleBatchLanguageModel
         continue;
       }
 
-      const result = this.convertGenerateContentResponse({
+      const result = GoogleLanguageModel.convertGenerateContentResponse({
+        config: this.batchConfig,
         response: response.value,
         warnings: [],
         providerOptionsNames: ['google'],
@@ -543,6 +543,7 @@ export class GoogleBatchLanguageModel
 
       if (unsupportedPart != null) {
         yield {
+          type: 'text',
           id: line.key,
           status: 'failed',
           error: {
@@ -555,7 +556,7 @@ export class GoogleBatchLanguageModel
         continue;
       }
 
-      yield { id: line.key, status: 'succeeded', result };
+      yield { type: 'text', id: line.key, status: 'succeeded', result };
     }
   }
 
@@ -680,3 +681,28 @@ const googleUploadUrlResponseHandler: ResponseHandler<string> = async ({
 
   return { value: uploadUrl };
 };
+
+function getGoogleBatchModelId(
+  requests: readonly GoogleBatchRequest[],
+): GoogleModelId {
+  const modelId = requests[0]?.modelId;
+
+  if (modelId == null) {
+    throw new InvalidArgumentError({
+      argument: 'requests',
+      message: 'Google batches require at least one request.',
+    });
+  }
+
+  for (const request of requests) {
+    if (request.modelId !== modelId) {
+      throw new InvalidArgumentError({
+        argument: 'requests',
+        message:
+          'Google batches require every request to use the same model because the model is part of the batch endpoint.',
+      });
+    }
+  }
+
+  return modelId;
+}

package/src/google-image-model.ts

@@ -243,6 +243,9 @@ export class GoogleImageModel implements ImageModelV4 {
 
     return {
       images,
+      ...(result.finishReason.unified === 'content-filter'
+        ? { isRetryable: false }
+        : {}),
       warnings,
       providerMetadata: {
         google: {

package/src/google-language-model.ts

@@ -13,6 +13,7 @@ import type {
 } from '@ai-sdk/provider';
 import {
   combineHeaders,
+  createToolNameMapping,
   createEventSourceResponseHandler,
   createJsonResponseHandler,
   generateId,
@@ -113,8 +114,10 @@ export class GoogleLanguageModel implements LanguageModelV4 {
     return this.config.supportedUrls?.() ?? {};
   }
 
-  protected async getArgs(
-    {
+  static async prepareRequest({
+    modelId,
+    config,
+    options: {
       prompt,
       maxOutputTokens,
       temperature,
@@ -129,19 +132,25 @@ export class GoogleLanguageModel implements LanguageModelV4 {
       toolChoice,
       reasoning,
       providerOptions,
-    }: LanguageModelV4CallOptions,
-    { isStreaming = false }: { isStreaming?: boolean } = {},
-  ) {
+    },
+    isStreaming = false,
+  }: {
+    modelId: GoogleModelId;
+    config: GoogleLanguageModelConfig;
+    options: LanguageModelV4CallOptions;
+    isStreaming?: boolean;
+  }) {
     const warnings: SharedV4Warning[] = [];
 
     // Names to look up in providerOptions and to write into providerMetadata.
     // For the Vertex provider we read both the new `googleVertex` key and the
     // legacy `vertex` key (new takes precedence) and write under both for
     // backward compatibility. For other Google providers we use just `google`.
-    const providerOptionsNames: readonly string[] =
-      this.config.provider.includes('vertex')
-        ? (['googleVertex', 'vertex'] as const)
-        : (['google'] as const);
+    const providerOptionsNames: readonly string[] = config.provider.includes(
+      'vertex',
+    )
+      ? (['googleVertex', 'vertex'] as const)
+      : (['google'] as const);
 
     let googleOptions: GoogleLanguageModelOptions | undefined;
     for (const name of providerOptionsNames) {
@@ -164,7 +173,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
     }
 
     // Add warning if Vertex rag tools are used with a non-Vertex Google provider
-    const isVertexProvider = this.config.provider.startsWith('google.vertex.');
+    const isVertexProvider = config.provider.startsWith('google.vertex.');
 
     if (
       tools?.some(
@@ -178,7 +187,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
         message:
           "The 'vertex_rag_store' tool is only supported with the Google Vertex provider " +
           'and might not be supported or could behave unexpectedly with the current Google provider ' +
-          `(${this.config.provider}).`,
+          `(${config.provider}).`,
       });
     }
 
@@ -188,7 +197,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
         message:
           "'streamFunctionCallArguments' is only supported on the Vertex AI API " +
           'and will be ignored with the current Google provider ' +
-          `(${this.config.provider}). See https://docs.cloud.google.com/vertex-ai/generative-ai/docs/multimodal/function-calling#streaming-fc`,
+          `(${config.provider}). See https://docs.cloud.google.com/vertex-ai/generative-ai/docs/multimodal/function-calling#streaming-fc`,
       });
     }
 
@@ -209,7 +218,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
         type: 'other',
         message:
           "'sharedRequestType' and 'requestType' are Vertex AI options and " +
-          `are ignored with the current Google provider (${this.config.provider}).`,
+          `are ignored with the current Google provider (${config.provider}).`,
       });
     }
 
@@ -253,15 +262,15 @@ export class GoogleLanguageModel implements LanguageModelV4 {
           message:
             `${droppedImageConfigFields.join(', ')} ` +
             `${droppedImageConfigFields.length === 1 ? 'is a Vertex AI option and is' : 'are Vertex AI options and are'} ` +
-            `ignored with the current Google provider (${this.config.provider}).`,
+            `ignored with the current Google provider (${config.provider}).`,
         });
         imageConfig = geminiApiImageConfig;
       }
     }
 
-    const isGemmaModel = this.modelId.toLowerCase().startsWith('gemma-');
+    const isGemmaModel = modelId.toLowerCase().startsWith('gemma-');
     const isGemini25DeveloperApiModel =
-      !isVertexProvider && gemini25ModelPattern.test(this.modelId);
+      !isVertexProvider && gemini25ModelPattern.test(modelId);
 
     if (isGemini25DeveloperApiModel && frequencyPenalty != null) {
       warnings.push({
@@ -276,7 +285,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
       });
     }
 
-    const { usesGemini3Features } = getGoogleModelCapabilities(this.modelId);
+    const { usesGemini3Features } = getGoogleModelCapabilities(modelId);
 
     const { contents, systemInstruction } = convertToGoogleMessages(prompt, {
       isGemmaModel,
@@ -294,13 +303,19 @@ export class GoogleLanguageModel implements LanguageModelV4 {
     } = prepareTools({
       tools,
       toolChoice,
-      modelId: this.modelId,
+      modelId,
       isVertexProvider,
     });
+    const toolNameMapping = createToolNameMapping({
+      tools,
+      providerToolNames: {
+        'google.code_execution': 'code_execution',
+      },
+    });
 
     const resolvedThinking = resolveThinkingConfig({
       reasoning,
-      modelId: this.modelId,
+      modelId,
       warnings,
     });
     const thinkingConfig =
@@ -394,17 +409,34 @@ export class GoogleLanguageModel implements LanguageModelV4 {
       warnings: [...warnings, ...toolWarnings],
       providerOptionsNames,
       extraHeaders: vertexPaygoHeaders,
+      toolNameMapping,
     };
   }
 
-  protected convertGenerateContentResponse({
+  private getArgs(
+    options: LanguageModelV4CallOptions,
+    { isStreaming = false }: { isStreaming?: boolean } = {},
+  ) {
+    return GoogleLanguageModel.prepareRequest({
+      modelId: this.modelId,
+      config: this.config,
+      options,
+      isStreaming,
+    });
+  }
+
+  static convertGenerateContentResponse({
+    config,
     response,
     warnings,
     providerOptionsNames,
+    toolNameMapping,
   }: {
+    config: GoogleLanguageModelConfig;
     response: InferSchema<typeof responseSchema>;
     warnings: SharedV4Warning[];
     providerOptionsNames: readonly string[];
+    toolNameMapping?: ReturnType<typeof createToolNameMapping>;
   }): LanguageModelV4GenerateResult {
     const wrapProviderMetadata = (payload: Record<string, unknown>) =>
       Object.fromEntries(
@@ -431,13 +463,15 @@ export class GoogleLanguageModel implements LanguageModelV4 {
     // Build content array from all parts
     for (const part of parts) {
       if ('executableCode' in part && part.executableCode?.code) {
-        const toolCallId = this.config.generateId();
+        const toolCallId = config.generateId();
         lastCodeExecutionToolCallId = toolCallId;
 
         content.push({
           type: 'tool-call',
           toolCallId,
-          toolName: 'code_execution',
+          toolName:
+            toolNameMapping?.toCustomToolName('code_execution') ??
+            'code_execution',
           input: JSON.stringify(part.executableCode),
           providerExecuted: true,
         });
@@ -446,7 +480,9 @@ export class GoogleLanguageModel implements LanguageModelV4 {
           type: 'tool-result',
           // Results correspond to the most recent executable code part.
           toolCallId: lastCodeExecutionToolCallId!,
-          toolName: 'code_execution',
+          toolName:
+            toolNameMapping?.toCustomToolName('code_execution') ??
+            'code_execution',
           result: {
             outcome: part.codeExecutionResult.outcome,
             output: part.codeExecutionResult.output ?? '',
@@ -474,7 +510,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
       } else if ('functionCall' in part && part.functionCall.name != null) {
         content.push({
           type: 'tool-call' as const,
-          toolCallId: part.functionCall.id || this.config.generateId(),
+          toolCallId: part.functionCall.id || config.generateId(),
           toolName: part.functionCall.name,
           input: JSON.stringify(part.functionCall.args ?? {}),
           providerMetadata: part.thoughtSignature
@@ -497,7 +533,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
             : undefined,
         });
       } else if ('toolCall' in part && part.toolCall) {
-        const toolCallId = part.toolCall.id || this.config.generateId();
+        const toolCallId = part.toolCall.id || config.generateId();
         lastServerToolCallId = toolCallId;
         content.push({
           type: 'tool-call',
@@ -519,9 +555,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
         });
       } else if ('toolResponse' in part && part.toolResponse) {
         const responseToolCallId =
-          lastServerToolCallId ||
-          part.toolResponse.id ||
-          this.config.generateId();
+          lastServerToolCallId || part.toolResponse.id || config.generateId();
         content.push({
           type: 'tool-result',
           toolCallId: responseToolCallId,
@@ -545,7 +579,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
     const sources =
       extractSources({
         groundingMetadata: candidate?.groundingMetadata,
-        generateId: this.config.generateId,
+        generateId: config.generateId,
       }) ?? [];
     for (const source of sources) {
       content.push(source);
@@ -586,8 +620,13 @@ export class GoogleLanguageModel implements LanguageModelV4 {
   async doGenerate(
     options: LanguageModelV4CallOptions,
   ): Promise<LanguageModelV4GenerateResult> {
-    const { args, warnings, providerOptionsNames, extraHeaders } =
-      await this.getArgs(options);
+    const {
+      args,
+      warnings,
+      providerOptionsNames,
+      extraHeaders,
+      toolNameMapping,
+    } = await this.getArgs(options);
 
     const mergedHeaders = combineHeaders(
       this.config.headers ? await resolve(this.config.headers) : undefined,
@@ -611,10 +650,12 @@ export class GoogleLanguageModel implements LanguageModelV4 {
       fetch: this.config.fetch,
     });
 
-    const result = this.convertGenerateContentResponse({
+    const result = GoogleLanguageModel.convertGenerateContentResponse({
+      config: this.config,
       response,
       warnings,
       providerOptionsNames,
+      toolNameMapping,
     });
 
     return {
@@ -631,8 +672,13 @@ export class GoogleLanguageModel implements LanguageModelV4 {
   async doStream(
     options: LanguageModelV4CallOptions,
   ): Promise<LanguageModelV4StreamResult> {
-    const { args, warnings, providerOptionsNames, extraHeaders } =
-      await this.getArgs(options, { isStreaming: true });
+    const {
+      args,
+      warnings,
+      providerOptionsNames,
+      extraHeaders,
+      toolNameMapping,
+    } = await this.getArgs(options, { isStreaming: true });
     const wrapProviderMetadata = (payload: Record<string, unknown>) =>
       Object.fromEntries(
         providerOptionsNames.map(name => [name, payload]),
@@ -820,7 +866,8 @@ export class GoogleLanguageModel implements LanguageModelV4 {
                   controller.enqueue({
                     type: 'tool-call',
                     toolCallId,
-                    toolName: 'code_execution',
+                    toolName:
+                      toolNameMapping.toCustomToolName('code_execution'),
                     input: JSON.stringify(part.executableCode),
                     providerExecuted: true,
                   });
@@ -835,7 +882,8 @@ export class GoogleLanguageModel implements LanguageModelV4 {
                     controller.enqueue({
                       type: 'tool-result',
                       toolCallId,
-                      toolName: 'code_execution',
+                      toolName:
+                        toolNameMapping.toCustomToolName('code_execution'),
                       result: {
                         outcome: part.codeExecutionResult.outcome,
                         output: part.codeExecutionResult.output ?? '',