Class MilvusV2EmbeddingStore

java.lang.Object
dev.langchain4j.store.embedding.milvus.v2.MilvusV2EmbeddingStore
All Implemented Interfaces:
EmbeddingStore<TextSegment>
public class MilvusV2EmbeddingStore extends Object implements EmbeddingStore<TextSegment>

  • Method Details

    • builder

      public static MilvusV2EmbeddingStore.Builder builder()

    • dropCollection

      public void dropCollection(String collectionName)

    • add

      public String add(Embedding embedding)
      Description copied from interface: EmbeddingStore
      Adds a given embedding to the store.
      Specified by:
      add in interface EmbeddingStore<TextSegment>
      Parameters:
      embedding - The embedding to be added to the store.
      Returns:
      The auto-generated ID associated with the added embedding.

    • add

      public void add(String id, Embedding embedding)
      Description copied from interface: EmbeddingStore
      Adds a given embedding to the store.
      Specified by:
      add in interface EmbeddingStore<TextSegment>
      Parameters:
      id - The unique identifier for the embedding to be added.
      embedding - The embedding to be added to the store.

    • add

      public String add(Embedding embedding, TextSegment textSegment)
      Description copied from interface: EmbeddingStore
      Adds a given embedding and the corresponding content that has been embedded to the store.
      Specified by:
      add in interface EmbeddingStore<TextSegment>
      Parameters:
      embedding - The embedding to be added to the store.
      textSegment - Original content that was embedded.
      Returns:
      The auto-generated ID associated with the added embedding.

    • addAll

      public List<String> addAll(List<Embedding> embeddings)
      Description copied from interface: EmbeddingStore
      Adds multiple embeddings to the store.
      Specified by:
      addAll in interface EmbeddingStore<TextSegment>
      Parameters:
      embeddings - A list of embeddings to be added to the store.
      Returns:
      A list of auto-generated IDs associated with the added embeddings.

    • search

      public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)
      Description copied from interface: EmbeddingStore
      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.
      Specified by:
      search in interface EmbeddingStore<TextSegment>
      Parameters:
      request - A request to search in an EmbeddingStore. Contains all search criteria.
      Returns:
      An EmbeddingSearchResult containing all found Embeddings.

    • search

      public EmbeddingSearchResult<TextSegment> search(MilvusV2EmbeddingSearchRequest embeddingSearchRequest)

    • addAll

      public void addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> textSegments)
      Description copied from interface: EmbeddingStore
      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.

      Specified by:
      addAll in interface EmbeddingStore<TextSegment>
      Parameters:
      ids - A list of IDs associated with the added embeddings.
      embeddings - A list of embeddings to be added to the store.
      textSegments - A list of original contents that were embedded, or null if they were not provided.

    • addAllSparse

      public void addAllSparse(List<String> ids, List<SparseEmbedding> embeddings, List<TextSegment> textSegments)

    • addAllHybrid

      public void addAllHybrid(List<String> ids, List<Embedding> denseEmbeddings, List<SparseEmbedding> sparseEmbeddings, List<TextSegment> textSegments)

    • removeAll

      public void removeAll(Collection<String> ids)
      Removes a single embedding from the store by ID.

      CAUTION

      • Deleted entities can still be retrieved immediately after the deletion if the consistency level is set lower than Strong
      • Entities deleted beyond the pre-specified span of time for Time Travel cannot be retrieved again.
      • Frequent deletion operations will impact the system performance.
      • Before deleting entities by comlpex boolean expressions, make sure the collection has been loaded.
      • Deleting entities by complex boolean expressions is not an atomic operation. Therefore, if it fails halfway through, some data may still be deleted.
      • Deleting entities by complex boolean expressions is supported only when the consistency is set to Bounded. For details, see Consistency
      Specified by:
      removeAll in interface EmbeddingStore<TextSegment>
      Parameters:
      ids - A collection of unique IDs of the embeddings to be removed.
      Since:
      Milvus version 2.3.x

    • removeAll

      public void removeAll(Filter filter)
      Removes all embeddings that match the specified Filter from the store.

      CAUTION

      • Deleted entities can still be retrieved immediately after the deletion if the consistency level is set lower than Strong
      • Entities deleted beyond the pre-specified span of time for Time Travel cannot be retrieved again.
      • Frequent deletion operations will impact the system performance.
      • Before deleting entities by comlpex boolean expressions, make sure the collection has been loaded.
      • Deleting entities by complex boolean expressions is not an atomic operation. Therefore, if it fails halfway through, some data may still be deleted.
      • Deleting entities by complex boolean expressions is supported only when the consistency is set to Bounded. For details, see Consistency
      Specified by:
      removeAll in interface EmbeddingStore<TextSegment>
      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.
      Since:
      Milvus version 2.3.x

    • removeAll

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

      CAUTION

      • Deleted entities can still be retrieved immediately after the deletion if the consistency level is set lower than Strong
      • Entities deleted beyond the pre-specified span of time for Time Travel cannot be retrieved again.
      • Frequent deletion operations will impact the system performance.
      • Before deleting entities by comlpex boolean expressions, make sure the collection has been loaded.
      • Deleting entities by complex boolean expressions is not an atomic operation. Therefore, if it fails halfway through, some data may still be deleted.
      • Deleting entities by complex boolean expressions is supported only when the consistency is set to Bounded. For details, see Consistency
      Specified by:
      removeAll in interface EmbeddingStore<TextSegment>
      Since:
      Milvus version 2.3.x