从 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_openai import ChatOpenAI
llm = ChatOpenAI(model="gpt-4o-mini")
示例
让我们通过一个分析一组文档的示例。我们首先生成一些简单的文档以用于说明目的
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,
)
我们现在可以调用我们的链
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 进行问答任务的更多信息。
请参阅 本教程,了解更多基于 LLM 的摘要策略。