ZettaBrain RAG 技能

使用本地 AI 与您自己的文档进行对话。当您采用**本地存储 + 本地 Ollama 端点**（默认配置）时，文档数据将**完全保留在您的设备上**。远程存储（S3、NFS、SMB）及远程 OLLAMA_HOST 为可选配置，启用后会导致数据离开本地设备——详见「隐私」章节。

支持 PDF、DOCX、TXT、Markdown 格式。兼容 Linux、macOS（含 EC2 Mac Apple Silicon）及 Windows。

• 源代码：https://github.com/zettabrain/zettabrain-rag（MIT 协议）
• 安装脚本：https://github.com/zettabrain/zettabrain-rag/blob/main/install.sh | install.ps1
• PyPI：https://pypi.org/project/zettabrain-rag/

安装

推荐方式 — pipx（无需提权，完全可审计）

pipx install zettabrain-rag
sudo zettabrain-setup

一键安装脚本（运行前请务必审阅源码）

安装脚本均为开源，您可在执行前通过上方链接完整审阅其源码。

# Linux — 请先审阅：https://github.com/zettabrain/zettabrain-rag/blob/main/install.sh
curl -fsSL https://zettabrain.app/install.sh | sudo bash

# macOS — 请先审阅：https://github.com/zettabrain/zettabrain-rag/blob/main/install.sh
curl -fsSL https://zettabrain.app/install.sh | bash

# Windows — 请先审阅：https://github.com/zettabrain/zettabrain-rag/blob/main/install.ps1
irm https://zettabrain.app/install.ps1 | iex

Linux 安装脚本需使用 sudo 权限，以实现 Ollama 的系统级安装及 systemd 服务注册；macOS 安装脚本在包安装阶段无需 sudo 权限。

初始化配置

安装完成后，请运行一次交互式配置向导：

sudo zettabrain-setup

该命令将执行以下操作：

1. 配置文档存储位置（本地、NFS、SMB 或 S3）
2. 安装并启动本地 Ollama
3. 根据您的硬件自动拉取推荐的 AI 模型
4. 生成自签名 TLS 证书（证书始终保留在设备本地）
5. 将 ZettaBrain 注册为后台服务（参见「服务管理」章节了解如何停止或卸载该服务）

命令列表

使用示例

通过 CLI 对话：

zettabrain-chat
# > 我们的 Q3 报告中关于云成本的内容是什么？

启动 Web 图形界面（访问 https://localhost:7860）：

zettabrain-server

索引指定文件夹：

ZETTABRAIN_DOCS=/path/to/docs zettabrain-ingest

向量数据库 — 存储位置、保留策略与删除方法

向量索引（即文档嵌入向量）**仅存储于您的本地机器上**：

嵌入向量绝不会传输至任何远程服务。它们由您的文档生成，并在本地 ChromaDB 中持久化存储。

删除向量索引：

# 通过 CLI 接口
zettabrain-server &
curl -X DELETE http://localhost:7860/api/vectorstore

# 或直接删除文件
rm -rf /opt/zettabrain/src/zettabrain_vectorstore
rm -f  /opt/zettabrain/src/ingested_files.json

从零重建索引：

zettabrain-ingest --rebuild

排除特定文件或文件夹：只需确保它们未包含在 ZETTABRAIN_DOCS 所指定路径下即可——仅该路径下的文件会被索引。

服务管理

ZettaBrain 会注册一个后台服务，使 Web 图形界面在系统启动时自动运行。以下是控制或彻底移除该服务的方法：

Linux（systemd）

# 停止服务
sudo systemctl stop zettabrain

# 禁用开机自启
sudo systemctl disable zettabrain

# 查看服务状态
sudo systemctl status zettabrain

# 查看实时日志
journalctl -u zettabrain -f

# 彻底移除服务
sudo systemctl stop zettabrain
sudo systemctl disable zettabrain
sudo rm /etc/systemd/system/zettabrain.service
sudo systemctl daemon-reload

macOS（launchd）

# 停止服务
sudo launchctl unload /Library/LaunchDaemons/io.zettabrain.server.plist

# 移除开机自启
sudo rm /Library/LaunchDaemons/io.zettabrain.server.plist

# 查看日志
tail -f /opt/zettabrain/logs/server.log

完全卸载

# 卸载 Python 包
pipx uninstall zettabrain-rag

# 停止并移除服务（Linux）
sudo systemctl stop zettabrain && sudo systemctl disable zettabrain
sudo rm -f /etc/systemd/system/zettabrain.service && sudo systemctl daemon-reload

# 停止并移除服务（macOS）
sudo launchctl unload /Library/LaunchDaemons/io.zettabrain.server.plist
sudo rm -f /Library/LaunchDaemons/io.zettabrain.server.plist

# 删除全部数据、配置及向量索引
sudo rm -rf /opt/zettabrain

隐私

隐私保护程度取决于您的具体配置：

默认配置为完全本地化。 配置向导默认选择本地存储与 localhost 上的 Ollama 端点。所有远程选项均为显式启用，并在配置过程中明确标注。

无论文档存储配置如何，文档嵌入向量（即向量索引）始终在本地存储。

配置

配置文件路径：/opt/zettabrain/src/zettabrain.env

支持平台

相关链接

• GitHub（源码 + 安装脚本）：https://github.com/zettabrain/zettabrain-rag
• PyPI：https://pypi.org/project/zettabrain-rag/
• 官网：https://zettabrain.io
• 问题反馈：https://github.com/zettabrain/zettabrain-rag/issues