「翻译」使用 Llama-index 实现的 Agentic RAG-Router Query Engine

Ryoma

发布于 2024-06-14 13:08:58

860

发布于 2024-06-14 13:08:58

原文：Agentic RAG With Llama-index | Router Query Engine #01 作者：Prince Krampah 翻译：RyomaHan | 小白提示：本文有对应的 YouTube 视频，本文中的我代指原作者

前言

你是否也厌倦了我在博文中经常提到的老式 RAG(Retrieval Augmented Generation | 检索增强生成) 系统？反正我是对此感到厌倦了。但我们可以做一些有趣的事情，让它更上一层楼。接下来就跟我一起将 agents 概念引入传统的 RAG 工作流，重新构建自己的 Agentic RAG 系统吧。

去年大模型领域最流行的关键词就是 RAG 了，而今年，一代新人换旧人，agents 已经取代 RAG 成为大模型领域的新宠。你大可不必为错过 RAG 的风口而沮丧，因为将 agents 引入 RAG 系统后会有更好的效果，所以现在开始学习也不晚。

在本文中，我会介绍如何使用 Llama-index 实现基本的 Agentic RAG 应用。我将在接下来的几周发布一系列（共四篇）有关 Agentic RAG 架构的文章，本文是这个系列的第一篇。

RAG 基础工作流

在开始新篇章前，让我们快速回顾一下传统的 RAG 架构的组织形式和工作原理。这部分知识在后续过程也会用到，那些对 RAG 没有任何经验的初学者务必仔细学习。

在上面简单的 RAG 架构图中，我们至少需要理解以下概念：

文档（Documents）：用于增强 LLM 理解特定领域的上下文。可以是 PDF 或者任何文本文档，对于多模态的 LLM 来说甚至可以是图片；
块（Chunks）/ 节点（nodes）：将较大的文档通过合适的算法分割成尺寸合适的块（或节点）；
特征映射（Embedings）：在将文档分割成块后，我们需要为每个块创建与之对应的特征映射（一般以向量的形式存储）。当系统收到来自用户的查询时，RAG 系统会通过相似性搜索找到与查询内容相关性最高的文档块。这些被检索出来的文档块会与用户查询内容一起发送给 LLM，检索出来的文档块会充当此次 LLM 调用的上下文。最终，LLM 会根据以上内容生成响应。

以上就是典型的传统 RAG 系统的组织形式和工作原理。

为什么要创建 Agentic RAG

通过上一章节我们了解了传统 RAG 的实现，这种实现方案适用于少量文档的简单 QA 任务，不适合复杂的 QA 任务和对较大文档集的总结。

而这恰好是 agents 的强势领域，将 agents 与 RAG 结合能够将传统 RAG 系统提升到一个全新的水平。通过 Agentic RAG 系统，可以轻松地执行更复杂的任务，例如文档集摘要、复杂 QA 以及其他复杂任务。Agentic RAG 还能使 RAG 系统具有工具调用的能力，并且这些工具可以是自定义函数。

在本系列文章中我将讨论以下内容：

路由式查询引擎（Router Query Engines）：这是最简单的 Agentic RAG 实现方式，它提供了添加逻辑声明的能力。这种能力可以帮助 LLM 根据需要执行的任务以及提供的工具确定通过何种路径能够达到最终目的；
工具调用（Tool Calling）：在这篇文章中，我将介绍如何将自己定义的工具（方法）添加到 Agentic RAG 架构中。我会为 agents 实现一些接口，以便从我们提供的工具中选择合适的工具并通过 LLM 生成调用这些工具（这里我们默认工具是自定义的 Python 函数）所需要的参数；
具有多步推理能力的 Agentic RAG；
在文档集中具有多步推理能力的 Agentic RAG。

路由式查询引擎 | Router Query Engine

这是 Llama-index 中最简单的 Agentic RAG 实现方案。在这种方案中，我们只需要创建一个路由式查询引擎。它能够在 LLM 帮助下，（从提供的工具和查询引擎列表中）确定具体使用什么工具或查询引擎来解决用户查询的。

下图是本文要实现的路由式查询引擎的基本结构：

项目环境初始化

创建一个名为 agentic_rag 的目录作为本系列文章的项目目录，再在 agentic_rag 内部创建一个名为 basics 的目录作为本文代码实践的工作目录。创建完成后进入 basics 目录中进行环境初始化：

# /root/to/agentic_rag/basics
poetry init

在正式开始前，你需要先准备好你的 OpenAI API 密钥，如果你还没有密钥，可以从此处获取。准备好密钥后，将其添加到你的 .env 文件中：

# /root/to/agentic_rag/basics/.env
OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

译者注：也可以使用其他平台的 LLM 接口，你可以在 此链接 下确认 Llama-index 是否支持你期望的平台。

译者注：如果没有能力购买平台提供的 LLM 能力，也可以使用 Ollama 在本地运行指定模型，并参考 文档 在 Llama-index 中调用模型能力。

