The Chroma component is a data component that allows users to build and search vector datasets.
It can carry out the following tasks:
Alpha
The component definition and tasks are defined in the definition.yaml and tasks.yaml files respectively.
In order to communicate with Chroma, the following connection details need to be
provided. You may specify them directly in a pipeline recipe as key-value pairs
within the component's setup block, or you can create a Connection from
the Integration Settings setup as setup: ${connection.<my-connection-id>}.
Field Field ID Type Note API Key (required) api-keystring Fill in your Chroma API key. Chroma URL Endpoint (required) urlstring Fill in your Chroma hosted public URL endpoint with port, e.g http://1.2.3:8000 .
Upsert multiple vector items into a collection, existing items will be updated
Input Field ID Type Description Task ID (required) taskstring TASK_BATCH_UPSERTCollection Name (required) collection-namestring The name of the collection to upsert the item into. Array ID (required) array-idarray[string] The array of id. Array Metadata (required)array-metadataarray[object] The array of vector metadata. Array Vector (required) array-vectorarray[array] The array of vector values. Array Document array-documentarray[string] The array of document string values. Array URI array-uriarray[string] The array of uri.
Output Field ID Type Description Status statusstring Batch add status.
Upsert a vector item into a collection, existing item will be updated
Input Field ID Type Description Task ID (required) taskstring TASK_UPSERTCollection Name (required) collection-namestring The name of the collection to upsert the item into. ID (required) idstring The ID of the item. Metadata (required) metadataobject The vector metadata. Vector (required) vectorarray[number] An array of dimensions for the vector value. Document documentstring The document string value. URI uristring The uri of the item.
Output Field ID Type Description Status statusstring Add status.
Perform a vector search on a collection
Input Field ID Type Description Task ID (required) taskstring TASK_QUERYCollection Name (required) collection-namestring The name of the collection to perform vector similarity search on. Vector (required) vectorarray[number] An array of dimensions for the vector query. N Results (required) n-resultsinteger The N amount of items to return from the vector search operation. Filter filterobject The metadata filter to be applied to the data with Chroma where filter, please refer to using-where-filters . Filter Document filter-documentstring The document content filter to be applied to the data, please refer to filtering-by-document-contents . Fields fieldsarray[string] The fields to be returned from the vector search operation.
Output Field ID Type Description Result resultobject Result of the vector search operation. Status statusstring Vector search status.
Output Objects in Query Result Field Field ID Type Note IDs idsarray The ids returned from the vector search operation. Items itemsarray The items returned from the vector search operation. Metadata metadataarray The metadata returned from the vector search operation. Vectors vectorsarray The vectors returned from the vector search operation.
Delete vector items from a collection
Input Field ID Type Description Task ID (required) taskstring TASK_DELETECollection Name (required) collection-namestring The name of the collection to delete the object from. ID idstring The ID of the item. Filter filterobject The metadata filter to be applied to the data with Chroma where filter, please refer to using-where-filters . Filter Document filter-documentstring The document content filter to be applied to the data, please refer to filtering-by-document-contents .
Output Field ID Type Description Status statusstring Delete status.
Create a collection
Input Field ID Type Description Task ID (required) taskstring TASK_CREATE_COLLECTIONCollection Name (required) collection-namestring The name of the collection to create. Config metadataobject The metadata of the collection. Please refer to creating-inspecting-and-deleting-collection . Configuration configurationobject The configuration of the collection. Please refer to creating-inspecting-and-deleting-collection . Get or Create get-or-createboolean If true, the collection will be created if it does not exist.
Output Field ID Type Description Status statusstring Create collection status.
Delete a collection
Input Field ID Type Description Task ID (required) taskstring TASK_DELETE_COLLECTIONCollection Name (required) collection-namestring The name of the collection to delete.
Output Field ID Type Description Status statusstring Delete collection status.
