Class ChromaEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.chroma.ChromaEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class ChromaEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

Represents a store for embeddings using the Chroma backend.

Collections created by this store use cosine distance. When an already existing collection is used, the distance metric it was created with is detected and EmbeddingMatch.score() is derived from it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChromaEmbeddingStore.Builder

Constructor Summary

Constructors

Constructor	Description
ChromaEmbeddingStore(ChromaEmbeddingStore.Builder builder)	Initializes a new instance of ChromaEmbeddingStore with the specified parameters.
ChromaEmbeddingStore(String baseUrl, String collectionName, Duration timeout, boolean logRequests, boolean logResponses)	Deprecated, for removal: This API element is subject to removal in a future version. Only works with the V1 API, use the ChromaEmbeddingStore(Builder) constructor instead.

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.
void	addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> textSegments)	Adds multiple embeddings and their corresponding contents that have been embedded to the store.
static ChromaEmbeddingStore.Builder	builder()
void	removeAll()	Removes all embeddings from the store.
void	removeAll(Filter filter)	Removes all embeddings that match the specified Filter from the store.
void	removeAll(Collection<String> ids)	Removes all embeddings that match the specified IDs from the store.
EmbeddingSearchResult<TextSegment>	search(EmbeddingSearchRequest request)	Searches for the most similar (closest in the embedding space) Embeddings.

Methods inherited from class Object

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

Methods inherited from interface EmbeddingStore

addAll, addListener, addListeners, generateIds, remove

Constructor Details

ChromaEmbeddingStore

public ChromaEmbeddingStore(ChromaEmbeddingStore.Builder builder)

Initializes a new instance of ChromaEmbeddingStore with the specified parameters.

Parameters:

builder - The builder instance of ChromaEmbeddingStore.Builder.

ChromaEmbeddingStore

@Deprecated(since="1.7.0-beta13",
            forRemoval=true)
public ChromaEmbeddingStore(String baseUrl,
 String collectionName,
 Duration timeout,
 boolean logRequests,
 boolean logResponses)

Deprecated, for removal: This API element is subject to removal in a future version.

Only works with the V1 API, use the ChromaEmbeddingStore(Builder) constructor instead.

Initializes a new instance of ChromaEmbeddingStore (V1 API) with the specified parameters.

Parameters:

baseUrl - The base URL of the Chroma service.

collectionName - The name of the collection in the Chroma service. If not specified, "default" will be used.

timeout - The timeout duration for the Chroma client. If not specified, 5 seconds will be used.

logRequests - If true, requests to the Chroma service are logged.

logResponses - If true, responses from the Chroma service are logged.

Method Details

builder

public static ChromaEmbeddingStore.Builder builder()

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)

Description copied from interface: EmbeddingStore

Adds multiple embeddings and their corresponding contents that have been embedded to the store.

The lists are positional: the i-th ID, the i-th embedding and the i-th embedded content belong together. ids and embeddings must therefore have the same size, and embedded, when provided, must have that size as well. A null list of IDs or embeddings counts as an empty list, so passing embeddings without IDs (or the other way around) is a size mismatch, not an empty input. ValidationUtils.ensureConsistentSizes(List, List, List) implements these rules and should be used by implementations.

Passing no embeddings at all (an empty or null embeddings together with an empty or null ids, and no embedded contents) is a no-op: nothing is stored and no exception is thrown.

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, or null if they were not provided.

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.

removeAll

public void removeAll(Collection<String> ids)

Description copied from interface: EmbeddingStore

Removes all embeddings that match the specified IDs from the store.

Having nothing to remove is a no-op: an empty or null collection of IDs leaves the store unchanged and throws nothing, in the same way that adding no embeddings stores nothing.

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>