Weaviate | Documentation

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

#Release Stage

Alpha

The component configuration is defined and maintained here.

Field	Field ID	Type	Note
API Key (required)	`api-key`	string	Fill in your Weaviate API key. Please refer to clusters in Weaviate Console
Weaviate URL Endpoint (required)	`url`	string	Fill in your Weaviate base URL without https:// or http://. Please refer to clusters in Weaviate Console

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 search on
Vector	`vector`	array[number]	An array of dimensions for the vector query, optional. If not provided, all objects will be returned
Limit	`limit`	integer	The limit of objects, empty for all objects
Fields	`fields`	array[string]	The fields to return in the objects. If empty then all fields will be returned
Filter	`filter`	object	The properties filter to be applied to the data with GraphQL queries, which starts with WHERE field, please refer to https://weaviate.io/developers/weaviate/search/filters
Tenant	`tenant`	string	The tenant to perform the vector search on

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

Insert multiple vector objects into a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_BATCH_INSERT`
Collection Name (required)	`collection-name`	string	The name of the collection to upsert the object into
Array ID	`array-id`	array[string]	The array of id
Array Metadata (required)	`array-metadata`	array[object]	The array of vector metadata properties
Array Vector (required)	`array-vector`	array[array]	The array of vector values

Output	ID	Type	Description
Status	`status`	string	Batch insert status

Insert a vector object into a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_INSERT`
Collection Name (required)	`collection-name`	string	The name of the collection to upsert the object into
ID	`id`	string	The ID of the object
Vector (required)	`vector`	array[number]	An array of dimensions for the vector value
Metadata (required)	`metadata`	object	The vector metadata properties

Output	ID	Type	Description
Status	`status`	string	Upsert status

Update vector object in a collection

Input	ID	Type	Description
Task ID (required)	`task`	string	`TASK_UPDATE`
Collection Name (required)	`collection-name`	string	The name of the collection to update the object in
ID (required)	`id`	string	The ID of the object
Update Vector	`update-vector`	array[number]	The updated vector value, optional
Update Metadata	`update-metadata`	object	The updated vector metadata properties, optional

Output	ID	Type	Description
Status	`status`	string	Update status

Delete vector objects 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 object
Filter	`filter`	object	The properties filter to be applied to the data with GraphQL queries, which starts with WHERE field, please refer to https://weaviate.io/developers/weaviate/search/filters

Output	ID	Type	Description
Status	`status`	string	Delete status

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