The Milvus 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 Milvus, 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 Milvus URL Endpoint (required) urlstring Fill in your Milvus public URL endpoint with port number, e.g http://3.25.202.142:19530 . Milvus Username (required) usernamestring Fill in your Milvus username. Milvus Password (required) passwordstring Fill in your Milvus password.
Perform a vector search on a collection
Input Field ID Type Description Task ID (required) taskstring TASK_VECTOR_SEARCHCollection Name (required) collection-namestring The name of the collection to perform vector search on. Partition Name partition-namestring The name of the partition to vector search the data from. Vector (required) vectorarray[number] An array of dimensions for the vector search. Vector Field (required) vector-fieldstring The name of the field to perform vector search on. Fields fieldsarray[string] The fields to return in the data. If empty then all fields will be returned. Limit (required) limitinteger The limit of the data to return. Filter filterstring The properties filter to be applied to the data with milvus scalar filter, please refer to filter-search . Offset offsetinteger The offset of the data to return. Grouping Field grouping-fieldstring The name of the field to group the data by, please refer to Grouping-search . Search Parameters search-paramsobject The search parameters to be applied to the data with milvus search parameters, please refer to Search-parameters .
Output Field ID Type Description Result resultobject Result of the vector search operation. Status statusstring Vector search status.
Output Objects in Vector Search Result Field Field ID Type Note Data dataarray The points returned from the vector search operation. IDs idsarray The ids 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.
Insert a vector data into a collection
Input Field ID Type Description Task ID (required) taskstring TASK_UPSERTCollection Name (required) collection-namestring The name of the collection to upsert the data into. Partition Name partition-namestring The name of the partition to upsert the data from. If empty then default partition will be used. Data (required) dataobject The data.
Output Field ID Type Description Status statusstring Upsert status.
Insert a batch of vector data into a collection
Input Field ID Type Description Task ID (required) taskstring TASK_BATCH_UPSERTCollection Name (required) collection-namestring The name of the collection to upsert the data into. Partition Name partition-namestring The name of the partition to upsert the data from. If empty then default partition will be used. Array Data (required)array-dataarray[object] The data.
Output Field ID Type Description Status statusstring Batch upsert status.
Delete vector data 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 data from. Partition Name partition-namestring The name of the partition to delete the data from. If empty then default partition will be used. Filter filterstring The properties filter to be applied to the data with milvus scalar filter, please refer to Filtered-search .
Output Field ID Type Description Status statusstring Delete status.
Create a collectio, please refer to Create-Collection
Input Field ID Type Description Task ID (required) taskstring TASK_CREATE_COLLECTIONCollection Name (required) collection-namestring The name of the collection to create. Dimension (required) dimensioninteger The dimension of the collection. ID Type id-typestring The type of the id. Schema schemaobject The schema of the collection. Auto ID auto-idboolean Whether to auto generate id. Metric Type metric-typestring The metric type of the collection. Enum values Index Parameters index-paramsarray[object] The index parameters to be applied to the collection with milvus index parameters, please refer to Create . Parameters paramsobject The parameters to be applied to the collection with milvus parameters, please refer to Parameters .
Output Field ID Type Description Status statusstring Create collection status.
Drop a collection
Input Field ID Type Description Task ID (required) taskstring TASK_DROP_COLLECTIONCollection Name (required) collection-namestring The name of the collection to drop.
Output Field ID Type Description Status statusstring Drop collection status.
Create a partition in a collection
Input Field ID Type Description Task ID (required) taskstring TASK_CREATE_PARTITIONCollection Name (required) collection-namestring The name of the collection to create the partition in. Partition Name (required) partition-namestring The name of the partition to create.
Output Field ID Type Description Status statusstring Create partition status.
Drop a partition from a collection
Input Field ID Type Description Task ID (required) taskstring TASK_DROP_PARTITIONCollection Name (required) collection-namestring The name of the collection to drop the partition from. Partition Name (required) partition-namestring The name of the partition to drop.
Output Field ID Type Description Status statusstring Drop partition status.
Create an index in a collection
Input Field ID Type Description Task ID (required) taskstring TASK_CREATE_INDEXCollection Name (required) collection-namestring The name of the collection to create the index in. Index Parameters (required) index-paramsobject The index parameters to be applied to the collection with milvus index parameters, please refer to Create .
Output Field ID Type Description Status statusstring Create index status.
Drop an index from a collection
Input Field ID Type Description Task ID (required) taskstring TASK_DROP_INDEXCollection Name (required) collection-namestring The name of the collection to drop the index from. Index Name (required) index-namestring The name of the index to drop.
Output Field ID Type Description Status statusstring Drop index status.