Milvus

If you’re new to Unstructured, read this note first.

Before you can create a destination connector, you must first sign in to your Unstructured account:

• If you do not already have an Unstructured account, go to https://unstructured.io/contact and fill out the online form to indicate your interest.
• If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at [e-mail].

After you sign in, the Unstructured user interface (UI) appears, which you use to create your destination connector.

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 UI quickstart or watch the 4-minute video tutorial.

You can also create destination connectors with the Unstructured API. 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:

  • A Zilliz Cloud account.

  • A Zilliz Cloud cluster.

  • 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, and record_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 of https://<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:

Python

import os
from pymilvus import (
    connections,
    FieldSchema,
    DataType,
    CollectionSchema,
    Collection,
)

connections.connect(
    alias="default",
    host=os.getenv("MILVUS_GRPC_HOST"),
    port=os.getenv("MILVUS_GRPC_PORT"),
    user=os.getenv("MILVUS_USER"),
    password=os.getenv("MILVUS_PASSWORD"),
    secure=True
)

primary_key = FieldSchema(
    name="element_id",
    dtype=DataType.VARCHAR,
    is_primary=True,
    max_length=200
)

vector = FieldSchema(
    name="embeddings",
    dtype=DataType.FLOAT_VECTOR,
    dim=3072
)

record_id = FieldSchema(
    name="record_id",
    dtype=DataType.VARCHAR,
    max_length=200
)

schema = CollectionSchema(
    fields=[primary_key, vector, record_id],
    enable_dynamic_field=True
)

collection = Collection(
    name="my_collection",
    schema=schema,
    using="default"
)

index_params = {
    "metric_type": "L2",
    "index_type": "IVF_FLAT",
    "params": {"nlist": 1024}
}

collection.create_index(
    field_name="embeddings",
    index_params=index_params
)

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 the destination connector:

1. On the sidebar, click Connectors.
2. Click Destinations.
3. Cick New or Create Connector.
4. Give the connector some unique Name.
5. In the Provider area, click Milvus.
6. Click Continue.
7. Follow the on-screen instructions to fill in the fields as described later on this page.
8. Click Save and Test.

Fill in the following fields for Milvus on IBM watsonx.data:

• Name (required): A unique name for this connector.
• GRPC Host (required): The GRPC host name for the Milvus instance.
• GRPC Port: The GRPC port number for the instance.
• DB Name: The name of the database in the instance. The default is default if not otherwise specified.
• Collection Name (required): The name of the collection in the database.
• Username: The username to access the Milvus instance. The default is ibmlhapikey if not otherwise specified.
• API Key (required): The IBM Cloud user API key.

Fill in the following fields for Milvus on Zilliz Cloud:

• Name (required): A unique name for this connector.
• URI (required): The URI of the Milvus instance, for example: https://12345.serverless.gcp-us-west1.cloud.zilliz.com.
• DB Name: The name of the database in the instance. The default is default if not otherwise specified.
• Collection Name (required): The name of the collection in the database.
• Username (required): The username to access the Milvus instance.
• Password (required): The password corresponding to the username to access the instance.

Fill in the following fields for other Milvus deployments:

• Name (required): A unique name for this connector.
• URI (required): The URI of the Milvus instance, for example: https://12345.serverless.gcp-us-west1.cloud.zilliz.com.
• DB Name: The name of the database in the instance. The default is default if not otherwise specified.
• Collection Name (required): The name of the collection in the database.
• Username (required): The username to access the Milvus instance.
• Password (required): The password corresponding to the username to access the instance.

Assistant

Responses are generated using AI and may contain mistakes.