github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-20 05:43:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve docstring of doc formatting (#7162)

Browse Source 
so it shows up nice
This commit is contained in:
Harrison Chase 2023-07-04 16:31:29 -07:00 committed by GitHub
parent 2984803597
commit e8531769f7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
langchain/schema/prompt_template.py
View File

@ -164,12 +164,13 @@ def format_document(doc: Document, prompt: BasePromptTemplate) -> str:
Example: Example:
.. code-block:: python .. code-block:: python
from langchain.schema import Document
from langchain.prompts import PromptTemplate from langchain.schema import Document
doc = Document(page_content="This is a joke", metadata={"page": "1"}) from langchain.prompts import PromptTemplate
prompt = PromptTemplate.from_template("Page {page}: {page_content}") doc = Document(page_content="This is a joke", metadata={"page": "1"})
format_document(doc, prompt) prompt = PromptTemplate.from_template("Page {page}: {page_content}")
>>> "Page 1: This is a joke" format_document(doc, prompt)
>>> "Page 1: This is a joke"
""" """
base_info = {"page_content": doc.page_content, **doc.metadata} base_info = {"page_content": doc.page_content, **doc.metadata}
missing_metadata = set(prompt.input_variables).difference(base_info) missing_metadata = set(prompt.input_variables).difference(base_info)