Skip to content

快速开始

1. 各模块简介

  • gc-qa-rag-etl
    用于知识库数据的采集、处理和向量化(ETL 流程),支持多种数据源和嵌入模型。

  • gc-qa-rag-server
    基于 FastAPI 的后端服务,提供语义检索、问答、推理等 API,集成向量数据库(Qdrant)和关系数据库(MySQL)。

  • gc-qa-rag-frontend
    前端界面,基于 React + Ant Design,提供智能问答、搜索等功能。

2. 环境准备

通用要求

  • 推荐操作系统:Windows 10/11 或 Linux
  • 推荐 IDE:Visual Studio Code

依赖工具

  • Python 3.13
  • Node.js 18+、pnpm
  • PDM(Python 包管理工具)
  • Docker(可选,推荐用于生产部署)
  • MySQL 8+
  • Qdrant

3. 部署步骤

3.1 gc-qa-rag-etl

安装依赖

# 进入目录
cd sources/gc-qa-rag-etl

# 安装依赖
pdm install

配置环境

  • 修改 .config.development.json.config.production.json,填写 LLM、Embedding、Qdrant 等服务的 API Key 和地址。

运行 ETL 流程

# 转换通用文档到文本文件
pdm run das

# 生成QA对并构建向量
pdm run etl

# 发布向量到知识库
pdm run ved

3.2 gc-qa-rag-server

安装依赖

cd sources/gc-qa-rag-server
pdm install

配置环境

  • 修改 .config.development.json.config.production.json,配置数据库、Qdrant、LLM 等信息。

启动服务

# 开发模式
pdm run dev

# 生产模式
pdm run start
  • 访问地址:http://localhost:8000

Docker 部署

docker build -t rag-server .
docker run -p 8000:8000 rag-server

一键部署(推荐)

sources/gc-qa-rag-server/deploy 目录下有 docker-compose.yml,可一键启动 MySQL、Qdrant、Server、Frontend:

cd sources/gc-qa-rag-server/deploy
docker compose up -d

3.3 gc-qa-rag-frontend

安装依赖

cd sources/gc-qa-rag-frontend
pnpm install

本地开发

pnpm run dev

构建生产包

pnpm run build

Docker 部署

docker build -t rag-frontend .
docker run -p 80:80 rag-frontend

4. 常见问题与解决办法

  • 端口冲突:确保 8000(后端)、80(前端)、3306(MySQL)、6333(Qdrant)未被占用。
  • 依赖安装失败:检查 Python、Node.js、PDM、pnpm 版本,建议使用官方推荐版本。
  • 数据库连接失败:确认 MySQL/Qdrant 配置正确,容器网络互通。
  • API Key 未配置:请在配置文件中填写正确的 LLM/Embedding 服务密钥。

如需详细参数说明或遇到其他问题,请查阅各模块的 README.md