企业级AI知识库
企业级全栈 AI 知识库平台，集成了现代化的内容管理、深度 AI 智能问答与极致的用户交互体验。
English | 简体中文
如果这个项目对你有帮助，请点击右上角 ⭐ Star 支持一下，这是对开发者最大的鼓励！
Important
全新品牌域名正式启用！ 我们已正式上线官方门户网站 catwiki.ai。所有的演示、文档以及管理服务均已迁移至新域名下。请更新您的书签！
- ⚙️ 支持 ReAct 循环架构: 支持 ReAct 循环架构，AI 可以自主调用知识库进行多轮检索。
- 🎨 工具调用展示: 前端 AI 对话支持展示完整的多轮检索历程，用户可以看到所有搜索尝试。
- 🚀 PaddleOCR 集成: 深度对接百度 PaddleOCR 引擎，提供业界领先的 OCR 识别精度，尤其在多语言和复杂场景下表现卓越。
- 🚀 全新品牌域名启用: 正式启用 catwiki.ai 官方网站与全线品牌域名。
- 🚀 文档图片公开化: 文档解析过程自动提取图片并上传至对象存储，生成永久公开访问链接。
- 🖼️ AI 图片回复: 知识库问答支持图文混排，AI 可直接引用文档中的图片进行回答。
- 🚀 MinerU 集成: 深度对接 MinerU (Magic-PDF) 高质量解析器，支持复杂版面分析和公式提取。
- 📦 Docling 集成: 对接 IBM Docling 解析引擎，提供轻量级高性能文档转换。
- 🔧 OCR 动态配置: 管理后台支持按解析器配置开启/关闭 OCR 识别。
- 🔧 LangGraph 集成: 采用 LangGraph 1.x 重构聊天功能，支持工具调用模式。
- 🛠️ RAG 工具化: 将知识库检索封装为
search_knowledge_base工具。 - 🚦 智能路由: AI 自主判断是否需要调用知识库。
Tip
查看完整更新日志: 访问 CatWiki 更新日志 了解完整版本历史。
- ✅ 开箱即用: Docker Compose 一键启动，自动初始化数据库和演示数据
- ✅ 双端架构: 独立的管理后台和客户端，职责清晰
- ✅ 类型安全: 前后端全面使用 TypeScript 和 Pydantic，类型安全有保障
- ✅ 现代技术栈: FastAPI + Next.js 14 + SQLAlchemy 2.0，使用最新技术
- ✅ AI 集成: 内置 AI 智能问答，基于 LangGraph 构建 Agentic RAG 流程
- ✅ 热更新: 开发环境支持前后端代码热更新
- ✅ 自动生成 SDK: 后端 API 变更后自动生成 TypeScript SDK
- ✅ 完善的文档: 详细的 API 文档和使用指南
运营概括 |
文档管理 |
用户管理 |
模型配置 |
文档解析器 |
站点管理 |
AI对话 - 基于知识库内容的智能对话助手，支持上下文理解
- 📝 富文本编辑: 基于 Markdown 的文档编辑器，支持实时预览
- 🗂️ 文档管理: 层级目录结构，支持拖拽排序
- 👥 用户管理: 完整的用户权限和角色管理
- 🌐 多站点支持: 支持创建和管理多个独立的知识库站点
- 🤖 AI 配置: 灵活的 AI 模型和机器人配置
- 🔍 智能搜索: 快速查找所需文档和内容
- 🤖 AI 问答: 基于知识库内容的智能对话助手
- 📱 响应式设计: 完美适配桌面端和移动端
- 🎨 现代化 UI: 使用 shadcn/ui 构建的优雅界面
- 框架: FastAPI
- AI 工作流: LangGraph 1.x + LangChain
- 数据库: PostgreSQL + SQLAlchemy 2.0
- 向量检索: pgvector + langchain-postgres
- 迁移工具: Alembic
- 包管理: uv (高性能 Python 包管理器)
- 身份认证: JWT + PassLib
- Python 版本: >= 3.10
- 框架: Next.js 14 (App Router)
- 语言: TypeScript 5.3+
- 样式: Tailwind CSS
- 组件库: shadcn/ui (基于 Radix UI)
- 状态管理: React Hooks
- 包管理: pnpm
- 拖拽排序: @dnd-kit/core + @dnd-kit/sortable (管理后台)
- Markdown 编辑: md-editor-rt (管理后台)
- Markdown 渲染: streamdown (客户端)
- 通知系统: Sonner (前端通用)
catWiki/
├── backend/ # 🐍 FastAPI 后端服务
│ ├── app/
│ │ ├── api/ # API 路由 (Admin/Client)
│ │ ├── core/ # 核心配置、中间件、工具
│ │ ├── crud/ # 数据库 CRUD 操作
│ │ ├── models/ # SQLAlchemy ORM 模型
│ │ ├── schemas/ # Pydantic 验证模式
│ │ └── main.py # 应用入口
│ ├── scripts/ # 工具脚本（同步 SDK、初始化数据）
│ ├── Dockerfile.dev # 开发环境镜像
│ └── pyproject.toml # 依赖管理（uv）
│
├── frontend/
│ ├── admin/ # 🎯 管理后台 (Next.js, 8001)
│ ├── client/ # 💬 客户端 (Next.js, 8002)
│ └── docs/ # 📚 文档站点 (VitePress, 8003)
│
├── deploy/ # 🚀 生产环境部署
├── docker-compose.dev.yml # 开发环境一键启动
├── Makefile # 项目管理脚本
└── README.md # 项目主文档
| 目录 | 说明 | 技术栈 |
|---|---|---|
backend/ |
后端 API 服务 | FastAPI + PostgreSQL + SQLAlchemy |
frontend/admin/ |
管理后台（内部使用） | Next.js 14 + shadcn/ui + Tailwind |
frontend/client/ |
客户端（对外展示） | Next.js 14 + AI 问答 + 搜索 |
frontend/docs/ |
文档站点（项目说明） | VitePress + Markdown |
- Docker >= 20.10
- Docker Compose >= 2.0
- Make (系统自带或通过包管理器安装)
# 克隆项目
git clone https://github.com/bulolo/CatWiki.git
cd catWiki适合本地测试、代码修改。支持热更新和调试日志。
# 1. 初始化本地环境配置 (只需运行一次)
make dev-init
# 2. 修改配置: 编辑 backend/.env 填入 OpenAI API Key 等
# 3. 启动环境
make dev-upWarning
关于 make dev-init: 它会重新从模板复制 .env 文件，这会覆盖您已有的配置。如果是后续启动，请直接跳过此步使用 make dev-up。
访问：
- 🎯 管理后台: http://localhost:8001 (admin@example.com / admin123)
- 💬 客户端: http://localhost:8002/medical
- 📚 文档站点: http://localhost:8003
- 🛡️ API 文档: http://localhost:3000/docs
适合正式部署。所有服务在后台运行，性能优化。
# 1. 生成生产环境配置模板 (位于 deploy/docker/)
make prod-init
# 2. 修改敏感信息: 编辑 deploy/docker/.env.backend/admin/client
# 填入域名、数据库密码、JWT 密钥等
# 3. 后台启动
make prod-upImportant
详细的安全配置建议（如证书配置、对象存储对接等）请参考： 👉 生产环境完整部署指南 (deploy/docker/README.md)
本项目根目录提供了 Makefile 工具，将复杂的 Docker 维护命令封装为简单的指令。
| 命令 | 说明 |
|---|---|
make gen-sdk |
生成 SDK：触发后端 API 自动生成前端 SDK |
make help |
预览命令：显示所有可用指令及其说明 |
| 命令 | 说明 |
|---|---|
make dev-init |
初始化环境配置：清理并重新从 .env.example 复制配置文件 |
make dev-up |
开发启动：构建镜像并在前台启动，实时查看所有服务日志 |
make dev-down |
优雅停止：停止并移除容器，保留数据库存储卷 |
make dev-restart |
快捷重启：仅重启后端应用容器 |
make dev-logs |
实时日志：查看后端核心服务的实时运行日志 |
make dev-db-migrate m="msg" |
生成迁移脚本：生成新的数据库迁移脚本（需提供备注 m） |
make dev-db-psql |
数据库终端：进入 PostgreSQL 交互式终端 |
make dev-clean |
深度重置：停止容器并删除所有数据卷（清空数据库和存储， |
| 命令 | 说明 |
|---|---|
make prod-init |
生产初始化：初始化生产环境配置文件模板 |
make prod-up |
生产启动：在后台启动生产环境所有服务 |
make prod-down |
生产停止：停止并移除生产环境容器 |
make prod-restart |
重启后端：仅重启生产环境后端应用容器 |
make prod-logs |
实时日志：查看生产环境容器日志 |
make prod-clean |
深度重置：停止容器并删除生产所有数据卷（ |
项目采用 独立初始化容器 (backend-init) 模式：
- 自我检测: 启动时自动检查数据库版本。
- 自动迁移: 自动执行 Alembic 脚本。
- 预置数据: 自动创建管理员 (
admin@example.com/admin123) 及医学演示站点。
后端 API 变更后，只需一行命令即可更新前端 SDK：
make gen-sdkTip
遇到问题时，通常 make dev-clean + make dev-up 能解决 90% 的本地环境异常。
A: 请确认是否运行了 make dev-init。如果数据库已损坏，请使用 make dev-clean 重置。
Q: 如何修改默认服务端口？
A: 直接在根目录的 docker-compose.dev.yml 中修改对应的 ports 映射即可。
Q: 客户端 API 报 404？
A: 确保你的访问路径包含站点域名后缀，例如：http://localhost:8002/medical。
- � 环境配置指南 - 开发和生产环境的完整配置说明
- 🚀 开发快速开始 - 5 分钟上手开发环境
- 🔌 API 架构细节 - Admin API 和 Client API 设计原则
- 📦 RustFS 使用指南 - 文件上传、下载、对象存储详解
- 🎯 SDK 使用指南 - 前端如何调用后端 API
- 🔗 文档解析器 - 文档解析引擎对接指南
文档解析器（Parser）是 CatWiki 知识库平台中用于文档预处理的核心组件。通过解析器，您可以接入不同的文档解析引擎，将 PDF、Word、图片等非结构化文档转换为可被 AI 理解的结构化文本。
- 文档解析: 将 PDF、Word、PPT 等文档转换为结构化文本
- OCR 识别: 识别扫描件和图片中的文字内容
- 版面分析: 识别文档结构（标题、段落、表格、图片等）
- 格式保留: 尽可能保留原文档的格式和层次结构
| 解析器 | 说明 | 特点 | 状态 |
|---|---|---|---|
| MinerU | (首选支持) 高质量文档解析工具 | 解析精度高、支持复杂版面 | ✅ 已集成 |
| Docling | IBM 开源文档处理引擎 | 轻量级、易部署 | ✅ 已集成 |
| PaddleOCR | 百度 OCR 引擎 | OCR 能力强、支持多语言 | ✅ 已集成 |
Tip
集成状态: 以上解析器已正式集成到系统中。我们首选支持 MinerU 和 Docling。 详细配置请参考 文档解析器指南
本项目采用 CatWiki 开源许可证 (基于 Apache 2.0 改进)。在保留开源灵活性的同时，我们增加了必要的条款以保护项目品牌和商业权益。
- 个人/企业内部使用：完全免费，无需额外授权。
- 所有场景必须保留品牌：无论何种用途，均严禁移除或修改 UI、控制台及 API 响应头中的 "CatWiki" 标识或版权声明。
- 严禁未经授权的 SaaS 服务：未经 CatWiki 官方书面授权，禁止利用本项目源码提供营利性的多租户 SaaS 服务（如：提供在线知识库托管、AI 问答订阅平台等）。
我们希望将核心技术贡献给开源社区，同时防止“去品牌化”的商业剽窃行为。如需商业授权或有合作意向，请联系官方：catwiki.ai。
详见 LICENSE 获取完整文本。
我们参考了 Dify.ai 的授权模式，旨在提供比 AGPL-3.0 更灵活的企业友好性，同时通过限制多租户 SaaS 服务来确保项目的核心资产和品牌得到保护。
- 💬 问题反馈: 通过 GitHub Issues 提交
- 📧 商务合作: 82607314@qq.com/ bulolo(微信)
- 🌐 官方网站: https://catwiki.ai
⭐ 如果这个项目对您有帮助，请给我们一个 Star！
Made with ❤️ by CatWiki Team