Class ChromaVectorStore
java.lang.Object
org.springframework.ai.vectorsore.ChromaVectorStore
- All Implemented Interfaces:
Consumer<List<Document>>
,DocumentWriter
,VectorStore
,org.springframework.beans.factory.InitializingBean
public class ChromaVectorStore
extends Object
implements VectorStore, org.springframework.beans.factory.InitializingBean
ChromaVectorStore
is a concrete implementation of the VectorStore
interface. It is responsible for adding, deleting, and searching documents based on
their similarity to a query, using the ChromaApi
and EmbeddingClient
for embedding calculations. For more information about how it does this, see the
official Chroma website.-
Field Summary
-
Constructor Summary
ConstructorDescriptionChromaVectorStore
(EmbeddingClient embeddingClient, ChromaApi chromaApi) ChromaVectorStore
(EmbeddingClient embeddingClient, ChromaApi chromaApi, String collectionName) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds list ofDocument
s to the vector store.void
Deletes documents from the vector store.void
setFilterExpressionConverter
(FilterExpressionConverter filterExpressionConverter) similaritySearch
(SearchRequest request) Retrieves documents by query embedding similarity and metadata filters to retrieve exactly the number of nearest-neighbor results that match the request criteria.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.ai.vectorstore.VectorStore
accept, similaritySearch
-
Field Details
-
DISTANCE_FIELD_NAME
- See Also:
-
DEFAULT_COLLECTION_NAME
- See Also:
-
SIMILARITY_THRESHOLD_ALL
public static final double SIMILARITY_THRESHOLD_ALL- See Also:
-
DEFAULT_TOP_K
public static final int DEFAULT_TOP_K- See Also:
-
-
Constructor Details
-
ChromaVectorStore
-
ChromaVectorStore
public ChromaVectorStore(EmbeddingClient embeddingClient, ChromaApi chromaApi, String collectionName)
-
-
Method Details
-
setFilterExpressionConverter
-
add
Description copied from interface:VectorStore
Adds list ofDocument
s to the vector store.- Specified by:
add
in interfaceVectorStore
- Parameters:
documents
- the list of documents to store. Throws an exception if the underlying provider checks for duplicate IDs.
-
delete
Description copied from interface:VectorStore
Deletes documents from the vector store.- Specified by:
delete
in interfaceVectorStore
- Parameters:
idList
- list of document ids for which documents will be removed.- Returns:
-
similaritySearch
Description copied from interface:VectorStore
Retrieves documents by query embedding similarity and metadata filters to retrieve exactly the number of nearest-neighbor results that match the request criteria.- Specified by:
similaritySearch
in interfaceVectorStore
- Parameters:
request
- Search request for set search parameters, such as the query text, topK, similarity threshold and metadata filter expressions.- Returns:
- Returns documents th match the query request conditions.
-
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
Exception
-