Skip to content

docs: clarify Vertex AI uses LLM_PROVIDER_MODE=vertex - #554

Merged
damianloch merged 2 commits into
mainfrom
docs/vertex-provider-mode
Jun 25, 2026
Merged

damianloch merged 2 commits into
mainfrom
docs/vertex-provider-mode

Conversation

@damianloch

@damianloch damianloch commented Jun 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Document LLM_PROVIDER_MODE=vertex as the recommended way to run Aurora on Vertex AI, instead of the previously-recommended direct mode.
  • The provider registry treats any non-openrouter/direct/auto value as a forced provider name. Under direct mode, routing is by model prefix, so only vertex/... ids reach Vertex — a clean google/... id silently goes to the Google AI (API-key) provider instead. LLM_PROVIDER_MODE=vertex removes that ambiguity by forcing all supported picks through Vertex.
  • Fix an inaccurate tip in the Vertex setup section claiming the project id is auto-extracted from the service account JSON. The provider reads VERTEX_AI_PROJECT directly (is_available() returns bool(self.project)) and is unavailable without it.

Docs-only change; no code behavior changes.

Test plan

  • cd website && npm run build (or docs build) renders the updated Vertex section without MDX errors
  • Verify the :::tip / :::note admonitions render correctly

Summary by CodeRabbit

  • Documentation
    • Updated Vertex AI setup guidance to include LLM_PROVIDER_MODE=vertex for clearer model routing.
    • Added a tip explaining two routing options for Vertex: using the Vertex mode or direct vertex/-prefixed model IDs.
    • Expanded authentication instructions with supported credential options and clarified that a project ID must be provided separately.
    • Added the same Vertex routing example to the environment configuration docs.

@damianloch
damianloch requested a review from a team as a code owner June 25, 2026 16:47
@coderabbitai

coderabbitai Bot commented Jun 25, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@damianloch, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 52 minutes and 6 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 314dcedd-f5fa-4576-ad8d-674c3e3f16a7

📥 Commits

Reviewing files that changed from the base of the PR and between d059414 and 95ad176.

📒 Files selected for processing (1)
  • website/docs/integrations/llm-providers.md

Walkthrough

Vertex AI documentation now shows LLM_PROVIDER_MODE=vertex in the environment example and revises the integration guide’s routing and authentication instructions for Vertex setups.

Changes

Vertex routing guidance

Layer / File(s) Summary
Provider-mode examples
website/docs/configuration/environment.md
The Vertex AI example environment block adds LLM_PROVIDER_MODE=vertex and notes that it routes model picks through Vertex.
Vertex setup instructions
website/docs/integrations/llm-providers.md
The Vertex AI setup guide recommends LLM_PROVIDER_MODE=vertex, contrasts vertex and direct routing for vertex/-prefixed model IDs, and states that VERTEX_AI_PROJECT is required with service account JSON, ADC, or GOOGLE_APPLICATION_CREDENTIALS.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Arvo-AI/aurora#488: Updates the forced-provider routing behavior that matches this docs change’s LLM_PROVIDER_MODE=vertex guidance.
  • Arvo-AI/aurora#501: Adds Vertex model-ID normalization for google/-prefixed inputs, which aligns with the routing and picker-name guidance here.
  • Arvo-AI/aurora#527: Reads LLM_PROVIDER_MODE to resolve the serving provider, matching the Vertex routing behavior described in these docs.

Suggested reviewers

  • OlivierTrudeau

Poem

I hopped through docs with a carrot pen,
and Vertex paths grew tidy again.
vertex in, direct too, neat as a chew,
with project keys and creds tucked through.
Hop, hop—cloud carrots! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main docs change about recommending LLM_PROVIDER_MODE=vertex for Vertex AI.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/vertex-provider-mode

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

arvo-ai-staging[bot]
arvo-ai-staging Bot previously approved these changes Jun 25, 2026

@arvo-ai-staging arvo-ai-staging Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aurora Risk Review

Verdict: SAFE

No risks identified. This change looks safe to ship.


Aurora reviews PRs for incident prevention.

The provider routing accepts a provider name as LLM_PROVIDER_MODE to force
all model picks through that provider, but the Vertex docs recommended
`direct` mode. Under `direct`, only `vertex/`-prefixed model ids route to
Vertex; a clean `google/...` id silently goes to the Google AI provider
instead. Document `LLM_PROVIDER_MODE=vertex` as the recommended, unambiguous
option.

Also corrects an inaccurate tip claiming the project id is auto-extracted from
the service account JSON; the provider reads VERTEX_AI_PROJECT directly and is
unavailable without it.
arvo-ai-staging[bot]
arvo-ai-staging Bot previously approved these changes Jun 25, 2026

@arvo-ai-staging arvo-ai-staging Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aurora Risk Review

Verdict: SAFE

No risks identified. This change looks safe to ship.


Aurora reviews PRs for incident prevention.

beng360
beng360 previously approved these changes Jun 25, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.env.example:
- Around line 109-112: The provider-mode comment in .env.example overstates the
behavior of explicit provider-name mode; update the description near the
provider mode setting so it says a named provider routes models through that
backend when supported, with unsupported models falling back to direct prefix
routing. Keep the wording aligned with the runtime contract by adjusting the
explanatory text for the provider mode options rather than changing behavior.

In `@website/docs/integrations/llm-providers.md`:
- Around line 147-163: The Vertex AI docs are inconsistent: the provider table
still marks Vertex AI as Direct even though this section now recommends routing
through Vertex with LLM_PROVIDER_MODE=vertex. Update the Vertex AI row in the
supported-providers table to match the behavior described here, and keep the
wording aligned with the llm-providers.md guidance so the table and the
Vertex-specific section agree.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c6dedcce-151c-486b-a68a-6458a61f03af

📥 Commits

Reviewing files that changed from the base of the PR and between 4671d1e and 28f0aca.

📒 Files selected for processing (3)
  • .env.example
  • website/docs/configuration/environment.md
  • website/docs/integrations/llm-providers.md

Comment thread .env.example Outdated
Comment thread website/docs/integrations/llm-providers.md
Use the LLM_PROVIDER_MODE value (openrouter, vertex, bedrock) in the Mode
column for the providers that have a dedicated routing mode, so the table
agrees with the Vertex setup section recommending LLM_PROVIDER_MODE=vertex.
@damianloch
damianloch dismissed stale reviews from beng360 and arvo-ai-staging[bot] via 95ad176 June 25, 2026 16:55

@arvo-ai-staging arvo-ai-staging Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aurora Risk Review — Latest changes

Verdict: SAFE

No new incident risk in the latest changes.


Aurora reviews PRs for incident prevention.

@damianloch
damianloch merged commit 7fbccdf into main Jun 25, 2026
17 checks passed
@damianloch
damianloch deleted the docs/vertex-provider-mode branch June 25, 2026 16:57
@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants