Skip to main content

Overview

ChromaDB is an open-source vector database designed for embedding search and similarity matching. It supports embedded, local, and cloud deployments with HNSW and FLAT index types. Provider Class: ChromaProvider
Config Class: ChromaConfig

Dependencies

pip install "upsonic[rag]"

Examples

from upsonic import Agent, Task, KnowledgeBase
from upsonic.embeddings.openai_provider import OpenAIEmbeddingProvider
from upsonic.vectordb import ChromaProvider, ChromaConfig, ConnectionConfig, Mode, HNSWIndexConfig

# Setup embedding provider
embedding = OpenAIEmbeddingProvider(api_key="your-api-key")

# Embedded mode (local file storage)
config = ChromaConfig(
    collection_name="my_collection",
    vector_size=1536,
    connection=ConnectionConfig(mode=Mode.EMBEDDED, db_path="./chroma_db"),
    index=HNSWIndexConfig(m=16, ef_construction=200)
)
vectordb = ChromaProvider(config)

# Create knowledge base
kb = KnowledgeBase(
    sources="document.pdf",
    embedding_provider=embedding,
    vectordb=vectordb
)

# Use with Agent
agent = Agent("openai/gpt-4o")
task = Task(
    description="What is this document about?",
    context=[kb]
)
result = agent.do(task)

Parameters

Base Parameters (from BaseVectorDBConfig)

ParameterTypeDescriptionDefaultRequired
collection_namestrName of the collection"default_collection"No
vector_sizeintDimension of vectors-Yes
distance_metricDistanceMetricSimilarity metric (COSINE, EUCLIDEAN, DOT_PRODUCT)COSINENo
recreate_if_existsboolRecreate collection if it existsFalseNo
default_top_kintDefault number of results10No
default_similarity_thresholdOptional[float]Minimum similarity score (0.0-1.0)NoneNo
dense_search_enabledboolEnable dense vector searchTrueNo
full_text_search_enabledboolEnable full-text searchTrueNo
hybrid_search_enabledboolEnable hybrid searchTrueNo
default_hybrid_alphafloatDefault alpha for hybrid search (0.0-1.0)0.5No
default_fusion_methodLiteral['rrf', 'weighted']Default fusion method for hybrid search'weighted'No
provider_nameOptional[str]Provider nameNoneNo
provider_descriptionOptional[str]Provider descriptionNoneNo
provider_idOptional[str]Provider IDNoneNo
default_metadataOptional[Dict[str, Any]]Default metadata for all recordsNoneNo
auto_generate_content_idboolAuto-generate content IDsTrueNo
indexed_fieldsOptional[List[Union[str, Dict[str, Any]]]]Fields to index for filteringNoneNo

Chroma-Specific Parameters

ParameterTypeDescriptionDefaultRequired
connectionConnectionConfigConnection configuration (mode, db_path, etc.)-Yes
indexUnion[HNSWIndexConfig, FlatIndexConfig]Index type configurationHNSWIndexConfig()No
tenantOptional[str]Tenant name for multi-tenancyNoneNo
databaseOptional[str]Database nameNoneNo

ConnectionConfig Parameters

ParameterTypeDescriptionDefaultRequired
modeModeConnection mode (EMBEDDED, LOCAL, CLOUD, IN_MEMORY)-Yes
db_pathOptional[str]Path for embedded/local storageNoneRequired for EMBEDDED
hostOptional[str]Host addressNoneRequired for LOCAL
portOptional[int]Port numberNoneRequired for LOCAL
api_keyOptional[SecretStr]API key for cloud/localNoneRequired for CLOUD
urlOptional[str]Full connection URLNoneNo
use_tlsboolUse TLS encryptionTrueNo
grpc_portOptional[int]gRPC portNoneNo
prefer_grpcboolPrefer gRPC over HTTPFalseNo
httpsOptional[bool]Use HTTPSNoneNo
prefixOptional[str]URL path prefixNoneNo
timeoutOptional[float]Request timeout in secondsNoneNo
locationOptional[str]Special location stringNoneNo