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

package/src/google-vertex-provider.ts

@@ -1,136 +1,24 @@
-import { GoogleLanguageModel } from '@ai-sdk/google/internal';
-import type {
-  Experimental_VideoModelV4,
-  ImageModelV4,
-  LanguageModelV4,
-  ProviderV4,
-} from '@ai-sdk/provider';
+import { loadOptionalSetting, resolve } from '@ai-sdk/provider-utils';
+import type { GoogleAuthOptions } from 'google-auth-library';
+import { generateAuthToken } from './google-vertex-auth-google-auth-library';
 import {
-  generateId,
-  loadOptionalSetting,
-  loadSetting,
-  normalizeHeaders,
-  resolve,
-  withoutTrailingSlash,
-  withUserAgentSuffix,
-  type FetchFunction,
-  type Resolvable,
-} from '@ai-sdk/provider-utils';
-import { VERSION } from './version';
-import type { GoogleVertexConfig } from './google-vertex-config';
-import { GoogleVertexEmbeddingModel } from './google-vertex-embedding-model';
-import type { GoogleVertexEmbeddingModelId } from './google-vertex-embedding-options';
-import { GoogleVertexImageModel } from './google-vertex-image-model';
-import type { GoogleVertexImageModelId } from './google-vertex-image-settings';
-import type { GoogleVertexModelId } from './google-vertex-options';
-import { googleVertexTools } from './google-vertex-tools';
-import { GoogleVertexVideoModel } from './google-vertex-video-model';
-import type { GoogleVertexVideoModelId } from './google-vertex-video-settings';
-
-const EXPRESS_MODE_BASE_URL =
-  'https://aiplatform.googleapis.com/v1/publishers/google';
-
-// set `x-goog-api-key` header to API key for express mode
-function createExpressModeFetch(
-  apiKey: string,
-  customFetch?: FetchFunction,
-): FetchFunction {
-  return async (url, init) => {
-    const modifiedInit: RequestInit = {
-      ...init,
-      headers: {
-        ...(init?.headers ? normalizeHeaders(init.headers) : {}),
-        'x-goog-api-key': apiKey,
-      },
-    };
-    return (customFetch ?? fetch)(url.toString(), modifiedInit);
-  };
-}
-
-export interface GoogleVertexProvider extends ProviderV4 {
-  /**
-   * Creates a model for text generation.
-   */
-  (modelId: GoogleVertexModelId): LanguageModelV4;
-
-  languageModel: (modelId: GoogleVertexModelId) => LanguageModelV4;
-
-  /**
-   * Creates a model for image generation.
-   */
-  image(modelId: GoogleVertexImageModelId): ImageModelV4;
-
-  /**
-   * Creates a model for image generation.
-   */
-  imageModel(modelId: GoogleVertexImageModelId): ImageModelV4;
-
-  tools: typeof googleVertexTools;
-
-  /**
-   * @deprecated Use `embeddingModel` instead.
-   */
-  textEmbeddingModel(
-    modelId: GoogleVertexEmbeddingModelId,
-  ): GoogleVertexEmbeddingModel;
-
-  /**
-   * Creates a model for video generation.
-   */
-  video(modelId: GoogleVertexVideoModelId): Experimental_VideoModelV4;
-
-  /**
-   * Creates a model for video generation.
-   */
-  videoModel(modelId: GoogleVertexVideoModelId): Experimental_VideoModelV4;
+  createGoogleVertex as createGoogleVertexOriginal,
+  type GoogleVertexProvider,
+  type GoogleVertexProviderSettings as GoogleVertexProviderSettingsOriginal,
+} from './google-vertex-provider-base';
+export interface GoogleVertexProviderSettings extends GoogleVertexProviderSettingsOriginal {
+  /**
+   * 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;
 }
 
-export interface GoogleVertexProviderSettings {
-  /**
-   * Optional. The API key for the Google Cloud project. If provided, the
-   * provider will use express mode with API key authentication. Defaults to
-   * the value of the `GOOGLE_VERTEX_API_KEY` environment variable.
-   */
-  apiKey?: string;
-
-  /**
-   * Your Google Vertex location. Defaults to the environment variable `GOOGLE_VERTEX_LOCATION`.
-   */
-  location?: string;
-
-  /**
-   * Your Google Vertex project. Defaults to the environment variable `GOOGLE_VERTEX_PROJECT`.
-   */
-  project?: string;
+export type { GoogleVertexProvider };
 
-  /**
-   * 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;
-
-  // for testing
-  generateId?: () => string;
-
-  /**
-   * Base URL for the Google Vertex API calls.
-   */
-  baseURL?: string;
-}
-
-/**
- * Create a Google Vertex AI provider instance.
- */
-export function createVertex(
+export function createGoogleVertex(
   options: GoogleVertexProviderSettings = {},
 ): GoogleVertexProvider {
   const apiKey = loadOptionalSetting({
@@ -138,108 +26,22 @@ export function createVertex(
     environmentVariableName: 'GOOGLE_VERTEX_API_KEY',
   });
 
-  const loadVertexProject = () =>
-    loadSetting({
-      settingValue: options.project,
-      settingName: 'project',
-      environmentVariableName: 'GOOGLE_VERTEX_PROJECT',
-      description: 'Google Vertex project',
-    });
-
-  const loadVertexLocation = () =>
-    loadSetting({
-      settingValue: options.location,
-      settingName: 'location',
-      environmentVariableName: 'GOOGLE_VERTEX_LOCATION',
-      description: 'Google Vertex location',
-    });
-
-  const loadBaseURL = () => {
-    if (apiKey) {
-      return withoutTrailingSlash(options.baseURL) ?? EXPRESS_MODE_BASE_URL;
-    }
-
-    const region = loadVertexLocation();
-    const project = loadVertexProject();
-
-    // For global region, use aiplatform.googleapis.com directly
-    // For other regions, use region-aiplatform.googleapis.com
-    const baseHost = `${region === 'global' ? '' : region + '-'}aiplatform.googleapis.com`;
-
-    return (
-      withoutTrailingSlash(options.baseURL) ??
-      `https://${baseHost}/v1beta1/projects/${project}/locations/${region}/publishers/google`
-    );
-  };
-
-  const createConfig = (name: string): GoogleVertexConfig => {
-    const getHeaders = async () => {
-      const originalHeaders = await resolve(options.headers ?? {});
-      return withUserAgentSuffix(
-        originalHeaders,
-        `ai-sdk/google-vertex/${VERSION}`,
-      );
-    };
-
-    return {
-      provider: `google.vertex.${name}`,
-      headers: getHeaders,
-      fetch: apiKey
-        ? createExpressModeFetch(apiKey, options.fetch)
-        : options.fetch,
-      baseURL: loadBaseURL(),
-    };
-  };
-
-  const createChatModel = (modelId: GoogleVertexModelId) => {
-    return new GoogleLanguageModel(modelId, {
-      ...createConfig('chat'),
-      generateId: options.generateId ?? generateId,
-      supportedUrls: () => ({
-        '*': [
-          // HTTP URLs:
-          /^https?:\/\/.*$/,
-          // Google Cloud Storage URLs:
-          /^gs:\/\/.*$/,
-        ],
-      }),
-    });
-  };
-
-  const createEmbeddingModel = (modelId: GoogleVertexEmbeddingModelId) =>
-    new GoogleVertexEmbeddingModel(modelId, createConfig('embedding'));
-
-  const createImageModel = (modelId: GoogleVertexImageModelId) =>
-    new GoogleVertexImageModel(modelId, {
-      ...createConfig('image'),
-      generateId: options.generateId ?? generateId,
-    });
-
-  const createVideoModel = (modelId: GoogleVertexVideoModelId) =>
-    new GoogleVertexVideoModel(modelId, {
-      ...createConfig('video'),
-      generateId: options.generateId ?? generateId,
-    });
-
-  const provider = function (modelId: GoogleVertexModelId) {
-    if (new.target) {
-      throw new Error(
-        'The Google Vertex AI model function cannot be called with the new keyword.',
-      );
-    }
-
-    return createChatModel(modelId);
-  };
-
-  provider.specificationVersion = 'v4' as const;
-  provider.languageModel = createChatModel;
-  provider.embeddingModel = createEmbeddingModel;
-  provider.textEmbeddingModel = createEmbeddingModel;
-  provider.image = createImageModel;
-  provider.imageModel = createImageModel;
-  provider.video = createVideoModel;
-  provider.videoModel = createVideoModel;
-  provider.tools = googleVertexTools;
-
-  return provider;
+  if (apiKey) {
+    return createGoogleVertexOriginal(options);
+  }
+
+  return createGoogleVertexOriginal({
+    ...options,
+    headers: async () => ({
+      Authorization: `Bearer ${await generateAuthToken(
+        options.googleAuthOptions,
+      )}`,
+      ...(await resolve(options.headers)),
+    }),
+  });
 }
+
+/**
+ * Default Google Vertex AI provider instance.
+ */
+export const googleVertex = createGoogleVertex();

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

@@ -0,0 +1,49 @@
+import { lazySchema, zodSchema } from '@ai-sdk/provider-utils';
+import { z } from 'zod/v4';
+
+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
+};
+
+export 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/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/google-vertex-provider-node.ts

@@ -1,47 +0,0 @@
-import { loadOptionalSetting, resolve } from '@ai-sdk/provider-utils';
-import type { GoogleAuthOptions } from 'google-auth-library';
-import { generateAuthToken } from './google-vertex-auth-google-auth-library';
-import {
-  createVertex as createVertexOriginal,
-  type GoogleVertexProvider,
-  type GoogleVertexProviderSettings as GoogleVertexProviderSettingsOriginal,
-} from './google-vertex-provider';
-export interface GoogleVertexProviderSettings extends GoogleVertexProviderSettingsOriginal {
-  /**
-   * 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;
-}
-
-export type { GoogleVertexProvider };
-
-export function createVertex(
-  options: GoogleVertexProviderSettings = {},
-): GoogleVertexProvider {
-  const apiKey = loadOptionalSetting({
-    settingValue: options.apiKey,
-    environmentVariableName: 'GOOGLE_VERTEX_API_KEY',
-  });
-
-  if (apiKey) {
-    return createVertexOriginal(options);
-  }
-
-  return createVertexOriginal({
-    ...options,
-    headers: async () => ({
-      Authorization: `Bearer ${await generateAuthToken(
-        options.googleAuthOptions,
-      )}`,
-      ...(await resolve(options.headers)),
-    }),
-  });
-}
-
-/**
- * Default Google Vertex AI provider instance.
- */
-export const vertex = createVertex();