llama-index

1
"""Simple reader that turns an iterable of strings into a list of Documents."""
2

3
from typing import List
4

5
from llama_index.legacy.readers.base import BasePydanticReader
6
from llama_index.legacy.schema import Document
7

8

9
class StringIterableReader(BasePydanticReader):
10
    """String Iterable Reader.
11

12
    Gets a list of documents, given an iterable (e.g. list) of strings.
13

14
    Example:
15
        .. code-block:: python
16

17
            from llama_index.legacy import StringIterableReader, TreeIndex
18

19
            documents = StringIterableReader().load_data(
20
                texts=["I went to the store", "I bought an apple"]
21
            )
22
            index = TreeIndex.from_documents(documents)
23
            query_engine = index.as_query_engine()
24
            query_engine.query("what did I buy?")
25

26
            # response should be something like "You bought an apple."
27
    """
28

29
    is_remote: bool = False
30

31
    @classmethod
32
    def class_name(cls) -> str:
33
        return "StringIterableReader"
34

35
    def load_data(self, texts: List[str]) -> List[Document]:
36
        """Load the data."""
37
        results = []
38
        for text in texts:
39
            results.append(Document(text=text))
40

41
        return results
42