Package com.google.genkit.plugins.qdrant

Class QdrantCollectionConfig

java.lang.Object

com.google.genkit.plugins.qdrant.QdrantCollectionConfig

public final class QdrantCollectionConfig
extends Object

Configuration for a single Qdrant collection managed by QdrantPlugin.

Each config registers a retriever and indexer named qdrant/<collectionName>.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	QdrantCollectionConfig.Builder	Builder for QdrantCollectionConfig.
static enum	QdrantCollectionConfig.Distance	Distance function used by the Qdrant collection.

Method Summary

Modifier and Type	Method	Description
static QdrantCollectionConfig.Builder	builder()	Creates a new builder.
Map<String,Object>	getAdditionalMetadata()	Returns additional metadata merged into every indexed document's payload.
String	getCollectionName()	Returns the Qdrant collection name.
int	getDimension()	Returns the embedding dimension (default 768).
QdrantCollectionConfig.Distance	getDistance()	Returns the distance function (default QdrantCollectionConfig.Distance.COSINE).
String	getEmbedderName()	Returns the name of the embedder used to vectorize documents and queries.
String	getTextPayloadKey()	Returns the payload key that stores the document text (default text).
boolean	isCreateCollectionIfNotExists()	Returns whether to create the collection on first use if it does not exist (default true).

Methods inherited from class java.lang.Object

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

Method Details

getCollectionName

public String getCollectionName()

Returns the Qdrant collection name.

Returns:

the collection name

getEmbedderName

public String getEmbedderName()

Returns the name of the embedder used to vectorize documents and queries.

Returns:

the embedder name

getDimension

public int getDimension()

Returns the embedding dimension (default 768).

Returns:

the embedding dimension

getDistance

public QdrantCollectionConfig.Distance getDistance()

Returns the distance function (default QdrantCollectionConfig.Distance.COSINE).

Returns:

the distance function

getTextPayloadKey

public String getTextPayloadKey()

Returns the payload key that stores the document text (default text).

Returns:

the text payload key

isCreateCollectionIfNotExists

public boolean isCreateCollectionIfNotExists()

Returns whether to create the collection on first use if it does not exist (default true).

Returns:

true if the collection should be created when missing

getAdditionalMetadata

public Map<String,Object> getAdditionalMetadata()

Returns additional metadata merged into every indexed document's payload.

Returns:

the additional metadata

builder

public static QdrantCollectionConfig.Builder builder()

Creates a new builder.

Returns:

a new builder