-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for Google ai/core provider. (#1263)
- Loading branch information
Showing
3 changed files
with
50 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, | ||
}); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters