PyPDFLoader#
- class langchain_community.document_loaders.pdf.PyPDFLoader(file_path: str, password: str | bytes | None = None, headers: Dict | None = None, extract_images: bool = False, *, extraction_mode: str = 'plain', extraction_kwargs: Dict | None = None)[source]#
Load PDF using pypdf into list of documents.
Loader chunks by page and stores page numbers in metadata.
Initialize with a file path.
Attributes
source
Methods
__init__
(file_path[,Β password,Β headers,Β ...])Initialize with a file path.
A lazy loader for Documents.
aload
()Load data into Document objects.
Lazy load given path as pages.
load
()Load data into Document objects.
load_and_split
([text_splitter])Load Documents and split into chunks.
- Parameters:
file_path (str) β
password (str | bytes | None) β
headers (Dict | None) β
extract_images (bool) β
extraction_mode (str) β
extraction_kwargs (Dict | None) β
- __init__(file_path: str, password: str | bytes | None = None, headers: Dict | None = None, extract_images: bool = False, *, extraction_mode: str = 'plain', extraction_kwargs: Dict | None = None) None [source]#
Initialize with a file path.
- Parameters:
file_path (str) β
password (str | bytes | None) β
headers (Dict | None) β
extract_images (bool) β
extraction_mode (str) β
extraction_kwargs (Dict | None) β
- Return type:
None
- async alazy_load() AsyncIterator[Document] #
A lazy loader for Documents.
- Return type:
AsyncIterator[Document]
- lazy_load() Iterator[Document] [source]#
Lazy load given path as pages.
- Return type:
Iterator[Document]
- load_and_split(text_splitter: TextSplitter | None = None) List[Document] #
Load Documents and split into chunks. Chunks are returned as Documents.
Do not override this method. It should be considered to be deprecated!
- Parameters:
text_splitter (Optional[TextSplitter]) β TextSplitter instance to use for splitting documents. Defaults to RecursiveCharacterTextSplitter.
- Returns:
List of Documents.
- Return type:
List[Document]
Examples using PyPDFLoader