Package org.springframework.ai.chroma.vectorstore

Class ChromaApi

java.lang.Object

org.springframework.ai.chroma.vectorstore.ChromaApi

public class ChromaApi
extends Object

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

Author:

Christian Tzolov, Eddú Meléndez, Jonghoon Park

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ChromaApi.AddEmbeddingsRequest	Add embeddings to the chroma data store.
static final class	ChromaApi.Builder
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.CreateDatabaseRequest	Request to create a new database
static final record	ChromaApi.CreateTenantRequest	Request to create a new tenant
static final record	ChromaApi.Database	Chroma database.
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.
static final record	ChromaApi.Tenant	Chroma tenant.

Constructor Summary

Constructors

Constructor	Description
ChromaApi(String baseUrl, org.springframework.web.client.RestClient.Builder restClientBuilder, tools.jackson.databind.json.JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
static ChromaApi.Builder	builder()
@Nullable Long	countEmbeddings(String tenantName, String databaseName, String collectionId)
@Nullable ChromaApi.Collection	createCollection(String tenantName, String databaseName, ChromaApi.CreateCollectionRequest createCollectionRequest)
void	createDatabase(String tenantName, String databaseName)
void	createTenant(String tenantName)
void	deleteCollection(String tenantName, String databaseName, String collectionName)	Delete a collection with the given name.
void	deleteDatabase(String tenantName, String databaseName)	Delete a database with the given name.
int	deleteEmbeddings(String tenantName, String databaseName, String collectionId, ChromaApi.DeleteEmbeddingsRequest deleteRequest)
@Nullable ChromaApi.Collection	getCollection(String tenantName, String databaseName, String collectionName)
@Nullable ChromaApi.Database	getDatabase(String tenantName, String databaseName)
@Nullable ChromaApi.GetEmbeddingResponse	getEmbeddings(String tenantName, String databaseName, String collectionId, ChromaApi.GetEmbeddingsRequest getEmbeddingsRequest)
@Nullable ChromaApi.Tenant	getTenant(String tenantName)
@Nullable List<ChromaApi.Collection>	listCollections(String tenantName, String databaseName)
@Nullable ChromaApi.QueryResponse	queryCollection(String tenantName, String databaseName, String collectionId, ChromaApi.QueryRequest queryRequest)
List<ChromaApi.Embedding>	toEmbeddingResponseList(@Nullable ChromaApi.QueryResponse queryResponse)
void	upsertEmbeddings(String tenantName, String databaseName, 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,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 tools.jackson.databind.json.JsonMapper jsonMapper)

Method Details

builder

public static ChromaApi.Builder builder()

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(@Nullable ChromaApi.QueryResponse queryResponse)

createTenant

public void createTenant(String tenantName)

getTenant

public @Nullable ChromaApi.Tenant getTenant(String tenantName)

createDatabase

public void createDatabase(String tenantName,
 String databaseName)

getDatabase

public @Nullable ChromaApi.Database getDatabase(String tenantName,
 String databaseName)

deleteDatabase

public void deleteDatabase(String tenantName,
 String databaseName)

Delete a database with the given name.

Parameters:

tenantName - the name of the tenant to delete.

databaseName - the name of the database to delete.

createCollection

public @Nullable ChromaApi.Collection createCollection(String tenantName,
 String databaseName,
 ChromaApi.CreateCollectionRequest createCollectionRequest)

deleteCollection

public void deleteCollection(String tenantName,
 String databaseName,
 String collectionName)

Delete a collection with the given name.

Parameters:

collectionName - the name of the collection to delete.

getCollection

public @Nullable ChromaApi.Collection getCollection(String tenantName,
 String databaseName,
 String collectionName)

listCollections

public @Nullable List<ChromaApi.Collection> listCollections(String tenantName,
 String databaseName)

upsertEmbeddings

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

deleteEmbeddings

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

countEmbeddings

public @Nullable Long countEmbeddings(String tenantName,
 String databaseName,
 String collectionId)

queryCollection

public @Nullable ChromaApi.QueryResponse queryCollection(String tenantName,
 String databaseName,
 String collectionId,
 ChromaApi.QueryRequest queryRequest)

getEmbeddings

public @Nullable ChromaApi.GetEmbeddingResponse getEmbeddings(String tenantName,
 String databaseName,
 String collectionId,
 ChromaApi.GetEmbeddingsRequest getEmbeddingsRequest)

where

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