hugegraph/rag

hugegraph-ai

概述和主要用途

hugegraph-ai是一个将https://github.com/apache/hugegraph%E4%B8%8E%E4%BA%BA%E5%B7%A5%E6%99%BA%E8%83%BD%E8%83%BD%E5%8A%9B%E9%9B%86%E6%88%90%E7%9A%84%E5%B7%A5%E5%85%B7%E5%8C%85%EF%BC%8C%E4%B8%BA%E5%BC%80%E5%8F%91%E8%80%85%E6%8F%90%E4%BE%9B%E5%85%A8%E9%9D%A2%E6%94%AF%E6%8C%81%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%9E%84%E5%BB%BAAI%E9%A9%B1%E5%8A%A8%E7%9A%84%E5%9B%BE%E5%BA%94%E7%94%A8%E3%80%82%E5%AE%83%E6%A1%A5%E6%8E%A5%E5%9B%BE%E6%95%B0%E6%8D%AE%E5%BA%93%E4%B8%8E%E5%A4%A7%E5%9E%8B%E8%AF%AD%E8%A8%80%E6%A8%A1%E5%9E%8B(LLM)%EF%BC%8C%E5%AE%9E%E7%8E%B0%E5%9B%BE%E6%95%B0%E6%8D%AE%E4%B8%8EAI%E8%83%BD%E5%8A%9B%E7%9A%84%E6%97%A0%E7%BC%9D%E5%8D%8F%E5%90%8C%E3%80%82

核心功能和特性

• LLM/GraphRAG：通过图增强检索构建智能问答系统，提升答案准确性和可解释性
• 知识图谱构建：利用LLM从文本中自动构建知识图谱，降低图谱构建门槛
• 图机器学习(Graph ML)：集成20+图学习算法（GCN、GAT、GraphSAGE等），支持节点分类、图分类、图嵌入和链接预测
• HG-Python Client：易用的Python接口，支持图模式管理、CRUD操作、Gremlin查询和REST API调用
• Vermeer Python Client：与https://github.com/apache/incubator-hugegraph-computer/tree/master/vermeer#readme%E5%9B%BE%E8%AE%A1%E7%AE%97%E7%B3%BB%E7%BB%9F%E9%9B%86%E6%88%90%E7%9A%84SDK/%E6%8E%A5%E5%8F%A3

使用场景和适用范围

• 智能问答系统：基于图数据的检索增强生成(GraphRAG)应用
• 知识图谱自动化构建：从非结构化文本中提取实体和关系，自动构建知识图谱
• 图数据分析与预测：利用图机器学习算法进行节点分类、链接预测等任务
• 自然语言图查询：通过自然语言接口操作图数据库，降低图查询门槛
• AI驱动的图分析应用：结合LLM与图数据进行复杂关系推理和分析

使用方法和配置说明

前提条件

• Python 3.10+（hugegraph-llm要求）
• uv 0.7+（工作区管理工具）
• HugeGraph Server 1.3+（推荐1.5+版本）
• Docker（可选，用于容器化部署）

部署方式

选项1：Docker部署（推荐）

bash
# 克隆仓库
git clone https://github.com/apache/incubator-hugegraph-ai.git
cd incubator-hugegraph-ai

# 设置环境变量
cp docker/env.template docker/.env
# 编辑docker/.env文件，设置PROJECT_PATH为实际项目路径

# 启动服务
cd docker
docker compose -f docker-compose-network.yml up -d

# 访问服务：
# - HugeGraph Server: http://localhost:8080
# - RAG服务: http://localhost:8001

选项2：源码安装

bash
# 1. 启动HugeGraph Server
docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph

# 2. 克隆并设置项目
git clone https://github.com/apache/incubator-hugegraph-ai.git
cd incubator-hugegraph-ai

# 3. 安装依赖（自动创建虚拟环境.venv）
# 注意：若下载缓慢，可取消pyproject.toml中的镜像注释，或使用国内镜像
uv sync --extra llm  # 安装LLM相关依赖
# 或安装所有可选依赖：uv sync --all-extras

# 4. 激活虚拟环境
source .venv/bin/activate

