From 94055741d44c283ddbc099764f7b617181fb8ba8 Mon Sep 17 00:00:00 2001 From: Cesar Garcia <128240629+Chesars@users.noreply.github.com> Date: Tue, 20 Jan 2026 20:22:52 -0300 Subject: [PATCH] docs: clarify Gemini vs Vertex AI model prefix behavior (#19443) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- docs/my-website/docs/providers/gemini.md | 11 +++++++++++ docs/my-website/docs/providers/vertex.md | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/my-website/docs/providers/gemini.md b/docs/my-website/docs/providers/gemini.md index 32dea2069b..110e3f3f09 100644 --- a/docs/my-website/docs/providers/gemini.md +++ b/docs/my-website/docs/providers/gemini.md @@ -15,6 +15,17 @@ import TabItem from '@theme/TabItem';
+:::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 diff --git a/docs/my-website/docs/providers/vertex.md b/docs/my-website/docs/providers/vertex.md index be2bf86ab1..5647b5292e 100644 --- a/docs/my-website/docs/providers/vertex.md +++ b/docs/my-website/docs/providers/vertex.md @@ -14,6 +14,17 @@ import TabItem from '@theme/TabItem'; | Base URL | 1. Regional endpoints
`https://{vertex_location}-aiplatform.googleapis.com/`
2. Global endpoints (limited availability)
`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. +:::