@ai-sdk/google-vertex 5.0.0-beta.62 → 5.0.0-beta.64

package/src/google-vertex-video-model.ts

@@ -8,40 +8,20 @@ import {
   convertUint8ArrayToBase64,
   createJsonResponseHandler,
   delay,
-  lazySchema,
   parseProviderOptions,
   postJsonToApi,
   resolve,
-  zodSchema,
   type FetchFunction,
   type Resolvable,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 import { googleVertexFailedResponseHandler } from './google-vertex-error';
+import {
+  googleVertexVideoModelOptionsSchema,
+  type GoogleVertexVideoModelOptions,
+} from './google-vertex-video-model-options';
 import type { GoogleVertexVideoModelId } from './google-vertex-video-settings';
 
-export type GoogleVertexVideoModelOptions = {
-  // Polling configuration
-  pollIntervalMs?: number | null;
-  pollTimeoutMs?: number | null;
-
-  // Video generation options
-  personGeneration?: 'dont_allow' | 'allow_adult' | 'allow_all' | null;
-  negativePrompt?: string | null;
-  generateAudio?: boolean | null;
-
-  // Output configuration
-  gcsOutputDirectory?: string | null;
-
-  // Reference images (for style/asset reference)
-  referenceImages?: Array<{
-    bytesBase64Encoded?: string;
-    gcsUri?: string;
-  }> | null;
-
-  [key: string]: unknown; // For passthrough
-};
-
 interface GoogleVertexVideoModelConfig {
   provider: string;
   baseURL: string;
@@ -76,11 +56,16 @@ export class GoogleVertexVideoModel implements Experimental_VideoModelV4 {
     const currentDate = this.config._internal?.currentDate?.() ?? new Date();
     const warnings: SharedV4Warning[] = [];
 
-    const vertexOptions = (await parseProviderOptions({
-      provider: 'vertex',
+    const googleVertexOptions = ((await parseProviderOptions({
+      provider: 'googleVertex',
       providerOptions: options.providerOptions,
       schema: googleVertexVideoModelOptionsSchema,
-    })) as GoogleVertexVideoModelOptions | undefined;
+    })) ??
+      (await parseProviderOptions({
+        provider: 'vertex',
+        providerOptions: options.providerOptions,
+        schema: googleVertexVideoModelOptionsSchema,
+      }))) as GoogleVertexVideoModelOptions | undefined;
 
     const instances: Array<Record<string, unknown>> = [{}];
     const instance = instances[0];
@@ -110,8 +95,8 @@ export class GoogleVertexVideoModel implements Experimental_VideoModelV4 {
       }
     }
 
-    if (vertexOptions?.referenceImages != null) {
-      instance.referenceImages = vertexOptions.referenceImages;
+    if (googleVertexOptions?.referenceImages != null) {
+      instance.referenceImages = googleVertexOptions.referenceImages;
     }
 
     const parameters: Record<string, unknown> = {
@@ -140,8 +125,8 @@ export class GoogleVertexVideoModel implements Experimental_VideoModelV4 {
       parameters.seed = options.seed;
     }
 
-    if (vertexOptions != null) {
-      const opts = vertexOptions;
+    if (googleVertexOptions != null) {
+      const opts = googleVertexOptions;
 
       if (
         opts.personGeneration !== undefined &&
@@ -190,7 +175,7 @@ export class GoogleVertexVideoModel implements Experimental_VideoModelV4 {
         parameters,
       },
       successfulResponseHandler: createJsonResponseHandler(
-        vertexOperationSchema,
+        googleVertexOperationSchema,
       ),
       failedResponseHandler: googleVertexFailedResponseHandler,
       abortSignal: options.abortSignal,
@@ -205,8 +190,8 @@ export class GoogleVertexVideoModel implements Experimental_VideoModelV4 {
       });
     }
 
-    const pollIntervalMs = vertexOptions?.pollIntervalMs ?? 10000; // 10 seconds
-    const pollTimeoutMs = vertexOptions?.pollTimeoutMs ?? 600000; // 10 minutes
+    const pollIntervalMs = googleVertexOptions?.pollIntervalMs ?? 10000; // 10 seconds
+    const pollTimeoutMs = googleVertexOptions?.pollTimeoutMs ?? 600000; // 10 minutes
 
     const startTime = Date.now();
     let finalOperation = operation;
@@ -240,7 +225,7 @@ export class GoogleVertexVideoModel implements Experimental_VideoModelV4 {
             operationName,
           },
           successfulResponseHandler: createJsonResponseHandler(
-            vertexOperationSchema,
+            googleVertexOperationSchema,
           ),
           failedResponseHandler: googleVertexFailedResponseHandler,
           abortSignal: options.abortSignal,
@@ -314,16 +299,20 @@ export class GoogleVertexVideoModel implements Experimental_VideoModelV4 {
         modelId: this.modelId,
         headers: responseHeaders,
       },
-      providerMetadata: {
-        'google-vertex': {
-          videos: videoMetadata,
-        },
-      },
+      providerMetadata: (() => {
+        const payload = { videos: videoMetadata };
+        return {
+          googleVertex: payload,
+          // Legacy keys preserved for backward compatibility.
+          'google-vertex': payload,
+          vertex: payload,
+        };
+      })(),
     };
   }
 }
 
-const vertexOperationSchema = z.object({
+const googleVertexOperationSchema = z.object({
   name: z.string().nullish(),
   done: z.boolean().nullish(),
   error: z
@@ -348,28 +337,3 @@ const vertexOperationSchema = z.object({
     })
     .nullish(),
 });
-
-const googleVertexVideoModelOptionsSchema = lazySchema(() =>
-  zodSchema(
-    z
-      .object({
-        pollIntervalMs: z.number().positive().nullish(),
-        pollTimeoutMs: z.number().positive().nullish(),
-        personGeneration: z
-          .enum(['dont_allow', 'allow_adult', 'allow_all'])
-          .nullish(),
-        negativePrompt: z.string().nullish(),
-        generateAudio: z.boolean().nullish(),
-        gcsOutputDirectory: z.string().nullish(),
-        referenceImages: z
-          .array(
-            z.object({
-              bytesBase64Encoded: z.string().nullish(),
-              gcsUri: z.string().nullish(),
-            }),
-          )
-          .nullish(),
-      })
-      .passthrough(),
-  ),
-);

package/src/index.ts

@@ -1,18 +1,25 @@
-export type { GoogleVertexEmbeddingModelOptions } from './google-vertex-embedding-options';
+export type { GoogleVertexEmbeddingModelOptions } from './google-vertex-embedding-model-options';
 export type {
   GoogleVertexImageModelOptions,
   /** @deprecated Use `GoogleVertexImageModelOptions` instead. */
   GoogleVertexImageModelOptions as GoogleVertexImageProviderOptions,
-} from './google-vertex-image-model';
+} from './google-vertex-image-model-options';
 export type {
   GoogleVertexVideoModelOptions,
   /** @deprecated Use `GoogleVertexVideoModelOptions` instead. */
   GoogleVertexVideoModelOptions as GoogleVertexVideoProviderOptions,
-} from './google-vertex-video-model';
+} from './google-vertex-video-model-options';
 export type { GoogleVertexVideoModelId } from './google-vertex-video-settings';
-export { createVertex, vertex } from './google-vertex-provider-node';
+export {
+  createGoogleVertex,
+  /** @deprecated Use `createGoogleVertex` instead. */
+  createGoogleVertex as createVertex,
+  googleVertex,
+  /** @deprecated Use `googleVertex` instead. */
+  googleVertex as vertex,
+} from './google-vertex-provider';
 export type {
   GoogleVertexProvider,
   GoogleVertexProviderSettings,
-} from './google-vertex-provider-node';
+} from './google-vertex-provider';
 export { VERSION } from './version';

package/src/maas/edge/google-vertex-maas-provider-edge.ts

@@ -4,7 +4,7 @@ import {
   type GoogleCredentials,
 } from '../../edge/google-vertex-auth-edge';
 import {
-  createVertexMaas as createVertexMaasOriginal,
+  createGoogleVertexMaas as createVertexMaasOriginal,
   type GoogleVertexMaasProvider,
   type GoogleVertexMaasProviderSettings as GoogleVertexMaasProviderSettingsOriginal,
 } from '../google-vertex-maas-provider';
@@ -26,7 +26,7 @@ export interface GoogleVertexMaasProviderSettings extends GoogleVertexMaasProvid
  *
  * @see https://cloud.google.com/vertex-ai/generative-ai/docs/maas/use-open-models
  */
-export function createVertexMaas(
+export function createGoogleVertexMaas(
   options: GoogleVertexMaasProviderSettings = {},
 ): GoogleVertexMaasProvider {
   // Create a custom fetch wrapper that adds auth headers
@@ -61,4 +61,4 @@ export function createVertexMaas(
 /**
  * Default Google Vertex AI MaaS provider instance for Edge runtimes.
  */
-export const vertexMaas = createVertexMaas();
+export const googleVertexMaas = createGoogleVertexMaas();

package/src/maas/edge/index.ts

@@ -1,6 +1,10 @@
 export {
-  createVertexMaas,
-  vertexMaas,
+  createGoogleVertexMaas,
+  /** @deprecated Use `createGoogleVertexMaas` instead. */
+  createGoogleVertexMaas as createVertexMaas,
+  googleVertexMaas,
+  /** @deprecated Use `googleVertexMaas` instead. */
+  googleVertexMaas as vertexMaas,
 } from './google-vertex-maas-provider-edge';
 export type {
   GoogleVertexMaasProvider,

package/src/maas/google-vertex-maas-provider-node.ts

@@ -2,7 +2,7 @@ import { resolve, type FetchFunction } from '@ai-sdk/provider-utils';
 import type { GoogleAuthOptions } from 'google-auth-library';
 import { generateAuthToken } from '../google-vertex-auth-google-auth-library';
 import {
-  createVertexMaas as createVertexMaasOriginal,
+  createGoogleVertexMaas as createVertexMaasOriginal,
   type GoogleVertexMaasProvider,
   type GoogleVertexMaasProviderSettings as GoogleVertexMaasProviderSettingsOriginal,
 } from './google-vertex-maas-provider';
@@ -25,7 +25,7 @@ export interface GoogleVertexMaasProviderSettings extends GoogleVertexMaasProvid
  *
  * @see https://cloud.google.com/vertex-ai/generative-ai/docs/maas/use-open-models
  */
-export function createVertexMaas(
+export function createGoogleVertexMaas(
   options: GoogleVertexMaasProviderSettings = {},
 ): GoogleVertexMaasProvider {
   // Create a custom fetch wrapper that adds auth headers
@@ -60,4 +60,4 @@ export function createVertexMaas(
 /**
  * Default Google Vertex AI MaaS provider instance for Node.js.
  */
-export const vertexMaas = createVertexMaas();
+export const googleVertexMaas = createGoogleVertexMaas();

package/src/maas/google-vertex-maas-provider.ts

@@ -57,7 +57,7 @@ export interface GoogleVertexMaasProviderSettings {
  *
  * @see https://cloud.google.com/vertex-ai/generative-ai/docs/maas/use-open-models
  */
-export function createVertexMaas(
+export function createGoogleVertexMaas(
   options: GoogleVertexMaasProviderSettings = {},
 ): GoogleVertexMaasProvider {
   // Lazy-load settings to support loading from environment variables at runtime

package/src/maas/index.ts

@@ -1,6 +1,10 @@
 export {
-  createVertexMaas,
-  vertexMaas,
+  createGoogleVertexMaas,
+  /** @deprecated Use `createGoogleVertexMaas` instead. */
+  createGoogleVertexMaas as createVertexMaas,
+  googleVertexMaas,
+  /** @deprecated Use `googleVertexMaas` instead. */
+  googleVertexMaas as vertexMaas,
 } from './google-vertex-maas-provider-node';
 export type {
   GoogleVertexMaasProvider,

package/src/xai/edge/google-vertex-xai-provider-edge.ts

@@ -0,0 +1,61 @@
+import { resolve, type FetchFunction } from '@ai-sdk/provider-utils';
+import {
+  generateAuthToken,
+  type GoogleCredentials,
+} from '../../edge/google-vertex-auth-edge';
+import {
+  createGoogleVertexXai as createGoogleVertexXaiOriginal,
+  type GoogleVertexXaiProvider,
+  type GoogleVertexXaiProviderSettings as GoogleVertexXaiProviderSettingsOriginal,
+} from '../google-vertex-xai-provider';
+export type { GoogleVertexXaiProvider };
+
+export interface GoogleVertexXaiProviderSettings extends GoogleVertexXaiProviderSettingsOriginal {
+  /**
+   * Optional. The Google credentials for the Google Cloud service account. If
+   * not provided, the Google Vertex provider will use environment variables to
+   * load the credentials.
+   */
+  googleCredentials?: GoogleCredentials;
+}
+
+/**
+ * Create a Google Vertex AI xAI provider instance for Edge runtimes.
+ * Uses the OpenAI-compatible Chat Completions API for Grok partner models.
+ * Automatically handles Google Cloud authentication.
+ *
+ * @see https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/grok
+ */
+export function createGoogleVertexXai(
+  options: GoogleVertexXaiProviderSettings = {},
+): GoogleVertexXaiProvider {
+  const customFetch: FetchFunction = async (url, init) => {
+    const token = await generateAuthToken(options.googleCredentials);
+    const resolvedHeaders = await resolve(options.headers);
+    const authHeaders = {
+      ...resolvedHeaders,
+      Authorization: `Bearer ${token}`,
+    };
+
+    const fetchInit = {
+      ...init,
+      headers: {
+        ...init?.headers,
+        ...authHeaders,
+      },
+    };
+
+    return (options.fetch ?? fetch)(url, fetchInit);
+  };
+
+  return createGoogleVertexXaiOriginal({
+    ...options,
+    fetch: customFetch,
+    headers: undefined,
+  });
+}
+
+/**
+ * Default Google Vertex AI xAI provider instance for Edge runtimes.
+ */
+export const googleVertexXai = createGoogleVertexXai();

package/src/xai/edge/index.ts

@@ -0,0 +1,9 @@
+export {
+  createGoogleVertexXai,
+  googleVertexXai,
+} from './google-vertex-xai-provider-edge';
+export type {
+  GoogleVertexXaiProvider,
+  GoogleVertexXaiProviderSettings,
+} from './google-vertex-xai-provider-edge';
+export type { GoogleVertexXaiModelId } from '../google-vertex-xai-options';

package/src/xai/google-vertex-xai-options.ts

@@ -0,0 +1,7 @@
+// https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/grok
+export type GoogleVertexXaiModelId =
+  | 'xai/grok-4.20-reasoning'
+  | 'xai/grok-4.20-non-reasoning'
+  | 'xai/grok-4.1-fast-reasoning'
+  | 'xai/grok-4.1-fast-non-reasoning'
+  | (string & {});

package/src/xai/google-vertex-xai-provider-node.ts

@@ -0,0 +1,60 @@
+import { resolve, type FetchFunction } from '@ai-sdk/provider-utils';
+import type { GoogleAuthOptions } from 'google-auth-library';
+import { generateAuthToken } from '../google-vertex-auth-google-auth-library';
+import {
+  createGoogleVertexXai as createGoogleVertexXaiOriginal,
+  type GoogleVertexXaiProvider,
+  type GoogleVertexXaiProviderSettings as GoogleVertexXaiProviderSettingsOriginal,
+} from './google-vertex-xai-provider';
+export type { GoogleVertexXaiProvider };
+
+export interface GoogleVertexXaiProviderSettings extends GoogleVertexXaiProviderSettingsOriginal {
+  /**
+   * Optional. The Authentication options provided by google-auth-library.
+   * Complete list of authentication options is documented in the
+   * GoogleAuthOptions interface:
+   * https://github.com/googleapis/google-auth-library-nodejs/blob/main/src/auth/googleauth.ts.
+   */
+  googleAuthOptions?: GoogleAuthOptions;
+}
+
+/**
+ * Create a Google Vertex AI xAI provider instance for Node.js.
+ * Uses the OpenAI-compatible Chat Completions API for Grok partner models.
+ * Automatically handles Google Cloud authentication.
+ *
+ * @see https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/grok
+ */
+export function createGoogleVertexXai(
+  options: GoogleVertexXaiProviderSettings = {},
+): GoogleVertexXaiProvider {
+  const customFetch: FetchFunction = async (url, init) => {
+    const token = await generateAuthToken(options.googleAuthOptions);
+    const resolvedHeaders = await resolve(options.headers);
+    const authHeaders = {
+      ...resolvedHeaders,
+      Authorization: `Bearer ${token}`,
+    };
+
+    const fetchInit = {
+      ...init,
+      headers: {
+        ...init?.headers,
+        ...authHeaders,
+      },
+    };
+
+    return (options.fetch ?? fetch)(url, fetchInit);
+  };
+
+  return createGoogleVertexXaiOriginal({
+    ...options,
+    fetch: customFetch,
+    headers: undefined,
+  });
+}
+
+/**
+ * Default Google Vertex AI xAI provider instance for Node.js.
+ */
+export const googleVertexXai = createGoogleVertexXai();

package/src/xai/google-vertex-xai-provider.ts

@@ -0,0 +1,212 @@
+import {
+  NoSuchModelError,
+  type LanguageModelV4,
+  type LanguageModelV4Usage,
+  type ProviderV4,
+} from '@ai-sdk/provider';
+import {
+  createOpenAICompatible,
+  type OpenAICompatibleProvider,
+} from '@ai-sdk/openai-compatible';
+import {
+  loadOptionalSetting,
+  loadSetting,
+  withoutTrailingSlash,
+  type FetchFunction,
+  type Resolvable,
+} from '@ai-sdk/provider-utils';
+import type { GoogleVertexXaiModelId } from './google-vertex-xai-options';
+
+export interface GoogleVertexXaiProvider extends ProviderV4 {
+  /**
+   * Creates a model for text generation.
+   */
+  (modelId: GoogleVertexXaiModelId): LanguageModelV4;
+
+  /**
+   * Creates a model for text generation.
+   */
+  languageModel(modelId: GoogleVertexXaiModelId): LanguageModelV4;
+
+  /**
+   * Creates a chat model for text generation.
+   */
+  chatModel(modelId: GoogleVertexXaiModelId): LanguageModelV4;
+
+  /**
+   * @deprecated Use `embeddingModel` instead.
+   */
+  textEmbeddingModel(modelId: string): never;
+}
+
+export interface GoogleVertexXaiProviderSettings {
+  /**
+   * Google Cloud project ID. Defaults to the value of the `GOOGLE_VERTEX_PROJECT` environment variable.
+   */
+  project?: string;
+
+  /**
+   * Google Cloud location/region. Defaults to the value of the `GOOGLE_VERTEX_LOCATION` environment variable.
+   * Use 'global' for the global endpoint.
+   */
+  location?: string;
+
+  /**
+   * Base URL for the API calls. If not provided, will be constructed from project and location.
+   */
+  baseURL?: string;
+
+  /**
+   * Headers to use for requests. Can be:
+   * - A headers object
+   * - A Promise that resolves to a headers object
+   * - A function that returns a headers object
+   * - A function that returns a Promise of a headers object
+   */
+  headers?: Resolvable<Record<string, string | undefined>>;
+
+  /**
+   * Custom fetch implementation. You can use it as a middleware to intercept requests,
+   * or to provide a custom fetch implementation for e.g. testing.
+   */
+  fetch?: FetchFunction;
+}
+
+type GoogleVertexXaiUsage =
+  | {
+      prompt_tokens?: number | null;
+      completion_tokens?: number | null;
+      prompt_tokens_details?: {
+        cached_tokens?: number | null;
+      } | null;
+      completion_tokens_details?: {
+        reasoning_tokens?: number | null;
+      } | null;
+    }
+  | undefined
+  | null;
+
+function convertGoogleVertexXaiUsage(
+  usage: GoogleVertexXaiUsage,
+): LanguageModelV4Usage {
+  if (usage == null) {
+    return {
+      inputTokens: {
+        total: undefined,
+        noCache: undefined,
+        cacheRead: undefined,
+        cacheWrite: undefined,
+      },
+      outputTokens: {
+        total: undefined,
+        text: undefined,
+        reasoning: undefined,
+      },
+      raw: undefined,
+    };
+  }
+
+  const promptTokens = usage.prompt_tokens ?? 0;
+  const completionTokens = usage.completion_tokens ?? 0;
+  const cacheReadTokens = usage.prompt_tokens_details?.cached_tokens ?? 0;
+  const reasoningTokens =
+    usage.completion_tokens_details?.reasoning_tokens ?? 0;
+
+  return {
+    inputTokens: {
+      total: promptTokens,
+      noCache: promptTokens - cacheReadTokens,
+      cacheRead: cacheReadTokens,
+      cacheWrite: undefined,
+    },
+    outputTokens: {
+      total: completionTokens + reasoningTokens,
+      text: completionTokens,
+      reasoning: reasoningTokens,
+    },
+    raw: usage,
+  };
+}
+
+function transformGoogleVertexXaiRequestBody(args: Record<string, any>) {
+  const { reasoning_effort: _reasoningEffort, ...rest } = args;
+  return rest;
+}
+
+/**
+ * Create a Google Vertex AI xAI provider instance.
+ * Uses the OpenAI-compatible Chat Completions API for Grok partner models.
+ *
+ * @see https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/grok
+ */
+export function createGoogleVertexXai(
+  options: GoogleVertexXaiProviderSettings = {},
+): GoogleVertexXaiProvider {
+  const loadLocation = () =>
+    loadOptionalSetting({
+      settingValue: options.location,
+      environmentVariableName: 'GOOGLE_VERTEX_LOCATION',
+    });
+
+  const loadProject = () =>
+    loadSetting({
+      settingValue: options.project,
+      settingName: 'project',
+      environmentVariableName: 'GOOGLE_VERTEX_PROJECT',
+      description: 'Google Vertex project',
+    });
+
+  const constructBaseURL = () => {
+    const projectId = loadProject();
+    const location = loadLocation() ?? 'global';
+
+    return `https://aiplatform.googleapis.com/v1/projects/${projectId}/locations/${location}/endpoints/openapi`;
+  };
+
+  const loadBaseURL = () =>
+    withoutTrailingSlash(options.baseURL ?? '') || constructBaseURL();
+
+  let cachedProvider:
+    | OpenAICompatibleProvider<GoogleVertexXaiModelId, string, string, string>
+    | undefined;
+  const getProvider = () =>
+    (cachedProvider ??= createOpenAICompatible({
+      name: 'googleVertex.xai',
+      baseURL: loadBaseURL(),
+      fetch: options.fetch,
+      includeUsage: true,
+      supportsStructuredOutputs: true,
+      supportedUrls: () => ({
+        'image/*': [/^https?:\/\/.*$/],
+      }),
+      transformRequestBody: transformGoogleVertexXaiRequestBody,
+      convertUsage: convertGoogleVertexXaiUsage,
+    }));
+
+  const createChatModel = (modelId: GoogleVertexXaiModelId) =>
+    getProvider().languageModel(modelId);
+
+  const provider = function (modelId: GoogleVertexXaiModelId) {
+    if (new.target) {
+      throw new Error(
+        'The Google Vertex xAI model function cannot be called with the new keyword.',
+      );
+    }
+
+    return createChatModel(modelId);
+  };
+
+  provider.specificationVersion = 'v4' as const;
+  provider.languageModel = createChatModel;
+  provider.chatModel = (modelId: GoogleVertexXaiModelId) =>
+    getProvider().chatModel(modelId);
+  provider.embeddingModel = (modelId: string): never => {
+    throw new NoSuchModelError({ modelId, modelType: 'embeddingModel' });
+  };
+  provider.textEmbeddingModel = provider.embeddingModel;
+  provider.imageModel = (modelId: string): never => {
+    throw new NoSuchModelError({ modelId, modelType: 'imageModel' });
+  };
+
+  return provider;
+}

package/src/xai/index.ts

@@ -0,0 +1,9 @@
+export {
+  createGoogleVertexXai,
+  googleVertexXai,
+} from './google-vertex-xai-provider-node';
+export type {
+  GoogleVertexXaiProvider,
+  GoogleVertexXaiProviderSettings,
+} from './google-vertex-xai-provider-node';
+export type { GoogleVertexXaiModelId } from './google-vertex-xai-options';

package/xai/edge.d.ts

@@ -0,0 +1 @@
+export * from '../dist/xai/edge';

package/xai/index.d.ts

@@ -0,0 +1 @@
+export * from '../dist/xai/index';