Skip to content

Base

BaseReader

Bases: BaseComponent

The base class for all readers

Source code in libs\kotaemon\kotaemon\loaders\base.py 
10
11
12
13
class BaseReader(BaseComponent):
    """The base class for all readers"""

    ...

AutoReader

Bases: BaseReader

General auto reader for a variety of files. (based on llama-hub)

Source code in libs\kotaemon\kotaemon\loaders\base.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class AutoReader(BaseReader):
    """General auto reader for a variety of files. (based on llama-hub)"""

    def __init__(self, reader_type: Union[str, Type["LIBaseReader"]]) -> None:
        """Init reader using string identifier or class name from llama-hub"""

        if isinstance(reader_type, str):
            from llama_index import download_loader

            self._reader = download_loader(reader_type)()
        else:
            self._reader = reader_type()
        super().__init__()

    def load_data(self, file: Union[Path, str], **kwargs: Any) -> List[Document]:
        documents = self._reader.load_data(file=file, **kwargs)

        # convert Document to new base class from kotaemon
        converted_documents = [Document.from_dict(doc.to_dict()) for doc in documents]
        return converted_documents

    def run(self, file: Union[Path, str], **kwargs: Any) -> List[Document]:
        return self.load_data(file=file, **kwargs)

LIReaderMixin

Bases: BaseComponent

Base wrapper around llama-index reader

To use the LIBaseReader, you need to implement the _get_wrapped_class method to return the relevant llama-index reader class that you want to wrap.

Example:

1
2
3
4
5
6
7
```python
class DirectoryReader(LIBaseReader):
    def _get_wrapped_class(self) -> Type["BaseReader"]:
        from llama_index import SimpleDirectoryReader

        return SimpleDirectoryReader
```
Source code in libs\kotaemon\kotaemon\loaders\base.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class LIReaderMixin(BaseComponent):
    """Base wrapper around llama-index reader

    To use the LIBaseReader, you need to implement the _get_wrapped_class method to
    return the relevant llama-index reader class that you want to wrap.

    Example:

        ```python
        class DirectoryReader(LIBaseReader):
            def _get_wrapped_class(self) -> Type["BaseReader"]:
                from llama_index import SimpleDirectoryReader

                return SimpleDirectoryReader
        ```
    """

    def _get_wrapped_class(self) -> Type["LIBaseReader"]:
        raise NotImplementedError(
            "Please return the relevant llama-index class in in _get_wrapped_class"
        )

    def __init__(self, *args, **kwargs):
        self._reader_class = self._get_wrapped_class()
        self._reader = self._reader_class(*args, **kwargs)
        super().__init__()

    def __setattr__(self, name: str, value: Any) -> None:
        if name.startswith("_"):
            return super().__setattr__(name, value)

        return setattr(self._reader, name, value)

    def __getattr__(self, name: str) -> Any:
        return getattr(self._reader, name)

    def load_data(self, *args, **kwargs: Any) -> List[Document]:
        documents = self._reader.load_data(*args, **kwargs)

        # convert Document to new base class from kotaemon
        converted_documents = [Document.from_dict(doc.to_dict()) for doc in documents]
        return converted_documents

    def run(self, *args, **kwargs: Any) -> List[Document]:
        return self.load_data(*args, **kwargs)