Function formatDocument

  • formatDocument(document, prompt): Promise<string>

  • Parameters

    • document: Document<Record<string, any>>

      The document to format.

    • prompt: BasePromptTemplate<any, BasePromptValueInterface, any>

      The prompt template to use for formatting.

    Returns Promise<string>

    A Promise that resolves to the formatted document as a string.

    ⚠️ Deprecated ⚠️

    Formats a document using a given prompt template.

    This feature is deprecated and will be removed in the future.

    It is not recommended for use.

    Async

    Throws

    If the document is missing required metadata variables specified in the prompt template.

Settings

Member Visibility

Theme

Generated using TypeDoc