Qdrant | Documentation

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

Vector Search
Batch Upsert
Upsert
Delete
Create Collection
Delete Collection

#Release Stage

Alpha

#Configuration

The component definition and tasks are defined in the definition.json and tasks.json files respectively.

#Setup

In order to communicate with Qdrant, 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 page and reference the whole setup as setup: ${connection.<my-connection-id>}.

Field	Field ID	Type	Note
API Key (required)	`api-key`	string	Fill in your Qdrant API key. Please refer to clusters in Qdrant data access control.
Qdrant URL Endpoint (required)	`url`	string	Fill in your Qdrant URL endpoint. Please refer to clusters in Qdrant cluster details.

#Supported Tasks

#Vector Search

Perform a vector search on a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_VECTOR_SEARCH`
Collection Name (required)	`collection-name`	string	The name of the collection to perform vector similarity search on.
Vector (required)	`vector`	array[number]	An array of dimensions for the vector query.
Limit (required)	`limit`	integer	The limit of points, empty for all points.
Payloads	`payloads`	array[string]	The payloads to return in the points. If empty then all payloads will be returned.
Filter	`filter`	object	The properties filter to be applied to the data with Qdrant filter, please refer to filter section.
Params	`params`	object	The additional parameters to be passed to the search, please refer to params section.
Min Score	`min-score`	number	The minimum score of the points to be returned.

Output	ID	Type	Description
Result	`result`	object	Result of the vector search operation.
Status	`status`	string	Vector search status.

Output Objects in Vector Search

Result

Field	Field ID	Type	Note
IDs	`ids`	array	The ids returned from the vector search operation.
Metadata	`metadata`	array	The metadata returned from the vector search operation.
Points	`points`	array	The points returned from the vector search operation.
Vectors	`vectors`	array	The vectors returned from the vector search operation.

#Batch Upsert

Insert multiple vector points into a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_BATCH_UPSERT`
Collection Name (required)	`collection-name`	string	The name of the collection to upsert the point into.
Array ID (required)	`array-id`	array[string]	The array of id.
Array Metadata	`array-metadata`	array[object]	The array of vector metadata payload.
Array Vector (required)	`array-vector`	array[array]	The array of vector values.
Ordering	`ordering`	string	The ordering guarantees of the batch upsert.

Output	ID	Type	Description
Status	`status`	string	Batch upsert status.

#Upsert

Upsert a vector point into a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_UPSERT`
Collection Name (required)	`collection-name`	string	The name of the collection to upsert the point into.
ID (required)	`id`	string	The ID of the point.
Metadata	`metadata`	object	The vector metadata payload.
Vector (required)	`vector`	array[number]	An array of dimensions for the vector value.
Ordering	`ordering`	string	The ordering guarantees of the batch upsert.

Output	ID	Type	Description
Status	`status`	string	Upsert status.

#Delete

Delete vector points from a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_DELETE`
Collection Name (required)	`collection-name`	string	The name of the collection to delete the object from.
ID	`id`	string	The ID of the point.
Filter	`filter`	object	The properties filter to be applied to the data with Qdrant filter, please refer to filter section.
Ordering	`ordering`	string	The ordering guarantees of the batch upsert.

Output	ID	Type	Description
Status	`status`	string	Delete status.

#Create Collection

Create a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_CREATE_COLLECTION`
Collection Name (required)	`collection-name`	string	The name of the collection to create.
Config (required)	`config`	object	The configuration of the collection. Please refer to here.

Output	ID	Type	Description
Status	`status`	string	Create collection status.

#Delete Collection

Delete a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_DELETE_COLLECTION`
Collection Name (required)	`collection-name`	string	The name of the collection to delete.

Output	ID	Type	Description
Status	`status`	string	Delete collection status.