跳转到主要内容

从 MapReduceDocumentsChain 迁移

MapReduceDocumentsChain 对(可能很长的)文本实现 map-reduce 策略。该策略如下:

  • 将文本拆分为较小的文档;
  • 将进程映射到较小的文档;
  • 将进程的结果缩减或合并为最终结果。

请注意,map 步骤通常在输入文档上并行化。

在此上下文中应用的常见过程是摘要,其中 map 步骤摘要单个文档,而 reduce 步骤生成摘要的摘要。

在 reduce 步骤中,MapReduceDocumentsChain 支持摘要的递归“折叠”:输入将根据令牌限制进行分区,并且将生成分区的摘要。此步骤将重复进行,直到摘要的总长度在所需限制内,从而允许对任意长度的文本进行摘要。这对于具有较小上下文窗口的模型尤其有用。

LangGraph 支持 map-reduce 工作流,并为此问题提供了一些优势:

  • LangGraph 允许对各个步骤(例如连续的摘要)进行流式处理,从而可以更好地控制执行;
  • LangGraph 的 检查点 支持错误恢复,扩展了人机协同工作流,并且更容易集成到会话应用程序中。
  • 正如我们将在下面看到的,LangGraph 的实现更容易扩展。

下面我们将介绍 MapReduceDocumentsChain 和相应的 LangGraph 实现,首先用一个简单的示例进行说明,其次用一个较长的示例文本演示递归的 reduce 步骤。

首先,让我们加载一个聊天模型

pip install -qU langchain-openai
import getpass
import os

if not os.environ.get("OPENAI_API_KEY"):
os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter API key for OpenAI: ")

from langchain_openai import ChatOpenAI

llm = ChatOpenAI(model="gpt-4o-mini")

基本示例(短文档)

为了说明目的,我们使用以下 3 个文档。

from langchain_core.documents import Document

documents = [
Document(page_content="Apples are red", metadata={"title": "apple_book"}),
Document(page_content="Blueberries are blue", metadata={"title": "blueberry_book"}),
Document(page_content="Bananas are yelow", metadata={"title": "banana_book"}),
]
API 参考:文档

旧版

详情

下面我们展示了使用 MapReduceDocumentsChain 的实现。我们为 map 和 reduce 步骤定义提示模板,为这些步骤实例化单独的链,最后实例化 MapReduceDocumentsChain

from langchain.chains import MapReduceDocumentsChain, ReduceDocumentsChain
from langchain.chains.combine_documents.stuff import StuffDocumentsChain
from langchain.chains.llm import LLMChain
from langchain_core.prompts import ChatPromptTemplate
from langchain_text_splitters import CharacterTextSplitter

# Map
map_template = "Write a concise summary of the following: {docs}."
map_prompt = ChatPromptTemplate([("human", map_template)])
map_chain = LLMChain(llm=llm, prompt=map_prompt)


# Reduce
reduce_template = """
The following is a set of summaries:
{docs}
Take these and distill it into a final, consolidated summary
of the main themes.
"""
reduce_prompt = ChatPromptTemplate([("human", reduce_template)])
reduce_chain = LLMChain(llm=llm, prompt=reduce_prompt)


# Takes a list of documents, combines them into a single string, and passes this to an LLMChain
combine_documents_chain = StuffDocumentsChain(
llm_chain=reduce_chain, document_variable_name="docs"
)

# Combines and iteratively reduces the mapped documents
reduce_documents_chain = ReduceDocumentsChain(
# This is final chain that is called.
combine_documents_chain=combine_documents_chain,
# If documents exceed context for `StuffDocumentsChain`
collapse_documents_chain=combine_documents_chain,
# The maximum number of tokens to group documents into.
token_max=1000,
)

# Combining documents by mapping a chain over them, then combining results
map_reduce_chain = MapReduceDocumentsChain(
# Map chain
llm_chain=map_chain,
# Reduce chain
reduce_documents_chain=reduce_documents_chain,
# The variable name in the llm_chain to put the documents in
document_variable_name="docs",
# Return the results of the map steps in the output
return_intermediate_steps=False,
)
result = map_reduce_chain.invoke(documents)

print(result["output_text"])
Fruits come in a variety of colors, with apples being red, blueberries being blue, and bananas being yellow.

LangSmith 跟踪中,我们观察到四个 LLM 调用:一个总结三个输入文档中的每一个,另一个总结摘要。

LangGraph

下面我们展示一个 LangGraph 实现,使用与上面相同的提示模板。该图包括一个用于生成摘要的节点,该节点映射到输入文档列表。然后,此节点流向第二个节点,该节点生成最终摘要。

详情

我们将需要安装 langgraph

%pip install -qU langgraph
import operator
from typing import Annotated, List, TypedDict

from langchain_core.output_parsers import StrOutputParser
from langchain_core.prompts import ChatPromptTemplate
from langgraph.constants import Send
from langgraph.graph import END, START, StateGraph

map_template = "Write a concise summary of the following: {context}."

