Toggle Menu
Prev Up Next

# `langchain_community.document_loaders.chm`.UnstructuredCHMLoader

class langchain_community.document_loaders.chm.UnstructuredCHMLoader(file_path: Optional[Union[str, List[str], Path, List[Path]]], mode: str = 'single', **unstructured_kwargs: Any)

  Load CHM files using Unstructured.

  CHM means Microsoft Compiled HTML Help.

  Examples

  from langchain_community.document_loaders import UnstructuredCHMLoader

  loader = UnstructuredCHMLoader(“example.chm”) docs = loader.load()

  References

  https://github.com/dottedmag/pychm http://www.jedrea.com/chmlib/

  Initialize with file path.

  Methods

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

  Parameters

    - file_path (Optional[Union[str, List[str], Path, List[Path]]]) –

    - mode (str) –

    - unstructured_kwargs (Any) –

  __init__(file_path: Optional[Union[str, List[str], Path, List[Path]]], mode: str = 'single', **unstructured_kwargs: Any)

    Initialize with file path.

    Parameters

      - file_path (Optional[Union[str, List[str], Path, List[Path]]]) –

      - mode (str) –

      - unstructured_kwargs (Any) –

  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]

    Load file.

    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 UnstructuredCHMLoader

- Unstructured