Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.toml`.TomlLoader

class langchain_community.document_loaders.toml.TomlLoader(source: Union[str, Path])

  Load TOML files.

  It can load a single source file or several files in a single directory.

  Initialize the TomlLoader with a source file or directory.

  Methods

  `__init__`(source) | Initialize the TomlLoader with a source file or directory.
  `alazy_load`() | A lazy loader for Documents.
  `aload`() | Load data into Document objects.
  `lazy_load`() | Lazily load the TOML documents from the source file or directory.
  `load`() | Load data into Document objects.
  `load_and_split`([text_splitter]) | Load Documents and split into chunks.

  Parameters

    source (Union[str, Path]) –

  __init__(source: Union[str, Path])

    Initialize the TomlLoader with a source file or directory.

    Parameters

      source (Union[str, 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]

    Lazily load the TOML documents from the source file or directory.

    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 TomlLoader

- toml.md