Milvus
Batch process all your records to store structured outputs in Milvus.
You will need:
The Milvus prerequisites:
- A Milvus instance.
- The URI of the instance.
- The username and password, or token to access the instance.
- The name of the database in the instance.
- The name of the collection in the database.
The Milvus connector dependencies:
pip install "unstructured-ingest[milvus]"
You might also need to install additional dependencies, depending on your needs. Learn more.
The following environment variables:
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).
Additional settings include:
- 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).
Now call the Unstructured CLI or Python. The source connector can be any of the ones supported. This example uses the local source connector:
This example sends files to Unstructured API services for processing by default. To process files locally instead, see the instructions at the end of this page.
For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --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 Unstructured API services for processing, specify
--partition-by-api
(CLI) orpartition_by_api=True
(Python).Unstructured API services 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.