Package org.springframework.ai.chroma

Class ChromaApi

java.lang.Object

org.springframework.ai.chroma.ChromaApi

public class ChromaApi
extends Object

Single-class Chroma API implementation based on the (unofficial) Chroma REST API.

Author:

Christian Tzolov, Eddú Meléndez

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ChromaApi.AddEmbeddingsRequest	Add embeddings to the chroma data store.
static final record	ChromaApi.Collection	Chroma embedding collection.
static final record	ChromaApi.CreateCollectionRequest	Request to create a new collection with the given name and metadata.
static final record	ChromaApi.DeleteEmbeddingsRequest	Request to delete embedding from a collection.
static final record	ChromaApi.Embedding	Single query embedding response.
static final record	ChromaApi.GetEmbeddingResponse	Object containing the get embedding results.
static final record	ChromaApi.GetEmbeddingsRequest	Get embeddings from a collection.
static final record	ChromaApi.QueryRequest	Request to get the nResults nearest neighbor embeddings for provided queryEmbeddings.
static final record	ChromaApi.QueryResponse	A QueryResponse object containing the query results.

Constructor Summary

Constructors

Constructor	Description
ChromaApi(String baseUrl)
ChromaApi(String baseUrl, org.springframework.web.client.RestClient.Builder restClientBuilder)
ChromaApi(String baseUrl, org.springframework.web.client.RestClient.Builder restClientBuilder, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method	Description
Long	countEmbeddings(String collectionId)
ChromaApi.Collection	createCollection(ChromaApi.CreateCollectionRequest createCollectionRequest)
void	deleteCollection(String collectionName)	Delete a collection with the given name.
int	deleteEmbeddings(String collectionId, ChromaApi.DeleteEmbeddingsRequest deleteRequest)
ChromaApi.Collection	getCollection(String collectionName)
ChromaApi.GetEmbeddingResponse	getEmbeddings(String collectionId, ChromaApi.GetEmbeddingsRequest getEmbeddingsRequest)
List<ChromaApi.Collection>	listCollections()
ChromaApi.QueryResponse	queryCollection(String collectionId, ChromaApi.QueryRequest queryRequest)
List<ChromaApi.Embedding>	toEmbeddingResponseList(ChromaApi.QueryResponse queryResponse)
void	upsertEmbeddings(String collectionId, ChromaApi.AddEmbeddingsRequest embedding)
Map<String,Object>	where(String text)
ChromaApi	withBasicAuthCredentials(String username, String password)	Configure access to ChromaDB secured with Basic Authentication: https://docs.trychroma.com/usage-guide#basic-authentication
ChromaApi	withKeyToken(String keyToken)	Configure access to ChromaDB secured with static API Token Authentication: https://docs.trychroma.com/usage-guide#static-api-token-authentication

Methods inherited from class java.lang.Object

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

Constructor Details

ChromaApi

public ChromaApi(String baseUrl)

ChromaApi

public ChromaApi(String baseUrl,
 org.springframework.web.client.RestClient.Builder restClientBuilder)

ChromaApi

public ChromaApi(String baseUrl,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Details

withKeyToken

public ChromaApi withKeyToken(String keyToken)

Configure access to ChromaDB secured with static API Token Authentication: https://docs.trychroma.com/usage-guide#static-api-token-authentication

Parameters:

keyToken - Chroma static API Token Authentication. (Optional)

withBasicAuthCredentials

public ChromaApi withBasicAuthCredentials(String username,
 String password)

Configure access to ChromaDB secured with Basic Authentication: https://docs.trychroma.com/usage-guide#basic-authentication

Parameters:

username - Credentials username.

password - Credentials password.

toEmbeddingResponseList

public List<ChromaApi.Embedding> toEmbeddingResponseList(ChromaApi.QueryResponse queryResponse)

createCollection

public ChromaApi.Collection createCollection(ChromaApi.CreateCollectionRequest createCollectionRequest)

deleteCollection

public void deleteCollection(String collectionName)

Delete a collection with the given name.

Parameters:

collectionName - the name of the collection to delete.

getCollection

public ChromaApi.Collection getCollection(String collectionName)

listCollections

public List<ChromaApi.Collection> listCollections()

upsertEmbeddings

public void upsertEmbeddings(String collectionId,
 ChromaApi.AddEmbeddingsRequest embedding)

deleteEmbeddings

public int deleteEmbeddings(String collectionId,
 ChromaApi.DeleteEmbeddingsRequest deleteRequest)

countEmbeddings

public Long countEmbeddings(String collectionId)

queryCollection

public ChromaApi.QueryResponse queryCollection(String collectionId,
 ChromaApi.QueryRequest queryRequest)

getEmbeddings

public ChromaApi.GetEmbeddingResponse getEmbeddings(String collectionId,
 ChromaApi.GetEmbeddingsRequest getEmbeddingsRequest)

where

public Map<String,Object> where(String text)