Interface EmbeddingStore<Embedded>

Type Parameters:
Embedded - The class of the object that has been embedded. Typically, this is TextSegment.
All Known Implementing Classes:
AbstractAzureAiSearchEmbeddingStore, AbstractAzureCosmosDBNoSqlEmbeddingStore, AbstractElasticsearchEmbeddingStore, AstraDbEmbeddingStore, AzureAiSearchContentRetriever, AzureAiSearchEmbeddingStore, AzureCosmosDbMongoVCoreEmbeddingStore, AzureCosmosDBNoSqlContentRetriever, AzureCosmosDbNoSqlEmbeddingStore, CassandraEmbeddingStore, ChromaEmbeddingStore, CoherenceEmbeddingStore, CouchbaseEmbeddingStore, ElasticsearchContentRetriever, ElasticsearchEmbeddingStore, HibernateEmbeddingStore, InfinispanEmbeddingStore, InMemoryEmbeddingStore, MariaDbEmbeddingStore, MilvusEmbeddingStore, MilvusV2EmbeddingStore, MongoDbEmbeddingStore, OpenSearchEmbeddingStore, OracleEmbeddingStore, PgVectorEmbeddingStore, PineconeEmbeddingStore, QdrantEmbeddingStore, TablestoreEmbeddingStore, VespaEmbeddingStore, WeaviateEmbeddingStore
public interface EmbeddingStore<Embedded>
Represents a store for embeddings, also known as a vector database.

  • Method Details

    • add

      String add(Embedding embedding)
      Adds a given embedding to the store.
      Parameters:
      embedding - The embedding to be added to the store.
      Returns:
      The auto-generated ID associated with the added embedding.

    • add

      void add(String id, Embedding embedding)
      Adds a given embedding to the store.
      Parameters:
      id - The unique identifier for the embedding to be added.
      embedding - The embedding to be added to the store.

    • add

      String add(Embedding embedding, Embedded embedded)
      Adds a given embedding and the corresponding content that has been embedded to the store.
      Parameters:
      embedding - The embedding to be added to the store.
      embedded - Original content that was embedded.
      Returns:
      The auto-generated ID associated with the added embedding.

    • addAll

      List<String> addAll(List<Embedding> embeddings)
      Adds multiple embeddings to the store.
      Parameters:
      embeddings - A list of embeddings to be added to the store.
      Returns:
      A list of auto-generated IDs associated with the added embeddings.

    • addAll

      default List<String> addAll(List<Embedding> embeddings, List<Embedded> embedded)
      Adds multiple embeddings and their corresponding contents that have been embedded to the store.
      Parameters:
      embeddings - A list of embeddings to be added to the store.
      embedded - A list of original contents that were embedded.
      Returns:
      A list of auto-generated IDs associated with the added embeddings.

    • generateIds

      default List<String> generateIds(int n)
      Generates list of UUID strings
      Parameters:
      n - - dimension of list

    • addAll

      default void addAll(List<String> ids, List<Embedding> embeddings, List<Embedded> embedded)
      Adds multiple embeddings and their corresponding contents that have been embedded to the store.

      The lists are positional: the i-th ID, the i-th embedding and the i-th embedded content belong together. ids and embeddings must therefore have the same size, and embedded, when provided, must have that size as well. A null list of IDs or embeddings counts as an empty list, so passing embeddings without IDs (or the other way around) is a size mismatch, not an empty input. ValidationUtils.ensureConsistentSizes(List, List, List) implements these rules and should be used by implementations.

      Passing no embeddings at all (an empty or null embeddings together with an empty or null ids, and no embedded contents) is a no-op: nothing is stored and no exception is thrown.

      Parameters:
      ids - A list of IDs associated with the added embeddings.
      embeddings - A list of embeddings to be added to the store.
      embedded - A list of original contents that were embedded, or null if they were not provided.
      Throws:
      IllegalArgumentException - if the sizes of the given lists do not match.

    • remove

      default void remove(String id)
      Removes a single embedding from the store by ID.
      Parameters:
      id - The unique ID of the embedding to be removed.

    • removeAll

      default void removeAll(Collection<String> ids)
      Removes all embeddings that match the specified IDs from the store.

      Having nothing to remove is a no-op: an empty or null collection of IDs leaves the store unchanged and throws nothing, in the same way that adding no embeddings stores nothing.

      Parameters:
      ids - A collection of unique IDs of the embeddings to be removed.

    • removeAll

      default void removeAll(Filter filter)
      Removes all embeddings that match the specified Filter from the store.
      Parameters:
      filter - The filter to be applied to the Metadata of the TextSegment during removal. Only embeddings whose TextSegment's Metadata match the Filter will be removed.

    • removeAll

      default void removeAll()
      Removes all embeddings from the store.

    • search

      EmbeddingSearchResult<Embedded> search(EmbeddingSearchRequest request)
      Searches for the most similar (closest in the embedding space) Embeddings.
      All search criteria are defined inside the EmbeddingSearchRequest.
      EmbeddingSearchRequest.filter() can be used to filter by various metadata entries (e.g., user/memory ID). Please note that not all EmbeddingStore implementations support Filtering.
      Parameters:
      request - A request to search in an EmbeddingStore. Contains all search criteria.
      Returns:
      An EmbeddingSearchResult containing all found Embeddings.

    • addListener

      @Experimental default EmbeddingStore<Embedded> addListener(EmbeddingStoreListener listener)
      Wraps this EmbeddingStore with a listening store that dispatches events to the provided listener.

      This is a non-breaking convenience method to add observability to any EmbeddingStore implementation.

      Parameters:
      listener - The listener to add.
      Returns:
      An observing EmbeddingStore that will dispatch events to the provided listener.
      Since:
      1.11.0

    • addListeners

      @Experimental default EmbeddingStore<Embedded> addListeners(List<EmbeddingStoreListener> listeners)
      Wraps this EmbeddingStore with a listening store that dispatches events to the provided listeners.

      Listeners are called in the order of iteration.

      Parameters:
      listeners - The listeners to add.
      Returns:
      An observing EmbeddingStore that will dispatch events to the provided listeners.
      Since:
      1.11.0