format_document#

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

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

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

  1. page_content:

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

  2. metadata:

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

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

Parameters:

  • doc (Document) – 文档，page_content 和 metadata 将用于创建最终的字符串。

  • prompt (BasePromptTemplate[str]) – BasePromptTemplate，将用于将page_content和metadata格式化为最终字符串。

Returns:

文档格式化的字符串。

Return type:

字符串

示例

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"
On this page