Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.pdf`.BasePDFLoader

class langchain_community.document_loaders.pdf.BasePDFLoader(file_path: Union[str, Path], *, headers: Optional[Dict] = None)

  Base Loader class for PDF files.

  If the file is a web path, it will download it to a temporary file, use it, then

    clean up the temporary file after completion.

  Initialize with a file path.

  Parameters

    - file_path (Union[str, Path]) – Either a local, S3 or web path to a PDF file.

    - headers (Optional[Dict]) – Headers to use for GET request to download a file from a web path.

  Attributes

  `source` |

  Methods

  `__init__`(file_path, *[, headers]) | Initialize with a file path.
  `alazy_load`() | A lazy loader for Documents.
  `aload`() | Load data into Document objects.
  `lazy_load`() | A lazy loader for Documents.
  `load`() | Load data into Document objects.
  `load_and_split`([text_splitter]) | Load Documents and split into chunks.

  __init__(file_path: Union[str, Path], *, headers: Optional[Dict] = None)

    Initialize with a file path.

    Parameters

      - file_path (Union[str, Path]) – Either a local, S3 or web path to a PDF file.

      - headers (Optional[Dict]) – Headers to use for GET request to download a file from a web path.

  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]

    A lazy loader for Documents.

    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]