reduce_template = """
The following is a set of summaries:
{docs}
Take these and distill it into a final, consolidated summary
of the main themes.
"""

map_prompt = ChatPromptTemplate([("human", map_template)])
reduce_prompt = ChatPromptTemplate([("human", reduce_template)])

map_chain = map_prompt | llm | StrOutputParser()
reduce_chain = reduce_prompt | llm | StrOutputParser()

# Graph components: define the components that will make up the graph


# This will be the overall state of the main graph.
# It will contain the input document contents, corresponding
# summaries, and a final summary.
class OverallState(TypedDict):
# Notice here we use the operator.add
# This is because we want combine all the summaries we generate
# from individual nodes back into one list - this is essentially
# the "reduce" part
contents: List[str]
summaries: Annotated[list, operator.add]
final_summary: str


# This will be the state of the node that we will "map" all
# documents to in order to generate summaries
class SummaryState(TypedDict):
content: str


# Here we generate a summary, given a document
async def generate_summary(state: SummaryState):
response = await map_chain.ainvoke(state["content"])
return {"summaries": [response]}


# Here we define the logic to map out over the documents
# We will use this an edge in the graph
def map_summaries(state: OverallState):
# We will return a list of `Send` objects
# Each `Send` object consists of the name of a node in the graph
# as well as the state to send to that node
return [
Send("generate_summary", {"content": content}) for content in state["contents"]
]


# Here we will generate the final summary
async def generate_final_summary(state: OverallState):
response = await reduce_chain.ainvoke(state["summaries"])
return {"final_summary": response}


# Construct the graph: here we put everything together to construct our graph
graph = StateGraph(OverallState)
graph.add_node("generate_summary", generate_summary)
graph.add_node("generate_final_summary", generate_final_summary)
graph.add_conditional_edges(START, map_summaries, ["generate_summary"])
graph.add_edge("generate_summary", "generate_final_summary")
graph.add_edge("generate_final_summary", END)
app = graph.compile()
from IPython.display import Image

Image(app.get_graph().draw_mermaid_png())

请注意,以流模式调用图允许我们在执行期间监视步骤并可能对其采取操作。

# Call the graph:
async for step in app.astream({"contents": [doc.page_content for doc in documents]}):
print(step)
{'generate_summary': {'summaries': ['Apples are typically red in color.']}}
{'generate_summary': {'summaries': ['Bananas are yellow in color.']}}
{'generate_summary': {'summaries': ['Blueberries are a type of fruit that are blue in color.']}}
{'generate_final_summary': {'final_summary': 'The main themes are the colors of different fruits: apples are red, blueberries are blue, and bananas are yellow.'}}

LangSmith 跟踪中,我们恢复了与之前相同的四个 LLM 调用。

总结长文档

当文本的长度相对于 LLM 的上下文窗口较长时,Map-reduce 流特别有用。 MapReduceDocumentsChain 支持摘要的递归“折叠”:输入根据令牌限制进行分区,并生成分区摘要。重复此步骤,直到摘要的总长度在所需的限制内,从而允许对任意长度的文本进行摘要。

此“折叠”步骤在 MapReduceDocumentsChain 中实现为 while 循环。我们可以在较长的文本上演示此步骤,即 Lilian Weng 的一篇 LLM Powered Autonomous Agents 博客文章(如 RAG 教程和其他文档中所述)。

首先,我们加载帖子并将其分成较小的“子文档”

from langchain_community.document_loaders import WebBaseLoader
from langchain_text_splitters import CharacterTextSplitter

loader = WebBaseLoader("https://lilianweng.github.io/posts/2023-06-23-agent/")
documents = loader.load()

text_splitter = CharacterTextSplitter.from_tiktoken_encoder(
chunk_size=1000, chunk_overlap=0
)
split_docs = text_splitter.split_documents(documents)
print(f"Generated {len(split_docs)} documents.")
USER_AGENT environment variable not set, consider setting it to identify your requests.
Created a chunk of size 1003, which is longer than the specified 1000
``````output
Generated 14 documents.

旧版

详情

我们可以像以前一样调用 MapReduceDocumentsChain

result = map_reduce_chain.invoke(split_docs)

print(result["output_text"])
The article discusses the use of Large Language Models (LLMs) to power autonomous agents in various tasks, showcasing their capabilities in problem-solving beyond generating written content. Key components such as planning, memory optimization, and tool use are explored, with proof-of-concept demos like AutoGPT and GPT-Engineer demonstrating the potential of LLM-powered agents. Challenges include limitations in historical information retention and natural language interface reliability, while the potential of LLMs in enhancing reasoning, problem-solving, and planning proficiency for autonomous agents is highlighted. Overall, the article emphasizes the versatility and power of LLMs in creating intelligent agents for tasks like scientific discovery and experiment design.

