@ai-sdk/google-vertex 1.0.4 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/google-vertex
 
+## 2.0.0
+
+### Major Changes
+
+- 0984f0b: feat (provider/google-vertex): Rewrite for Edge runtime support.
+
+### Patch Changes
+
+- 0984f0b: chore (providers/google-vertex): Remove unref'd base default provider.
+- Updated dependencies [0984f0b]
+- Updated dependencies [0984f0b]
+  - @ai-sdk/google@1.0.5
+  - @ai-sdk/provider-utils@2.0.3
+
 ## 1.0.4
 
 ### Patch Changes

package/README.md

@@ -10,24 +10,90 @@ The Google provider is available in the `@ai-sdk/google-vertex` module. You can
 npm i @ai-sdk/google-vertex
 ```
 
-## Provider Instance
+## Authentication & Usage Examples
 
-You can import the default provider instance `vertex` from `@ai-sdk/google-vertex`:
+The Google Vertex provider has two different authentication implementations depending on your runtime environment:
+
+### Node.js Runtime
+
+The Node.js runtime is the default runtime supported by the AI SDK. You can use the default provider instance to generate text with the `gemini-1.5-flash` model like this:
 
 ```ts
 import { vertex } from '@ai-sdk/google-vertex';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: vertex('gemini-1.5-flash'),
+  prompt: 'Write a vegetarian lasagna recipe.',
+});
+```
+
+This provider 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). The most common authentication method is to set the path to a json credentials file in the `GOOGLE_APPLICATION_CREDENTIALS` environment variable. Credentials can be obtained from the [Google Cloud Console](https://console.cloud.google.com/apis/credentials).
+
+### Edge Runtime
+
+The Edge runtime is supported through the `@ai-sdk/google-vertex/edge` module. Note the additional sub-module path `/edge` required to differentiate the Edge provider from the Node.js provider.
+
+You can use the default provider instance to generate text with the `gemini-1.5-flash` model like this:
+
+```ts
+import { vertex } from '@ai-sdk/google-vertex/edge';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: vertex('gemini-1.5-flash'),
+  prompt: 'Write a vegetarian lasagna recipe.',
+});
+```
+
+This method supports Google's [Application Default Credentials](https://github.com/googleapis/google-auth-library-nodejs?tab=readme-ov-file#application-default-credentials) through the environment variables `GOOGLE_CLIENT_EMAIL`, `GOOGLE_PRIVATE_KEY`, and (optionally) `GOOGLE_PRIVATE_KEY_ID`. The values can be obtained from a json credentials file obtained from the [Google Cloud Console](https://console.cloud.google.com/apis/credentials).
+
+## Custom Provider Configuration
+
+You can create a custom provider instance using the `createVertex` function. This allows you to specify additional configuration options. Below is an example with the default Node.js provider which includes a `googleAuthOptions` object.
+
+```ts
+import { createVertex } from '@ai-sdk/google-vertex';
+import { generateText } from 'ai';
+
+const customProvider = createVertex({
+  projectId: 'your-project-id',
+  location: 'us-central1',
+  googleAuthOptions: {
+    credentials: {
+      client_email: 'your-client-email',
+      private_key: 'your-private-key',
+    },
+  },
+});
+
+const { text } = await generateText({
+  model: customProvider('gemini-1.5-flash'),
+  prompt: 'Write a vegetarian lasagna recipe.',
+});
 ```
 
-## Example
+The `googleAuthOptions` object is not present in the Edge provider options but custom provider creation is otherwise identical.
+
+The Edge provider supports a `googleCredentials` option rather than `googleAuthOptions`. This can be used to specify the Google Cloud service account credentials and will take precedence over the environment variables used otherwise.
 
 ```ts
