- For the Unstructured UI or the Unstructured API, only Qdrant Cloud is supported.
- For Unstructured Ingest, Qdrant Cloud, Qdrant local, and Qdrant client-server are supported.
-
For Qdrant local, the path to the local Qdrant installation, for example:
/qdrant/local
-
For Qdrant client-server, the Qdrant server URL, for example:
http://localhost:6333
-
For Qdrant Cloud:
- A Qdrant account.
- A Qdrant cluster.
-
The cluster’s URL. To get this URL, do the following:
- Sign in to your Qdrant Cloud account.
- On the sidebar, under Dashboard, click Clusters.
- Click the cluster’s name.
- Note the value of the Endpoint field, for example:
https://<random-guid>.<region-id>.<cloud-provider>.cloud.qdrant.io
.
- A Qdrant API key.
-
The name of the target collection on the Qdrant local installation,
Qdrant server, or Qdrant Cloud cluster.
Qdrant requires the target collection to exist before Unstructured can write to the collection.
The following example code demonstrates the use of the Python Qdrant Client to create
a collection on a Qdrant Cloud cluster, configuring the collection for vectors with 3072 dimensions:
Python
-
QDRANT_COLLECTION
- The name of the target collection on the Qdrant local installation, Qdrant server, or Qdrant Cloud cluster, represented by--collection-name
(CLI) orcollection_name
(Python). -
For Qdrant local,
QDRANT_PATH
- The path to the local Qdrant installation, represented by--path
(CLI) orpath
(Python). -
For Qdrant client-server,
QDRANT_URL
- The Qdrant server’s URL, represented by--url
(CLI) orurl
(Python). -
For Qdrant Cloud:
QDRANT_URL
- The Qdrant cluster’s URL, represented by--url
(CLI) orurl
(Python).QDRANT_API_KEY
- The Qdrant API key, represented by--api-key
(CLI) orapi_key
(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.