Simple

SimpleDocumentStore

Bases: KVDocumentStore

Simple Document (Node) store.

An in-memory store for Document and Node objects.

Parameters:

Name	Type	Description	Default
simple_kvstore	SimpleKVStore	simple key-value store	None
namespace	str	namespace for the docstore	None

Source code in llama-index-core/llama_index/core/storage/docstore/simple_docstore.py

class SimpleDocumentStore(KVDocumentStore):
    """Simple Document (Node) store.

    An in-memory store for Document and Node objects.

    Args:
        simple_kvstore (SimpleKVStore): simple key-value store
        namespace (str): namespace for the docstore

    """

    def __init__(
        self,
        simple_kvstore: Optional[SimpleKVStore] = None,
        namespace: Optional[str] = None,
        batch_size: int = DEFAULT_BATCH_SIZE,
    ) -> None:
        """Init a SimpleDocumentStore."""
        simple_kvstore = simple_kvstore or SimpleKVStore()
        super().__init__(simple_kvstore, namespace=namespace, batch_size=batch_size)

    @classmethod
    def from_persist_dir(
        cls,
        persist_dir: str = DEFAULT_PERSIST_DIR,
        namespace: Optional[str] = None,
        fs: Optional[fsspec.AbstractFileSystem] = None,
    ) -> "SimpleDocumentStore":
        """Create a SimpleDocumentStore from a persist directory.

        Args:
            persist_dir (str): directory to persist the store
            namespace (Optional[str]): namespace for the docstore
            fs (Optional[fsspec.AbstractFileSystem]): filesystem to use

        """
        if fs is not None:
            persist_path = concat_dirs(persist_dir, DEFAULT_PERSIST_FNAME)
        else:
            persist_path = os.path.join(persist_dir, DEFAULT_PERSIST_FNAME)
        return cls.from_persist_path(persist_path, namespace=namespace, fs=fs)

    @classmethod
    def from_persist_path(
        cls,
        persist_path: str,
        namespace: Optional[str] = None,
        fs: Optional[fsspec.AbstractFileSystem] = None,
    ) -> "SimpleDocumentStore":
        """Create a SimpleDocumentStore from a persist path.

        Args:
            persist_path (str): Path to persist the store
            namespace (Optional[str]): namespace for the docstore
            fs (Optional[fsspec.AbstractFileSystem]): filesystem to use

        """
        simple_kvstore = SimpleKVStore.from_persist_path(persist_path, fs=fs)
        return cls(simple_kvstore, namespace)

    def persist(
        self,
        persist_path: str = DEFAULT_PERSIST_PATH,
        fs: Optional[fsspec.AbstractFileSystem] = None,
    ) -> None:
        """Persist the store."""
        if isinstance(self._kvstore, BaseInMemoryKVStore):
            self._kvstore.persist(persist_path, fs=fs)

    @classmethod
    def from_dict(
        cls, save_dict: dict, namespace: Optional[str] = None
    ) -> "SimpleDocumentStore":
        simple_kvstore = SimpleKVStore.from_dict(save_dict)
        return cls(simple_kvstore, namespace)

    def to_dict(self) -> dict:
        assert isinstance(self._kvstore, SimpleKVStore)
        return self._kvstore.to_dict()

from_persist_dir classmethod

from_persist_dir(persist_dir: str = DEFAULT_PERSIST_DIR, namespace: Optional[str] = None, fs: Optional[AbstractFileSystem] = None) -> SimpleDocumentStore

Create a SimpleDocumentStore from a persist directory.

Parameters:

Name	Type	Description	Default
persist_dir	str	directory to persist the store	DEFAULT_PERSIST_DIR
namespace	Optional[str]	namespace for the docstore	None
fs	Optional[AbstractFileSystem]	filesystem to use	None

Source code in llama-index-core/llama_index/core/storage/docstore/simple_docstore.py

@classmethod
def from_persist_dir(
    cls,
    persist_dir: str = DEFAULT_PERSIST_DIR,
    namespace: Optional[str] = None,
    fs: Optional[fsspec.AbstractFileSystem] = None,
) -> "SimpleDocumentStore":
    """Create a SimpleDocumentStore from a persist directory.

    Args:
        persist_dir (str): directory to persist the store
        namespace (Optional[str]): namespace for the docstore
        fs (Optional[fsspec.AbstractFileSystem]): filesystem to use

    """
    if fs is not None:
        persist_path = concat_dirs(persist_dir, DEFAULT_PERSIST_FNAME)
    else:
        persist_path = os.path.join(persist_dir, DEFAULT_PERSIST_FNAME)
    return cls.from_persist_path(persist_path, namespace=namespace, fs=fs)

from_persist_path classmethod

from_persist_path(persist_path: str, namespace: Optional[str] = None, fs: Optional[AbstractFileSystem] = None) -> SimpleDocumentStore

Create a SimpleDocumentStore from a persist path.

Parameters:

Name	Type	Description	Default
persist_path	str	Path to persist the store	required
namespace	Optional[str]	namespace for the docstore	None
fs	Optional[AbstractFileSystem]	filesystem to use	None

Source code in llama-index-core/llama_index/core/storage/docstore/simple_docstore.py

@classmethod
def from_persist_path(
    cls,
    persist_path: str,
    namespace: Optional[str] = None,
    fs: Optional[fsspec.AbstractFileSystem] = None,
) -> "SimpleDocumentStore":
    """Create a SimpleDocumentStore from a persist path.

    Args:
        persist_path (str): Path to persist the store
        namespace (Optional[str]): namespace for the docstore
        fs (Optional[fsspec.AbstractFileSystem]): filesystem to use

    """
    simple_kvstore = SimpleKVStore.from_persist_path(persist_path, fs=fs)
    return cls(simple_kvstore, namespace)

persist

persist(persist_path: str = DEFAULT_PERSIST_PATH, fs: Optional[AbstractFileSystem] = None) -> None

Persist the store.

Source code in llama-index-core/llama_index/core/storage/docstore/simple_docstore.py

def persist(
    self,
    persist_path: str = DEFAULT_PERSIST_PATH,
    fs: Optional[fsspec.AbstractFileSystem] = None,
) -> None:
    """Persist the store."""
    if isinstance(self._kvstore, BaseInMemoryKVStore):
        self._kvstore.persist(persist_path, fs=fs)