docs: clarify Gemini vs Vertex AI model prefix behavior (#19443)
Add documentation explaining the difference between model formats: - `gemini/model` → Gemini API (simple API key) - `vertex_ai/model` → Vertex AI (GCP credentials) - `model` (no prefix) → defaults to Vertex AI This addresses user confusion when models without prefix require GCP authentication instead of simple API key auth. Ref #8424
This commit is contained in:
parent
2b44d02682
commit
94055741d4
@ -15,6 +15,17 @@ import TabItem from '@theme/TabItem';
|
||||
|
||||
<br />
|
||||
|
||||
:::tip Gemini API vs Vertex AI
|
||||
| Model Format | Provider | Auth Required |
|
||||
|-------------|----------|---------------|
|
||||
| `gemini/gemini-2.0-flash` | Gemini API | `GEMINI_API_KEY` (simple API key) |
|
||||
| `vertex_ai/gemini-2.0-flash` | Vertex AI | GCP credentials + project |
|
||||
| `gemini-2.0-flash` (no prefix) | Vertex AI | GCP credentials + project |
|
||||
|
||||
**If you just want to use an API key** (like OpenAI), use the `gemini/` prefix.
|
||||
|
||||
Models without a prefix default to Vertex AI which requires full GCP authentication.
|
||||
:::
|
||||
|
||||
## API Keys
|
||||
|
||||
|
||||
@ -14,6 +14,17 @@ import TabItem from '@theme/TabItem';
|
||||
| Base URL | 1. Regional endpoints<br/>`https://{vertex_location}-aiplatform.googleapis.com/`<br/>2. Global endpoints (limited availability)<br/>`https://aiplatform.googleapis.com/`|
|
||||
| Supported Operations | [`/chat/completions`](#sample-usage), `/completions`, [`/embeddings`](#embedding-models), [`/audio/speech`](#text-to-speech-apis), [`/fine_tuning`](#fine-tuning-apis), [`/batches`](#batch-apis), [`/files`](#batch-apis), [`/images`](#image-generation-models), [`/rerank`](#rerank-api) |
|
||||
|
||||
:::tip Vertex AI vs Gemini API
|
||||
| Model Format | Provider | Auth Required |
|
||||
|-------------|----------|---------------|
|
||||
| `vertex_ai/gemini-2.0-flash` | Vertex AI | GCP credentials + project |
|
||||
| `gemini-2.0-flash` (no prefix) | Vertex AI | GCP credentials + project |
|
||||
| `gemini/gemini-2.0-flash` | Gemini API | `GEMINI_API_KEY` (simple API key) |
|
||||
|
||||
**If you just want to use an API key** (like OpenAI), use the `gemini/` prefix instead. See [Gemini - Google AI Studio](./gemini.md).
|
||||
|
||||
Models without a prefix default to Vertex AI which requires GCP authentication.
|
||||
:::
|
||||
|
||||
<br />
|
||||
<br />
|
||||
|
||||
Loading…
Reference in New Issue
Block a user