Class ChromaEmbeddingStore
java.lang.Object
dev.langchain4j.store.embedding.chroma.ChromaEmbeddingStore
- All Implemented Interfaces:
EmbeddingStore<TextSegment>
Represents a store for embeddings using the Chroma backend.
Always uses cosine distance as the distance metric.
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionChromaEmbeddingStore
(String baseUrl, String collectionName, Duration timeout, boolean logRequests, boolean logResponses) Initializes a new instance of ChromaEmbeddingStore with the specified parameters. -
Method Summary
Modifier and TypeMethodDescriptionAdds a given embedding to the store.add
(Embedding embedding, TextSegment textSegment) Adds a given embedding and the corresponding content that has been embedded to the store.void
Adds a given embedding to the store.Adds multiple embeddings to the store.addAll
(List<Embedding> embeddings, List<TextSegment> textSegments) Adds multiple embeddings and their corresponding contents that have been embedded to the store.static ChromaEmbeddingStore.Builder
builder()
findRelevant
(Embedding referenceEmbedding, int maxResults, double minScore) Finds the most relevant (closest in space) embeddings to the provided reference embedding.void
Removes all embeddings from the store.void
Removes all embeddings that match the specifiedFilter
from the store.void
removeAll
(Collection<String> ids) Removes all embeddings that match the specified IDs from the store.search
(EmbeddingSearchRequest request) Searches for the most similar (closest in the embedding space)Embedding
s.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface dev.langchain4j.store.embedding.EmbeddingStore
findRelevant, findRelevant, findRelevant, remove
-
Constructor Details
-
ChromaEmbeddingStore
public ChromaEmbeddingStore(String baseUrl, String collectionName, Duration timeout, boolean logRequests, boolean logResponses) Initializes a new instance of ChromaEmbeddingStore 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
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embedding
- The embedding to be added to the store.- Returns:
- The auto-generated ID associated with the added embedding.
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
id
- The unique identifier for the embedding to be added.embedding
- The embedding to be added to the store.
-
add
Description copied from interface:EmbeddingStore
Adds a given embedding and the corresponding content that has been embedded to the store.- Specified by:
add
in interfaceEmbeddingStore<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
Description copied from interface:EmbeddingStore
Adds multiple embeddings to the store.- Specified by:
addAll
in interfaceEmbeddingStore<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
Description copied from interface:EmbeddingStore
Adds multiple embeddings and their corresponding contents that have been embedded to the store.- Specified by:
addAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embeddings
- A list of embeddings to be added to the store.textSegments
- A list of original contents that were embedded.- Returns:
- A list of auto-generated IDs associated with the added embeddings.
-
findRelevant
public List<EmbeddingMatch<TextSegment>> findRelevant(Embedding referenceEmbedding, int maxResults, double minScore) Description copied from interface:EmbeddingStore
Finds the most relevant (closest in space) embeddings to the provided reference embedding.- Specified by:
findRelevant
in interfaceEmbeddingStore<TextSegment>
- Parameters:
referenceEmbedding
- The embedding used as a reference. Returned embeddings should be relevant (closest) to this one.maxResults
- The maximum number of embeddings to be returned.minScore
- The minimum relevance score, ranging from 0 to 1 (inclusive). Only embeddings with a score of this value or higher will be returned.- Returns:
- A list of embedding matches. Each embedding match includes a relevance score (derivative of cosine distance), ranging from 0 (not relevant) to 1 (highly relevant).
-
search
Description copied from interface:EmbeddingStore
Searches for the most similar (closest in the embedding space)Embedding
s.
All search criteria are defined inside theEmbeddingSearchRequest
.
EmbeddingSearchRequest.filter()
can be used to filter by user/memory ID. Please note that not allEmbeddingStore
implementations supportFilter
ing.- Specified by:
search
in interfaceEmbeddingStore<TextSegment>
- Parameters:
request
- A request to search in anEmbeddingStore
. Contains all search criteria.- Returns:
- An
EmbeddingSearchResult
containing all foundEmbedding
s.
-
removeAll
Description copied from interface:EmbeddingStore
Removes all embeddings that match the specified IDs from the store.- Specified by:
removeAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
ids
- A collection of unique IDs of the embeddings to be removed.
-
removeAll
Description copied from interface:EmbeddingStore
Removes all embeddings that match the specifiedFilter
from the store.- Specified by:
removeAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
filter
- The filter to be applied to theMetadata
of theTextSegment
during removal. Only embeddings whoseTextSegment
'sMetadata
match theFilter
will be removed.
-
removeAll
public void removeAll()Description copied from interface:EmbeddingStore
Removes all embeddings from the store.- Specified by:
removeAll
in interfaceEmbeddingStore<TextSegment>
-