# 5. 启动demo
cd hugegraph-llm
python -m hugegraph_llm.demo.rag_demo.app
# 访问 http://127.0.0.1:8001

基本使用示例

图机器学习

bash
# 安装机器学习依赖
uv sync --extra ml
source .venv/bin/activate

# 运行机器学习算法示例
cd hugegraph-ml
python examples/your_ml_example.py

知识图谱构建（Web界面）

通过Gradio界面进行可视化知识图谱构建：

• 输入选项：直接文本输入或上传TXT/DOCX文件（支持多文件选择）
• 模式配置：自定义JSON模式或使用现有HugeGraph实例模式（如"hugegraph"）

程序调用示例（RAG查询）

python
from hugegraph_llm.flows.scheduler import SchedulerSingleton

scheduler = SchedulerSingleton.get_instance()
res = scheduler.schedule_flow(
  "rag_graph_only",
  query="介绍阿尔·帕西诺的相关信息。",
  graph_only_answer=True,
  vector_only_answer=False,
  raw_answer=False
)

print(res.get("graph_only_answer"))

配置说明

部署后自动生成配置文件：

• 环境配置：hugegraph-llm/.env
• 提示词配置：hugegraph-llm/src/hugegraph_llm/resources/demo/config_prompt.yaml

语言支持：

• 修改.env文件中的LANGUAGE参数切换中英文提示词
  • LANGUAGE=EN：英文提示词（默认）
  • LANGUAGE=CN：中文提示词

模块详情

hugegraph-llm

大型语言模型与图应用集成模块：

• GraphRAG：基于图数据的检索增强生成
• 知识图谱构建：从文本自动构建知识图谱
• 自然语言接口：使用自然语言查询图数据
• AI智能体：智能图分析与推理能力

hugegraph-ml

图机器学习模块，实现20+图算法：

• 节点分类：GCN、GAT、GraphSAGE、APPNP等
• 图分类：DiffPool、P-GNN等
• 图嵌入：DeepWalk、Node2Vec、GRACE等
• 链接预测：SEAL、GATNE等

hugegraph-python-client

HugeGraph操作的Python客户端：

• 模式管理：定义顶点/边标签和属性
• CRUD操作：创建、读取、更新、删除图数据
• Gremlin查询：执行图遍历查询
• REST API：完整覆盖HugeGraph REST API

更多资源

• 项目主页
• https://github.com/apache/incubator-hugegraph-ai/blob/main/hugegraph-llm/quick_start.md
• DeepWiki AI文档

相关HugeGraph项目

1. https://github.com/apache/hugegraph%EF%BC%9A%E5%9B%BE%E6%95%B0%E6%8D%AE%E5%BA%93%E6%A0%B8%E5%BF%83%E7%BB%84%E4%BB%B6%EF%BC%88%E5%9B%BE%E6%9C%8D%E5%8A%A1%E5%99%A8+PD+%E5%AD%98%E5%82%A8%EF%BC%89
2. https://github.com/apache/hugegraph-toolchain%EF%BC%9A%E5%9B%BE%E5%B7%A5%E5%85%B7%E9%9B%86%EF%BC%88%E5%8A%A0%E8%BD%BD%E5%99%A8%E3%80%81%E6%8E%A7%E5%88%B6%E5%8F%B0%E3%80%81%E5%B7%A5%E5%85%B7%E3%80%81%E5%AE%A2%E6%88%B7%E7%AB%AF%EF%BC%89
3. https://github.com/apache/hugegraph-computer%EF%BC%9A%E9%9B%86%E6%88%90%E5%9B%BE%E8%AE%A1%E7%AE%97%E7%B3%BB%E7%BB%9F
4. https://github.com/apache/hugegraph-doc%EF%BC%9A%E6%96%87%E6%A1%A3%E5%92%8C%E7%BD%91%E7%AB%99%E4%BB%A3%E7%A0%81

许可证

hugegraph-ai采用Apache 2.0许可证。

联系方式

• GitHub Issues：https://github.com/apache/incubator-hugegraph-ai/issues
• 邮件：***（需订阅邮件列表）
• Slack：加入ASF HugeGraph频道
• 微信：关注"Apache HugeGraph"官方公众号