This page was recently updated. What do you think about it? Let us know!.
- 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.
-
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
. To get this public endpoint value, do the following:- After you sign in to your Zilliz Cloud account, on the sidebar, in the list of available projects, select the project that contains the cluster.
- On the sidebar, click Clusters.
- Click the tile for the cluster.
- On the Cluster Details tab, on the Connect subtab, copy the Public Endpoint value.
-
The username and password to access the cluster, as follows:
- After you sign in to your Zilliz Cloud account, on the sidebar, in the list of available projects, select the project that contains the cluster.
- On the sidebar, click Clusters.
- Click the tile for the cluster.
- On the Users tab, copy the name of the user.
- Next to the user’s name, under Actions, click the ellipsis (three dots) icon, and then click Reset Password.
- Enter a new password for the user, and then click Confirm. Copy this new password.
- 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:
In the Create Index area for the collection, next to Vector Fields, click Edit Index. Make sure that for theField Name Field Type Max Length Dimension element_id
(primary key field)VARCHAR 200
— embeddings
(vector field)FLOAT_VECTOR — 3072
record_id
VARCHAR 200
— embeddings
field, the Field Type is set to FLOAT_VECTOR and the Metric Type is set to Cosine.
-
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.
element_id
, embeddings
, and record_id
, as follows. Adding a text
field is optional but highly recommended.This example code demonstrates the use of the
Python SDK for Milvus to create a collection with this 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
CLI, Python
MILVUS_URI
- The Milvus instance’s URI, represented by--uri
(CLI) oruri
(Python).MILVUS_USER
andMILVUS_PASSWORD
, orMILVUS_TOKEN
- The username and password, or token, to access the instance. This is represented by--user
and--password
, or--token
(CLI); oruser
andpassword
, ortoken
(Python).MILVUS_DB
- The database’s name, represented by--db-name
(CLI) ordb_name
(Python).MILVUS_COLLECTION
- The collection’s name, represented by--collection-name
(CLI) orcollection_name
(Python).MILVUS_FIELDS_TO_INCLUDE
- A list of fields to include a comma-separated list (CLI) or an array of strings (Python), represented by--field-to-include
(CLI) orfields_to_include
(Python).
- To emit the
metadata
field’s child fields directly into the output, include--flatten-metadata
(CLI) orflatten_metadata=True
(Python). This is the default if not specified. - To keep the
metadata
field with its child fields intact in the output, include--no-flatten-metadata
(CLI) orflatten_metadata=False
(Python).
--partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
-
To do local file processing, omit
--partition-by-api
(CLI) orpartition_by_api
(Python), or explicitly specifypartition_by_api=False
(Python). Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:--api-key $UNSTRUCTURED_API_KEY
(CLI) orapi_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) orpartition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)- The environment variables
UNSTRUCTURED_API_KEY
andUNSTRUCTURED_API_URL
-
To send files to the Unstructured Partition Endpoint for processing, specify
--partition-by-api
(CLI) orpartition_by_api=True
(Python). Unstructured also requires an Unstructured API key and API URL, by adding the following:--api-key $UNSTRUCTURED_API_KEY
(CLI) orapi_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) orpartition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)- The environment variables
UNSTRUCTURED_API_KEY
andUNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.
You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, which applies to Starter and Team accounts.The default API URL for Unstructured Ingest ishttps://api.unstructuredapp.io/general/v0/general
, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, email Unstructured Support at support@unstructured.io.If you do not have an API key, get one now.If you are using an Enterprise account, the process for generating Unstructured API keys, and the Unstructured API URL that you use, are different. For instructions, see your Unstructured account administrator, or email Unstructured Support at support@unstructured.io.