langchain_core.prompts.base.format_document

langchain_core.prompts.base.format_document(doc: Document, prompt: BasePromptTemplate[str]) → str

将文档根据提示模板格式化为字符串。

首先，这从两个来源的文档中提取信息：

1. page_content：

   这获取`document.page_content`中的信息 并将其分配给名为`page_content`的变量。

2. metadata：

   这从`document.metadata`中获取信息并分配 给同名的变量。

然后将这些变量传递到`prompt`中以生成格式化的字符串。

参数：

doc: Document，将使用page_content和metadata创建最终字符串。 prompt: BasePromptTemplate，将用于将page_content和metadata格式化为最终字符串。

返回：

格式化的文档字符串。

示例：

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"

Parameters

• doc (Document) –

• prompt (BasePromptTemplate[str]) –

Return type

str

Examples using format_document

• QA with private data protection {#qa-with-private-data-protection}