面向 Minecraft 模组知识问答的 RAG 项目,以及用于比较 RAG / Prompt 效果的评测平台。四个项目集中在一个 Git 仓库中,分别安装依赖和启动。
| 目录 | 用途 | 本地默认端口 |
|---|---|---|
rag/ |
RAG API、检索、合成导航、数据处理脚本 | 8080 |
rag-frontend/ |
Minecraft 问答前端,Vue + Vite | 3002 |
evaluation-platform-backend/ |
评测平台 API,FastAPI | 8000 |
evaluation-platform-frontend/ |
评测平台前端,Vue + Vite | 3000 |
本仓库仅包含代码、依赖锁文件及配置模板。不包含原有 Git 历史、课程迭代文档、数据库、知识库数据、模型权重、实验输出或真实凭据。数据库及数据来源需要自行准备,克隆仓库不能直接恢复原有数据。
Python 后端建议分别使用虚拟环境。两个前端使用 Node.js 20+ 和 npm。
- 将两个后端的
.env.example各自复制为.env,填写所用模型服务、数据库和可选 OSS / Neo4j 配置。 - 为每个后端单独生成
SECRET_KEY:python -c "import secrets; print(secrets.token_urlsafe(48))"。未设置或使用示例密钥时,后端会拒绝加载配置。 - 将前端
.env.example复制为.env.local;需要连接不同地址时修改API_PROXY_TARGET,地址末尾不加/。前端请求统一通过/api转发。 - 为 RAG 配置 MySQL 的
DATABASE_URL,以及CHROMA_PATH、KNOWLEDGE_BASE_PATH。使用合成导航时再配置 Neo4j;数据库和知识库应独立备份。
.env 和 .env.local 已被 Git 和 Docker 构建上下文排除。不要使用 git add -f 强行加入它们。VITE_* 变量会进入浏览器端代码,不能用于存放 API 密钥。
在 rag/ 下安装依赖后启动:
python -m venv .venv
# 激活虚拟环境后执行;Windows 使用 .venv\Scripts\activate
pip install -r requirements.txt
python run.py数据构建脚本位于 rag/scripts/。代理爬虫需要在 rag/.env 填写 CRAWLER_PROXY_*,不再内置任何账号。调用模型服务、代理服务或抓取数据前,请确认相应费用、授权和站点规则。
在 evaluation-platform-backend/ 下使用独立虚拟环境:
pip install -r requirements.txt
python -m uvicorn app.main:app --host 127.0.0.1 --port 8000 --loop asyncioMongoDB 可以使用 MONGO_* 分项配置,或通过 MONGO_URL 指定完整连接 URI(如需 authSource)。使用 OSS 时需要自行提供账号与存储桶。
分别在 rag-frontend/ 和 evaluation-platform-frontend/ 下执行:
npm ci
npm run dev生产构建使用 npm run build。前端 Docker 镜像中的 Nginx 配置由启动时的 API_PROXY_TARGET 环境变量生成;默认服务地址分别为 http://rag:8080 与 http://evaluation-platform-backend:8000,需要对应的容器网络或自行覆盖。直接在宿主机使用 Nginx 时,先将配置中的 ${API_PROXY_TARGET} 替换为实际后端地址。
git status --short
git diff --cached --stat确认没有 .env、数据库、压缩包、模型、日志或爬取数据。若密钥曾出现在旧仓库或被分享过,应在服务商处撤销并重新签发;从当前代码删除密钥不会使旧凭据失效。
离线配置检查可在根目录执行 python -m unittest discover -s tests -v,需要 requests 和 python-dotenv。这些检查不会连接数据库或调用外部服务,涵盖缺失密钥、占位密钥、MongoDB URI、代理凭据编码和错误信息脱敏。
此仓库整理面向代码发布,不代表已完成生产安全审计。连接数据库、模型服务后的端到端验证和生产部署加固仍需在配置好环境后进行。