[PR #305] [MERGED] docs(graphiti): note beta status and OpenAI-only provider limitation #309

New Issue

2026-06-06T22:10:09-04:00

yindo commented

2026-06-06 22:10:09 -04:00

📋 Pull Request Information

Original PR: https://github.com/vxcontrol/pentagi/pull/305
Author: @mason5052
Created: 5/7/2026
Status: ✅ Merged
Merged: 5/21/2026
Merged by: @asdek

Base: feature/next-release ← Head: codex/issue-187-graphiti-limitations-docs

📝 Commits (2)

fa53a4e docs(graphiti): note beta status and OpenAI-only provider limitation
c0e9ed7 docs(graphiti): use user-facing env vars for OpenAI endpoint

📊 Changes

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

View changed files

📝 README.md (+14 -0)
📝 backend/docs/config.md (+13 -0)

📄 Description

Summary

Documents that the Graphiti knowledge graph integration is currently a beta feature, and that the bundled container today only consumes OpenAI-compatible LLM credentials. Adds the note in two places (README and backend/docs/config.md) without changing any runtime behavior.

Problem

Issue #187 raised that Graphiti's current provider story is not obvious to users. PentAGI itself is configured against many LLM providers (Anthropic, Google AI / Gemini, AWS Bedrock, DeepSeek, GLM, Kimi, Qwen, OpenAI, Ollama), but the bundled vxcontrol/graphiti container in docker-compose-graphiti.yml only reads OPENAI_API_KEY and a single OPEN_AI_SERVER_URL (default https://api.openai.com/v1) for entity extraction, with a fixed model name from GRAPHITI_MODEL_NAME (default gpt-5-mini).

Today neither the README's Graphiti section nor backend/docs/config.md's Graphiti settings call this out, and they do not flag the integration as beta. Users have to read docker-compose-graphiti.yml to understand the constraint.

Solution

Add a small, accurate, English-only note in two surfaces:

README.md — Adds an [!IMPORTANT] beta callout at the top of the Knowledge Graph Integration (Graphiti) section and a new Current Limitations subsection covering:
- OpenAI-compatible LLM only (with the relevant env vars and the list of unaffected PentAGI providers),
- single fixed model per deployment,
- independent billing from the main flow LLM,
- no in-app graph explorer yet (Neo4j Browser / Swagger UI are the supported surfaces),
- explicit fallback: leave GRAPHITI_ENABLED=false if the deployment cannot reach an OpenAI-compatible endpoint.
backend/docs/config.md — Mirrors the same beta callout at the top of Graphiti Knowledge Graph Settings and adds a Current Limitations (Beta) subsection so config-focused readers see the same message.

The commit is documentation only; no runtime, schema, or env-var behavior changes.

User Impact

Operators evaluating Graphiti can see the OpenAI-compatible-LLM constraint and the beta status before they enable it in production.
Users running PentAGI on a non-OpenAI provider learn the documented fallback (GRAPHITI_ENABLED=false) and that the rest of the stack still works.
The note is honest about scope: it does not promise multi-provider Graphiti work; it documents what ships today and points at what the user can choose.

Test Plan

git diff --stat shows only README.md and backend/docs/config.md changed.
Markdown renders without broken anchor, callout, or code-fence syntax.
Constraints quoted in the note match docker-compose-graphiti.yml on feature/next-release (env vars OPENAI_API_KEY, OPENAI_BASE_URL from OPEN_AI_SERVER_URL, default https://api.openai.com/v1, MODEL_NAME from GRAPHITI_MODEL_NAME, default gpt-5-mini).
No code or tests changed.

Refs #187

_{🔄 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/305 **Author:** [@mason5052](https://github.com/mason5052) **Created:** 5/7/2026 **Status:** ✅ Merged **Merged:** 5/21/2026 **Merged by:** [@asdek](https://github.com/asdek) **Base:** `feature/next-release` ← **Head:** `codex/issue-187-graphiti-limitations-docs` --- ### 📝 Commits (2) - [`fa53a4e`](https://github.com/vxcontrol/pentagi/commit/fa53a4e1d26004f48c9366f37bf569918b04e1c7) docs(graphiti): note beta status and OpenAI-only provider limitation - [`c0e9ed7`](https://github.com/vxcontrol/pentagi/commit/c0e9ed74fd5655d0ceb87ed16b2fe53f2a283ac9) docs(graphiti): use user-facing env vars for OpenAI endpoint ### 📊 Changes **2 files changed** (+27 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+14 -0) 📝 `backend/docs/config.md` (+13 -0) </details> ### 📄 Description ## Summary Documents that the Graphiti knowledge graph integration is currently a beta feature, and that the bundled container today only consumes OpenAI-compatible LLM credentials. Adds the note in two places (README and ``backend/docs/config.md``) without changing any runtime behavior. ## Problem Issue #187 raised that Graphiti's current provider story is not obvious to users. PentAGI itself is configured against many LLM providers (Anthropic, Google AI / Gemini, AWS Bedrock, DeepSeek, GLM, Kimi, Qwen, OpenAI, Ollama), but the bundled ``vxcontrol/graphiti`` container in ``docker-compose-graphiti.yml`` only reads ``OPENAI_API_KEY`` and a single ``OPEN_AI_SERVER_URL`` (default ``https://api.openai.com/v1``) for entity extraction, with a fixed model name from ``GRAPHITI_MODEL_NAME`` (default ``gpt-5-mini``). Today neither the README's Graphiti section nor ``backend/docs/config.md``'s Graphiti settings call this out, and they do not flag the integration as beta. Users have to read ``docker-compose-graphiti.yml`` to understand the constraint. ## Solution Add a small, accurate, English-only note in two surfaces: - **README.md** — Adds an ``[!IMPORTANT]`` beta callout at the top of the *Knowledge Graph Integration (Graphiti)* section and a new *Current Limitations* subsection covering: - OpenAI-compatible LLM only (with the relevant env vars and the list of unaffected PentAGI providers), - single fixed model per deployment, - independent billing from the main flow LLM, - no in-app graph explorer yet (Neo4j Browser / Swagger UI are the supported surfaces), - explicit fallback: leave ``GRAPHITI_ENABLED=false`` if the deployment cannot reach an OpenAI-compatible endpoint. - **backend/docs/config.md** — Mirrors the same beta callout at the top of *Graphiti Knowledge Graph Settings* and adds a *Current Limitations (Beta)* subsection so config-focused readers see the same message. The commit is documentation only; no runtime, schema, or env-var behavior changes. ## User Impact - Operators evaluating Graphiti can see the OpenAI-compatible-LLM constraint and the beta status before they enable it in production. - Users running PentAGI on a non-OpenAI provider learn the documented fallback (``GRAPHITI_ENABLED=false``) and that the rest of the stack still works. - The note is honest about scope: it does not promise multi-provider Graphiti work; it documents what ships today and points at what the user can choose. ## Test Plan - [x] ``git diff --stat`` shows only ``README.md`` and ``backend/docs/config.md`` changed. - [x] Markdown renders without broken anchor, callout, or code-fence syntax. - [x] Constraints quoted in the note match ``docker-compose-graphiti.yml`` on ``feature/next-release`` (env vars ``OPENAI_API_KEY``, ``OPENAI_BASE_URL`` from ``OPEN_AI_SERVER_URL``, default ``https://api.openai.com/v1``, ``MODEL_NAME`` from ``GRAPHITI_MODEL_NAME``, default ``gpt-5-mini``). - [x] No code or tests changed. Refs #187 --- <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:09 -04:00

yindo closed this issue

2026-06-06 22:10:09 -04:00

yindo referenced this issue

2026-06-06 22:10:11 -04:00

[PR #320] [MERGED] fix(providers): clarify misleading docker image LLM error (#312) #315

yindo referenced this issue

2026-06-06 22:10:12 -04:00

[PR #325] docs: clarify "primary docker image" error is an LLM backend failure #320

Sign in to join this conversation.