考虑上述调用的 LangSmith 跟踪。在实例化我们的 ReduceDocumentsChain 时,我们将 token_max 设置为 1,000 个令牌。 这导致总共 17 个 LLM 调用

  • 14 个调用用于总结我们的文本拆分器生成的 14 个子文档。
  • 这生成了总共约 1,000 - 2,000 个令牌的摘要。 由于我们设置的 token_max 为 1,000,因此还有两个调用来总结(或“折叠”)这些摘要。
  • 最后一个调用用于生成两个“折叠”摘要的最终摘要。

LangGraph

详情

我们可以扩展 LangGraph 中原始的 map-reduce 实现,以实现相同的递归折叠步骤。我们进行以下更改:

  • 向状态添加一个 collapsed_summaries 键,用于存储折叠的摘要;
  • 更新最终摘要节点以总结折叠的摘要;
  • 添加一个 collapse_summaries 节点,该节点根据令牌长度(此处为 1,000 个令牌,与以前一样)对文档列表进行分区,并生成每个分区的摘要,并将结果存储在 collapsed_summaries 中。

我们添加了一个从 collapse_summaries 到自身的有条件边,以形成一个循环:如果折叠的摘要总和超过 token_max,我们将重新运行该节点。

from typing import Literal

from langchain.chains.combine_documents.reduce import (
acollapse_docs,
split_list_of_docs,
)


def length_function(documents: List[Document]) -> int:
"""Get number of tokens for input contents."""
return sum(llm.get_num_tokens(doc.page_content) for doc in documents)


token_max = 1000


class OverallState(TypedDict):
contents: List[str]
summaries: Annotated[list, operator.add]
collapsed_summaries: List[Document] # add key for collapsed summaries
final_summary: str


# Add node to store summaries for collapsing
def collect_summaries(state: OverallState):
return {
"collapsed_summaries": [Document(summary) for summary in state["summaries"]]
}


# Modify final summary to read off collapsed summaries
async def generate_final_summary(state: OverallState):
response = await reduce_chain.ainvoke(state["collapsed_summaries"])
return {"final_summary": response}


graph = StateGraph(OverallState)
graph.add_node("generate_summary", generate_summary) # same as before
graph.add_node("collect_summaries", collect_summaries)
graph.add_node("generate_final_summary", generate_final_summary)


# Add node to collapse summaries
async def collapse_summaries(state: OverallState):
doc_lists = split_list_of_docs(
state["collapsed_summaries"], length_function, token_max
)
results = []
for doc_list in doc_lists:
results.append(await acollapse_docs(doc_list, reduce_chain.ainvoke))

return {"collapsed_summaries": results}


graph.add_node("collapse_summaries", collapse_summaries)


def should_collapse(
state: OverallState,
) -> Literal["collapse_summaries", "generate_final_summary"]:
num_tokens = length_function(state["collapsed_summaries"])
if num_tokens > token_max:
return "collapse_summaries"
else:
return "generate_final_summary"


graph.add_conditional_edges(START, map_summaries, ["generate_summary"])
graph.add_edge("generate_summary", "collect_summaries")
graph.add_conditional_edges("collect_summaries", should_collapse)
graph.add_conditional_edges("collapse_summaries", should_collapse)
graph.add_edge("generate_final_summary", END)
app = graph.compile()

LangGraph 允许绘制图结构,以帮助可视化其功能

from IPython.display import Image

Image(app.get_graph().draw_mermaid_png())

与之前一样,我们可以流式传输图以观察其步骤序列。 下面,我们将简单地打印出步骤的名称。

请注意,由于我们在图中有一个循环,因此在执行时指定 recursion_limit 会很有帮助。 这类似于 ReduceDocumentsChain.token_max,当超出指定限制时将引发特定错误。

async for step in app.astream(
{"contents": [doc.page_content for doc in split_docs]},
{"recursion_limit": 10},
):
print(list(step.keys()))
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['generate_summary']
['collect_summaries']
['collapse_summaries']
['generate_final_summary']
print(step)
{'generate_final_summary': {'final_summary': 'The summaries discuss the use of Large Language Models (LLMs) to power autonomous agents in various tasks such as problem-solving, planning, and tool use. Key components like planning, memory, and task decomposition are highlighted, along with challenges such as inefficient planning and hallucination. Techniques like Algorithm Distillation and Maximum Inner Product Search are explored for optimization, while frameworks like ReAct and Reflexion show improvements in knowledge-intensive tasks. The importance of accurate interpretation of user input and well-structured code for functional autonomy is emphasized, along with the potential of LLMs in prompting, reasoning, and emergent social behavior in simulation environments. Challenges in real-world scenarios and the use of LLMs with expert-designed tools for tasks like organic synthesis and drug discovery are also discussed.'}}

在相应的 LangSmith 跟踪中,我们可以看到与之前相同的 17 个 LLM 调用,这次它们被分组在各自的节点下。

后续步骤

请查看 LangGraph 文档,了解有关使用 LangGraph 构建的详细信息,包括 本指南,其中介绍了 LangGraph 中 map-reduce 的详细信息。

请参阅 本教程,了解更多基于 LLM 的摘要策略。


此页面是否对您有所帮助?