create_stuff_documents_chain#

langchain.chains.combine_documents.stuff.create_stuff_documents_chain(llm: Runnable[PromptValue | str | Sequence[BaseMessage | list[str] | tuple[str, str] | str | dict[str, Any]], BaseMessage | str], prompt: BasePromptTemplate, *, output_parser: BaseOutputParser | None = None, document_prompt: BasePromptTemplate | None = None, document_separator: str = '\n\n', document_variable_name: str = 'context') → Runnable[Dict[str, Any], Any][source]#

Create a chain for passing a list of Documents to a model.

Parameters:

  • llm (Runnable[PromptValue | str | Sequence[BaseMessage | list[str] | tuple[str, str] | str | dict[str, Any]], BaseMessage | str]) – Language model.

  • prompt (BasePromptTemplate) – Prompt template. Must contain input variable “context” (override by setting document_variable), which will be used for passing in the formatted documents.

  • output_parser (BaseOutputParser | None) – Output parser. Defaults to StrOutputParser.

  • document_prompt (BasePromptTemplate | None) – Prompt used for formatting each document into a string. Input variables can be “page_content” or any metadata keys that are in all documents. “page_content” will automatically retrieve the Document.page_content, and all other inputs variables will be automatically retrieved from the Document.metadata dictionary. Default to a prompt that only contains Document.page_content.

  • document_separator (str) – String separator to use between formatted document strings.

  • document_variable_name (str) – Variable name to use for the formatted documents in the prompt. Defaults to “context”.

Returns:

An LCEL Runnable. The input is a dictionary that must have a “context” key that maps to a List[Document], and any other input variables expected in the prompt. The Runnable return type depends on output_parser used.

Return type:

Runnable[Dict[str, Any], Any]

Example

# pip install -U langchain langchain-community

from langchain_community.chat_models import ChatOpenAI
from langchain_core.documents import Document
from langchain_core.prompts import ChatPromptTemplate
from langchain.chains.combine_documents import create_stuff_documents_chain

prompt = ChatPromptTemplate.from_messages(
    [("system", "What are everyone's favorite colors:\n\n{context}")]
)
llm = ChatOpenAI(model="gpt-3.5-turbo")
chain = create_stuff_documents_chain(llm, prompt)

docs = [
    Document(page_content="Jesse loves red but not yellow"),
    Document(page_content = "Jamal loves green but not as much as he loves orange")
]

chain.invoke({"context": docs})

Examples using create_stuff_documents_chain