@ai-sdk/google-vertex 4.0.115 → 4.0.117

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

@@ -0,0 +1,212 @@
+import {
+  NoSuchModelError,
+  type LanguageModelV3,
+  type LanguageModelV3Usage,
+  type ProviderV3,
+} 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 ProviderV3 {
+  /**
+   * Creates a model for text generation.
+   */
+  (modelId: GoogleVertexXaiModelId): LanguageModelV3;
+
+  /**
+   * Creates a model for text generation.
+   */
+  languageModel(modelId: GoogleVertexXaiModelId): LanguageModelV3;
+
+  /**
+   * Creates a chat model for text generation.
+   */
+  chatModel(modelId: GoogleVertexXaiModelId): LanguageModelV3;
+
+  /**
+   * @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,
+): LanguageModelV3Usage {
+  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 = 'v3' 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';