USearch

Returns a string representing the type of vector store, which subclasses must implement to identify their specific vector storage type.

Method that adds documents to the usearch index. It generates embeddings for the documents and adds them to the index.

Method that adds vectors to the usearch index. It also updates the mapping between vector IDs and document IDs.

Creates a VectorStoreRetriever instance with flexible configuration options.

Deletes documents from the vector store based on the specified parameters.

Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.

Method that saves the usearch index and the document store to disk.

Searches for documents similar to a text query by embedding the query and performing a similarity search on the resulting vector.

Method that performs a similarity search in the usearch index. It returns the k most similar documents to a given query vector, along with their similarity scores.

Searches for documents similar to a text query by embedding the query, and returns results with similarity scores.

Static method that creates a new USearch instance from a list of documents. It generates embeddings for the documents and adds them to the usearch index.

Static method that creates a new USearch instance from a list of texts. It generates embeddings for the texts and adds them to the usearch index.

The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Loads a vector store instance from the specified directory, using the provided embeddings to ensure compatibility.

This static method reconstructs a SaveableVectorStore from previously saved data. Implementations should interpret the saved data format to recreate the vector store instance.