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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QdrantEmbeddingStore.Builder

Constructor Summary

Constructors

Constructor	Description
QdrantEmbeddingStore(io.qdrant.client.QdrantClient client, String collectionName, String payloadTextKey)
QdrantEmbeddingStore(String collectionName, String host, int port, boolean useTls, String payloadTextKey, String apiKey)

Method Summary

Modifier and Type	Method	Description
String	add(Embedding embedding)	Adds a given embedding to the store.
String	add(Embedding embedding, TextSegment textSegment)	Adds a given embedding and the corresponding content that has been embedded to the store.
void	add(String id, Embedding embedding)	Adds a given embedding to the store.
List<String>	addAll(List<Embedding> embeddings)	Adds multiple embeddings to the store.
List<String>	addAll(List<Embedding> embeddings, List<TextSegment> textSegments)	Adds multiple embeddings and their corresponding contents that have been embedded to the store.
static QdrantEmbeddingStore.Builder	builder()
void	clearStore()	Deletes all points from the Qdrant collection.
void	close()	Closes the underlying GRPC client.
List<EmbeddingMatch<TextSegment>>	findRelevant(Embedding referenceEmbedding, int maxResults, double minScore)	Finds the most relevant (closest in space) embeddings to the provided reference embedding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.langchain4j.store.embedding.EmbeddingStore

findRelevant, findRelevant, findRelevant, remove, removeAll, removeAll, removeAll, search

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 List<String> addAll(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.

Specified by:

addAll in interface EmbeddingStore<TextSegment>

Parameters:

embeddings - A list of embeddings to be added to the store.

textSegments - A list of original contents that were embedded.

Returns:

A list of auto-generated IDs associated with the added 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()