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

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>
@@ -45,18 +45,18 @@ The Google Vertex provider instance is used to create model instances that call
 
 ### Provider Instance
 
-You can import the default provider instance `vertex` from `@ai-sdk/google-vertex`:
+You can import the default provider instance `googleVertex` from `@ai-sdk/google-vertex`:
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 ```
 
-If you need a customized setup, you can import `createVertex` from `@ai-sdk/google-vertex` and create a provider instance with your settings:
+If you need a customized setup, you can import `createGoogleVertex` from `@ai-sdk/google-vertex` and create a provider instance with your settings:
 
 ```ts
-import { createVertex } from '@ai-sdk/google-vertex';
+import { createGoogleVertex } from '@ai-sdk/google-vertex';
 
-const vertex = createVertex({
+const googleVertex = createGoogleVertex({
   project: 'my-project', // optional
   location: 'us-central1', // optional
 });
@@ -68,12 +68,12 @@ Google Vertex supports multiple authentication methods depending on your runtime
 
 The Node.js runtime is the default runtime supported by the AI SDK. It supports all standard Google Cloud authentication options through the [`google-auth-library`](https://github.com/googleapis/google-auth-library-nodejs?tab=readme-ov-file#ways-to-authenticate). Typical use involves setting a path to a json credentials file in the `GOOGLE_APPLICATION_CREDENTIALS` environment variable. The credentials file can be obtained from the [Google Cloud Console](https://console.cloud.google.com/apis/credentials).
 
-If you want to customize the Google authentication options you can pass them as options to the `createVertex` function, for example:
+If you want to customize the Google authentication options you can pass them as options to the `createGoogleVertex` function, for example:
 
 ```ts
-import { createVertex } from '@ai-sdk/google-vertex';
+import { createGoogleVertex } from '@ai-sdk/google-vertex';
 
-const vertex = createVertex({
+const googleVertex = createGoogleVertex({
   googleAuthOptions: {
     credentials: {
       client_email: 'my-email',
@@ -156,10 +156,10 @@ For example, direct file system access is not available, and many Node.js-specif
 
 The Edge runtime version of the Google Vertex provider supports Google's [Application Default Credentials](https://github.com/googleapis/google-auth-library-nodejs?tab=readme-ov-file#application-default-credentials) through environment variables. The values can be obtained from a json credentials file from the [Google Cloud Console](https://console.cloud.google.com/apis/credentials).
 
-You can import the default provider instance `vertex` from `@ai-sdk/google-vertex/edge`:
+You can import the default provider instance `googleVertex` from `@ai-sdk/google-vertex/edge`:
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex/edge';
+import { googleVertex } from '@ai-sdk/google-vertex/edge';
 ```
 
 <Note>
@@ -168,12 +168,12 @@ import { vertex } from '@ai-sdk/google-vertex/edge';
   `@ai-sdk/google-vertex/edge` to differentiate it from the Node.js provider.
 </Note>
 
-If you need a customized setup, you can import `createVertex` from `@ai-sdk/google-vertex/edge` and create a provider instance with your settings:
+If you need a customized setup, you can import `createGoogleVertex` from `@ai-sdk/google-vertex/edge` and create a provider instance with your settings:
 
 ```ts
-import { createVertex } from '@ai-sdk/google-vertex/edge';
+import { createGoogleVertex } from '@ai-sdk/google-vertex/edge';
 
-const vertex = createVertex({
+const googleVertex = createGoogleVertex({
   project: 'my-project', // optional
   location: 'us-central1', // optional
 });
@@ -235,9 +235,9 @@ You can use the following optional settings to customize the provider instance:
 Express mode provides a simplified authentication method using an API key instead of OAuth or service account credentials. When using express mode, the `project` and `location` settings are not required.
 
 ```ts
-import { createVertex } from '@ai-sdk/google-vertex';
+import { createGoogleVertex } from '@ai-sdk/google-vertex';
 
-const vertex = createVertex({
+const googleVertex = createGoogleVertex({
   apiKey: process.env.GOOGLE_VERTEX_API_KEY,
 });
 ```
@@ -255,7 +255,7 @@ You can create models that call the Vertex API using the provider instance.
 The first argument is the model id, e.g. `gemini-2.5-pro`.
 
 ```ts
-const model = vertex('gemini-2.5-pro');
+const model = googleVertex('gemini-2.5-pro');
 ```
 
 <Note>
@@ -269,10 +269,10 @@ of the [standard call settings](/docs/ai-sdk-core/settings). You can pass them a
 an options argument:
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { type GoogleLanguageModelOptions } from '@ai-sdk/google';
 
-const model = vertex('gemini-2.5-pro');
+const model = googleVertex('gemini-2.5-pro');
 
 await generateText({
   model,
@@ -357,11 +357,11 @@ The following optional provider options are available for Google Vertex models:
 You can use Google Vertex language models to generate text with the `generateText` function:
 
 ```ts highlight="1,4"
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateText } from 'ai';
 
 const { text } = await generateText({
-  model: vertex('gemini-2.5-pro'),
+  model: googleVertex('gemini-2.5-pro'),
   prompt: 'Write a vegetarian lasagna recipe for 4 people.',
 });
 ```
@@ -376,12 +376,12 @@ With [Code Execution](https://cloud.google.com/vertex-ai/generative-ai/docs/mult
 You can enable code execution by adding the `code_execution` tool to your request.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateText } from 'ai';
 
 const result = await generateText({
-  model: vertex('gemini-2.5-pro'),
-  tools: { code_execution: vertex.tools.codeExecution({}) },
+  model: googleVertex('gemini-2.5-pro'),
+  tools: { code_execution: googleVertex.tools.codeExecution({}) },
   prompt:
     'Use python to calculate 20th fibonacci number. Then find the nearest palindrome to it.',
 });
@@ -394,12 +394,12 @@ The response will contain `tool-call` and `tool-result` parts for the executed c
 URL Context allows Gemini models to retrieve and analyze content from URLs. Supported models: Gemini 2.5 Flash-Lite, 2.5 Pro, 2.5 Flash, 2.0 Flash.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateText } from 'ai';
 
 const result = await generateText({
-  model: vertex('gemini-2.5-pro'),
-  tools: { url_context: vertex.tools.urlContext({}) },
+  model: googleVertex('gemini-2.5-pro'),
+  tools: { url_context: googleVertex.tools.urlContext({}) },
   prompt: 'What are the key points from https://example.com/article?',
 });
 ```
@@ -409,12 +409,12 @@ const result = await generateText({
 Google Search enables Gemini models to access real-time web information. Supported models: Gemini 2.5 Flash-Lite, 2.5 Flash, 2.0 Flash, 2.5 Pro.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateText } from 'ai';
 
 const result = await generateText({
-  model: vertex('gemini-2.5-pro'),
-  tools: { google_search: vertex.tools.googleSearch({}) },
+  model: googleVertex('gemini-2.5-pro'),
+  tools: { google_search: googleVertex.tools.googleSearch({}) },
   prompt: 'What are the latest developments in AI?',
 });
 ```
@@ -424,13 +424,13 @@ const result = await generateText({
 [Enterprise Web Search](https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/web-grounding-enterprise) provides grounding using a compliance-focused web index designed for highly-regulated industries such as finance, healthcare, and the public sector. Unlike standard Google Search grounding, Enterprise Web Search does not log customer data and supports VPC service controls. Supported models: Gemini 2.0 and newer.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateText } from 'ai';
 
 const result = await generateText({
-  model: vertex('gemini-2.5-flash'),
+  model: googleVertex('gemini-2.5-flash'),
   tools: {
-    enterprise_web_search: vertex.tools.enterpriseWebSearch({}),
+    enterprise_web_search: googleVertex.tools.enterpriseWebSearch({}),
   },
   prompt: 'What are the latest FDA regulations for clinical trials?',
 });
@@ -441,14 +441,14 @@ const result = await generateText({
 Google Maps grounding enables Gemini models to access Google Maps data for location-aware responses. Supported models: Gemini 2.5 Flash-Lite, 2.5 Flash, 2.0 Flash, 2.5 Pro, 3.0 Pro.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { type GoogleLanguageModelOptions } from '@ai-sdk/google';
 import { generateText } from 'ai';
 
 const result = await generateText({
-  model: vertex('gemini-2.5-flash'),
+  model: googleVertex('gemini-2.5-flash'),
   tools: {
-    google_maps: vertex.tools.googleMaps({}),
+    google_maps: googleVertex.tools.googleMaps({}),
   },
   providerOptions: {
     vertex: {
@@ -472,13 +472,13 @@ arguments as they are generated by setting `streamFunctionCallArguments` to
 complete arguments. This option defaults to `false`.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { type GoogleLanguageModelOptions } from '@ai-sdk/google';
 import { streamText } from 'ai';
 import { z } from 'zod';
 
 const result = streamText({
-  model: vertex('gemini-3.1-pro-preview'),
+  model: googleVertex('gemini-3.1-pro-preview'),
   prompt: 'What is the weather in Boston and San Francisco?',
   tools: {
     getWeather: {
@@ -523,13 +523,13 @@ Google Vertex AI, through its support for Gemini models, can also emit "thinking
 To enable thinking tokens for compatible Gemini models via Vertex, set `includeThoughts: true` in the `thinkingConfig` provider option. These options are passed through `providerOptions.vertex`:
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { type GoogleLanguageModelOptions } from '@ai-sdk/google';
 import { generateText, streamText } from 'ai';
 
 // For generateText:
 const { text, reasoningText, reasoning } = await generateText({
-  model: vertex('gemini-2.0-flash-001'), // Or other supported model via Vertex
+  model: googleVertex('gemini-2.0-flash-001'), // Or other supported model via Vertex
   providerOptions: {
     vertex: {
       thinkingConfig: {
@@ -547,7 +547,7 @@ console.log('Final Text:', text);
 
 // For streamText:
 const result = streamText({
-  model: vertex('gemini-2.0-flash-001'), // Or other supported model via Vertex
+  model: googleVertex('gemini-2.0-flash-001'), // Or other supported model via Vertex
   providerOptions: {
     vertex: {
       thinkingConfig: {
@@ -584,11 +584,11 @@ When `includeThoughts` is true, parts of the API response marked with `thought:
 The Google Vertex provider supports file inputs, e.g. PDF files.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateText } from 'ai';
 
 const { text } = await generateText({
-  model: vertex('gemini-2.5-pro'),
+  model: googleVertex('gemini-2.5-pro'),
   messages: [
     {
       role: 'user',
@@ -623,7 +623,7 @@ Google Vertex AI supports both explicit and implicit caching to help reduce cost
 #### Implicit Caching
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateText } from 'ai';
 
 // Structure prompts with consistent content at the beginning
@@ -631,13 +631,13 @@ const baseContext =
   'You are a cooking assistant with expertise in Italian cuisine. Here are 1000 lasagna recipes for reference...';
 
 const { text: veggieLasagna } = await generateText({
-  model: vertex('gemini-2.5-pro'),
+  model: googleVertex('gemini-2.5-pro'),
   prompt: `${baseContext}\n\nWrite a vegetarian lasagna recipe for 4 people.`,
 });
 
 // Second request with same prefix - eligible for cache hit
 const { text: meatLasagna, providerMetadata } = await generateText({
-  model: vertex('gemini-2.5-pro'),
+  model: googleVertex('gemini-2.5-pro'),
   prompt: `${baseContext}\n\nWrite a meat lasagna recipe for 12 people.`,
 });
 
@@ -695,12 +695,12 @@ console.log('Cache created:', cache.name);
 Then use the cache with the AI SDK:
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { type GoogleLanguageModelOptions } from '@ai-sdk/google';
 import { generateText } from 'ai';
 
 const { text: veggieLasagnaRecipe } = await generateText({
-  model: vertex('gemini-2.5-pro'),
+  model: googleVertex('gemini-2.5-pro'),
   prompt: 'Write a vegetarian lasagna recipe for 4 people.',
   providerOptions: {
     vertex: {
@@ -710,7 +710,7 @@ const { text: veggieLasagnaRecipe } = await generateText({
 });
 
 const { text: meatLasagnaRecipe } = await generateText({
-  model: vertex('gemini-2.5-pro'),
+  model: googleVertex('gemini-2.5-pro'),
   prompt: 'Write a meat lasagna recipe for 12 people.',
   providerOptions: {
     vertex: {
@@ -779,12 +779,12 @@ By default, structured outputs are enabled (and for tool calling they are requir
 You can disable structured outputs for object generation as a workaround:
 
 ```ts highlight="7,12"
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { type GoogleLanguageModelOptions } from '@ai-sdk/google';
 import { generateText, Output } from 'ai';
 
 const result = await generateText({
-  model: vertex('gemini-2.5-pro'),
+  model: googleVertex('gemini-2.5-pro'),
   providerOptions: {
     vertex: {
       structuredOutputs: false,
@@ -836,19 +836,19 @@ The following Zod features are known to not work with Google Vertex:
 You can create models that call the Google Vertex AI embeddings API using the `.embeddingModel()` factory method:
 
 ```ts
-const model = vertex.embeddingModel('text-embedding-005');
+const model = googleVertex.embeddingModel('text-embedding-005');
 ```
 
 Google Vertex AI embedding models support additional settings. You can pass them as an options argument:
 
 ```ts
 import {
-  vertex,
+  googleVertex,
   type GoogleVertexEmbeddingModelOptions,
 } from '@ai-sdk/google-vertex';
 import { embed } from 'ai';
 
-const model = vertex.embeddingModel('text-embedding-005');
+const model = googleVertex.embeddingModel('text-embedding-005');
 
 const { embedding } = await embed({
   model,
@@ -911,11 +911,11 @@ You can create image models using the `.image()` factory method. The Google Vert
 [Imagen models](https://cloud.google.com/vertex-ai/generative-ai/docs/image/generate-images) generate images using the Imagen on Vertex AI API.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateImage } from 'ai';
 
 const { image } = await generateImage({
-  model: vertex.image('imagen-4.0-generate-001'),
+  model: googleVertex.image('imagen-4.0-generate-001'),
   prompt: 'A futuristic cityscape at sunset',
   aspectRatio: '16:9',
 });
@@ -924,12 +924,12 @@ const { image } = await generateImage({
 Further configuration can be done using Google Vertex provider options. You can validate the provider options using the `GoogleVertexImageModelOptions` type.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { GoogleVertexImageModelOptions } from '@ai-sdk/google-vertex';
 import { generateImage } from 'ai';
 
 const { image } = await generateImage({
-  model: vertex.image('imagen-4.0-generate-001'),
+  model: googleVertex.image('imagen-4.0-generate-001'),
   providerOptions: {
     vertex: {
       negativePrompt: 'pixelated, blurry, low-quality',
@@ -964,12 +964,12 @@ The following provider options are available:
 Additional information about the images can be retrieved using Google Vertex meta data.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { GoogleVertexImageModelOptions } from '@ai-sdk/google-vertex';
 import { generateImage } from 'ai';
 
 const { image, providerMetadata } = await generateImage({
-  model: vertex.image('imagen-4.0-generate-001'),
+  model: googleVertex.image('imagen-4.0-generate-001'),
   prompt: 'A futuristic cityscape at sunset',
   aspectRatio: '16:9',
 });
@@ -993,7 +993,7 @@ Google Vertex Imagen models support image editing through inpainting, outpaintin
 Insert or replace objects in specific areas using a mask:
 
 ```ts
-import { vertex, GoogleVertexImageModelOptions } from '@ai-sdk/google-vertex';
+import { googleVertex, GoogleVertexImageModelOptions } from '@ai-sdk/google-vertex';
 import { generateImage } from 'ai';
 import fs from 'fs';
 
@@ -1001,7 +1001,7 @@ const image = fs.readFileSync('./input-image.png');
 const mask = fs.readFileSync('./mask.png'); // White = edit area
 
 const { images } = await generateImage({
-  model: vertex.image('imagen-3.0-capability-001'),
+  model: googleVertex.image('imagen-3.0-capability-001'),
   prompt: {
     text: 'A sunlit indoor lounge area with a pool containing a flamingo',
     images: [image],
@@ -1025,7 +1025,7 @@ const { images } = await generateImage({
 Extend an image beyond its original boundaries:
 
 ```ts
-import { vertex, GoogleVertexImageModelOptions } from '@ai-sdk/google-vertex';
+import { googleVertex, GoogleVertexImageModelOptions } from '@ai-sdk/google-vertex';
 import { generateImage } from 'ai';
 import fs from 'fs';
 
@@ -1033,7 +1033,7 @@ const image = fs.readFileSync('./input-image.png');
 const mask = fs.readFileSync('./outpaint-mask.png'); // White = extend area
 
 const { images } = await generateImage({
-  model: vertex.image('imagen-3.0-capability-001'),
+  model: googleVertex.image('imagen-3.0-capability-001'),
   prompt: {
     text: 'Extend the scene with more of the forest background',
     images: [image],
@@ -1098,11 +1098,11 @@ The following options are available under `providerOptions.vertex.edit`:
 [Gemini image models](https://cloud.google.com/vertex-ai/generative-ai/docs/models/gemini/2-5-flash-image) (e.g. `gemini-2.5-flash-image`) are multimodal output language models that can be used with `generateImage()` for a simpler image generation experience. Internally, the provider calls the language model API with `responseModalities: ['IMAGE']`.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateImage } from 'ai';
 
 const { image } = await generateImage({
-  model: vertex.image('gemini-2.5-flash-image'),
+  model: googleVertex.image('gemini-2.5-flash-image'),
   prompt: 'A photorealistic image of a cat wearing a wizard hat',
   aspectRatio: '1:1',
 });
@@ -1111,14 +1111,14 @@ const { image } = await generateImage({
 Gemini image models also support image editing by providing input images:
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateImage } from 'ai';
 import fs from 'node:fs';
 
 const sourceImage = fs.readFileSync('./cat.png');
 
 const { image } = await generateImage({
-  model: vertex.image('gemini-2.5-flash-image'),
+  model: googleVertex.image('gemini-2.5-flash-image'),
   prompt: {
     text: 'Add a small wizard hat to this cat',
     images: [sourceImage],
@@ -1129,11 +1129,11 @@ const { image } = await generateImage({
 You can also use URLs (including `gs://` Cloud Storage URIs) for input images:
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { generateImage } from 'ai';
 
 const { image } = await generateImage({
-  model: vertex.image('gemini-2.5-flash-image'),
+  model: googleVertex.image('gemini-2.5-flash-image'),
   prompt: {
     text: 'Add a small wizard hat to this cat',
     images: ['https://example.com/cat.png'],
@@ -1174,11 +1174,11 @@ You can create [Veo](https://cloud.google.com/vertex-ai/generative-ai/docs/video
 using the `.video()` factory method. For more on video generation with the AI SDK see [generateVideo()](/docs/reference/ai-sdk-core/generate-video).
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { experimental_generateVideo as generateVideo } from 'ai';
 
 const { video } = await generateVideo({
-  model: vertex.video('veo-3.1-generate-001'),
+  model: googleVertex.video('veo-3.1-generate-001'),
   prompt:
     'A pangolin curled on a mossy stone in a glowing bioluminescent forest',
   aspectRatio: '16:9',
@@ -1188,11 +1188,11 @@ const { video } = await generateVideo({
 You can configure resolution and duration:
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { experimental_generateVideo as generateVideo } from 'ai';
 
 const { video } = await generateVideo({
-  model: vertex.video('veo-3.1-generate-001'),
+  model: googleVertex.video('veo-3.1-generate-001'),
   prompt: 'A serene mountain landscape at sunset',
   aspectRatio: '16:9',
   resolution: '1920x1080',
@@ -1205,12 +1205,12 @@ const { video } = await generateVideo({
 Further configuration can be done using Google Vertex provider options. You can validate the provider options using the `GoogleVertexVideoModelOptions` type.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex';
+import { googleVertex } from '@ai-sdk/google-vertex';
 import { GoogleVertexVideoModelOptions } from '@ai-sdk/google-vertex';
 import { experimental_generateVideo as generateVideo } from 'ai';
 
 const { video } = await generateVideo({
-  model: vertex.video('veo-3.1-generate-001'),
+  model: googleVertex.video('veo-3.1-generate-001'),
   prompt: 'A serene mountain landscape at sunset',
   aspectRatio: '16:9',
   providerOptions: {
@@ -1579,7 +1579,7 @@ console.log(
 
 You can also use cache control on system messages by providing multiple system messages at the head of your messages array:
 
-```ts highlight="3,9-11"
+```ts highlight="3,7-9"
 const result = await generateText({
   model: vertexAnthropic('claude-3-5-sonnet-20240620'),
   messages: [
@@ -1782,6 +1782,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.