wehub-resource-sync
bcbd1bdb22
Integ / changes (push) Has been skipped
Pre-commit / pre-commit (push) Failing after 1s
CLI exit codes / changes (push) Has been skipped
Test (Install) / changes (push) Has been skipped
Test (Python) / changes (push) Has been skipped
Test (TypeScript) / changes (push) Has been skipped
CLI exit codes / cli-gate (push) Has been cancelled
Test (Install) / test-install-gate (push) Has been cancelled
Integ / integ-gate (push) Has been cancelled
Test (Python) / test-python-gate (push) Has been cancelled
Test (TypeScript) / test-typescript-gate (push) Has been cancelled
Test (Install) / python-minimal (3.12) (push) Has been cancelled
Test (Install) / python-minimal (3.11) (push) Has been cancelled
Test (Install) / python-extra (agno, mirage.agents.agno) (push) Has been cancelled
Test (Install) / python-extra (chroma, mirage.resource.chroma) (push) Has been cancelled
Test (Install) / python-extra (pdf, mirage.core.filetype.pdf) (push) Has been cancelled
Integ / integ (push) Has been cancelled
Integ / integ-database (push) Has been cancelled
Integ / integ-database-ts (push) Has been cancelled
Integ / integ-data (push) Has been cancelled
Integ / integ-ssh (push) Has been cancelled
Integ / integ-ssh-ts (push) Has been cancelled
Test (Python) / audit (push) Has been cancelled
Test (TypeScript) / test (push) Has been cancelled
Test (TypeScript) / python-fs-shim (push) Has been cancelled
CLI exit codes / Python CLI (push) Has been cancelled
CLI exit codes / TypeScript CLI (push) Has been cancelled
CLI exit codes / Cross-language snapshot interop (push) Has been cancelled
Test (Python) / test (push) Has been cancelled
Test (Python) / import-isolation (deepagents, openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Python) / import-isolation (deepagents, pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Integ / integ-ts (push) Has been cancelled
Integ / integ-fuse (push) Has been cancelled
Test (Install) / python-extra (databricks, mirage.resource.databricks_volume) (push) Has been cancelled
Test (Install) / python-extra (deepagents, mirage.agents.langchain) (push) Has been cancelled
Test (Install) / python-extra (email, mirage.resource.email) (push) Has been cancelled
Test (Install) / python-extra (fuse, mirage.fuse.mount) (push) Has been cancelled
Test (Install) / python-extra (hdf5, mirage.core.filetype.hdf5) (push) Has been cancelled
Test (Install) / python-extra (hf, mirage.resource.hf_buckets) (push) Has been cancelled
Test (Install) / python-extra (lancedb, mirage.resource.lancedb) (push) Has been cancelled
Test (Install) / python-extra (langfuse, mirage.resource.langfuse) (push) Has been cancelled
Test (Install) / python-extra (mongodb, mirage.resource.mongodb) (push) Has been cancelled
Test (Install) / python-extra (nextcloud, mirage.resource.nextcloud) (push) Has been cancelled
Test (Install) / python-extra (openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Install) / python-extra (openhands, mirage.agents.openhands, 3.12) (push) Has been cancelled
Test (Install) / python-extra (parquet, mirage.core.filetype.parquet) (push) Has been cancelled
Test (Install) / python-extra (postgres, mirage.resource.postgres) (push) Has been cancelled
Test (Install) / python-extra (pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Test (Install) / python-extra (qdrant, mirage.resource.qdrant) (push) Has been cancelled
Test (Install) / python-extra (redis, mirage.resource.redis) (push) Has been cancelled
Test (Install) / python-extra (s3, mirage.resource.s3) (push) Has been cancelled
Test (Install) / python-extra (ssh, mirage.resource.ssh) (push) Has been cancelled
Test (Install) / ts-minimal (push) Has been cancelled
79 lines
2.1 KiB
Plaintext
79 lines
2.1 KiB
Plaintext
---
|
|
title: Chroma
|
|
icon: database
|
|
description: Set up the Chroma resource in Python.
|
|
---
|
|
|
|
## Dependencies
|
|
|
|
Install the Chroma extra:
|
|
|
|
```bash
|
|
cd python
|
|
uv sync --extra chroma
|
|
```
|
|
|
|
The resource imports `chromadb` lazily when it first connects to a collection.
|
|
|
|
For collection schema setup, see the [Chroma Setup](/home/setup/chroma) guide.
|
|
|
|
## Configuration
|
|
|
|
```python
|
|
import os
|
|
|
|
from mirage import MountMode, Workspace
|
|
from mirage.resource.chroma import ChromaConfig, ChromaResource
|
|
|
|
config = ChromaConfig(
|
|
host=os.environ.get("CHROMA_HOST", "localhost"),
|
|
port=int(os.environ.get("CHROMA_PORT", "8000")),
|
|
ssl=os.environ.get("CHROMA_SSL", "false").lower() == "true",
|
|
collection_name=os.environ["CHROMA_COLLECTION"],
|
|
slug_field=os.environ.get("CHROMA_SLUG_FIELD", "page_slug"),
|
|
chunk_index_field=os.environ.get("CHROMA_CHUNK_INDEX_FIELD", "chunk_index"),
|
|
)
|
|
resource = ChromaResource(config=config)
|
|
ws = Workspace({"/knowledge/": resource}, mode=MountMode.READ)
|
|
```
|
|
|
|
Mirage connects via Chroma's `AsyncHttpClient` using `host`, `port`, and `ssl`.
|
|
|
|
## Config Reference
|
|
|
|
| Field | Required | Default | Description |
|
|
| ----- | -------- | ------- | ----------- |
|
|
| `collection_name` | Yes | | Chroma collection name |
|
|
| `host` | No | `localhost` | Chroma HTTP host |
|
|
| `port` | No | `8000` | Chroma HTTP port |
|
|
| `ssl` | No | `False` | Use HTTPS for Chroma HTTP connections |
|
|
| `slug_field` | No | `page_slug` | Chunk metadata field containing the virtual file path |
|
|
| `chunk_index_field` | No | `chunk_index` | Chunk metadata field used to order file chunks |
|
|
|
|
`collection_name`, `slug_field`, and `chunk_index_field` are trimmed and must
|
|
not be empty.
|
|
|
|
## Environment Example
|
|
|
|
```bash
|
|
# .env.development
|
|
CHROMA_COLLECTION=knowledge
|
|
CHROMA_HOST=localhost
|
|
CHROMA_PORT=8000
|
|
CHROMA_SSL=false
|
|
CHROMA_SLUG_FIELD=page_slug
|
|
CHROMA_CHUNK_INDEX_FIELD=chunk_index
|
|
CHROMA_EXAMPLE_QUERY=getting started
|
|
```
|
|
|
|
## Run the Examples
|
|
|
|
From the repository root:
|
|
|
|
```bash
|
|
./python/.venv/bin/python examples/python/chroma/chroma.py
|
|
./python/.venv/bin/python examples/python/chroma/chroma_vfs.py
|
|
```
|
|
|
|
The examples load `.env.development` from the repository root.
|