veyliss/ai-localbase

AI LocalBase – 本地优先的 RAG 知识库系统

一句话概述

一个用 Go、React 与 Qdrant 搭建的自托管向量检索 + 大模型对话平台，帮助个人或小团队把本地文档（TXT、Markdown、PDF、Excel、CSV 等）接入检索增强问答（RAG），并通过 Ollama 或兼容 OpenAI 的模型进行对话。

---

核心技术栈

层级	技术	说明
后端	Go + Gin	高性能 HTTP API，负责文档解析、向量化、检索、会话管理等业务逻辑
前端	React + Vite + TypeScript	单页面 Web UI，提供知识库管理、文件上传、聊天界面等交互
向量库	Qdrant	开源向量数据库，存储文档向量并支持混合搜索、MMR 去冗余等高级检索功能
模型接入	Ollama / OpenAI‑compatible API	通过统一的 Provider 配置，使用本地 Ollama 模型或任何兼容 OpenAI 的聊天/嵌入模型
持久化	SQLite（聊天记录） + JSON 文件（配置）	轻量本地存储，无需外部数据库
部署	Docker‑Compose（推荐）	前端、后端、Qdrant 三容器一键启动；也提供单进程调试方式
扩展	MCP Server（内置）	HTTP/JSON‑RPC 接口，供外部 Agent、脚本或工具系统调用本地知识库、检索、评估等功能

---

主要功能

1. 知识库管理 – 创建、删除、浏览多个知识库；每个库对应一套 Qdrant collection。
2. 文档上传 & 自动索引 – 支持 TXT、Markdown、PDF、xlsx、csv；自动切分、批量嵌入并写入向量库。
3. 检索增强问答 (RAG) – 检索命中内容后注入对话上下文，支持：
   • 动态召回、关键词覆盖、MMR 去冗余
   • 低置信度二次召回、语义缓存、Hybrid Search、Semantic Reranker、Query Rewrite、Context Compression
4. 聊天记录持久化 – 所有会话保存在本地 SQLite，前端可查看历史对话。
5. 配置持久化 – 模型、向量库、认证等设置写入本地 JSON，容器重启后自动恢复。
6. MCP（Modular Capability Provider） – 为外部 Agent 提供工具列表、调用接口、权限分级、限流、审计日志等；支持异步导入、索引重建、评估数据集生成等工作流。
7. 安全 & 认证 – 可通过环境变量开启 Web 登录、API‑Key 鉴权；生产部署默认开启。

---

典型使用场景

• 个人知识库：把笔记、技术文档、PDF 手册等本地化，随时用聊天方式查询。
• 小团队内部文档问答：在公司内部网络中自托管，保证数据不离网。
• RAG 原型验证：快速搭建并实验不同检索策略、混合搜索或重排模型。
• 模型接入测试：对比 Ollama 本地模型与云端 OpenAI‑compatible 模型的效果与成本。
• Agent 后端：通过 MCP 为自定义 AI Agent 提供“读取文档 → 检索 → 生成答案”的能力。
• 批量文档处理：异步导入大批量文件，支持进度查询与任务取消。

---

快速上手（最小步骤）

# 复制环境变量模板并启动所有容器
cp .env.example .env
docker compose up --build

• 访问 http://localhost:4173 → Settings → 配置 Chat 与 Embedding 模型（示例：Ollama qwen2.5:7b + bge-m3）
• 上传文档 → 开始对话，系统会自动检索并把相关片段注入上下文。

完整的启动、调试、生产部署细节请参考 docs/getting-started.md、DOCKER_DEPLOY.md 等文档。

---

部署选项

场景	推荐方式
本地体验	docker compose up --build（单机）
生产自托管	使用 docker-compose.prod.yml，开启 ENABLE_AUTH=true，设置强密码或 AUTH_SETUP_TOKEN，并根据需要把 Qdrant 绑定到 0.0.0.0 并配置 API‑Key
只跑后端/前端	分别启动 docker-compose.dev.yml 中的对应服务，代码挂载便于调试
自定义镜像	AI_LOCALBASE_IMAGE_TAG=v1.4.6 docker compose -f docker-compose.prod.yml up -d

---

开源许可 & 社区

• License: MIT (see LICENSE)
• Contributing: Guidelines in CONTRIBUTING.md
• Security: SECURITY.md
• Changelog: CHANGELOG.md
• Community: Discussion on https://linux.do and Discord https://discord.gg/YzFeYC66y5

---

适合的读者

• 开发者想在本地快速实验 RAG 流程而不依赖云服务。
• 小团队需要一个可自行托管、可扩展的文档问答平台。
• AI 研究者想评估检索策略、混合搜索或自定义工具链（通过 MCP）。

---

如果项目对你有帮助，记得给仓库点个 ⭐