译者注：如果使用了不同平台的接口需要将后文中提到的 OpenAI 相关的接口替换成你所使用的平台的接口。

安装依赖

我们会在本项目中使用到 Llama-index 以及一些其他的依赖库，你可以通过如下命令进行安装：

# /root/to/agentic_rag/basics
poetry add python-dotenv ipykernel llama-index nest_asyncio

下载数据集

我们需要一个 PDF 文件用于后续代码实践，你可以点击此链接下载我所使用的 PDF。当然你也可以使用你手中的任何一个 PDF 文件（译者注：对于初学者来说最好是一个纯文本的 PDF 文件）。将它保存到 /path/to/agentic_rag/basic/datasets 目录下。

加载文档并将其处理成块

译者注：原文作者是使用 .ipynb 格式来编写并运行代码的，如果你不熟悉这个文件格式可以使用正常的 .py 文件。

现在我们已经将代码运行的基础环境准备好了，然我们先通过 python-dotenv 库加载环境变量：

import dotenv
%load_ext dotenv
%dotenv

随后我们需要引入 nest_asyncio 库，因为 Llama-index 在后台使用大量 asyncio 功能：

import nest_asyncio
nest_asyncio.apply()

现在，然我们加载准备好的 PDF 文档：

from llama_index.core import SimpleDirectoryReader  
  
# load lora_paper.pdf documents  
documents = SimpleDirectoryReader(input_files=["./datasets/lora_paper.pdf"]).load_data()

创建文档块

成功加载文档后，我们需要将其分解成合适大小的块：

from llama_index.core.node_parser import SentenceSplitter  
  
# chunk_size of 1024 is a good default value  
splitter = SentenceSplitter(chunk_size=1024)  
# Create nodes from documents  
nodes = splitter.get_nodes_from_documents(documents)

可以使用以下方法获取有关每个块的详细信息：

node_metadata = nodes[1].get_content(metadata_mode=True)  
print(node_metadata)

创建所需的 LLM 和 Embedding 模型对象

译者注：这里你需要将用到的模型类替换为你所使用的平台所对应的类，有些类需要添加额外的第三方依赖，详情请查看 Llama-index 文档。

在本次代码实践中，我将使用 OpenAI 的 gpt-3.5-turbo 模型作为 LLM 模型，使用 OpenAI 的 text-embedding-ada-002 模型作为 Embedding 模型。

from llama_index.core import Settings  
from llama_index.llms.openai import OpenAI  
from llama_index.embeddings.openai import OpenAIEmbedding  

# LLM model  
Settings.llm = OpenAI(model="gpt-3.5-turbo")  
# embedding model  
Settings.embed_model = OpenAIEmbedding(model="text-embedding-ada-002")

创建索引

正如前文基本结构图片所示，在本次代码实践中，我们将使用两个主要的索引：

摘要索引（Summary Index）：根据 Llama-index 对应文档所示，摘要索引是一种简单的数据结构，其中节点按顺序存储。在索引构建过程中，文档文本被分块、转换为节点并存储在列表中。在查询期间，摘要索引使用一些可选的过滤器参数迭代节点，并综合所有节点的答案。
向量索引（Vector Index）：一个通过 Embedding 创建的常规索引存储，可以执行相似性搜索，以获得与搜索条件最相似的 n 个的索引。

可以使用下面的代码来创建这两个索引：

from llama_index.core import SummaryIndex, VectorStoreIndex  
  
# summary index  
summary_index = SummaryIndex(nodes)  
# vector store index  
vector_index = VectorStoreIndex(nodes)

将向量索引转换为查询引擎

在创建并存储向量索引后，我们需要继续创建查询引擎，后续会将它们转换为 agnets 使用的工具（又名查询工具）。

# summary query engine  
summary_query_engine = summary_index.as_query_engine(  
	response_mode="tree_summarize",  
	use_async=True,  
)  
  
# vector query engine  
vector_query_engine = vector_index.as_query_engine()

在上面的例子中，我们创建了两个不同的查询引擎。后续我们会将它们都挂载到路由式查询引擎下，然后路由式查询引擎会根据用户的查询内容决定具体使用哪个查询引擎。

在上面的代码中，我们指定了 use_async 参数以加快查询速度，这是我们必须使用 nest_asyncio 库的原因之一。

译者注：我刚去看 nest_asyncio 的代码库，发现被 archive 了，我还以为是 Python 官方支持了，后面在阅读 相关 issue 的时候才发现原来是代码库的作者年初去世了，RIP.

创建查询工具

查询工具是一个带有元数据（例如存储当前查询工具可以用来做什么）的查询引擎。这有助于路由式查询引擎能够根据传入的用户查询来决定具体使用哪个查询引擎。

