Class VectorStore

finagent/memory/base.py:14–55

Interface for vector store.

Image = Any

class VectorStore(abc.ABC):
    """Interface for vector store."""

    @abc.abstractmethod
    def add_embeddings(
        self,
        *args: Any,
        **kwargs: Any,
    ) -> None:
        """Add embeddings to the vectorstore.

        Args:
            keys: list of metadatas associated with the embedding.
            embeddings: Iterable of embeddings to add to the vectorstore.
            kwargs: vectorstore specific parameters
        """

    @abc.abstractmethod
    def delete(self,
               *args: Any,
               **kwargs: Any,) -> bool:
        """Delete by keys.

        Args:
            keys: List of keys to delete.
            **kwargs: Other keyword arguments that subclasses might use.

        Returns:
            bool: True if deletion is successful,
            False otherwise, None if not implemented.
        """

    @abc.abstractmethod
    def similarity_search(
        self,
        *args: Any,
        **kwargs: Any,
    ) -> List[Tuple[str, float]]:
        """Return keys most similar to query."""

    def save_local(self, memory_path = None) -> None:
        """Save FAISS index and index_to_key to disk."""


class BaseMemory: