Package com.google.genkit.plugins.chroma

Class ChromaPlugin

java.lang.Object

com.google.genkit.plugins.chroma.ChromaPlugin

All Implemented Interfaces:

Plugin

public final class ChromaPlugin
extends Object
implements Plugin

Chroma vector database plugin for Genkit.

Registers a retriever and indexer named chroma/<collectionName> for each configured collection, talking to a Chroma server over its v2 REST API.

Example usage:

 Genkit genkit = Genkit.builder()
     .plugin(GoogleGenAIPlugin.create(apiKey))
     .plugin(
         ChromaPlugin.builder()
             .url("http://localhost:8000")
             .addCollection(
                 ChromaCollectionConfig.builder()
                     .collectionName("films")
                     .embedderName("googleai/gemini-embedding-001")
                     .build())
             .build())
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ChromaPlugin.Builder	Builder for ChromaPlugin.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DATABASE	Default Chroma database.
static final String	DEFAULT_TENANT	Default Chroma tenant.
static final String	DEFAULT_URL	Default Chroma server URL.
static final String	PLUGIN_NAME	The plugin name; used as the chroma/... action prefix.

Method Summary

Modifier and Type	Method	Description
static ChromaPlugin.Builder	builder()	Creates a new builder.
String	getName()	Returns the unique identifier for the plugin.
List<Action<?,?,?>>	init()	Initializes the plugin.
List<Action<?,?,?>>	init(Registry registry)	Initializes the plugin with access to the registry.

Methods inherited from class java.lang.Object

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

Field Details

PLUGIN_NAME

public static final String PLUGIN_NAME

The plugin name; used as the chroma/... action prefix.

See Also:

• Constant Field Values

DEFAULT_TENANT

public static final String DEFAULT_TENANT

Default Chroma tenant.

See Also:

• Constant Field Values

DEFAULT_DATABASE

public static final String DEFAULT_DATABASE

Default Chroma database.

See Also:

• Constant Field Values

DEFAULT_URL

public static final String DEFAULT_URL

Default Chroma server URL.

See Also:

• Constant Field Values

Method Details

builder

public static ChromaPlugin.Builder builder()

Creates a new builder.

Returns:

a new builder

getName

public String getName()

Description copied from interface: Plugin

Returns the unique identifier for the plugin. This name is used for registration and lookup.

Specified by:

getName in interface Plugin

Returns:

the plugin name

init

public List<Action<?,?,?>> init()

Description copied from interface: Plugin

Initializes the plugin. This method is called once during Genkit initialization. The plugin should return a list of actions that it provides.

Specified by:

init in interface Plugin

Returns:

list of actions provided by this plugin

init

public List<Action<?,?,?>> init(Registry registry)

Description copied from interface: Plugin

Initializes the plugin with access to the registry. This method is called once during Genkit initialization. The plugin should return a list of actions that it provides.

Override this method instead of Plugin.init() when your plugin needs to resolve dependencies from the registry (e.g., embedders, models).

Specified by:

init in interface Plugin

Parameters:

registry - the Genkit registry for resolving dependencies

Returns:

list of actions provided by this plugin