Chroma Delete

Chroma Delete

Certified

Delete records from a Chroma collection

Deletes records by their ids and/or by a metadata (where) or document (whereDocument) filter. At least one of ids, where or whereDocument must be provided.

yaml
type: io.kestra.plugin.chroma.Delete

Delete specific records by id

yaml
id: chroma_delete_by_id
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.chroma.Delete
    baseUrl: http://localhost:8000
    collectionName: docs
    ids: ["doc-1", "doc-2"]

Delete records matching a metadata filter

yaml
id: chroma_delete_by_filter
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.chroma.Delete
    baseUrl: http://localhost:8000
    collectionName: docs
    where:
      source: handbook
Properties

Base URL of the Chroma server

The base URL of the Chroma HTTP server, for example http://localhost: 8000.

Collection name

The name of the collection to delete from.

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

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

The Chroma database that holds the collection (default: default_database).

Record ids

Ids of the records to delete.

Basic-auth password

Password for HTTP basic authentication. Requires username.

Tenant

The Chroma tenant that holds the database (default: default_tenant).

Basic-auth username

Username for HTTP basic authentication. Requires password.

Metadata filter

A Chroma where filter selecting records to delete by metadata.

Document filter

A Chroma where_document filter selecting records to delete by document text.

Requested id count

The number of ids sent for deletion when deleting by ids, or null when deleting by filter. Chroma does not report how many records actually matched, and the task fails if the request is rejected.