Skip to content

Commit

Permalink
improve docstring of doc formatting (#7162)
Browse files Browse the repository at this point in the history
so it shows up nice
  • Loading branch information
hwchase17 committed Jul 4, 2023
1 parent 2984803 commit e853176
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions langchain/schema/prompt_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -164,12 +164,13 @@ def format_document(doc: Document, prompt: BasePromptTemplate) -> str:
Example:
.. code-block:: python
from langchain.schema import Document
from langchain.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"
from langchain.schema import Document
from langchain.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"
"""
base_info = {"page_content": doc.page_content, **doc.metadata}
missing_metadata = set(prompt.input_variables).difference(base_info)
Expand Down

0 comments on commit e853176

Please sign in to comment.