Skip to main content

ZettaBrain: install, setup, ingest, chat

ZettaBrain RAG

Chat with your documents. Generate documents from them.

ZettaBrain plugs into NFS, SMB, S3, or OneDrive, answers questions with citations, and runs 21 Skills that turn your corpus into SOPs, quotes, compliance reports, and more. Local AI, no cloud.

PyPI Downloads Python License Platform

Install · Try with sample data · Star the repo


Your first answer in 60 seconds

curl -fsSL https://zettabrain.app/install.sh | sudo bash

The installer sets up Python, Ollama, and the embedding model. Run the setup wizard, then launch:

sudo zettabrain-setup      # Configure storage and model
zettabrain-server          # Start web GUI at https://localhost:7860

Or install via pip:

pip install zettabrain-rag

Try with sample data

Not ready to point it at your own files? Download a test corpus and start asking questions immediately:

curl -LO https://zettabrain.io/sample-data/zettabrain-financial-test-docs.zip
unzip zettabrain-financial-test-docs.zip -d ~/zettabrain-test
zettabrain-ingest --folder ~/zettabrain-test/financial
zettabrain-chat

Ask: "What is the pre-clearance process for personal securities trades?"

You'll get an answer with citations like [Trading_Policy.docx p.3].


The problem

Before: Someone asks about the expense policy. You open the shared drive, guess which folder it's in, skim three PDFs, Ctrl+F through a 40-page handbook, and hope you found the right version.

After: You ask ZettaBrain. It searches every document you've indexed, pulls the relevant paragraphs, and gives you a sourced answer in seconds.

And when you need to write a compliance report, SOP, or RFP response? Skills pull facts from your corpus and generate a draft grounded in your actual documents, not hallucinated boilerplate.


What you get

Connects to your storage Local disk, NFS, SMB/CIFS, S3, OneDrive. No uploads, no file migration.
Chat with citations Ask questions in plain language. Every answer cites the source document and page.
21 built-in Skills Generate executive summaries, compliance audits, RFP responses, SOPs, runbooks, and more.
Fully local by default Runs on Ollama. Your documents and queries never leave your machine.
Cloud LLMs optional Connect Claude, Gemini, or OpenAI when you need more power.
25 free trial requests Try instantly with zero setup. No API key, no model download.

How it works

flowchart LR
    A[Your Storage] --> B[Ingest]
    B --> C[Vector Store]
    D[Question] --> E[Hybrid Retrieval]
    C --> E
    E --> F[Local LLM]
    F --> G[Answer + Sources]

Storage: ZettaBrain reads from wherever your documents already live: a local folder, NFS share, SMB server, S3 bucket, or OneDrive.

Ingest: Documents are chunked (size tuned per file type and storage latency), embedded, and stored in ChromaDB. MD5 hashes track what's been indexed, so re-runs only process new or changed files.

Retrieval: A five-stage hybrid pipeline finds the best context for your question:

  1. MMR semantic search finds chunks with similar meaning while maintaining diversity
  2. BM25 keyword search catches exact terms the embedding might miss
  3. Merge and deduplicate combines both result sets
  4. Cross-encoder re-ranking (FlashRank) scores each chunk against your question
  5. Top chunks go to the LLM with your question

Generation: The LLM sees only your question and the retrieved context. It answers based on that context and cites sources. For Skills, the same retrieval feeds a structured prompt that produces a formatted document.


Built for

Finance and compliance

"When do I need to file a Suspicious Activity Report and what is the deadline?"

Index your AML policy, trading guidelines, and expense handbook. Get sourced answers for audits. Generate compliance checklists grounded in your actual procedures.

Healthcare

"Which medications require an independent double-check before administration?"

HIPAA policies, medication protocols, emergency codes. Staff can ask questions without digging through binders. Nothing leaves your network.

"What are the termination provisions in the Acme vendor contract?"

Index contracts, NDAs, and procurement policies. Summarize key terms with the Contract Summary skill. Flag unusual clauses automatically.

IT and consulting

"How do we handle an S3 bucket permission escalation?"

Runbooks, architecture docs, past incident reports. Generate new runbooks from existing documentation. Keep tribal knowledge searchable.


Your data stays yours

ZettaBrain is private by default:

  • Local inference: Ollama runs on your machine. Queries and documents never hit an external API unless you configure one.
  • Local vector store: Embeddings are stored in ChromaDB on disk, not in any cloud service.
  • No telemetry: No analytics, no usage tracking, no phoning home.
  • Your storage: Documents stay where they are. ZettaBrain reads from your NFS/SMB/S3 mount; it doesn't copy files to a separate location.

When you enable a cloud LLM (Claude, Gemini, OpenAI), your queries and retrieved chunks are sent to that provider. The setup wizard and web UI make this choice explicit.


Skills

Skills are document generators. They combine a structured prompt with context retrieved from your corpus to produce formatted output: an executive summary, a compliance audit, an RFP response.

Built-in Skills

Category Skills
Business Executive Summary, Project Proposal, Status Report, RFP Response, Contract Summary
Technical API Documentation, Architecture Decision Record, Technical Doc, Data Dictionary
Operations SOP Generator, Runbook, Incident Report, Change Request, Release Notes
Compliance Compliance Audit, Security Assessment
HR and training Onboarding Guide, Training Material, Knowledge Base Article
Communication Email Drafter, Meeting Notes