-import { vertex } from '@ai-sdk/google-vertex'
-import { generateText } from 'ai'
+import { createVertex } from '@ai-sdk/google-vertex/edge';
+import { generateText } from 'ai';
+
+const customProvider = createVertex({
+  projectId: 'your-project-id',
+  location: 'us-central1',
+  googleCredentials: {
+    clientEmail: 'your-client-email',
+    privateKey: 'your-private-key',
+  },
+});
 
 const { text } = await generateText({
-  model: vertex('gemini-1.5-flash')
-  prompt: 'Write a vegetarian lasagna recipe for 4 people.'
-})
+  model: customProvider('gemini-1.5-flash'),
+  prompt: 'Write a vegetarian lasagna recipe.',
+});
 ```
 
 ## Documentation

package/dist/index.d.mts

@@ -1,30 +1,10 @@
 import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
-import { VertexInit, VertexAI } from '@google-cloud/vertexai';
+import { Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
+import { InternalGoogleGenerativeAISettings } from '@ai-sdk/google/internal';
+import { GoogleAuthOptions } from 'google-auth-library';
 
-type GoogleVertexModelId = 'gemini-1.5-flash' | 'gemini-1.5-flash-001' | 'gemini-1.5-flash-002' | 'gemini-1.5-pro' | 'gemini-1.5-pro-001' | 'gemini-1.5-pro-002' | 'gemini-1.0-pro' | 'gemini-1.0-pro-001' | 'gemini-1.0-pro-vision' | 'gemini-1.0-pro-vision-001' | (string & {});
-interface GoogleVertexSettings {
-    /**
-     * Optional. Enable structured output. Default is true.
-     *
-     * This is useful when the JSON Schema contains elements that are
-     * not supported by the OpenAPI schema version that
-     * Google Generative AI uses. You can use this to disable
-     * structured outputs if you need to.
-     */
-    structuredOutputs?: boolean;
-    /**
-  Optional. A list of unique safety settings for blocking unsafe content.
-     */
-    safetySettings?: Array<{
-        category: 'HARM_CATEGORY_UNSPECIFIED' | 'HARM_CATEGORY_HATE_SPEECH' | 'HARM_CATEGORY_DANGEROUS_CONTENT' | 'HARM_CATEGORY_HARASSMENT' | 'HARM_CATEGORY_SEXUALLY_EXPLICIT';
-        threshold: 'HARM_BLOCK_THRESHOLD_UNSPECIFIED' | 'BLOCK_LOW_AND_ABOVE' | 'BLOCK_MEDIUM_AND_ABOVE' | 'BLOCK_ONLY_HIGH' | 'BLOCK_NONE';
-    }>;
-    /**
-  Optional. When enabled, the model will use Google search to ground the response.
-  
-  @see https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/overview
-     */
-    useSearchGrounding?: boolean;
+type GoogleVertexModelId = 'gemini-1.5-flash' | 'gemini-1.5-flash-001' | 'gemini-1.5-flash-002' | 'gemini-1.5-pro' | 'gemini-1.5-pro-001' | 'gemini-1.5-pro-002' | 'gemini-1.0-pro-001' | 'gemini-1.0-pro-vision-001' | 'gemini-1.0-pro' | 'gemini-1.0-pro-001' | 'gemini-1.0-pro-002' | (string & {});
+interface GoogleVertexSettings extends InternalGoogleGenerativeAISettings {
 }
 
 interface GoogleVertexProvider extends ProviderV1 {
@@ -34,7 +14,7 @@ interface GoogleVertexProvider extends ProviderV1 {
     (modelId: GoogleVertexModelId, settings?: GoogleVertexSettings): LanguageModelV1;
     languageModel: (modelId: GoogleVertexModelId, settings?: GoogleVertexSettings) => LanguageModelV1;
 }
-interface GoogleVertexProviderSettings {
+interface GoogleVertexProviderSettings$1 {
     /**
   Your Google Vertex location. Defaults to the environment variable `GOOGLE_VERTEX_LOCATION`.
      */
@@ -43,22 +23,32 @@ interface GoogleVertexProviderSettings {
   Your Google Vertex project. Defaults to the environment variable `GOOGLE_VERTEX_PROJECT`.
     */
     project?: 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;
+    generateId?: () => string;
+}
+
+interface GoogleVertexProviderSettings extends GoogleVertexProviderSettings$1 {
     /**
    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?: VertexInit['googleAuthOptions'];
-    generateId?: () => string;
-    createVertexAI?: ({ project, location, }: {
-        project: string;
-        location: string;
-    }) => VertexAI;
+    googleAuthOptions?: GoogleAuthOptions;
 }
-/**
-Create a Google Vertex AI provider instance.
- */
+
 declare function createVertex(options?: GoogleVertexProviderSettings): GoogleVertexProvider;
 /**
 Default Google Vertex AI provider instance.

package/dist/index.d.ts

@@ -1,30 +1,10 @@
 import { ProviderV1, LanguageModelV1 } from '@ai-sdk/provider';
-import { VertexInit, VertexAI } from '@google-cloud/vertexai';
+import { Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
+import { InternalGoogleGenerativeAISettings } from '@ai-sdk/google/internal';
+import { GoogleAuthOptions } from 'google-auth-library';
 
-type GoogleVertexModelId = 'gemini-1.5-flash' | 'gemini-1.5-flash-001' | 'gemini-1.5-flash-002' | 'gemini-1.5-pro' | 'gemini-1.5-pro-001' | 'gemini-1.5-pro-002' | 'gemini-1.0-pro' | 'gemini-1.0-pro-001' | 'gemini-1.0-pro-vision' | 'gemini-1.0-pro-vision-001' | (string & {});
-interface GoogleVertexSettings {
-    /**
-     * Optional. Enable structured output. Default is true.
-     *
-     * This is useful when the JSON Schema contains elements that are
-     * not supported by the OpenAPI schema version that
-     * Google Generative AI uses. You can use this to disable
-     * structured outputs if you need to.
-     */
-    structuredOutputs?: boolean;
-    /**
-  Optional. A list of unique safety settings for blocking unsafe content.
-     */
-    safetySettings?: Array<{
-        category: 'HARM_CATEGORY_UNSPECIFIED' | 'HARM_CATEGORY_HATE_SPEECH' | 'HARM_CATEGORY_DANGEROUS_CONTENT' | 'HARM_CATEGORY_HARASSMENT' | 'HARM_CATEGORY_SEXUALLY_EXPLICIT';
-        threshold: 'HARM_BLOCK_THRESHOLD_UNSPECIFIED' | 'BLOCK_LOW_AND_ABOVE' | 'BLOCK_MEDIUM_AND_ABOVE' | 'BLOCK_ONLY_HIGH' | 'BLOCK_NONE';
-    }>;
-    /**
-  Optional. When enabled, the model will use Google search to ground the response.
-  
-  @see https://cloud.google.com/vertex-ai/generative-ai/docs/grounding/overview
-     */
-    useSearchGrounding?: boolean;
+type GoogleVertexModelId = 'gemini-1.5-flash' | 'gemini-1.5-flash-001' | 'gemini-1.5-flash-002' | 'gemini-1.5-pro' | 'gemini-1.5-pro-001' | 'gemini-1.5-pro-002' | 'gemini-1.0-pro-001' | 'gemini-1.0-pro-vision-001' | 'gemini-1.0-pro' | 'gemini-1.0-pro-001' | 'gemini-1.0-pro-002' | (string & {});
+interface GoogleVertexSettings extends InternalGoogleGenerativeAISettings {
 }
 
 interface GoogleVertexProvider extends ProviderV1 {
@@ -34,7 +14,7 @@ interface GoogleVertexProvider extends ProviderV1 {
     (modelId: GoogleVertexModelId, settings?: GoogleVertexSettings): LanguageModelV1;
     languageModel: (modelId: GoogleVertexModelId, settings?: GoogleVertexSettings) => LanguageModelV1;
 }
-interface GoogleVertexProviderSettings {
+interface GoogleVertexProviderSettings$1 {
     /**
   Your Google Vertex location. Defaults to the environment variable `GOOGLE_VERTEX_LOCATION`.
      */
@@ -43,22 +23,32 @@ interface GoogleVertexProviderSettings {
   Your Google Vertex project. Defaults to the environment variable `GOOGLE_VERTEX_PROJECT`.
     */
     project?: 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;
+    generateId?: () => string;
+}
+
+interface GoogleVertexProviderSettings extends GoogleVertexProviderSettings$1 {
     /**
    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?: VertexInit['googleAuthOptions'];
-    generateId?: () => string;
-    createVertexAI?: ({ project, location, }: {
-        project: string;
-        location: string;
-    }) => VertexAI;
+    googleAuthOptions?: GoogleAuthOptions;
 }
-/**
-Create a Google Vertex AI provider instance.
- */
+
 declare function createVertex(options?: GoogleVertexProviderSettings): GoogleVertexProvider;
 /**
 Default Google Vertex AI provider instance.