OPENSEARCH_HOST
- The hostname and port number, defined as <hostname>:<port-number>
and represented by --hosts
(CLI) or hosts
(Python).OPENSEARCH_INDEX_NAME
- The name of the search index, represented by --index-name
(CLI) or index_name
(Python).OPENSEARCH_USERNAME
- The user’s name, represented by --username
(CLI) or username
(Python).OPENSEARCH_PASSWORD
- The user’s password, represented by --password
(CLI) or password
(Python).OPENSEARCH_CA_CERTS
- The path to the Certificate Authority (CA) bundle, if you use intermediate CAs with your root CA. This is represented by --ca-certs
(CLI) or ca_certs
(Python).OPENSEARCH_CLIENT_CERT
- The path to the combined private key and certificate file, or the path to just the certificate file. This is represented by --client-cert
(CLI) or client_cert
(Python).OPENSEARCH_CLIENT_KEY
- The path to the private key file, if OPENSEARCH_CLIENT_CERT
refers to just the certificate file. This is represented by --client-key
(CLI) or client_key
(Python).--use-ssl
(CLI) or use_ssl=True
(Python) to use SSL for the connection.--verify-certs
(CLI) or verify_certs=True
(Python) to verify SSL certificates.--ssl-show-warn
(CLI) or ssl_show_warn=True
(Python) to show a warning when verifying SSL certificates is disabled.--partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
--partition-by-api
(CLI) or partition_by_api
(Python), or explicitly specify partition_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) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
--partition-by-api
(CLI) or partition_by_api=True
(Python).
Unstructured also requires an Unstructured API key and API URL, by adding the following:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.https://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, contact Unstructured Sales at sales@unstructured.io.If you do not have an API key, get one now.If the Unstructured API is self-hosted, the process
for generating Unstructured API keys, and the Unstructured API URL that you use, are different.
For details, contact Unstructured Sales at
sales@unstructured.io.