@ai-sdk/google-vertex 4.0.27 → 4.0.29

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @ai-sdk/google-vertex
 
+## 4.0.29
+
+### Patch Changes
+
+- Updated dependencies [462ad00]
+  - @ai-sdk/provider-utils@4.0.10
+  - @ai-sdk/anthropic@3.0.24
+  - @ai-sdk/google@3.0.14
+
+## 4.0.28
+
+### Patch Changes
+
+- 4de5a1d: chore: excluded tests from src folder in npm package
+- Updated dependencies [4de5a1d]
+  - @ai-sdk/anthropic@3.0.23
+  - @ai-sdk/google@3.0.13
+  - @ai-sdk/provider@3.0.5
+  - @ai-sdk/provider-utils@4.0.9
+
 ## 4.0.27
 
 ### Patch Changes

package/dist/anthropic/edge/index.js

@@ -32,7 +32,7 @@ var import_provider_utils3 = require("@ai-sdk/provider-utils");
 var import_provider_utils = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "4.0.27" : "0.0.0-test";
+var VERSION = true ? "4.0.29" : "0.0.0-test";
 
 // src/edge/google-vertex-auth-edge.ts
 var loadCredentials = async () => {

package/dist/anthropic/edge/index.mjs

@@ -10,7 +10,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "4.0.27" : "0.0.0-test";
+var VERSION = true ? "4.0.29" : "0.0.0-test";
 
 // src/edge/google-vertex-auth-edge.ts
 var loadCredentials = async () => {

package/dist/edge/index.js

@@ -33,7 +33,7 @@ var import_internal2 = require("@ai-sdk/google/internal");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "4.0.27" : "0.0.0-test";
+var VERSION = true ? "4.0.29" : "0.0.0-test";
 
 // src/google-vertex-embedding-model.ts
 var import_provider = require("@ai-sdk/provider");

package/dist/edge/index.mjs

@@ -14,7 +14,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "4.0.27" : "0.0.0-test";
+var VERSION = true ? "4.0.29" : "0.0.0-test";
 
 // src/google-vertex-embedding-model.ts
 import {

package/dist/index.js

@@ -55,7 +55,7 @@ var import_internal2 = require("@ai-sdk/google/internal");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "4.0.27" : "0.0.0-test";
+var VERSION = true ? "4.0.29" : "0.0.0-test";
 
 // src/google-vertex-embedding-model.ts
 var import_provider = require("@ai-sdk/provider");

package/dist/index.mjs

@@ -35,7 +35,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "4.0.27" : "0.0.0-test";
+var VERSION = true ? "4.0.29" : "0.0.0-test";
 
 // src/google-vertex-embedding-model.ts
 import {

package/docs/16-google-vertex.mdx

@@ -287,6 +287,11 @@ await generateText({
 
 The following optional provider options are available for Google Vertex models:
 
+- **cachedContent** _string_
+
+  Optional. The name of the cached content used as context to serve the prediction.
+  Format: projects/\{project\}/locations/\{location\}/cachedContents/\{cachedContent\}
+
 - **structuredOutputs** _boolean_
 
   Optional. Enable structured output. Default is true.
@@ -546,6 +551,109 @@ const { text } = await generateText({
 
 See [File Parts](/docs/foundations/prompts#file-parts) for details on how to use files in prompts.
 
+### Cached Content
+
+Google Vertex AI supports both explicit and implicit caching to help reduce costs on repetitive content.
+
+#### Implicit Caching
+
+```ts
+import { vertex } from '@ai-sdk/google-vertex';
+import { generateText } from 'ai';
+
+// Structure prompts with consistent content at the beginning
+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'),
+  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'),
+  prompt: `${baseContext}\n\nWrite a meat lasagna recipe for 12 people.`,
+});
+
+// Check cached token count in usage metadata
+console.log('Cached tokens:', providerMetadata.google);
+// e.g.
+// {
+//   groundingMetadata: null,
+//   safetyRatings: null,
+//   usageMetadata: {
+//     cachedContentTokenCount: 2027,
+//     thoughtsTokenCount: 702,
+//     promptTokenCount: 2152,
+//     candidatesTokenCount: 710,
+//     totalTokenCount: 3564
+//   }
+// }
+```
+
+#### Explicit Caching
+
+You can use explicit caching with Gemini models. See the [Vertex AI context caching documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-overview) to check if caching is supported for your model.
+
+First, create a cache using the Google GenAI SDK with Vertex mode enabled:
+
+```ts
+import { GoogleGenAI } from '@google/genai';
+
+const ai = new GoogleGenAI({
+  vertexai: true,
+  project: process.env.GOOGLE_VERTEX_PROJECT,
+  location: process.env.GOOGLE_VERTEX_LOCATION,
+});
+
+const model = 'gemini-2.5-pro';
+
+// Create a cache with the content you want to reuse
+const cache = await ai.caches.create({
+  model,
+  config: {
+    contents: [
+      {
+        role: 'user',
+        parts: [{ text: '1000 Lasagna Recipes...' }],
+      },
+    ],
+    ttl: '300s', // Cache expires after 5 minutes
+  },
+});
+
+console.log('Cache created:', cache.name);
+// e.g. projects/my-project/locations/us-central1/cachedContents/abc123
+```
+
+Then use the cache with the AI SDK:
+
+```ts
+import { vertex } from '@ai-sdk/google-vertex';
+import { generateText } from 'ai';
+
+const { text: veggieLasagnaRecipe } = await generateText({
+  model: vertex('gemini-2.5-pro'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+  providerOptions: {
+    google: {
+      cachedContent: cache.name,
+    },
+  },
+});
+
+const { text: meatLasagnaRecipe } = await generateText({
+  model: vertex('gemini-2.5-pro'),
+  prompt: 'Write a meat lasagna recipe for 12 people.',
+  providerOptions: {
+    google: {
+      cachedContent: cache.name,
+    },
+  },
+});
+```
+
 ### Safety Ratings
 
 The safety ratings provide insight into the safety of the model's response.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/google-vertex",
-  "version": "4.0.27",
+  "version": "4.0.29",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -10,6 +10,10 @@
     "dist/**/*",
     "docs/**/*",
     "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/**/__snapshots__",
+    "!src/**/__fixtures__",
     "CHANGELOG.md",
     "README.md",
     "edge.d.ts",
@@ -44,17 +48,17 @@
   },
   "dependencies": {
     "google-auth-library": "^10.5.0",
-    "@ai-sdk/anthropic": "3.0.22",
-    "@ai-sdk/google": "3.0.12",
-    "@ai-sdk/provider": "3.0.4",
-    "@ai-sdk/provider-utils": "4.0.8"
+    "@ai-sdk/anthropic": "3.0.24",
+    "@ai-sdk/provider": "3.0.5",
+    "@ai-sdk/provider-utils": "4.0.10",
+    "@ai-sdk/google": "3.0.14"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
     "tsup": "^8",
     "typescript": "5.8.3",
     "zod": "3.25.76",
-    "@ai-sdk/test-server": "1.0.2",
+    "@ai-sdk/test-server": "1.0.3",
     "@vercel/ai-tsconfig": "0.0.0"
   },
   "peerDependencies": {

package/src/__snapshots__/google-vertex-embedding-model.test.ts.snap

@@ -1,39 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`GoogleVertexEmbeddingModel > should expose the raw response 1`] = `
-{
-  "body": {
-    "predictions": [
-      {
-        "embeddings": {
-          "statistics": {
-            "token_count": 1,
-          },
-          "values": [
-            0.1,
-            0.2,
-            0.3,
-          ],
-        },
-      },
-      {
-        "embeddings": {
-          "statistics": {
-            "token_count": 1,
-          },
-          "values": [
-            0.4,
-            0.5,
-            0.6,
-          ],
-        },
-      },
-    ],
-  },
-  "headers": {
-    "content-length": "159",
-    "content-type": "application/json",
-    "test-header": "test-value",
-  },
-}
-`;

package/src/anthropic/edge/google-vertex-anthropic-provider-edge.test.ts

@@ -1,87 +0,0 @@
-import { resolve } from '@ai-sdk/provider-utils';
-import * as edgeAuth from '../../edge/google-vertex-auth-edge';
-import { createVertexAnthropic as createVertexAnthropicOriginal } from '../google-vertex-anthropic-provider';
-import { createVertexAnthropic as createVertexAnthropicEdge } from './google-vertex-anthropic-provider-edge';
-import { describe, beforeEach, expect, it, vi } from 'vitest';
-
-// Mock the imported modules
-vi.mock('../../edge/google-vertex-auth-edge', () => ({
-  generateAuthToken: vi.fn().mockResolvedValue('mock-auth-token'),
-}));
-
-vi.mock('../google-vertex-anthropic-provider', () => ({
-  createVertexAnthropic: vi.fn().mockImplementation(options => ({
-    ...options,
-  })),
-}));
-
-describe('google-vertex-anthropic-provider-edge', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it('default headers function should return auth token', async () => {
-    createVertexAnthropicEdge({ project: 'test-project' });
-
-    const mockCreateVertex = vi.mocked(createVertexAnthropicOriginal);
-    const passedOptions = mockCreateVertex.mock.calls[0][0];
-
-    expect(mockCreateVertex).toHaveBeenCalledTimes(1);
-    expect(typeof passedOptions?.headers).toBe('function');
-
-    expect(await resolve(passedOptions?.headers)).toStrictEqual({
-      Authorization: 'Bearer mock-auth-token',
-    });
-  });
-
-  it('should use custom headers in addition to auth token when provided', async () => {
-    createVertexAnthropicEdge({
-      project: 'test-project',
-      headers: async () => ({
-        'Custom-Header': 'custom-value',
-      }),
-    });
-
-    const mockCreateVertex = vi.mocked(createVertexAnthropicOriginal);
-    const passedOptions = mockCreateVertex.mock.calls[0][0];
-
-    expect(mockCreateVertex).toHaveBeenCalledTimes(1);
-    expect(typeof passedOptions?.headers).toBe('function');
-    expect(await resolve(passedOptions?.headers)).toEqual({
-      Authorization: 'Bearer mock-auth-token',
-      'Custom-Header': 'custom-value',
-    });
-  });
-
-  it('should use edge auth token generator', async () => {
-    createVertexAnthropicEdge({ project: 'test-project' });
-
-    const mockCreateVertex = vi.mocked(createVertexAnthropicOriginal);
-    const passedOptions = mockCreateVertex.mock.calls[0][0];
-
-    // Verify the headers function actually calls generateAuthToken by checking its result
-    expect(passedOptions?.headers).toBeDefined();
-    await resolve(passedOptions?.headers);
-    expect(edgeAuth.generateAuthToken).toHaveBeenCalled();
-  });
-
-  it('passes googleCredentials to generateAuthToken', async () => {
-    createVertexAnthropicEdge({
-      project: 'test-project',
-      googleCredentials: {
-        clientEmail: 'test@example.com',
-        privateKey: 'test-key',
-      },
-    });
-
-    const mockCreateVertex = vi.mocked(createVertexAnthropicOriginal);
-    const passedOptions = mockCreateVertex.mock.calls[0][0];
-
-    await resolve(passedOptions?.headers); // call the headers function
-
-    expect(edgeAuth.generateAuthToken).toHaveBeenCalledWith({
-      clientEmail: 'test@example.com',
-      privateKey: 'test-key',
-    });
-  });
-});

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

@@ -1,73 +0,0 @@
-import { resolve } from '@ai-sdk/provider-utils';
-import { createVertexAnthropic as createVertexAnthropicOriginal } from './google-vertex-anthropic-provider';
-import { createVertexAnthropic as createVertexAnthropicNode } from './google-vertex-anthropic-provider-node';
-import { generateAuthToken } from '../google-vertex-auth-google-auth-library';
-import { describe, beforeEach, expect, it, vi } from 'vitest';
-
-// Mock the imported modules
-vi.mock('../google-vertex-auth-google-auth-library', () => ({
-  generateAuthToken: vi.fn().mockResolvedValue('mock-auth-token'),
-}));
-
-vi.mock('./google-vertex-anthropic-provider', () => ({
-  createVertexAnthropic: vi.fn().mockImplementation(options => ({
-    ...options,
-  })),
-}));
-
-describe('google-vertex-anthropic-provider-node', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it('default headers function should return auth token', async () => {
-    createVertexAnthropicNode({ project: 'test-project' });
-
-    expect(createVertexAnthropicOriginal).toHaveBeenCalledTimes(1);
-    const passedOptions = vi.mocked(createVertexAnthropicOriginal).mock
-      .calls[0][0];
-
-    expect(typeof passedOptions?.headers).toBe('function');
-    expect(await resolve(passedOptions?.headers)).toStrictEqual({
-      Authorization: 'Bearer mock-auth-token',
-    });
-  });
-
-  it('should use custom headers in addition to auth token when provided', async () => {
-    createVertexAnthropicNode({
-      project: 'test-project',
-      headers: async () => ({
-        'Custom-Header': 'custom-value',
-      }),
-    });
-
-    expect(createVertexAnthropicOriginal).toHaveBeenCalledTimes(1);
-    const passedOptions = vi.mocked(createVertexAnthropicOriginal).mock
-      .calls[0][0];
-
-    expect(await resolve(passedOptions?.headers)).toEqual({
-      Authorization: 'Bearer mock-auth-token',
-      'Custom-Header': 'custom-value',
-    });
-  });
-
-  it('passes googleAuthOptions to generateAuthToken', async () => {
-    createVertexAnthropicNode({
-      googleAuthOptions: {
-        scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-        keyFile: 'path/to/key.json',
-      },
-    });
-
-    expect(createVertexAnthropicOriginal).toHaveBeenCalledTimes(1);
-    const passedOptions = vi.mocked(createVertexAnthropicOriginal).mock
-      .calls[0][0];
-
-    await resolve(passedOptions?.headers); // call the headers function
-
-    expect(generateAuthToken).toHaveBeenCalledWith({
-      scopes: ['https://www.googleapis.com/auth/cloud-platform'],
-      keyFile: 'path/to/key.json',
-    });
-  });
-});

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

@@ -1,208 +0,0 @@
-import {
-  createVertexAnthropic,
-  vertexAnthropicTools,
-} from './google-vertex-anthropic-provider';
-import { NoSuchModelError } from '@ai-sdk/provider';
-import { AnthropicMessagesLanguageModel } from '@ai-sdk/anthropic/internal';
-import { vi, describe, beforeEach, it, expect } from 'vitest';
-
-// Mock the imported modules
-vi.mock('@ai-sdk/provider-utils', () => ({
-  loadOptionalSetting: vi
-    .fn()
-    .mockImplementation(({ settingValue }) => settingValue),
-  withoutTrailingSlash: vi.fn().mockImplementation(url => url),
-  createJsonErrorResponseHandler: vi.fn(),
-  createProviderToolFactory: vi.fn(),
-  createProviderToolFactoryWithOutputSchema: vi.fn(),
-  lazySchema: vi.fn(),
-  zodSchema: vi.fn(),
-}));
-
-vi.mock('@ai-sdk/anthropic/internal', async () => {
-  const originalModule = await vi.importActual('@ai-sdk/anthropic/internal');
-  return {
-    ...originalModule,
-    AnthropicMessagesLanguageModel: vi.fn(),
-  };
-});
-
-describe('google-vertex-anthropic-provider', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it('should create a language model with default settings', () => {
-    const provider = createVertexAnthropic({
-      project: 'test-project',
-      location: 'test-location',
-    });
-    provider('test-model-id');
-
-    // Assert that the model constructor was called with the correct arguments
-    expect(AnthropicMessagesLanguageModel).toHaveBeenCalledWith(
-      'test-model-id',
-      expect.objectContaining({
-        baseURL: expect.stringContaining(
-          '/projects/test-project/locations/test-location/publishers/anthropic/models',
-        ),
-        provider: 'vertex.anthropic.messages',
-        headers: expect.any(Object),
-        buildRequestUrl: expect.any(Function),
-        transformRequestBody: expect.any(Function),
-      }),
-    );
-  });
-
-  it('should throw an error when using new keyword', () => {
-    const provider = createVertexAnthropic({ project: 'test-project' });
-
-    expect(() => new (provider as any)('test-model-id')).toThrow(
-      'The Anthropic model function cannot be called with the new keyword.',
-    );
-  });
-
-  it('should pass baseURL to the model when created', () => {
-    const customBaseURL = 'https://custom-url.com';
-    const provider = createVertexAnthropic({
-      project: 'test-project',
-      baseURL: customBaseURL,
-    });
-    provider('test-model-id');
-
-    // Assert that the constructor was called with the correct baseURL
-    expect(AnthropicMessagesLanguageModel).toHaveBeenCalledWith(
-      expect.anything(), // modelId
-      expect.objectContaining({
-        baseURL: customBaseURL,
-      }),
-    );
-  });
-
-  it('should throw NoSuchModelError for textEmbeddingModel', () => {
-    const provider = createVertexAnthropic({ project: 'test-project' });
-
-    expect(() => provider.embeddingModel('invalid-model-id')).toThrow(
-      NoSuchModelError,
-    );
-  });
-
-  it('should include vertexAnthropicTools (subset of anthropicTools)', () => {
-    const provider = createVertexAnthropic({ project: 'test-project' });
-
-    expect(provider.tools).toBe(vertexAnthropicTools);
-    expect(provider.tools).toHaveProperty('bash_20241022');
-    expect(provider.tools).toHaveProperty('bash_20250124');
-    expect(provider.tools).toHaveProperty('textEditor_20241022');
-    expect(provider.tools).toHaveProperty('textEditor_20250124');
-    expect(provider.tools).toHaveProperty('textEditor_20250429');
-    expect(provider.tools).toHaveProperty('textEditor_20250728');
-    expect(provider.tools).toHaveProperty('computer_20241022');
-    expect(provider.tools).toHaveProperty('webSearch_20250305');
-    expect(provider.tools).not.toHaveProperty('codeExecution_20250825');
-  });
-
-  it('should pass custom headers to the model constructor', () => {
-    const customHeaders = { 'Custom-Header': 'custom-value' };
-    const provider = createVertexAnthropic({
-      project: 'test-project',
-      headers: customHeaders,
-    });
-    provider('test-model-id');
-
-    // Assert that the model constructor was called with the correct headers
-    expect(AnthropicMessagesLanguageModel).toHaveBeenCalledWith(
-      expect.anything(), // modelId
-      expect.objectContaining({
-        headers: customHeaders,
-      }),
-    );
-  });
-
-  it('should create a Google Vertex Anthropic provider instance with custom settings', () => {
-    const customProvider = createVertexAnthropic({
-      project: 'custom-project',
-      location: 'custom-location',
-      baseURL: 'https://custom.base.url',
-      headers: { 'Custom-Header': 'value' },
-    });
-
-    expect(customProvider).toBeDefined();
-    expect(typeof customProvider).toBe('function');
-    expect(customProvider.languageModel).toBeDefined();
-  });
-
-  it('should not support URL sources to force base64 conversion', () => {
-    const provider = createVertexAnthropic();
-    provider('test-model-id');
-
-    // Assert that the model constructor was called with supportedUrls function
-    expect(AnthropicMessagesLanguageModel).toHaveBeenCalledWith(
-      'test-model-id',
-      expect.objectContaining({
-        supportedUrls: expect.any(Function),
-      }),
-    );
-
-    // Get the actual config passed to the constructor
-    const constructorCall = vi.mocked(AnthropicMessagesLanguageModel).mock
-      .calls[vi.mocked(AnthropicMessagesLanguageModel).mock.calls.length - 1];
-    const config = constructorCall[1];
-
-    // Verify that supportedUrls returns empty object to force base64 conversion
-    expect(config.supportedUrls?.()).toEqual({});
-  });
-
-  it('should use correct URL for global location', () => {
-    const provider = createVertexAnthropic({
-      project: 'test-project',
-      location: 'global',
-    });
-    provider('test-model-id');
-
-    expect(AnthropicMessagesLanguageModel).toHaveBeenCalledWith(
-      'test-model-id',
-      expect.objectContaining({
-        baseURL:
-          'https://aiplatform.googleapis.com/v1/projects/test-project/locations/global/publishers/anthropic/models',
-        provider: 'vertex.anthropic.messages',
-      }),
-    );
-  });
-
-  it('should use region-prefixed URL for non-global locations', () => {
-    const provider = createVertexAnthropic({
-      project: 'test-project',
-      location: 'us-east5',
-    });
-    provider('test-model-id');
-
-    expect(AnthropicMessagesLanguageModel).toHaveBeenCalledWith(
-      'test-model-id',
-      expect.objectContaining({
-        baseURL:
-          'https://us-east5-aiplatform.googleapis.com/v1/projects/test-project/locations/us-east5/publishers/anthropic/models',
-        provider: 'vertex.anthropic.messages',
-      }),
-    );
-  });
-
-  it('should support combining tools with structured outputs (inherited from Anthropic)', () => {
-    const provider = createVertexAnthropic({
-      project: 'test-project',
-      location: 'us-east5',
-    });
-
-    // Create a model instance
-    const model = provider('claude-3-5-sonnet-v2@20241022');
-
-    // Verify the model was created using AnthropicMessagesLanguageModel
-    // which already supports combining tools with structured outputs
-    expect(AnthropicMessagesLanguageModel).toHaveBeenCalledWith(
-      'claude-3-5-sonnet-v2@20241022',
-      expect.objectContaining({
-        provider: 'vertex.anthropic.messages',
-      }),
-    );
-  });
-});