Package org.springframework.ai.chroma.vectorstore

Class ChromaVectorStore

java.lang.Object

org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

org.springframework.ai.chroma.vectorstore.ChromaVectorStore

All Implemented Interfaces:

Consumer<List<Document>>, DocumentWriter, VectorStore, VectorStoreRetriever, org.springframework.beans.factory.InitializingBean

public class ChromaVectorStore
extends AbstractObservationVectorStore
implements 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 EmbeddingModel for embedding calculations. For more information about how it does this, see the official Chroma website.

Author:

Christian Tzolov, Fu Cheng, Sebastien Deleuze, Soby Chacko, Thomas Vitale, Jonghoon Park

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChromaVectorStore.Builder

Field Summary

Fields inherited from class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

batchingStrategy, embeddingModel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChromaVectorStore(ChromaVectorStore.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
static ChromaVectorStore.Builder	builder(ChromaApi chromaApi, EmbeddingModel embeddingModel)
VectorStoreObservationContext.Builder	createObservationContextBuilder(String operationName)	Create a new VectorStoreObservationContext.Builder instance.
void	doAdd(List<Document> documents)	Perform the actual add operation.
void	doDelete(List<String> idList)	Perform the actual delete operation.
protected void	doDelete(Filter.Expression expression)	Template method for concrete implementations to provide filter-based deletion logic.
List<Document>	doSimilaritySearch(SearchRequest request)	Perform the actual similarity search operation.

Methods inherited from class org.springframework.ai.vectorstore.observation.AbstractObservationVectorStore

add, delete, delete, similaritySearch

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.springframework.ai.document.DocumentWriter

write

Methods inherited from interface org.springframework.ai.vectorstore.VectorStore

accept, delete, getName, getNativeClient

Methods inherited from interface org.springframework.ai.vectorstore.VectorStoreRetriever

similaritySearch

Constructor Details

ChromaVectorStore

protected ChromaVectorStore(ChromaVectorStore.Builder builder)

Parameters:

builder - VectorStore.Builder for chroma vector store

Method Details

builder

public static ChromaVectorStore.Builder builder(ChromaApi chromaApi,
 EmbeddingModel embeddingModel)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

doAdd

public void doAdd(List<Document> documents)

Description copied from class: AbstractObservationVectorStore

Perform the actual add operation.

Specified by:

doAdd in class AbstractObservationVectorStore

Parameters:

documents - the documents to add

doDelete

public void doDelete(List<String> idList)

Description copied from class: AbstractObservationVectorStore

Perform the actual delete operation.

Specified by:

doDelete in class AbstractObservationVectorStore

Parameters:

idList - the list of document IDs to delete

doDelete

protected void doDelete(Filter.Expression expression)

Description copied from class: AbstractObservationVectorStore

Template method for concrete implementations to provide filter-based deletion logic.

Overrides:

doDelete in class AbstractObservationVectorStore

Parameters:

expression - Filter expression to identify documents to delete

doSimilaritySearch

public List<Document> doSimilaritySearch(SearchRequest request)

Description copied from class: AbstractObservationVectorStore

Perform the actual similarity search operation.

Specified by:

doSimilaritySearch in class AbstractObservationVectorStore

Parameters:

request - the search request

Returns:

the list of documents that match the query request conditions

createObservationContextBuilder

public VectorStoreObservationContext.Builder createObservationContextBuilder(String operationName)

Description copied from class: AbstractObservationVectorStore

Create a new VectorStoreObservationContext.Builder instance.

Specified by:

createObservationContextBuilder in class AbstractObservationVectorStore

Parameters:

operationName - the operation name

Returns:

the observation context builder