GraphRAG4OpenWebUI 使用与启动教程

GraphRAG4OpenWebUI 使用与启动教程

1. 项目介绍

GraphRAG4OpenWebUI 是一个开源项目，它将微软研究院的 GraphRAG（基于图的检索增强生成）技术集成到 Open WebUI 中。该项目提供了一个强大的信息检索系统，支持多种搜索模型，尤其适合在开放的网页用户界面中使用。

GraphRAG4OpenWebUI 集成了本地搜索、全局搜索和 Tavily 搜索三种主要检索方法，并提供了全面的搜索选项，使用户能够获得详尽准确的搜索结果。

2. 项目快速启动

确保您的系统已安装 Python 3.8 或更高版本。以下是安装步骤：

# 克隆仓库
git clone https://github.com/your-username/GraphRAG4OpenWebUI.git
cd GraphRAG4OpenWebUI

# 创建并激活虚拟环境
python -m venv venv
source venv/bin/activate  # Windows 下使用 venv\Scripts\activate

# 安装依赖
pip install -r requirements.txt

在开始之前，您需要设置以下环境变量：

# 设置 TAVILY API 密钥
export TAVILY_API_KEY="your_tavily_api_key"
export INPUT_DIR="/path/to/your/input/directory"

# 设置 LLM API 密钥
export GRAPHRAG_API_KEY="your_actual_api_key_here"

# 设置嵌入模型 API 密钥（如果与 GRAPHRAG_API_KEY 不同）
export GRAPHRAG_API_KEY_EMBEDDING="your_embedding_api_key_here"

# 设置 LLM 模型
export GRAPHRAG_LLM_MODEL="gemma2"

# 设置 API 基础 URL
export API_BASE="http://localhost:11434/v1"

# 设置嵌入模型 API 基础 URL（默认为 OpenAI 的 API）
export API_BASE_EMBEDDING="https://api.openai.com/v1"

# 设置嵌入模型（默认为 "text-embedding-3-small"）
export GRAPHRAG_EMBEDDING_MODEL="text-embedding-3-small"

确保将占位符替换为您的实际 API 密钥和路径。

启动服务器：

python main-en.py

服务器将在 http://localhost:8012 上运行。

3. 应用案例和最佳实践

以下是一个使用 GraphRAG4OpenWebUI 进行搜索的示例请求：

import requests
import json

url = "http://localhost:8012/v1/chat/completions"
headers = {
    "Content-Type": "application/json"
}
data = {
    "model": "full-model:latest",
    "messages": [{
        "role": "user",
        "content": "您的搜索查询"
    }],
    "temperature": 0.7
}

response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.json())

在 Open WebUI 配置中，将 API 端点设置为 http://localhost:8012/v1/chat/completions，这样 Open WebUI 就可以使用 GraphRAG4OpenWebUI 的搜索功能。

4. 典型生态项目

GraphRAG4OpenWebUI 可以与多种网页应用集成，提供强大的信息检索功能。开发者可以根据具体需求，将该系统集成到问答系统、搜索引擎或其他需要复杂信息检索的场景中。通过结合本地模型和外部 API，该项目为开放网络环境中的信息检索提供了一个灵活且隐私友好的解决方案。