文档助手

一个基于RAG的模块化文档助手,用于开发者使用LlamaIndex、Postgres和Ollama进行文档处理。

  • by feirorum
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 feirorum/dev-chatbot

使用说明

RAG文档助理

一个基于RAG的模块化文档助手,适用于使用LlamaIndex、Postgres和Ollama的开发人员。

建筑

  • 后端:用于RAG操作的FastAPI+LlamaIdex
  • 向量存储:带有pgvector扩展名的Postgres
  • LLM:Ollama(本地)未来将支持Vertex AI
  • 摄入:用于Confluence、Git仓库和Markdown文件的LlamaIdex加载器
  • MCP服务器:用于GitHub Copilot集成的Python MCP服务器
  • 前端:React/Vite静态网络聊天(GitHub Pages)

项目结构

.
├── planning/          # Project specifications and planning docs
├── backend/           # FastAPI + LlamaIndex RAG backend
├── ingestion/         # Data ingestion scripts
├── mcp/              # MCP server for GitHub Copilot
├── frontend/         # React/Vite web chat UI
└── docker-compose.yml # Local development environment

快速开始

先决条件

  • Docker&Docker编写
  • Python 3.10+
  • Node.js 18+(用于前端)

设置

  1. 克隆存储库:
git clone <your-repo-url>
cd dev-chatbot
  1. 使用Docker Compose启动服务:
docker-compose up -d
  1. 设置后端:
cd backend
cp .env.example .env
# Edit .env with your configuration
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
  1. 运行后端:
uvicorn main:app --reload
  1. 设置并运行前端:
cd frontend
npm install
npm run dev

发展

看 规划/初始规格.md 详细的架构和实施计划。

许可证

麻省理工学院