迁移自 StuffDocumentsChain

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

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

下面我们将通过一个简单的示例来介绍 StuffDocumentsChain 和 create_stuff_documents_chain，以进行说明。

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

选择 聊天模型

OpenAI

Anthropic

Azure

Google Vertex

AWS

Groq

Cohere

NVIDIA

Fireworks AI

Mistral AI

Together AI

IBM watsonx

Databricks

xAI

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 参考：Document

旧版

详情

下面我们展示了使用 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,
)

API 参考：LLMChain | StuffDocumentsChain | ChatPromptTemplate | PromptTemplate

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

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)

API 参考：create_stuff_documents_chain | ChatPromptTemplate

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

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 的问答任务。

查看 本教程，了解更多基于 LLM 的摘要策略。