Skip to content

Commit

Permalink
Add docs for Google ai/core provider. (#1263)
Browse files Browse the repository at this point in the history
  • Loading branch information
lgrammel authored Apr 2, 2024
1 parent b289930 commit b7732d7
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/pages/docs/ai-core/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"tools": "Tools and Tool Calling",
"openai": "OpenAI Provider",
"mistral": "Mistral Provider",
"google": "Google Provider",
"custom-provider": "Custom Providers",
"generate-text": "generateText API",
"stream-text": "streamText API",
Expand Down
48 changes: 48 additions & 0 deletions docs/pages/docs/ai-core/google.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Google Provider
---

import { Callout } from 'nextra-theme-docs';

# Google Provider

The Google provider 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.

## Provider Instance

You can import `Google` from `ai/google` and initialize a provider instance with various settings:

```ts
import { Google } from 'ai/google';

const google = new Google({
baseUrl: '', // optional base URL for proxies etc.
apiKey: '', // optional API key, default to env property GOOGLE_GENERATIVE_AI_API_KEY
});
```

The AI SDK also provides a shorthand `google` import with a Google provider instance that uses defaults:

```ts
import { google } from 'ai/google';
```

## Generative AI Models

You can create models that call the [Google Generative AI API](https://ai.google.dev/api/rest) using the `.generativeAI()` factory method.
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.generativeAI('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.generativeAI('models/gemini-pro', {
topK: 0.2,
});
```
1 change: 1 addition & 0 deletions docs/pages/docs/ai-core/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ The AI SDK contains the following providers:

- [OpenAI Provider](/docs/ai-core/openai) (`ai/openai`)
- [Mistral Provider](/docs/ai-core/mistral) (`ai/mistral`)
- [Google Provider](/docs/ai-core/google) (`ai/google`)

The AI SDK also provides a [language model specification](https://github.com/vercel/ai/tree/main/packages/core/spec/language-model/v1) that you can use to implement [custom providers](/docs/ai-core/custom-provider).

Expand Down

0 comments on commit b7732d7

Please sign in to comment.