langchain_community.document_loaders.pdf.PyPDFLoader

class langchain_community.document_loaders.pdf.PyPDFLoader(file_path: str, password: Optional[Union[str, bytes]] = None, headers: Optional[Dict] = None, extract_images: bool = False)[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.

alazy_load()

A lazy loader for Documents.

aload()

Load data into Document objects.

lazy_load()

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 (Optional[Union[str, bytes]]) –

  • headers (Optional[Dict]) –

  • extract_images (bool) –

__init__(file_path: str, password: Optional[Union[str, bytes]] = None, headers: Optional[Dict] = None, extract_images: bool = False) None[source]

Initialize with a file path.

Parameters
  • file_path (str) –

  • password (Optional[Union[str, bytes]]) –

  • headers (Optional[Dict]) –

  • extract_images (bool) –

Return type

None

async alazy_load() AsyncIterator[Document]

A lazy loader for Documents.

Return type

AsyncIterator[Document]

async aload() List[Document]

Load data into Document objects.

Return type

List[Document]

lazy_load() Iterator[Document][source]

Lazy load given path as pages.

Return type

Iterator[Document]

load() List[Document]

Load data into Document objects.

Return type

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = 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