@ai-sdk/google 0.0.0-85f9a635-20240518005312

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,75 @@
+# Vercel AI SDK - Google Generative AI Provider
+
+The Google provider for the [Vercel AI SDK](https://sdk.vercel.ai/docs) contains language model support for the [Google Generative AI](https://ai.google/discover/generativeai/) APIs.
+It creates language model objects that can be used with the `generateText`, `streamText`, `generateObject`, and `streamObject` AI functions.
+
+## Setup
+
+The Google provider is available in the `@ai-sdk/google` module. You can install it with
+
+```bash
+npm i @ai-sdk/google
+```
+
+## Provider Instance
+
+You can import the default provider instance `google` from `@ai-sdk/google`:
+
+```ts
+import { google } from '@ai-sdk/google';
+```
+
+If you need a customized setup, you can import `createGoogleGenerativeAI` from `@ai-sdk/google` and create a provider instance with your settings:
+
+```ts
+import { createGoogleGenerativeAI } from '@ai-sdk/google';
+
+const google = createGoogleGenerativeAI({
+  // custom settings
+});
+```
+
+You can use the following optional settings to customize the Google Generative AI provider instance:
+
+- **baseURL** _string_
+
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://generativelanguage.googleapis.com/v1beta`.
+
+- **apiKey** _string_
+
+  API key that is being send using the `x-goog-api-key` header.
+  It defaults to the `GOOGLE_GENERATIVE_AI_API_KEY` environment variable.
+
+- **headers** _Record<string,string>_
+
+  Custom headers to include in the requests.
+
+## Models
+
+You can create models that call the [Google Generative AI API](https://ai.google.dev/api/rest) using the provider instance.
+The first argument is the model id, e.g. `models/gemini-pro`.
+The models support tool calls and some have multi-modal capabilities.
+
+```ts
+const model = google('models/gemini-pro');
+```
+
+Google Generative AI models support also some model specific settings that are not part of the [standard call settings](/docs/ai-core/settings).
+You can pass them as an options argument:
+
+```ts
+const model = google('models/gemini-pro', {
+  topK: 0.2,
+});
+```
+
+The following optional settings are available for Google Generative AI models:
+
+- **topK** _number_
+
+  Optional. The maximum number of tokens to consider when sampling.
+
+  Models use nucleus sampling or combined Top-k and nucleus sampling.
+  Top-k sampling considers the set of topK most probable tokens.
+  Models running with nucleus sampling don't allow topK setting.

package/dist/index.d.mts

@@ -0,0 +1,95 @@
+import { LanguageModelV1 } from '@ai-sdk/provider';
+
+type GoogleGenerativeAIModelId = 'models/gemini-1.5-flash-latest' | 'models/gemini-1.5-pro-latest' | 'models/gemini-pro' | 'models/gemini-pro-vision' | (string & {});
+interface GoogleGenerativeAISettings {
+    /**
+  Optional. The maximum number of tokens to consider when sampling.
+  
+  Models use nucleus sampling or combined Top-k and nucleus sampling.
+  Top-k sampling considers the set of topK most probable tokens.
+  Models running with nucleus sampling don't allow topK setting.
+     */
+    topK?: number;
+}
+
+type GoogleGenerativeAIConfig = {
+    provider: string;
+    baseURL: string;
+    headers: () => Record<string, string | undefined>;
+    generateId: () => string;
+};
+declare class GoogleGenerativeAILanguageModel implements LanguageModelV1 {
+    readonly specificationVersion = "v1";
+    readonly defaultObjectGenerationMode = "json";
+    readonly modelId: GoogleGenerativeAIModelId;
+    readonly settings: GoogleGenerativeAISettings;
+    private readonly config;
+    constructor(modelId: GoogleGenerativeAIModelId, settings: GoogleGenerativeAISettings, config: GoogleGenerativeAIConfig);
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
+    doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
+}
+
+interface GoogleGenerativeAIProvider {
+    (modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+    chat(modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+    /**
+     * @deprecated Use `chat()` instead.
+     */
+    generativeAI(modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+}
+interface GoogleGenerativeAIProviderSettings {
+    /**
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://generativelanguage.googleapis.com/v1beta`.
+     */
+    baseURL?: string;
+    /**
+  @deprecated Use `baseURL` instead.
+     */
+    baseUrl?: string;
+    /**
+  API key that is being send using the `x-goog-api-key` header.
+  It defaults to the `GOOGLE_GENERATIVE_AI_API_KEY` environment variable.
+     */
+    apiKey?: string;
+    /**
+  Custom headers to include in the requests.
+       */
+    headers?: Record<string, string>;
+    generateId?: () => string;
+}
+/**
+Create a Google Generative AI provider instance.
+ */
+declare function createGoogleGenerativeAI(options?: GoogleGenerativeAIProviderSettings): GoogleGenerativeAIProvider;
+/**
+Default Google Generative AI provider instance.
+ */
+declare const google: GoogleGenerativeAIProvider;
+
+/**
+ * @deprecated Use `createGoogleGenerativeAI` instead.
+ */
+declare class Google {
+    /**
+     * Base URL for the Google API calls.
+     */
+    readonly baseURL: string;
+    readonly apiKey?: string;
+    readonly headers?: Record<string, string>;
+    private readonly generateId;
+    /**
+     * Creates a new Google provider instance.
+     */
+    constructor(options?: GoogleGenerativeAIProviderSettings);
+    private get baseConfig();
+    /**
+     * @deprecated Use `chat()` instead.
+     */
+    generativeAI(modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+    chat(modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+}
+
+export { Google, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderSettings, createGoogleGenerativeAI, google };

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+import { LanguageModelV1 } from '@ai-sdk/provider';
+
+type GoogleGenerativeAIModelId = 'models/gemini-1.5-flash-latest' | 'models/gemini-1.5-pro-latest' | 'models/gemini-pro' | 'models/gemini-pro-vision' | (string & {});
+interface GoogleGenerativeAISettings {
+    /**
+  Optional. The maximum number of tokens to consider when sampling.
+  
+  Models use nucleus sampling or combined Top-k and nucleus sampling.
+  Top-k sampling considers the set of topK most probable tokens.
+  Models running with nucleus sampling don't allow topK setting.
+     */
+    topK?: number;
+}
+
+type GoogleGenerativeAIConfig = {
+    provider: string;
+    baseURL: string;
+    headers: () => Record<string, string | undefined>;
+    generateId: () => string;
+};
+declare class GoogleGenerativeAILanguageModel implements LanguageModelV1 {
+    readonly specificationVersion = "v1";
+    readonly defaultObjectGenerationMode = "json";
+    readonly modelId: GoogleGenerativeAIModelId;
+    readonly settings: GoogleGenerativeAISettings;
+    private readonly config;
+    constructor(modelId: GoogleGenerativeAIModelId, settings: GoogleGenerativeAISettings, config: GoogleGenerativeAIConfig);
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doGenerate']>>>;
+    doStream(options: Parameters<LanguageModelV1['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV1['doStream']>>>;
+}
+
+interface GoogleGenerativeAIProvider {
+    (modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+    chat(modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+    /**
+     * @deprecated Use `chat()` instead.
+     */
+    generativeAI(modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+}
+interface GoogleGenerativeAIProviderSettings {
+    /**
+  Use a different URL prefix for API calls, e.g. to use proxy servers.
+  The default prefix is `https://generativelanguage.googleapis.com/v1beta`.
+     */
+    baseURL?: string;
+    /**
+  @deprecated Use `baseURL` instead.
+     */
+    baseUrl?: string;
+    /**
+  API key that is being send using the `x-goog-api-key` header.
+  It defaults to the `GOOGLE_GENERATIVE_AI_API_KEY` environment variable.
+     */
+    apiKey?: string;
+    /**
+  Custom headers to include in the requests.
+       */
+    headers?: Record<string, string>;
+    generateId?: () => string;
+}
+/**
+Create a Google Generative AI provider instance.
+ */
+declare function createGoogleGenerativeAI(options?: GoogleGenerativeAIProviderSettings): GoogleGenerativeAIProvider;
+/**
+Default Google Generative AI provider instance.
+ */
+declare const google: GoogleGenerativeAIProvider;
+
+/**
+ * @deprecated Use `createGoogleGenerativeAI` instead.
+ */
+declare class Google {
+    /**
+     * Base URL for the Google API calls.
+     */
+    readonly baseURL: string;
+    readonly apiKey?: string;
+    readonly headers?: Record<string, string>;
+    private readonly generateId;
+    /**
+     * Creates a new Google provider instance.
+     */
+    constructor(options?: GoogleGenerativeAIProviderSettings);
+    private get baseConfig();
+    /**
+     * @deprecated Use `chat()` instead.
+     */
+    generativeAI(modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+    chat(modelId: GoogleGenerativeAIModelId, settings?: GoogleGenerativeAISettings): GoogleGenerativeAILanguageModel;
+}
+
+export { Google, type GoogleGenerativeAIProvider, type GoogleGenerativeAIProviderSettings, createGoogleGenerativeAI, google };