vxcontrol/pentagi
1
0
Fork 0
mirror of https://github.com/vxcontrol/pentagi.git synced 2026-07-20 12:37:04 -04:00
Code Issues 45 Packages Projects Releases 9 Wiki Activity

[PR #318] [MERGED] docs(llm): clarify Vertex AI configuration options #313

New Issue
Closed
opened 2026-06-06 22:10:11 -04:00 by yindo · 0 comments
yindo commented 2026-06-06 22:10:11 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/vxcontrol/pentagi/pull/318
Author: @mason5052
Created: 5/22/2026
Status: ✅ Merged
Merged: 5/27/2026
Merged by: @asdek

Base: feature/next-release ← Head: codex/issue-310-vertex-ai-config-docs

📝 Commits (1)

  • 5ff63cc docs(llm): clarify Vertex AI configuration options

📊 Changes

2 files changed (+17 additions, -0 deletions)

View changed files

📝 README.md (+10 -0)
📝 backend/docs/config.md (+7 -0)

📄 Description

Summary

Clarify in the user-facing LLM provider docs that PentAGI does not currently expose a dedicated Google Vertex AI configuration path for Anthropic Claude in .env, and describe the routes that actually work today (direct Anthropic, AWS Bedrock, or a custom OpenAI-compatible gateway).

Docs-only change. No Go code, no installer behavior, no new environment variables.

Problem

Issue #310 asks how to provide a Google Vertex AI API key in .env for Anthropic Claude. PentAGI's .env.example, backend/pkg/config, and backend/cmd/installer/wizard do not read any VERTEX_*, GOOGLE_APPLICATION_CREDENTIALS, or vertex_ai variable. The current provider initialization for Claude only knows about:

  • ANTHROPIC_API_KEY / ANTHROPIC_SERVER_URL (direct Anthropic API)
  • BEDROCK_REGION / BEDROCK_DEFAULT_AUTH / BEDROCK_BEARER_TOKEN / BEDROCK_ACCESS_KEY_ID / BEDROCK_SECRET_ACCESS_KEY / BEDROCK_SESSION_TOKEN / BEDROCK_SERVER_URL (AWS Bedrock)
  • LLM_SERVER_URL / LLM_SERVER_KEY / LLM_SERVER_MODEL (custom OpenAI-compatible endpoint)

Today this leaves users guessing whether some hidden Vertex AI configuration exists. The user in issue #310 hit exactly this — they "tried multiple methods of adding Anthropic's Claude models Vertex AI keys but the application couldn't parse it."

Solution

Add a small clarification in two places, matching the existing style of each file:

  • README.md: a > [!NOTE] callout inside the Anthropic Provider Configuration section. It states the current limitation, lists the supported Claude routes (direct Anthropic, AWS Bedrock), and describes the safest workaround for users who must use Vertex AI today (front it with an OpenAI-compatible gateway and configure the existing Custom LLM provider, with a caveat that reliability depends on the gateway).
  • backend/docs/config.md: a matching Note paragraph under the Anthropic section, pointing at the AWS Bedrock LLM Provider and Custom LLM Provider sections already in the same doc, and stating that no VERTEX_API_KEY or GOOGLE_APPLICATION_CREDENTIALS variable is wired into provider initialization today.

Wording is intentionally hedged ("currently", "at this time", "today") to avoid permanent claims, and no fake env vars are introduced.

User Impact

  • Users following issue #310 get a direct, accurate answer in the docs they were already reading.
  • New users evaluating PentAGI for Claude-on-Vertex-AI workloads see the limitation up front and the supported workaround, instead of trial-and-erroring .env keys that do nothing.
  • No runtime change: existing deployments keep working unchanged.

Test Plan

  • git diff --check clean
  • git status shows only README.md and backend/docs/config.md modified; no unrelated dirty files staged
  • Verified every env var named in the new text exists in code or existing docs:
    • ANTHROPIC_API_KEY, ANTHROPIC_SERVER_URL: backend/pkg/config/config.go, .env.example, README, backend/docs/config.md
    • BEDROCK_REGION, BEDROCK_DEFAULT_AUTH, BEDROCK_BEARER_TOKEN, BEDROCK_ACCESS_KEY_ID, BEDROCK_SECRET_ACCESS_KEY, BEDROCK_SESSION_TOKEN, BEDROCK_SERVER_URL: backend/pkg/config/config.go, .env.example, README, backend/docs/config.md
    • LLM_SERVER_URL, LLM_SERVER_KEY, LLM_SERVER_MODEL: backend/pkg/config/config.go, .env.example, backend/docs/config.md
  • Verified VERTEX_*, vertex_ai, and GOOGLE_APPLICATION_CREDENTIALS are NOT present in backend/pkg/config or backend/pkg/providers — the doc claim that no such variable is wired in today is accurate
  • Anchor links resolve: #aws-bedrock-provider-configuration (README) and #aws-bedrock-llm-provider + #custom-llm-provider (config.md) match real headings in the same files
  • No runtime Go files, installer behavior, or generated files modified

Refs #310

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/vxcontrol/pentagi/pull/318 **Author:** [@mason5052](https://github.com/mason5052) **Created:** 5/22/2026 **Status:** ✅ Merged **Merged:** 5/27/2026 **Merged by:** [@asdek](https://github.com/asdek) **Base:** `feature/next-release` ← **Head:** `codex/issue-310-vertex-ai-config-docs` --- ### 📝 Commits (1) - [`5ff63cc`](https://github.com/vxcontrol/pentagi/commit/5ff63cc4a83a82d08c396e32a66b48e53cfb76ee) docs(llm): clarify Vertex AI configuration options ### 📊 Changes **2 files changed** (+17 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+10 -0) 📝 `backend/docs/config.md` (+7 -0) </details> ### 📄 Description ## Summary Clarify in the user-facing LLM provider docs that PentAGI does not currently expose a dedicated Google Vertex AI configuration path for Anthropic Claude in `.env`, and describe the routes that actually work today (direct Anthropic, AWS Bedrock, or a custom OpenAI-compatible gateway). Docs-only change. No Go code, no installer behavior, no new environment variables. ## Problem Issue #310 asks how to provide a Google Vertex AI API key in `.env` for Anthropic Claude. PentAGI's `.env.example`, `backend/pkg/config`, and `backend/cmd/installer/wizard` do not read any `VERTEX_*`, `GOOGLE_APPLICATION_CREDENTIALS`, or `vertex_ai` variable. The current provider initialization for Claude only knows about: - `ANTHROPIC_API_KEY` / `ANTHROPIC_SERVER_URL` (direct Anthropic API) - `BEDROCK_REGION` / `BEDROCK_DEFAULT_AUTH` / `BEDROCK_BEARER_TOKEN` / `BEDROCK_ACCESS_KEY_ID` / `BEDROCK_SECRET_ACCESS_KEY` / `BEDROCK_SESSION_TOKEN` / `BEDROCK_SERVER_URL` (AWS Bedrock) - `LLM_SERVER_URL` / `LLM_SERVER_KEY` / `LLM_SERVER_MODEL` (custom OpenAI-compatible endpoint) Today this leaves users guessing whether some hidden Vertex AI configuration exists. The user in issue #310 hit exactly this — they "tried multiple methods of adding Anthropic's Claude models Vertex AI keys but the application couldn't parse it." ## Solution Add a small clarification in two places, matching the existing style of each file: - `README.md`: a `> [!NOTE]` callout inside the Anthropic Provider Configuration section. It states the current limitation, lists the supported Claude routes (direct Anthropic, AWS Bedrock), and describes the safest workaround for users who must use Vertex AI today (front it with an OpenAI-compatible gateway and configure the existing Custom LLM provider, with a caveat that reliability depends on the gateway). - `backend/docs/config.md`: a matching Note paragraph under the Anthropic section, pointing at the AWS Bedrock LLM Provider and Custom LLM Provider sections already in the same doc, and stating that no `VERTEX_API_KEY` or `GOOGLE_APPLICATION_CREDENTIALS` variable is wired into provider initialization today. Wording is intentionally hedged ("currently", "at this time", "today") to avoid permanent claims, and no fake env vars are introduced. ## User Impact - Users following issue #310 get a direct, accurate answer in the docs they were already reading. - New users evaluating PentAGI for Claude-on-Vertex-AI workloads see the limitation up front and the supported workaround, instead of trial-and-erroring `.env` keys that do nothing. - No runtime change: existing deployments keep working unchanged. ## Test Plan - [x] `git diff --check` clean - [x] `git status` shows only `README.md` and `backend/docs/config.md` modified; no unrelated dirty files staged - [x] Verified every env var named in the new text exists in code or existing docs: - `ANTHROPIC_API_KEY`, `ANTHROPIC_SERVER_URL`: `backend/pkg/config/config.go`, `.env.example`, README, `backend/docs/config.md` - `BEDROCK_REGION`, `BEDROCK_DEFAULT_AUTH`, `BEDROCK_BEARER_TOKEN`, `BEDROCK_ACCESS_KEY_ID`, `BEDROCK_SECRET_ACCESS_KEY`, `BEDROCK_SESSION_TOKEN`, `BEDROCK_SERVER_URL`: `backend/pkg/config/config.go`, `.env.example`, README, `backend/docs/config.md` - `LLM_SERVER_URL`, `LLM_SERVER_KEY`, `LLM_SERVER_MODEL`: `backend/pkg/config/config.go`, `.env.example`, `backend/docs/config.md` - [x] Verified `VERTEX_*`, `vertex_ai`, and `GOOGLE_APPLICATION_CREDENTIALS` are NOT present in `backend/pkg/config` or `backend/pkg/providers` — the doc claim that no such variable is wired in today is accurate - [x] Anchor links resolve: `#aws-bedrock-provider-configuration` (README) and `#aws-bedrock-llm-provider` + `#custom-llm-provider` (config.md) match real headings in the same files - [x] No runtime Go files, installer behavior, or generated files modified Refs #310 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-06 22:10:11 -04:00
yindo closed this issue 2026-06-06 22:10:11 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
help wanted
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: vxcontrol/pentagi#313
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?