Neo4j LLM Knowledge Graph Builder 项目教程
1. 项目目录结构及介绍
llm-graph-builder/
├── POC_Documents/
│ └── V1/
├── POC_Experiments/
├── backend/
│ ├── __init__.py
│ ├── main.py
│ ├── ...
├── data/
├── docs/
├── experiments/
├── frontend/
│ ├── public/
│ ├── src/
│ ├── ...
├── .gitignore
├── LICENSE
├── README.md
├── docker-compose.yml
└── example.env
目录结构介绍
- POC_Documents/: 存放概念验证文档的目录。
- POC_Experiments/: 存放概念验证实验的目录。
- backend/: 后端代码目录,包含主要的Python文件和依赖。
- data/: 数据存储目录,用于存放项目运行时生成的数据。
- docs/: 项目文档目录,包含项目的详细文档。
- experiments/: 实验代码目录,用于存放实验相关的代码。
- frontend/: 前端代码目录,包含React应用的代码。
- .gitignore: Git忽略文件,指定哪些文件和目录不需要被Git管理。
- LICENSE: 项目许可证文件。
- README.md: 项目介绍文件,包含项目的基本信息和使用说明。
- docker-compose.yml: Docker Compose配置文件,用于定义和运行多容器Docker应用。
- example.env: 示例环境变量文件,用于配置项目运行时的环境变量。
2. 项目启动文件介绍
后端启动文件
- backend/main.py: 这是后端的主要启动文件。它包含了FastAPI应用的初始化代码,负责处理HTTP请求和响应。
前端启动文件
- frontend/src/index.js: 这是前端的主要启动文件。它包含了React应用的初始化代码,负责渲染应用的UI。
3. 项目配置文件介绍
环境变量配置
- example.env: 这是一个示例环境变量文件,包含了项目运行时需要的环境变量。用户可以根据自己的需求修改这个文件,并将其重命名为
.env
。
Docker Compose配置
- docker-compose.yml: 这个文件定义了项目中使用的Docker服务,包括前端、后端和数据库服务。通过运行
docker-compose up
命令,可以启动整个项目。
其他配置文件
- frontend/src/config.js: 前端应用的配置文件,包含了应用的一些基本配置,如API地址等。
- backend/config.py: 后端应用的配置文件,包含了应用的一些基本配置,如数据库连接信息等。
通过以上配置文件,用户可以轻松地启动和配置Neo4j LLM Knowledge Graph Builder项目。