Skip to main content
Open In ColabOpen on GitHub

从 StuffDocumentsChain 迁移

StuffDocumentsChain 通过将文档拼接成单个上下文窗口来组合文档。这是一种简单有效的策略，用于将文档组合以进行问答、摘要和其他用途。

create_stuff_documents_chain 是推荐的替代方案。它的功能与 StuffDocumentsChain 相同，但对流式处理和批量功能的支持更好。由于它是 LCEL 原语 的简单组合，因此也更容易扩展并集成到其他 LangChain 应用程序中。

下面我们将通过一个简单的示例，对 StuffDocumentsChain 和 create_stuff_documents_chain 进行说明，以便更好地理解。

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

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.chat_models import init_chat_model

llm = init_chat_model("gpt-4o-mini", model_provider="openai")

示例​

让我们通过一个示例来分析一组文档。我们首先为说明目的生成一些简单的文档：

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 参考:文档

遗留​

详细信息

下面我们将展示一个使用 StuffDocumentsChain 的实现。我们定义一个用于摘要任务的提示模板，并为此目的实例化一个 LLMChain 对象。我们定义了如何将文档格式化为提示，并确保各个提示中的键保持一致。

from langchain.chains import LLMChain, StuffDocumentsChain
from langchain_core.prompts import ChatPromptTemplate, PromptTemplate

# This controls how each document will be formatted. Specifically,
# it will be passed to `format_document` - see that function for more
# details.
document_prompt = PromptTemplate(
    input_variables=["page_content"], template="{page_content}"
)
document_variable_name = "context"
# The prompt here should take as an input variable the
# `document_variable_name`
prompt = ChatPromptTemplate.from_template("Summarize this content: {context}")

llm_chain = LLMChain(llm=llm, prompt=prompt)
chain = StuffDocumentsChain(
    llm_chain=llm_chain,
    document_prompt=document_prompt,
    document_variable_name=document_variable_name,
)

我们现在可以调用我们的链：

result = chain.invoke(documents)
result["output_text"]
'This content describes the colors of different fruits: apples are red, blueberries are blue, and bananas are yellow.'
for chunk in chain.stream(documents):
    print(chunk)
{'input_documents': [Document(metadata={'title': 'apple_book'}, page_content='Apples are red'), Document(metadata={'title': 'blueberry_book'}, page_content='Blueberries are blue'), Document(metadata={'title': 'banana_book'}, page_content='Bananas are yelow')], 'output_text': 'This content describes the colors of different fruits: apples are red, blueberries are blue, and bananas are yellow.'}

LCEL​

详细信息

下面我们展示一个使用 create_stuff_documents_chain 的实现：

from langchain.chains.combine_documents import create_stuff_documents_chain
from langchain_core.prompts import ChatPromptTemplate

prompt = ChatPromptTemplate.from_template("Summarize this content: {context}")
chain = create_stuff_documents_chain(llm, prompt)

调用链后，我们得到了与之前类似的结果：

result = chain.invoke({"context": documents})
result
'This content describes the colors of different fruits: apples are red, blueberries are blue, and bananas are yellow.'

请注意，此实现支持输出令牌的流式传输：

for chunk in chain.stream({"context": documents}):
    print(chunk, end=" | ")
 | This |  content |  describes |  the |  colors |  of |  different |  fruits | : |  apples |  are |  red | , |  blue | berries |  are |  blue | , |  and |  bananas |  are |  yellow | . |  |

下一步​

查看 LCEL 概念文档 以获取更多信息。

查看这些操操作指南，了解更多关于使用 RAG 进行问答任务的内容。

查看 此教程 了解更多基于大语言模型的摘要策略。