Package com.google.genkit.plugins.chroma

Class ChromaCollectionConfig

java.lang.Object

com.google.genkit.plugins.chroma.ChromaCollectionConfig

public final class ChromaCollectionConfig
extends Object

Configuration for a single Chroma collection managed by ChromaPlugin.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ChromaCollectionConfig.Builder	Builder for ChromaCollectionConfig.
static enum	ChromaCollectionConfig.Distance	Distance function used by the Chroma HNSW index.

Method Summary

Modifier and Type	Method	Description
static ChromaCollectionConfig.Builder	builder()	Creates a new builder.
Map<String,Object>	getAdditionalMetadata()	Returns additional metadata merged into every indexed document.
String	getCollectionName()	Returns the Chroma collection name.
ChromaCollectionConfig.Distance	getDistance()	Returns the distance function (default ChromaCollectionConfig.Distance.COSINE).
String	getEmbedderName()	Returns the name of the embedder used to vectorize documents and queries.
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 Chroma 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

getDistance

public ChromaCollectionConfig.Distance getDistance()

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

Returns:

the distance function

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.

Returns:

the additional metadata

builder

public static ChromaCollectionConfig.Builder builder()

Creates a new builder.

Returns:

a new builder