Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.acreom`.AcreomLoader

class langchain_community.document_loaders.acreom.AcreomLoader(path: Union[str, Path], encoding: str = 'UTF-8', collect_metadata: bool = True)

  Load acreom vault from a directory.

  Initialize the loader.

  Attributes

  `FRONT_MATTER_REGEX` | Regex to match front matter metadata in markdown files.
  `file_path` | Path to the directory containing the markdown files.
  `encoding` | Encoding to use when reading the files.
  `collect_metadata` | Whether to collect metadata from the front matter.

  Methods

  `__init__`(path[, encoding, collect_metadata]) | Initialize the loader.
  `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.

  Parameters

    - path (Union[str, Path]) –

    - encoding (str) –

    - collect_metadata (bool) –

  __init__(path: Union[str, Path], encoding: str = 'UTF-8', collect_metadata: bool = True)

    Initialize the loader.

    Parameters

      - path (Union[str, Path]) –

      - encoding (str) –

      - collect_metadata (bool) –

  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]

# Examples using AcreomLoader

- Acreom

- acreom.md