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. Always uses cosine distance as the distance metric.

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)
String	add(Embedding embedding, TextSegment textSegment)
void	add(String id, Embedding embedding)
List<String>	addAll(List<Embedding> embeddings)
void	addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> textSegments)
static ChromaEmbeddingStore.Builder	builder()
void	removeAll()
void	removeAll(Filter filter)
void	removeAll(Collection<String> ids)
EmbeddingSearchResult<TextSegment>	search(EmbeddingSearchRequest request)

Methods inherited from class Object

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

Methods inherited from interface EmbeddingStore

addAll, 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)

Specified by:

add in interface EmbeddingStore<TextSegment>

add

public void add(String id,
 Embedding embedding)

Specified by:

add in interface EmbeddingStore<TextSegment>

add

public String add(Embedding embedding,
 TextSegment textSegment)

Specified by:

add in interface EmbeddingStore<TextSegment>

addAll

public List<String> addAll(List<Embedding> embeddings)

Specified by:

addAll in interface EmbeddingStore<TextSegment>

addAll

public void addAll(List<String> ids,
 List<Embedding> embeddings,
 List<TextSegment> textSegments)

Specified by:

addAll in interface EmbeddingStore<TextSegment>

search

public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)

Specified by:

search in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll(Collection<String> ids)

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll(Filter filter)

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll()

Specified by:

removeAll in interface EmbeddingStore<TextSegment>