Bi-temporal RAG platform: cited, temporally-correct answers plus system-time replay. Self-hostable memory and audit layer for AI agents.
Project description
RAGBrain
The bi-temporal RAG platform. Prove what your AI knew, and when.
Any document in, a cited and temporally-correct answer out, plus the capability the rest of the field lacks: replay what the system believed at any past moment, without leaking later corrections into the past.
Quick start · Architecture · Benchmarks · API · Documentation
Why RAGBrain
Every fact is stored on two independent time axes: when it was true in the world (event time) and when the system learned it (system time). The second axis is what makes answers defensible rather than merely plausible.
Consider one fact that changed: Acme Corp's HQ was Boston (2019 filing), then Denver (2022 filing).
| Question | Vector RAG | Valid-time RAG | RAGBrain |
|---|---|---|---|
| Where is Acme HQ now? | ✅ Denver | ✅ Denver | ✅ Denver |
| Where was it in 2020? | ❌ | ✅ Boston | ✅ Boston |
| What did we believe in 2021, before the 2022 filing? | ❌ | ❌ | ✅ Boston, Denver un-known |
| Show the timeline and what superseded what | ❌ | ⚠️ partial | ✅ full provenance and audit |
The third row is system-time replay. It requires an independent record of when each fact was learned, and the discipline never to let a later correction leak into a past belief state: the un-knowing invariant, enforced in CI against a live graph store.
Capabilities
- Bi-temporal knowledge graph. Four timestamps per fact (
valid_at,invalid_at,created_at,expired_at) in FalkorDB or Neo4j. - As-of retrieval. Ask any question as of any instant; context is validity-filtered before ranking.
- System-time replay and audit. Reconstruct what the system believed at any past moment; a live web scrubber makes it visible.
- Supersession with provenance. A correcting fact expires the old one and stamps a
superseded_byback-link at write time; every answer carries citations. - Checked generation. Answers are verified claim-by-claim against the served facts after generation; unsupported claims are flagged, never silently shipped.
- Pluggable everything. Embedder, reranker, generation model, and graph backend are config-selected and fail loud; bring hosted APIs or fully local models.
- Secure by default. Bearer-token auth, token-scoped sessions, rate limits, upload caps.
- Multi-replica ready. Shared session state and a shared durable write-back journal, proven by a two-replica test; a metrics endpoint for operations.
- Self-hostable end to end. Your documents, your models, your infrastructure.
Quick start
Prereqs: Docker. No API keys required for the demo.
git clone https://github.com/Nagendhra-Madishetti/ragbrain && cd ragbrain
docker compose up -d --build
bash scripts/demo.sh
The demo seeds the Acme scenario and asserts four answers:
now -> Denver
as of 2020 -> Boston
replay(2021) -> Boston (the 2022 Denver correction is un-known)
timeline -> Boston (2019 report) superseded by Denver (2022 press release)
Open the live scrubber at http://localhost:3000/playground and drag the system-time slider across 2022; the answer flips in front of you:
Install as a library
pip install ragbrain # import ragbrain
pip install "ragbrain[all,serve]" # backends + the platform API
Architecture
The bi-temporal model
- Event time
[valid_at, invalid_at): when the fact was true in the world. Answers "as of 2020". - System time
[created_at, expired_at): when the system learned or retracted it. Answers "what did we believe at S" and powers the un-knowing replay. - A correction supersedes: the old fact receives
invalid_at(event) andexpired_at(system) plus asuperseded_byback-link, stamped at write time. - Replay to S drops everything learned after S, including the knowledge that a fact was
later corrected. That is the invariant, enforced two ways: as pure deterministic tests and
live against a FalkorDB service in CI (
tests/integration/test_replay_seeded.py).
Benchmarks
All published numbers come from live, reproducible runs on a fictional corpus (invented companies, dates only in metadata), so no model can answer from training. Results carry a content hash and a reproduce command; scores are claims exactly the size of the measurement.
| Comparison | Chart |
|---|---|
| As-of questions vs LlamaIndex, LangChain, Haystack, and a temporal-graph ablation | |
| Current-fact questions (the honest tie) |
Reproduce: python demo/benchmark_frameworks.py. Full per-question answers, methodology,
and the measured evaluation floors (verify recall, faithfulness checker precision and recall)
are in the web app's Benchmark page and PROJECT_STATUS.md.
API
Every route except /api/health requires a bearer token (RAGBRAIN_API_TOKENS; the compose
stack provisions ragbrain-demo-token). A session is scoped to the token that created it.
TOKEN=ragbrain-demo-token
API=http://localhost:8000
H="Authorization: Bearer $TOKEN"
curl -H "$H" -X POST "$API/api/demo/seed"
curl -H "$H" "$API/api/audit/current?session_id=demo_acme"
curl -H "$H" "$API/api/audit/event?session_id=demo_acme&as_of=2020-06-01"
curl -H "$H" "$API/api/audit/replay?session_id=demo_acme&system_time=2021-06-01"
curl -H "$H" "$API/api/audit/timeline/demo-belief-boston?session_id=demo_acme"
curl -H "$H" -H 'Content-Type: application/json' -X POST "$API/api/context" \
-d '{"session_id":"mine","query":"Where is Acme headquartered?","as_of":"2020-06-01"}'
Ingest your own documents (local; data never leaves your environment):
cp .env.example .env # provider keys for generation and semantic retrieval
curl -H "$H" -F session_id=mine -F reference_time=2019-01-01 \
-F file=@your_report.pdf "$API/api/ingest"
For semantic retrieval configure a real embedder: RAGBRAIN_EMBEDDER=bge-m3-local
(key-free, requires the [embeddings] extra) or RAGBRAIN_EMBEDDER=bge-m3 with
RAGBRAIN_EMBEDDER_API_KEY. The key-free boot default (hash) is lexical and states so
loudly in every response until a real embedder is configured.
Deployment
- Local and trusted environments:
docker compose up -d --build. - Multi-replica:
docker compose -f docker-compose.yml -f docker-compose.replicas.yml up -dwithRAGBRAIN_SHARED_STATE=1; verify withbash scripts/two_replica_proof.sh. - Operations: an authenticated
/metricsendpoint exposes per-replica counters. - Security posture, scope, and the operator checklist: SECURITY.md. Project status and measured evaluation floors: PROJECT_STATUS.md. Defect ledger: docs/KNOWN_ISSUES.md.
Documentation
| Topic | Where |
|---|---|
| Context-serving API | docs/CONTEXT_API.md |
| Audit and replay | docs/AUDIT_DASHBOARD.md |
| Document ingestion | docs/DOCUMENT_INGESTION.md |
| Embedders | docs/EMBEDDERS.md |
| Generation and faithfulness | docs/GENERATION.md |
| Extending without touching core | docs/EXTENDING.md, CONTRIBUTING.md |
Development
pip install -e ".[dev]"
ruff check .
pytest
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ragbrain-0.1.0.tar.gz.
File metadata
- Download URL: ragbrain-0.1.0.tar.gz
- Upload date:
- Size: 2.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b1c2e582f69ff5d526238c36d293b5dc24984d540405c90952b02871e87acbf0
|
|
| MD5 |
8a8d769fa72c79f7050917d7a9be88d6
|
|
| BLAKE2b-256 |
2b3089bdcd609a2b837811da6d8b8f94fc4483fa6bd648851a6a354dba95f180
|
Provenance
The following attestation bundles were made for ragbrain-0.1.0.tar.gz:
Publisher:
publish.yml on Nagendhra-Madishetti/ragbrain
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ragbrain-0.1.0.tar.gz -
Subject digest:
b1c2e582f69ff5d526238c36d293b5dc24984d540405c90952b02871e87acbf0 - Sigstore transparency entry: 2195159809
- Sigstore integration time:
-
Permalink:
Nagendhra-Madishetti/ragbrain@aafde7f1709e1bc048043b0d220a26de2a407541 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/Nagendhra-Madishetti
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@aafde7f1709e1bc048043b0d220a26de2a407541 -
Trigger Event:
push
-
Statement type:
File details
Details for the file ragbrain-0.1.0-py3-none-any.whl.
File metadata
- Download URL: ragbrain-0.1.0-py3-none-any.whl
- Upload date:
- Size: 96.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ddd4ad79f543674dfc856df3182edc8c57ca3802cc474dab9d0403f910551819
|
|
| MD5 |
97bf5eeaa238ce6cd13797cb20c7adef
|
|
| BLAKE2b-256 |
d37d98f9bfdecc6fff26a90a1720005e92d033baa475bbc3ac848fd23a966d42
|
Provenance
The following attestation bundles were made for ragbrain-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on Nagendhra-Madishetti/ragbrain
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ragbrain-0.1.0-py3-none-any.whl -
Subject digest:
ddd4ad79f543674dfc856df3182edc8c57ca3802cc474dab9d0403f910551819 - Sigstore transparency entry: 2195159826
- Sigstore integration time:
-
Permalink:
Nagendhra-Madishetti/ragbrain@aafde7f1709e1bc048043b0d220a26de2a407541 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/Nagendhra-Madishetti
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@aafde7f1709e1bc048043b0d220a26de2a407541 -
Trigger Event:
push
-
Statement type: