Format a document into a string based on a prompt template.
First, this pulls information from the document from two sources:
page_content: This takes the information from the document.page_content and
assigns it to a variable named page_content.metadata: This takes information from document.metadata and assigns it to
variables of the same name.Those variables are then passed into the prompt to produce a formatted string.
format_document(
doc: Document,
prompt: BasePromptTemplate[str],
) -> strExample:
from langchain_core.documents import Document
from langchain_core.prompts import PromptTemplate
doc = Document(page_content="This is a joke", metadata={"page": "1"})
prompt = PromptTemplate.from_template("Page {page}: {page_content}")
format_document(doc, prompt)
# -> "Page 1: This is a joke"| Name | Type | Description |
|---|---|---|
doc* | Document |
|
prompt* | BasePromptTemplate[str] |
|