Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

docs: add Vertex AI (GCP) tab to Language Models guide (#9329)

at384782651b93d64
diff --git a/docs/docs/learn/programming/language_models.md b/docs/docs/learn/programming/language_models.md
index 4152c26de..b37ce0942 100644
--- a/docs/docs/learn/programming/language_models.md
+++ b/docs/docs/learn/programming/language_models.md
@@ -41,6 +41,44 @@ dspy.configure(lm=lm)
dspy.configure(lm=lm)
```
+ === "Vertex AI (GCP)"
+ For Google Cloud's Vertex AI, authenticate with a service account JSON key or Application Default Credentials. You can pass credentials directly in code or set environment variables.
+
+ ```python linenums="1"
+ import dspy
+ import json
+
+ # Load the service account JSON and convert to a string
+ with open("service_account.json") as f:
+ credentials = json.dumps(json.load(f))
+
+ lm = dspy.LM(
+ "vertex_ai/gemini-2.0-flash",
+ vertex_credentials=credentials,
+ vertex_project="your-gcp-project-id",
+ vertex_location="us-central1",
+ )
+ dspy.configure(lm=lm)
+ ```
+
+ Alternatively, set environment variables and skip the kwargs:
+
+ ```bash
+ export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service_account.json"
+ export VERTEXAI_PROJECT="your-gcp-project-id"
+ export VERTEXAI_LOCATION="us-central1"
+ ```
+
+ ```python linenums="1"
+ import dspy
+ lm = dspy.LM("vertex_ai/gemini-2.0-flash")
+ dspy.configure(lm=lm)
+ ```
+
+ !!! warning "Common pitfalls"
+ - Use the `vertex_ai/` model prefix, not `gemini/`. The `gemini/` prefix routes to the Gemini API which requires an API key instead of GCP credentials.
+ - Use `vertex_project` and `vertex_location`, not `project` or `location`. Parameters without the `vertex_` prefix are silently ignored and LiteLLM falls back to defaults, which may cause requests to land in an unintended region.
+
=== "Databricks"
If you're on the Databricks platform, authentication is automatic via their SDK. If not, you can set the env variables `DATABRICKS_API_KEY` and `DATABRICKS_API_BASE`, or pass `api_key` and `api_base` below.