GraphRAG4OpenWebUI开源项目使用教程

GraphRAG4OpenWebUI开源项目使用教程

GraphRAG4OpenWebUI GraphRAG4OpenWebUI integrates Microsoft's GraphRAG technology into Open WebUI, providing a versatile information retrieval API. It combines local, global, and web searches for advanced Q&A systems and search engines. This tool simplifies graph-based retrieval integration in open web environments. 项目地址: https://gitcode.com/gh_mirrors/gr/GraphRAG4OpenWebUI

1. 项目目录结构及介绍

GraphRAG4OpenWebUI项目的目录结构如下：

GraphRAG4OpenWebUI/
├── LICENSE
├── README.md
├── README_ZH-CN.md
├── graphrag3dknowledge.py
├── main-cn.py
├── main-en.py
├── main-graph-1.1.py
├── requirements.txt

• LICENSE：项目的Apache-2.0协议许可证文件。
• README.md：项目的英文说明文档。
• README_ZH-CN.md：项目的中文说明文档。
• graphrag3dknowledge.py：包含了项目使用的图知识库处理逻辑。
• main-cn.py：项目的中文启动文件。
• main-en.py：项目的英文启动文件。
• main-graph-1.1.py：可能是一个特定版本的启动文件或者实验性的代码。
• requirements.txt：项目依赖的Python库列表。

2. 项目的启动文件介绍

项目的启动文件有两个，分别是main-cn.py和main-en.py，它们的主要区别在于语言版本的不同。

启动文件的主要功能是启动GraphRAG4OpenWebUI服务，使其能够接收来自Open WebUI的请求并进行信息检索。

以下是一个简化的main-cn.py文件内容示例：

# main-cn.py 示例代码

# 导入必要的模块
from flask import Flask, request, jsonify
from graphrag3dknowledge import GraphRAG

# 初始化Flask应用
app = Flask(__name__)

# 初始化GraphRAG实例
graphrag = GraphRAG()

@app.route('/v1/chat/completions', methods=['POST'])
def completions():
    # 处理接收到的请求
    data = request.json
    # 调用GraphRAG的方法进行信息检索
    response = graphrag.search(data)
    # 返回检索结果
    return jsonify(response)

if __name__ == '__main__':
    # 启动应用
    app.run(host='0.0.0.0', port=8012)

3. 项目的配置文件介绍

GraphRAG4OpenWebUI项目使用环境变量进行配置。通常，这些环境变量可以在一个.env文件中设置，或者在终端中直接导出。

以下是一些基本的环境变量配置：

• TAVILY_API_KEY：Tavily搜索API的密钥。
• INPUT_DIR：输入目录的路径，用于存放如Parquet文件等数据。
• GRAPHRAG_API_KEY：GraphRAG API的密钥。
• GRAPHRAG_API_KEY_EMBEDDING：嵌入模型API的密钥（如果与GRAPHRAG_API_KEY不同）。
• GRAPHRAG_LLM_MODEL：使用的语言模型。
• API_BASE：API的基础URL。
• API_BASE_EMBEDDING：嵌入模型API的基础URL。
• GRAPHRAG_EMBEDDING_MODEL：嵌入模型的名称。

在终端中设置环境变量的示例：

export TAVILY_API_KEY="your_tavily_api_key"
export INPUT_DIR="/path/to/your/input/directory"
export GRAPHRAG_API_KEY="your_actual_api_key_here"
export GRAPHRAG_API_KEY_EMBEDDING="your_embedding_api_key_here"
export GRAPHRAG_LLM_MODEL="gemma2"
export API_BASE="http://localhost:11434/v1"
export API_BASE_EMBEDDING="https://api.openai.com/v1"
export GRAPHRAG_EMBEDDING_MODEL="text-embedding-3-small"

确保在启动项目之前设置好这些环境变量，以便项目可以正确地访问外部API和内部资源。

GraphRAG4OpenWebUI GraphRAG4OpenWebUI integrates Microsoft's GraphRAG technology into Open WebUI, providing a versatile information retrieval API. It combines local, global, and web searches for advanced Q&A systems and search engines. This tool simplifies graph-based retrieval integration in open web environments. 项目地址: https://gitcode.com/gh_mirrors/gr/GraphRAG4OpenWebUI