langchain_core.prompts.base.format_document

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

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

首先，它从以下两个来源获取文档信息

  1. 页面内容

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

  2. 元数据

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

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

参数

  • doc (Document) – 文档，将使用页面内容和元数据创建最终字符串。

  • prompt (BasePromptTemplate[str]) – BasePromptTemplate，将用于将页面内容和元数据格式化为最终字符串。

返回

文档的格式化字符串。

返回类型

str

示例

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"