@ai-sdk/google-vertex 4.0.116 → 4.0.118

package/docs/16-google-vertex.mdx

@@ -5,7 +5,7 @@ description: Learn how to use the Google Vertex AI provider.
 
 # Google Vertex Provider
 
-The Google Vertex provider for the [AI SDK](/docs) contains language model support for the [Google Vertex AI](https://cloud.google.com/vertex-ai) APIs. This includes support for [Google's Gemini models](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models), [Anthropic's Claude partner models](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/use-claude), and [MaaS (Model as a Service) open models](https://cloud.google.com/vertex-ai/generative-ai/docs/maas/use-open-models).
+The Google Vertex provider for the [AI SDK](/docs) contains language model support for the [Google Vertex AI](https://cloud.google.com/vertex-ai) APIs. This includes support for [Google's Gemini models](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models), [Anthropic's Claude partner models](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/use-claude), [xAI's Grok partner models](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/grok), and [MaaS (Model as a Service) open models](https://cloud.google.com/vertex-ai/generative-ai/docs/maas/use-open-models).
 
 <Note>
   The Google Vertex provider is compatible with both Node.js and Edge runtimes.
@@ -18,7 +18,7 @@ The Google Vertex provider for the [AI SDK](/docs) contains language model suppo
 
 ## Setup
 
-The Google Vertex and Google Vertex Anthropic providers are both available in the `@ai-sdk/google-vertex` module. You can install it with
+The Google Vertex, Google Vertex Anthropic, Google Vertex xAI, and Google Vertex MaaS providers are available in the `@ai-sdk/google-vertex` module. You can install it with
 
 <Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
   <Tab>
@@ -1780,6 +1780,185 @@ See also [Anthropic Model Comparison](https://docs.anthropic.com/en/docs/about-c
   model ID as a string if needed.
 </Note>
 
+## Google Vertex xAI Provider Usage
+
+The Google Vertex xAI provider offers support for xAI's Grok partner models through the Google Vertex AI OpenAI-compatible Chat Completions API.
+
+For more information, see the [Vertex AI Grok documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/grok).
+
+### Provider Instance
+
+You can import the default provider instance `googleVertexXai` from `@ai-sdk/google-vertex/xai`:
+
+```typescript
+import { googleVertexXai } from '@ai-sdk/google-vertex/xai';
+```
+
+If you need a customized setup, you can import `createGoogleVertexXai` from `@ai-sdk/google-vertex/xai` and create a provider instance with your settings:
+
+```typescript
+import { createGoogleVertexXai } from '@ai-sdk/google-vertex/xai';
+
+const googleVertexXai = createGoogleVertexXai({
+  project: 'my-project', // optional
+  location: 'global', // optional, defaults to 'global'
+});
+```
+
+#### Node.js Runtime
+
+For Node.js environments, the Google Vertex xAI provider supports all standard Google Cloud authentication options through the `google-auth-library`:
+
+```typescript
+import { createGoogleVertexXai } from '@ai-sdk/google-vertex/xai';
+
+const googleVertexXai = createGoogleVertexXai({
+  googleAuthOptions: {
+    credentials: {
+      client_email: 'my-email',
+      private_key: 'my-private-key',
+    },
+  },
+});
+```
+
+##### Optional Provider Settings
+
+- **project** _string_
+
+  The Google Cloud project ID. Defaults to the `GOOGLE_VERTEX_PROJECT` environment variable.
+
+- **location** _string_
+
+  The Google Cloud location. Grok models are available on the global endpoint. Defaults to the `GOOGLE_VERTEX_LOCATION` environment variable. If not set, defaults to `global`.
+
+- **googleAuthOptions** _object_
+
+  Optional. The Authentication options used by the [Google Auth Library](https://github.com/googleapis/google-auth-library-nodejs/).
+
+- **headers** _Resolvable&lt;Record&lt;string, string | undefined&gt;&gt;_
+
+  Headers to include in requests.
+
+- **fetch** _(input: RequestInfo, init?: RequestInit) => Promise&lt;Response&gt;_
+
+  Custom [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) implementation.
+
+<a id="google-vertex-xai-edge-runtime"></a>
+
+#### Edge Runtime
+
+For Edge runtimes, import from `@ai-sdk/google-vertex/xai/edge`:
+
+```typescript
+import { googleVertexXai } from '@ai-sdk/google-vertex/xai/edge';
+```
+
+```typescript
+import { createGoogleVertexXai } from '@ai-sdk/google-vertex/xai/edge';
+
+const googleVertexXai = createGoogleVertexXai({
+  project: 'my-project',
+  location: 'global',
+});
+```
+
+For Edge runtime authentication, set these environment variables:
+
+- `GOOGLE_CLIENT_EMAIL`
+- `GOOGLE_PRIVATE_KEY`
+- `GOOGLE_PRIVATE_KEY_ID` (optional)
+
+### Language Models
+
+You can create models using the provider instance. The first argument is the model ID:
+
+```ts
+import { googleVertexXai } from '@ai-sdk/google-vertex/xai';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: googleVertexXai('xai/grok-4.1-fast-reasoning'),
+  prompt: 'Invent a new holiday and describe its traditions.',
+});
+```
+
+Streaming is also supported:
+
+```ts
+import { googleVertexXai } from '@ai-sdk/google-vertex/xai';
+import { streamText } from 'ai';
+
+const result = streamText({
+  model: googleVertexXai('xai/grok-4.1-fast-reasoning'),
+  prompt: 'Invent a new holiday and describe its traditions.',
+});
+
+for await (const textPart of result.textStream) {
+  process.stdout.write(textPart);
+}
+```
+
+### Function Calling
+
+Grok models on Vertex support OpenAI-compatible function calling. You can use AI SDK tools as usual:
+
+```ts
+import { googleVertexXai } from '@ai-sdk/google-vertex/xai';
+import { generateText, tool } from 'ai';
+import { z } from 'zod';
+
+const result = await generateText({
+  model: googleVertexXai('xai/grok-4.1-fast-reasoning'),
+  tools: {
+    weather: tool({
+      description: 'Get the weather in a city',
+      inputSchema: z.object({ city: z.string() }),
+      execute: async ({ city }) => `The weather in ${city} is sunny.`,
+    }),
+  },
+  prompt: 'What is the weather in San Francisco?',
+});
+```
+
+### Structured Outputs
+
+Grok models on Vertex support JSON mode and schema-backed structured outputs:
+
+```ts
+import { googleVertexXai } from '@ai-sdk/google-vertex/xai';
+import { generateText, Output } from 'ai';
+import { z } from 'zod';
+
+const result = await generateText({
+  model: googleVertexXai('xai/grok-4.1-fast-reasoning'),
+  output: Output.object({  
+    schema: z.object({
+      name: z.string(),
+      date: z.string(),
+      participants: z.array(z.string()),
+    }),
+  }),
+  prompt: 'Alice and Bob are going to a science fair on Friday.',
+});
+```
+
+### Available Models
+
+The following models are available through the Google Vertex xAI provider. You can also pass any valid model ID as a string.
+
+| Model ID                            | Reasoning |
+| ----------------------------------- | --------- |
+| `xai/grok-4.20-reasoning`           | Yes       |
+| `xai/grok-4.20-non-reasoning`       | No        |
+| `xai/grok-4.1-fast-reasoning`       | Yes       |
+| `xai/grok-4.1-fast-non-reasoning`   | No        |
+
+<Note>
+  Grok reasoning models on Vertex report reasoning token counts in usage
+  metadata. They do not support the `reasoning_effort` request parameter.
+</Note>
+
 ## Google Vertex MaaS Provider Usage
 
 The Google Vertex MaaS (Model as a Service) provider offers access to partner and open models hosted on Vertex AI through an OpenAI-compatible Chat Completions API. This includes models from DeepSeek, Qwen, Meta, MiniMax, Moonshot, and OpenAI.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/google-vertex",
-  "version": "4.0.116",
+  "version": "4.0.118",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -20,7 +20,9 @@
     "anthropic/edge.d.ts",
     "anthropic/index.d.ts",
     "maas/edge.d.ts",
-    "maas/index.d.ts"
+    "maas/index.d.ts",
+    "xai/edge.d.ts",
+    "xai/index.d.ts"
   ],
   "directories": {
     "doc": "./docs"
@@ -54,16 +56,26 @@
     },
     "./maas/edge": {
       "types": "./dist/maas/edge/index.d.ts",
-      "import": "./dist/maas/edge/index.mjs",
-      "require": "./dist/maas/edge/index.js"
+      "import": "./dist/maas/edge/index.js",
+      "default": "./dist/maas/edge/index.js"
+    },
+    "./xai": {
+      "types": "./dist/xai/index.d.ts",
+      "import": "./dist/xai/index.js",
+      "default": "./dist/xai/index.js"
+    },
+    "./xai/edge": {
+      "types": "./dist/xai/edge/index.d.ts",
+      "import": "./dist/xai/edge/index.js",
+      "default": "./dist/xai/edge/index.js"
     }
   },
   "dependencies": {
     "google-auth-library": "^10.5.0",
     "@ai-sdk/anthropic": "3.0.74",
     "@ai-sdk/google": "3.0.67",
+    "@ai-sdk/openai-compatible": "2.0.45",
     "@ai-sdk/provider": "3.0.10",
-    "@ai-sdk/openai-compatible": "2.0.44",
     "@ai-sdk/provider-utils": "4.0.26"
   },
   "devDependencies": {
@@ -71,8 +83,8 @@
     "tsup": "^8",
     "typescript": "5.8.3",
     "zod": "3.25.76",
-    "@vercel/ai-tsconfig": "0.0.0",
-    "@ai-sdk/test-server": "1.0.5"
+    "@ai-sdk/test-server": "1.0.5",
+    "@vercel/ai-tsconfig": "0.0.0"
   },
   "peerDependencies": {
     "zod": "^3.25.76 || ^4.1.8"

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

@@ -1,6 +1,6 @@
 import { resolve } from '@ai-sdk/provider-utils';
 import type { GoogleAuthOptions } from 'google-auth-library';
-import { generateAuthToken as defaultGenerateAuthToken } from '../google-vertex-auth-google-auth-library';
+import { createAuthTokenGenerator } from '../google-vertex-auth-google-auth-library';
 import {
   createVertexAnthropic as createVertexAnthropicOriginal,
   type GoogleVertexAnthropicProvider,
@@ -29,7 +29,8 @@ export function createVertexAnthropic(
 ): GoogleVertexAnthropicProvider {
   const generateAuthToken =
     options.generateAuthToken ??
-    (() => defaultGenerateAuthToken(options.googleAuthOptions));
+    createAuthTokenGenerator(options.googleAuthOptions);
+
   return createVertexAnthropicOriginal({
     ...options,
     headers: async () => ({

package/src/google-vertex-auth-google-auth-library.ts

@@ -1,27 +1,14 @@
 import { GoogleAuth, type GoogleAuthOptions } from 'google-auth-library';
 
-let authInstance: GoogleAuth | null = null;
-let authOptions: GoogleAuthOptions | null = null;
-
-function getAuth(options: GoogleAuthOptions) {
-  if (!authInstance || options !== authOptions) {
-    authInstance = new GoogleAuth({
-      scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-      ...options,
-    });
-    authOptions = options;
-  }
-  return authInstance;
-}
-
-export async function generateAuthToken(options?: GoogleAuthOptions) {
-  const auth = getAuth(options || {});
-  const client = await auth.getClient();
-  const token = await client.getAccessToken();
-  return token?.token || null;
-}
-
-// For testing purposes only
-export function _resetAuthInstance() {
-  authInstance = null;
+export function createAuthTokenGenerator(options?: GoogleAuthOptions) {
+  const auth = new GoogleAuth({
+    scopes: ['https://www.googleapis.com/auth/cloud-platform'],
+    ...options,
+  });
+
+  return async function generateAuthToken() {
+    const client = await auth.getClient();
+    const token = await client.getAccessToken();
+    return token?.token ?? null;
+  };
 }

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

@@ -1,6 +1,6 @@
 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 { createAuthTokenGenerator } from './google-vertex-auth-google-auth-library';
 import {
   createVertex as createVertexOriginal,
   type GoogleVertexProvider,
@@ -31,12 +31,12 @@ export function createVertex(
     return createVertexOriginal(options);
   }
 
+  const generateAuthToken = createAuthTokenGenerator(options.googleAuthOptions);
+
   return createVertexOriginal({
     ...options,
     headers: async () => ({
-      Authorization: `Bearer ${await generateAuthToken(
-        options.googleAuthOptions,
-      )}`,
+      Authorization: `Bearer ${await generateAuthToken()}`,
       ...(await resolve(options.headers)),
     }),
   });

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

@@ -1,6 +1,6 @@
 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 { createAuthTokenGenerator } from '../google-vertex-auth-google-auth-library';
 import {
   createVertexMaas as createVertexMaasOriginal,
   type GoogleVertexMaasProvider,
@@ -29,9 +29,11 @@ export interface GoogleVertexMaasProviderSettings extends GoogleVertexMaasProvid
 export function createVertexMaas(
   options: GoogleVertexMaasProviderSettings = {},
 ): GoogleVertexMaasProvider {
+  const generateAuthToken = createAuthTokenGenerator(options.googleAuthOptions);
+
   // Create a custom fetch wrapper that adds auth headers
   const customFetch: FetchFunction = async (url, init) => {
-    const token = await generateAuthToken(options.googleAuthOptions);
+    const token = await generateAuthToken();
     const resolvedHeaders = await resolve(options.headers);
     const authHeaders = {
       ...resolvedHeaders,

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();