Price lists

Upload an Excel price list and Skills can generate quotes with real prices. Figures are tool-calculated from your data, never hallucinated by the model.

Create your own

Add a markdown file to /opt/zettabrain/src/skills/:

---
name: My Custom Skill
version: 1.0.0
description: What this skill generates
requires_corpus: true
temperature: 0.5
max_tokens: 2000
---

Your prompt instructions here. Reference {context} for retrieved documents
and {user_input} for what the user provides.

Or use the AI-assisted skill drafter in the web UI: describe what you want, and ZettaBrain generates a skill definition from your corpus.


Pick your model

Laptop (no GPU)? Start with phi4-mini. Best reasoning-per-GB on CPU.

Have a GPU? qwen2.5:14b for quality, mistral:7b for speed.

Apple Silicon? Metal acceleration is automatic. phi4-mini or llama3.1:8b work well.

Just trying it out? Use the trial mode (25 free requests, no setup).

Full model tables

CPU-only

Model Size Speed Best for
qwen3:0.6b ~500 MB Instant Quick lookups
gemma3:1b ~815 MB Very fast Structured explanations
phi4-mini ~2.5 GB Moderate Best RAG reasoning on CPU
llama3.2:3b ~2 GB Moderate General purpose
mistral:7b ~4 GB Slow Strong instruction (12 GB+ RAM)
llama3.1:8b ~5 GB Slow Balanced quality (16 GB+ RAM)

GPU

Model VRAM Speed Best for
phi4-mini ~2.5 GB Fast Best reasoning per GB
mistral:7b ~4 GB Fast Strong instruction following
llama3.1:8b ~5 GB Fast Balanced quality
mistral-nemo:12b ~7 GB Moderate Better reasoning
qwen2.5:14b ~9 GB Moderate Excellent quality
qwen2.5:32b ~20 GB Slower Best quality

Performance

ZettaBrain runs on CPU, flies on GPU.

Retrieval is fast everywhere (~1 second). Generation speed depends on your hardware:

Setup Generate time Total
phi4-mini on CPU 2-5 min Usable for async workflows
mistral:7b on GPU 5-12 s Interactive
qwen2.5:14b on GPU 4-10 s Interactive, higher quality
Apple M2/M3 16 GB 10-20 s Interactive

For CPU-only machines, the trial mode or a cloud LLM gives instant responses while you evaluate.


Supported platforms

Platform Versions
Ubuntu 20.04, 22.04, 24.04
Debian 11, 12
Amazon Linux 2, 2023
RHEL / Rocky / AlmaLinux 8, 9
Fedora 38+
macOS 12+ (Intel and Apple Silicon)
Windows 10/11 via WSL2

Reference

Full documentation for commands, configuration, diagnostics, storage backends, API endpoints, and uninstallation:

docs/REFERENCE.md


Roadmap

  • Scheduled ingestion (auto-sync on interval)
  • Multi-user authentication
  • More built-in Skills
  • Slack and Teams integration
  • API rate limiting and usage tracking

Have a feature request? Open an issue.


Contributing

Contributions welcome. Please open an issue to discuss before submitting large changes.

git clone https://github.com/zettabrain/zettabrain-rag.git
cd zettabrain-rag
pip install -e ".[dev]"
pytest

License

MIT. See LICENSE.


Built by ZettaBrain
If this helps you, star the repo.

Metadata

Release files for zettabrain-rag 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zettabrain-rag 1.0.0
File Size Uploaded
zettabrain_rag-1.0.0.tar.gz 197.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for zettabrain-rag 1.0.0
File Interpreter ABI Platform
zettabrain_rag-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 398.1 kB

Release files / zettabrain_rag-1.0.0.tar.gz

Download URL zettabrain_rag-1.0.0.tar.gz
Size 197.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3461cf619234cb518beb5bf732b36f383939306cc9a67aa91b51f9aeb055e1b3
BLAKE2b-256 checksum
How to use checksums
1b08639e2d91485abe896940c7fb755803e8b56f7ae51634df3a90a74fe04523
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.5

Release files / zettabrain_rag-1.0.0-py3-none-any.whl

Download URL zettabrain_rag-1.0.0-py3-none-any.whl
Size 200.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ea2d4167901d8356cae715370faf9f7b88bae2d94fc7ba9efa4f893b0608ca96
BLAKE2b-256 checksum
How to use checksums
44278a363bfcb3cab99f8105a4afc1d591e1f668317220b64cf6b57e81c54265
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.5

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.5.31

2 release files

0.5.30

2 release files

0.5.29

2 release files

0.5.28

2 release files

0.5.27

2 release files

0.5.26

2 release files

0.5.25

2 release files

0.5.24

2 release files

0.5.23

2 release files

0.5.22

2 release files

0.5.21

2 release files

0.5.20

2 release files

0.5.19

2 release files

0.5.9

2 release files

0.5.8

2 release files

0.5.7

2 release files

0.5.6

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.9

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.2

2 release files

0.4.0

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.0

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page