LightRAG 使用教程

LightRAG 使用教程

LightRAG "LightRAG: Simple and Fast Retrieval-Augmented Generation" 项目地址: https://gitcode.com/gh_mirrors/li/LightRAG

1. 项目介绍

LightRAG 是一个简单且高效的重检索增强生成（Retrieval-Augmented Generation, RAG）的开源项目。它通过结合检索和生成的方式，使得生成的内容更加丰富和准确。LightRAG 支持多种数据存储类型，并提供了一个 Web UI 和 API 用于文档索引、知识图谱探索以及简单的 RAG 查询。

2. 项目快速启动

安装 LightRAG 核心库

首先，从源代码安装 LightRAG：

cd LightRAG
pip install -e .

或者，你也可以从 PyPI 安装：

pip install lightrag-hku

安装 LightRAG 服务端

LightRAG 服务端提供了 Web UI 和 API 支持。以下是从 PyPI 安装的命令：

pip install "lightrag-hku[api]"

从源代码安装服务端并支持 API：

# 创建一个 Python 虚拟环境（如果需要的话）
# 安装可编辑模式并支持 API
pip install -e ".[api]"

快速开始

以下是一个使用 Python 脚本初始化 LightRAG 并执行查询的示例：

import os
import asyncio
from lightrag import LightRAG, QueryParam
from lightrag.llm.openai import gpt_4o_mini_complete, gpt_4o_complete, openai_embed
from lightrag.kg.shared_storage import initialize_pipeline_status
from lightrag.utils import setup_logger

setup_logger("lightrag", level="INFO")

async def initialize_rag():
    rag = LightRAG(
        working_dir="your/path",
        embedding_func=openai_embed,
        llm_model_func=gpt_4o_mini_complete
    )
    await rag.initialize_storages()
    await initialize_pipeline_status()
    return rag

def main():
    # 初始化 RAG 实例
    rag = asyncio.run(initialize_rag())

    # 插入文本
    rag.insert("Your text")

    # 执行查询
    query = "What are the top themes in this story?"
    rag.query(query, param=QueryParam(mode="global"))

if __name__ == "__main__":
    main()

确保将 "your/path" 替换为你希望 LightRAG 工作的目标路径。

3. 应用案例和最佳实践

在此部分，你可以提供一些使用 LightRAG 的实际案例，比如如何将 LightRAG 集成到一个问答系统中，或者如何使用 LightRAG 来增强机器生成的文本内容。

4. 典型生态项目

在此部分，可以列出一些与 LightRAG 相关的生态项目，例如支持不同类型数据库存储的项目，或者是为 LightRAG 提供可视化工具的项目。

请注意，由于你的要求，本文档中不包含任何链接，所有内容均使用中文，并且采用 markdown 格式编写。

LightRAG "LightRAG: Simple and Fast Retrieval-Augmented Generation" 项目地址: https://gitcode.com/gh_mirrors/li/LightRAG