@ai-sdk/google-vertex 5.0.0-beta.10 → 5.0.0-beta.109

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

@@ -0,0 +1,122 @@
+import {
+  createOpenAICompatible,
+  type OpenAICompatibleProvider,
+} from '@ai-sdk/openai-compatible';
+import {
+  loadOptionalSetting,
+  loadSetting,
+  withoutTrailingSlash,
+  type FetchFunction,
+  type Resolvable,
+} from '@ai-sdk/provider-utils';
+import type { GoogleVertexMaasModelId } from './google-vertex-maas-options';
+
+export interface GoogleVertexMaasProvider extends OpenAICompatibleProvider<
+  GoogleVertexMaasModelId,
+  string,
+  string,
+  string
+> {}
+
+export interface GoogleVertexMaasProviderSettings {
+  /**
+   * 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;
+}
+
+/**
+ * Create a Google Vertex AI MaaS (Model as a Service) provider instance.
+ * Uses the OpenAI-compatible Chat Completions API for partner and open models.
+ *
+ * @see https://cloud.google.com/vertex-ai/generative-ai/docs/maas/use-open-models
+ */
+export function createGoogleVertexMaas(
+  options: GoogleVertexMaasProviderSettings = {},
+): GoogleVertexMaasProvider {
+  // Lazy-load settings to support loading from environment variables at runtime
+  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 getHost = (location: string) => {
+    if (location === 'global') {
+      return 'aiplatform.googleapis.com';
+    } else if (location === 'eu' || location === 'us') {
+      return `aiplatform.${location}.rep.googleapis.com`;
+    } else {
+      return `${location}-aiplatform.googleapis.com`;
+    }
+  };
+
+  const constructBaseURL = () => {
+    const projectId = loadProject();
+    const location = loadLocation() ?? 'global';
+
+    return `https://${getHost(location)}/v1/projects/${projectId}/locations/${location}/endpoints/openapi`;
+  };
+
+  const loadBaseURL = () =>
+    withoutTrailingSlash(options.baseURL ?? '') || constructBaseURL();
+
+  let cachedProvider: GoogleVertexMaasProvider | undefined;
+  const getProvider = () =>
+    (cachedProvider ??= createOpenAICompatible({
+      name: 'vertex.maas',
+      baseURL: loadBaseURL(),
+      fetch: options.fetch,
+    }));
+
+  const provider = (modelId: GoogleVertexMaasModelId) => getProvider()(modelId);
+
+  provider.specificationVersion = 'v4' as const;
+  provider.languageModel = (modelId: GoogleVertexMaasModelId) =>
+    getProvider().languageModel(modelId);
+  provider.chatModel = (modelId: GoogleVertexMaasModelId) =>
+    getProvider().chatModel(modelId);
+  provider.completionModel = (modelId: string) =>
+    getProvider().completionModel(modelId);
+  provider.embeddingModel = (modelId: string) =>
+    getProvider().embeddingModel(modelId);
+  provider.textEmbeddingModel = (modelId: string) =>
+    getProvider().textEmbeddingModel(modelId);
+  provider.imageModel = (modelId: string) => getProvider().imageModel(modelId);
+
+  return provider as GoogleVertexMaasProvider;
+}

package/src/maas/index.ts

@@ -0,0 +1,13 @@
+export {
+  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,
+  GoogleVertexMaasProviderSettings,
+} from './google-vertex-maas-provider-node';
+export type { GoogleVertexMaasModelId } from './google-vertex-maas-options';

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,62 @@
+import { resolve, type FetchFunction } from '@ai-sdk/provider-utils';
+import type { GoogleAuthOptions } from 'google-auth-library';
+import { createAuthTokenGenerator } 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 generateAuthToken = createAuthTokenGenerator(options.googleAuthOptions);
+
+  const customFetch: FetchFunction = async (url, init) => {
+    const token = await generateAuthToken();
+    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';