Chroma CreateCollection
CertifiedCreate a Chroma collection
Chroma CreateCollection
Create a Chroma collection
Creates a collection in the configured tenant and database. By default it is a get-or-create, so running it against an existing collection returns that collection instead of failing. Chroma infers the vector dimension from the first records you add.
type: io.kestra.plugin.chroma.CreateCollectionExamples
Create a collection with cosine distance
id: chroma_create_collection
namespace: company.team
tasks:
- id: create_collection
type: io.kestra.plugin.chroma.CreateCollection
baseUrl: http://localhost:8000
collectionName: docs
distance: COSINE
Create a collection on Chroma Cloud using a token stored as a secret
id: chroma_cloud_create_collection
namespace: company.team
tasks:
- id: create_collection
type: io.kestra.plugin.chroma.CreateCollection
baseUrl: https://api.trychroma.com
tenant: "{{ secret('CHROMA_TENANT') }}"
database: "{{ secret('CHROMA_DATABASE') }}"
authToken: "{{ secret('CHROMA_TOKEN') }}"
collectionName: docs
distance: COSINE
Properties
baseUrl *string
Base URL of the Chroma server
The base URL of the Chroma HTTP server, for example http://localhost: 8000.
collectionName *string
Collection name
The name of the collection to create.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150authToken string
Authentication token
Token sent in the X-Chroma-Token header. Used by token-authenticated self-hosted servers and by Chroma Cloud. Mutually exclusive with username/password.
database string
Database
The Chroma database that holds the collection (default: default_database).
distance string
L2COSINEIPDistance metric
Distance function for similarity search. When unset, Chroma uses its default (L2).
getOrCreate booleanstring
trueGet or create
When true (default), returns the existing collection if one with the same name already exists instead of failing.
metadata object
Collection metadata
Arbitrary key/value metadata stored on the collection.
password string
Basic-auth password
Password for HTTP basic authentication. Requires username.
tenant string
Tenant
The Chroma tenant that holds the database (default: default_tenant).
username string
Basic-auth username
Username for HTTP basic authentication. Requires password.
Outputs
collectionId string
Collection id
The UUID assigned to the collection by Chroma.
collectionName string
Collection name
The name of the collection.
