Milvus
If you’re new to Unstructured, read this note first.
Before you can create a destination connector, you must first sign up for Unstructured and get your Unstructured API key. After you sign up, the Unstructured user interface (UI) appears, which you use to get the key. To learn how, watch this 40-second how-to video.
After you create the destination connector, add it along with a source connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.
You can also create destination connectors with the Unstructured user interface (UI). Learn how.
If you need help, reach out to the community on Slack, or contact us directly.
You are now ready to start creating a destination connector! Keep reading to learn how.
Send processed data from Unstructured to Milvus.
The requirements are as follows.
- For the Unstructured UI or the Unstructured API, only Milvus cloud-based instances (such as Zilliz Cloud, and Milvus on IBM watsonx.data) are supported.
- For Unstructured Ingest, Milvus local and cloud-based instances are supported.
The following video shows how to fulfill the minimum set of requirements for Milvus cloud-based instances, demonstrating Milvus on IBM watsonx.data:
-
For Zilliz Cloud, you will need:
-
The URI of the cluster, also known as the cluster’s public endpoint, which takes a format such as
https://<cluster-id>.<cluster-type>.<cloud-provider>-<region>.cloud.zilliz.com
. Get the cluster’s public endpoint. -
The token to access the cluster. Get the cluster’s token.
-
The name of the database in the instance.
-
The name of the collection in the database.
The collection must have a a defined schema before Unstructured can write to the collection. The minimum viable schema for Unstructured contains only the fields
element_id
,embeddings
, andrecord_id
, as follows:Field Name Field Type Max Length Dimension Index Metric Type element_id
(primary key field)VARCHAR 200
— — — embeddings
(vector field)FLOAT_VECTOR — 3072
Yes (Checked) Cosine record_id
VARCHAR 200
— — —
-
For Milvus on IBM watsonx.data, you will need:
- An IBM Cloud account.
- The IBM watsonx.data subscription plan.
- A Milvus service instance in IBM watsonx.data.
- The URI of the instance, which takes the format of
https://
, followed by instance’s GRPC host, followed by a colon and the GRPC port. This takes the format ofhttps://<host>:<port>
. Get the instance’s GRPC host and GRPC port. - The name of the database in the instance.
- The name of the collection in the database. Note the collection requirements at the end of this section.
- The uername and password to access the instance.
The username for Milvus on IBM watsonx.data is always
ibmlhapikey
. The password for Milvus on IBM watsonx.data is in the form of an IBM Cloud user API key. Get the user API key.
-
For Milvus local, you will need:
- A Milvus instance.
- The URI of the instance.
- The name of the database in the instance.
- The name of the collection in the database. Note the collection requirements at the end of this section.
- The username and password, or token to access the instance.
All Milvus instances require the target collection to have a defined schema before Unstructured can write to the collection. The minimum viable
schema for Unstructured contains only the fields element_id
, embeddings
, and record_id
, as follows. This example code demonstrates the use of the
Python SDK for Milvus to create a collection with this minimum viable schema,
targeting Milvus on IBM watsonx.data. For the connections.connect
arguments to connect to other types of Milvus deployments, see your Milvus provider’s documentation:
Other approaches, such as creating collections instantly or setting nullable and default fields, have not been fully evaluated by Unstructured and might produce unexpected results.
Unstructured cannot provide a schema that is guaranteed to work in all circumstances. This is because these schemas will vary based on your source files’ types; how you want Unstructured to partition, chunk, and generate embeddings; any custom post-processing code that you run; and other factors.
To create a Milvus destination connector, see the following examples.
Replace the preceding placeholders as follows:
<name>
(required) - A unique name for this connector.<user>
(required) - The username to access the Milvus instance.<uri>
(required) - The URI of the instance, for example:https://12345.serverless.gcp-us-west1.cloud.zilliz.com.
<db-name>
(required) - The name of the database in the instance.<password>
(required) - The password corresponding to the username to access the instance.<collection-name>
(required) - The name of the collection in the database.
Was this page helpful?