GraphRAG4OpenWebUI

GraphRAG4OpenWebUI

高级信息检索技术在 Open WebUI 的全面集成

GraphRAG4OpenWebUI 为 Open WebUI 提供了一个强大而高效的信息检索系统,集成了微软研究院的 GraphRAG 技术,支持本地搜索、全球搜索和 Tavily 搜索。该项目专为需要精确和全面搜索结果的开放网络用户界面设计,并且支持本地语言模型和嵌入模型,增强了灵活性和隐私性。通过多个 API 接口,用户可以轻松实现复杂的信息检索需求。

GraphRAG4OpenWebUIGraphRAG信息检索Local LLM嵌入模型Github开源项目

项目介绍:GraphRAG4OpenWebUI

GraphRAG4OpenWebUI 是一个专为 Open WebUI 设计的 API 接口,旨在整合微软研究院的 GraphRAG(基于图的检索增强生成)技术。这一项目通过提供一个强大的信息检索系统,支持多种搜索模型,非常适合在开放网页用户界面中使用。

项目概述

GraphRAG4OpenWebUI 的主要目标是为 Open WebUI 提供一个便捷的接口,以利用 GraphRAG 强大的功能。它集成了三种主要的检索方法,并提供了一个综合的搜索选项,使用户能够获得全面而精确的搜索结果。

关键检索功能

  1. 本地搜索

    • 使用 GraphRAG 技术在本地知识库中进行高效检索
    • 适用于快速访问预定义的结构化信息
    • 利用图结构提高检索的准确性和相关性
  2. 全局搜索

    • 在更广泛的范围内搜索信息,超过本地知识库的范围
    • 适用于需要更全面信息的查询
    • 利用 GraphRAG 的全球上下文理解能力提供更丰富的搜索结果
  3. Tavily 搜索

    • 集成外部 Tavily 搜索 API
    • 提供额外的互联网搜索能力,扩展了信息来源
    • 适用于需要最新或广泛网络信息的查询
  4. 全模型搜索

    • 结合以上三种搜索方法
    • 提供最全面的搜索结果,满足复杂的信息需求
    • 自动整合和排名来自不同来源的信息

支持本地的 LLM 和嵌入模型

GraphRAG4OpenWebUI 目前支持使用本地语言模型(LLM)和嵌入模型,增加了项目的灵活性和隐私性。具体支持的本地模型包括:

  • Ollama:支持通过 Ollama 运行的各种开源 LLM,如 Llama 2、Mistral 等。可以通过设置 API_BASE 环境变量指向 Ollama 的 API 端点来进行配置。
  • LM Studio:兼容由 LM Studio 运行的模型。通过配置 API_BASE 环境变量连接到 LM Studio 的服务。
  • 本地嵌入模型:支持使用本地运行的嵌入模型,如 SentenceTransformers。可以通过设置 GRAPHRAG_EMBEDDING_MODEL 环境变量指定使用的嵌入模型。

这种对本地模型的支持允许 GraphRAG4OpenWebUI 在不依赖外部 API 的情况下运行,从而增强数据隐私并降低使用成本。

安装指南

确保您的系统上安装了 Python 3.8 或更高版本。然后按照以下步骤进行安装:

  1. 克隆代码库:

    git clone https://github.com/your-username/GraphRAG4OpenWebUI.git cd GraphRAG4OpenWebUI
  2. 创建并激活虚拟环境:

    python -m venv venv source venv/bin/activate # 在 Windows 上使用 venv\Scripts\activate
  3. 安装依赖项:

    pip install -r requirements.txt

    注意:graphrag 包可能需要从特定来源安装。如果上述命令无法安装 graphrag,请参考微软研究院的具体说明或联系维护者获取正确的安装方法。

配置

在运行 API 之前,您需要设置以下环境变量。可以通过创建 .env 文件或直接在终端中导出它们:

# 设置 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 密钥和路径。

使用方法

  1. 启动服务器:

    python main-en.py
    

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

  2. API 端点:

    • /v1/chat/completions:POST 请求用于执行搜索
    • /v1/models:GET 请求用于检索可用模型列表
  3. 与 Open WebUI 集成: 在 Open WebUI 配置中,将 API 端点设置为 http://localhost:8012/v1/chat/completions。这将允许 Open WebUI 使用 GraphRAG4OpenWebUI 的搜索功能。

  4. 示例搜索请求:

    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": "Your search query"}], "temperature": 0.7 } response = requests.post(url, headers=headers, data=json.dumps(data)) print(response.json())

可用模型

  • graphrag-local-search:latest:本地搜索
  • graphrag-global-search:latest:全局搜索
  • tavily-search:latest:Tavily 搜索
  • full-model:latest:综合搜索(包含以上所有搜索方法)

注意事项

  • 确保在 INPUT_DIR 目录下拥有正确的输入文件(如 Parquet 文件)。
  • API 使用异步编程,确保您的环境支持异步操作。
  • 对于大规模部署,考虑使用生产级 ASGI 服务器。
  • 该项目专为 Open WebUI 设计,可以轻松集成到各种基于 Web 的应用中。

贡献

欢迎拉取请求。对于重大更改,请先打开一个 issue 以讨论您希望进行的更改。

许可证

该项目采用 Apache-2.0 许可证 授权。

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多