Qdrant

The Qdrant component is a data component that allows users to build and search vector datasets. It can carry out the following tasks:

#Release Stage

Alpha

#Configuration

The component configuration is defined and maintained here.

#Setup

FieldField IDTypeNote
API Key (required)api-keystringFill in your Qdrant API key. Please refer to clusters in Qdrant data access control
Qdrant URL Endpoint (required)urlstringFill in your Qdrant URL endpoint. Please refer to clusters in Qdrant cluster details

#Supported Tasks

Perform a vector search on a collection

InputIDTypeDescription
Task ID (required)taskstringTASK_VECTOR_SEARCH
Collection Name (required)collection-namestringThe name of the collection to perform vector similarity search on
Vector (required)vectorarray[number]An array of dimensions for the vector query.
Limit (required)limitintegerThe limit of points, empty for all points
Payloadspayloadsarray[string]The payloads to return in the points. If empty then all payloads will be returned
FilterfilterobjectThe properties filter to be applied to the data with Qdrant filter, please refer to https://api.qdrant.tech/api-reference/search/points filter section
ParamsparamsobjectThe additional parameters to be passed to the search, please refer to https://api.qdrant.tech/api-reference/search/points params section
Min Scoremin-scorenumberThe minimum score of the points to be returned
OutputIDTypeDescription
ResultresultobjectResult of the vector search operation
StatusstatusstringVector search status

#Batch Upsert

Insert multiple vector points into a collection

InputIDTypeDescription
Task ID (required)taskstringTASK_BATCH_UPSERT
Collection Name (required)collection-namestringThe name of the collection to upsert the point into
Array ID (required)array-idarray[string]The array of id
Array Metadataarray-metadataarray[object]The array of vector metadata payload
Array Vector (required)array-vectorarray[array]The array of vector values
OrderingorderingstringThe ordering guarantees of the batch upsert
OutputIDTypeDescription
StatusstatusstringBatch upsert status

#Upsert

Upsert a vector point into a collection

InputIDTypeDescription
Task ID (required)taskstringTASK_UPSERT
Collection Name (required)collection-namestringThe name of the collection to upsert the point into
ID (required)idstringThe ID of the point
MetadatametadataobjectThe vector metadata payload
Vector (required)vectorarray[number]An array of dimensions for the vector value
OrderingorderingstringThe ordering guarantees of the batch upsert
OutputIDTypeDescription
StatusstatusstringUpsert status

#Delete

Delete vector points from a collection

InputIDTypeDescription
Task ID (required)taskstringTASK_DELETE
Collection Name (required)collection-namestringThe name of the collection to delete the object from
IDidstringThe ID of the point
FilterfilterobjectThe properties filter to be applied to the data with Qdrant filter, please refer to https://api.qdrant.tech/api-reference/points/delete-points filter section
OrderingorderingstringThe ordering guarantees of the batch upsert
OutputIDTypeDescription
StatusstatusstringDelete status

#Create Collection

Create a collection

InputIDTypeDescription
Task ID (required)taskstringTASK_CREATE_COLLECTION
Collection Name (required)collection-namestringThe name of the collection to create
Config (required)configobjectThe configuration of the collection. Please refer to https://api.qdrant.tech/api-reference/collections/create-collection
OutputIDTypeDescription
StatusstatusstringCreate collection status

#Delete Collection

Delete a collection

InputIDTypeDescription
Task ID (required)taskstringTASK_DELETE_COLLECTION
Collection Name (required)collection-namestringThe name of the collection to delete
OutputIDTypeDescription
StatusstatusstringDelete collection status