langchain_core.prompts.base.aformat_document

async langchain_core.prompts.base.aformat_document(doc: Document, prompt: BasePromptTemplate[str]) str[源代码]

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

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

  1. 页面内容

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

  2. 元数据

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

然后,这些变量通过prompt传递以生成格式化字符串。

参数
  • doc (Document) – 文档,页面内容和元数据将被用来创建最终的字符串。

  • prompt (BasePromptTemplate[str]) – 基础提示模板,将用于将页面内容和元数据格式化成最终的字符串。

返回

格式化后的文档字符串。

返回类型

str