from llama_index.core.tools import QueryEngineTool  
  
  
summary_tool = QueryEngineTool.from_defaults(  
	query_engine=summary_query_engine,  
	description=(  
		"Useful for summarization questions related to the Lora paper."  
	),  
)  
  
vector_tool = QueryEngineTool.from_defaults(  
	query_engine=vector_query_engine,  
	description=(  
		"Useful for retrieving specific context from the the Lora paper."  
	),
)

创建路由式查询引擎

最后，我们需要创建最终用于查询的路由式查询引擎。它能够帮我们聚合上文所创建的所有查询工具，即 summary_tool 和 vector_tool。

from llama_index.core.query_engine.router_query_engine import RouterQueryEngine  
from llama_index.core.selectors import LLMSingleSelector  
  
  
query_engine = RouterQueryEngine(  
	selector=LLMSingleSelector.from_defaults(),  
	query_engine_tools=[  
		summary_tool,  
		vector_tool,  
	],  
	verbose=True  
)

LLMSingleSelector：是一个使用 LLM 从选项列表中选择出单个选项的选择器。你可以在这个链接中查看更多信息。

测试路由式查询引擎

译者注：在执行如下代码是记得把问题换成与你使用的 PDF 相关的问题。

可以通过如下代码测试我们创建的路由式查询引擎：

response = query_engine.query("What is the summary of the document?")  
print(str(response))

以上是论文的摘要，总结了我们传递给查询引擎的 Lora 论文的所有上下文。

由于我们使用的摘要索引是将所有块存储在顺序列表中，因此在生成摘要时会访问所有块并从中生成一个总摘要，然后再以此生成最终摘要。

可以通过检查响应中 source_nodes 列表的长度来确认这一点，source_nodes 属性是这次响应中用到的所有块的列表。

可以看到最终的结果 38 与我们前面创建的块的数量相同，这意味着所有的块都用于本次摘要生成。

再提问一个不涉及总结的问题：

response = query_engine.query("What is the long from of Lora?")  
print(str(response))

这次回答使用了向量索引，尽管响应内容不是很准确。

将代码合并

现在你已经大致理解了这套 Agentic RAG 工作流，让我们将其抽象成函数方便后续调用：

from llama_index.core.query_engine.router_query_engine import RouterQueryEngine  
from llama_index.core.selectors import LLMSingleSelector  
from llama_index.core.tools import QueryEngineTool  
from llama_index.core import SummaryIndex, VectorStoreIndex  
from llama_index.core import Settings  
from llama_index.llms.openai import OpenAI  
from llama_index.embeddings.openai import OpenAIEmbedding  
from llama_index.core.node_parser import SentenceSplitter  
from llama_index.core import SimpleDirectoryReader


async def create_router_query_engine(  
	document_fp: str,  
	verbose: bool = True,  
) -> RouterQueryEngine:  
	# load lora_paper.pdf documents  
	documents = SimpleDirectoryReader(input_files=[document_fp]).load_data()  
  
	# chunk_size of 1024 is a good default value  
	splitter = SentenceSplitter(chunk_size=1024)  
	# Create nodes from documents  
	nodes = splitter.get_nodes_from_documents(documents)  
  
	# LLM model  
	Settings.llm = OpenAI(model="gpt-3.5-turbo")  
	# embedding model  
	Settings.embed_model = OpenAIEmbedding(model="text-embedding-ada-002")  
	  
	# summary index  
	summary_index = SummaryIndex(nodes)  
	# vector store index  
	vector_index = VectorStoreIndex(nodes)  
  
	# summary query engine  
	summary_query_engine = summary_index.as_query_engine(  
		response_mode="tree_summarize",  
		use_async=True,  
	)  
  
	# vector query engine  
	vector_query_engine = vector_index.as_query_engine()  
	  
	summary_tool = QueryEngineTool.from_defaults(  
		query_engine=summary_query_engine,  
		description=(  
			"Useful for summarization questions related to the Lora paper."  
		),  
	)  
  
	vector_tool = QueryEngineTool.from_defaults(  
		query_engine=vector_query_engine,  
		description=(  
			"Useful for retrieving specific context from the the Lora paper."  
		),  
	)  
  
  
	query_engine = RouterQueryEngine(  
		selector=LLMSingleSelector.from_defaults(),  
		query_engine_tools=[  
			summary_tool,  
			vector_tool,  
		],  
		verbose=verbose  
	)  
  
	  
	return query_engine

然后我们就可以通过如下方法便捷的调用次函数：

query_engine = await create_router_query_engine("./datasets/lora_paper.pdf")  
response = query_engine.query("What is the summary of the document?")  
print(str(response))

我们可以在当前目录下创建一个 utils.py 文件，用于存放刚刚抽象出来的函数：

之后我们就可以通过如下代码便捷的调用此函数：

from utils import create_router_query_engine  
  
query_engine = await create_router_query_engine("./datasets/lora_paper.pdf")  
response = query_engine.query("What is the summary of the document?")  
print(str(response))