GraphRAG-Local-UI 使用与启动教程-优快云博客

GraphRAG-Local-UI 使用与启动教程

【免费下载链接】GraphRAG-Local-UI GraphRAG using Local LLMs - Features robust API and multiple apps for Indexing/Prompt Tuning/Query/Chat/Visualizing/Etc. This is meant to be the ultimate GraphRAG/KG local LLM app. 项目地址: https://gitcode.com/gh_mirrors/gr/GraphRAG-Local-UI

1. 项目目录结构及介绍

GraphRAG-Local-UI 项目是一个基于 GraphRAG 的本地化知识图谱和语言模型应用，其目录结构如下：

GraphRAG-Local-UI/
├── .DS_Store
├── API_README.md
├── EMBEDDING_PROXY_README.md
├── INDEX_APP_README.md
├── LICENSE
├── README.md
├── api.py           # API 服务器主文件
├── app.py           # 主应用界面文件
├── css/
├── embedding_proxy.py  # 嵌入代理文件
├── env-example.txt
├── index_app.py     # 索引和提示调整界面文件
├── requirements.txt # 项目依赖
├── scripts/
├── settings-example.yaml # 配置文件示例
├── uiv2.png
├── uiv3.png
└── web.py

api.py: FastAPI 基础的服务器代码，提供核心的 GraphRAG 操作。
app.py: 主应用界面，用于管理数据、运行查询和可视化结果。
embedding_proxy.py: 嵌入代理，用于处理 Ollama 嵌入。
index_app.py: 索引和提示调整的界面，用于管理索引和提示调整过程。
requirements.txt: 项目所需的 Python 包。
settings-example.yaml: 配置文件的示例，用于 GraphRAG 的配置。

2. 项目的启动文件介绍

项目的启动主要通过以下几个文件：

api.py: 启动 FastAPI 服务器的文件。使用以下命令启动：
```
python api.py --host 0.0.0.0 --port 8012 --reload
```
embedding_proxy.py: 如果使用 Ollama 进行嵌入，需要启动嵌入代理。使用以下命令启动：
```
python embedding_proxy.py --port 11435 --host http://localhost:11434
```
index_app.py: 启动索引和提示调整界面的文件。使用以下命令启动：
```
gradio index_app.py
```
app.py: 启动主交互界面的文件。使用以下命令启动：
```
gradio app.py
```
或者
```
python app.py
```

启动后，可以通过浏览器访问对应的 UI 界面。

3. 项目的配置文件介绍

项目的配置主要通过 settings-example.yaml 文件进行。这个文件包含了 GraphRAG 的主要配置，预设为使用本地模型。

配置文件的基本内容如下：

# GraphRAG 配置文件示例

# 模型配置
model:
  # 指定使用的模型
  model_type: 'ollama'

# 索引配置
index:
  # 索引文件夹路径
  root: './indexing'

# 嵌入代理配置
embedding_proxy:
  # 嵌入代理的端口号
  port: 11435
  # 嵌入代理的地址
  host: 'http://localhost:11434'

在使用前，需要根据实际情况对配置文件进行调整。如果需要自定义设置，可以通过修改 settings.yaml 文件来实现。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考