Package dev.langchain4j.store.embedding.qdrant

Class QdrantEmbeddingStore

java.lang.Object
dev.langchain4j.store.embedding.qdrant.QdrantEmbeddingStore
All Implemented Interfaces:
EmbeddingStore<TextSegment>
public class QdrantEmbeddingStore extends Object implements EmbeddingStore<TextSegment>
Represents a Qdrant collection as an embedding store. With support for storing Metadata.

  • Constructor Details

    • QdrantEmbeddingStore

      public QdrantEmbeddingStore(String collectionName, String host, int port, boolean useTls, String payloadTextKey, @Nullable String apiKey)
      Parameters:
      collectionName - The name of the Qdrant collection.
      host - The host of the Qdrant instance.
      port - The GRPC port of the Qdrant instance.
      useTls - Whether to use TLS(HTTPS).
      payloadTextKey - The field name of the text segment in the Qdrant payload.
      apiKey - The Qdrant API key to authenticate with.

    • QdrantEmbeddingStore

      public QdrantEmbeddingStore(io.qdrant.client.QdrantClient client, String collectionName, String payloadTextKey)
      Parameters:
      client - A Qdrant client instance.
      collectionName - The name of the Qdrant collection.
      payloadTextKey - The field name of the text segment in the Qdrant payload.

  • Method Details

    • 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.

    • addAll

      public void addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> textSegments) throws RuntimeException
      Description copied from interface: EmbeddingStore
      Adds multiple embeddings and their corresponding contents that have been embedded to the store.
      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.
      Throws:
      RuntimeException

    • remove

      public void remove(String id)
      Description copied from interface: EmbeddingStore
      Removes a single embedding from the store by ID.
      Specified by:
      remove in interface EmbeddingStore<TextSegment>
      Parameters:
      id - The unique ID of the embedding to be removed.

    • removeAll

      public void removeAll(Collection<String> ids)
      Description copied from interface: EmbeddingStore
      Removes all embeddings that match the specified IDs from the store.
      Specified by:
      removeAll in interface EmbeddingStore<TextSegment>
      Parameters:
      ids - A collection of unique IDs of the embeddings to be removed.

    • removeAll

      public void removeAll(Filter filter)
      Description copied from interface: EmbeddingStore
      Removes all embeddings that match the specified Filter from the store.
      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.

    • removeAll

      public void removeAll()
      Description copied from interface: EmbeddingStore
      Removes all embeddings from the store.
      Specified by:
      removeAll in interface EmbeddingStore<TextSegment>

    • 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.

    • findRelevant

      public List<EmbeddingMatch<TextSegment>> findRelevant(Embedding referenceEmbedding, int maxResults, double minScore)
      Description copied from interface: EmbeddingStore
      Finds the most relevant (closest in space) embeddings to the provided reference embedding.
      Specified by:
      findRelevant in interface EmbeddingStore<TextSegment>
      Parameters:
      referenceEmbedding - The embedding used as a reference. Returned embeddings should be relevant (closest) to this one.
      maxResults - The maximum number of embeddings to be returned.
      minScore - The minimum relevance score, ranging from 0 to 1 (inclusive). Only embeddings with a score of this value or higher will be returned.
      Returns:
      A list of embedding matches. Each embedding match includes a relevance score (derivative of cosine distance), ranging from 0 (not relevant) to 1 (highly relevant).

    • clearStore

      public void clearStore()
      Deletes all points from the Qdrant collection.

    • close

      public void close()
      Closes the underlying GRPC client.

    • builder

      public static QdrantEmbeddingStore.Builder builder()