Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.dataframe`.DataFrameLoader

class langchain_community.document_loaders.dataframe.DataFrameLoader(data_frame: Any, page_content_column: str = 'text', engine: Literal['pandas', 'modin'] = 'pandas')

  Load Pandas DataFrame.

  Initialize with dataframe object.

  Parameters

    - data_frame (Any) – Pandas DataFrame object.

    - page_content_column (str) – Name of the column containing the page content. Defaults to “text”.

    - engine (Literal['pandas', 'modin']) –

  Methods

  `__init__`(data_frame[, page_content_column, ...]) | Initialize with dataframe object.
  `alazy_load`() | A lazy loader for Documents.
  `aload`() | Load data into Document objects.
  `lazy_load`() | Lazy load records from dataframe.
  `load`() | Load data into Document objects.
  `load_and_split`([text_splitter]) | Load Documents and split into chunks.

  __init__(data_frame: Any, page_content_column: str = 'text', engine: Literal['pandas', 'modin'] = 'pandas')

    Initialize with dataframe object.

    Parameters

      - data_frame (Any) – Pandas DataFrame object.

      - page_content_column (str) – Name of the column containing the page content. Defaults to “text”.

      - engine (Literal['pandas', 'modin']) –

  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]

    Lazy load records from dataframe.

    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 DataFrameLoader

- Use lazy load for larger table, which won’t read the full table into memory