- A Redis database, for example in Redis Cloud.
- The target database’s hostname and port number. Create a database in Redis Cloud.
- The username and password for the target database. Get the username and password in Redis Cloud.
- The database number for the target database. Redis databases are typically numbered from 0 to 15, with the default database number typically being 0.
-
For connecting with a Redis connection string,
REDIS_URI
, represented by--uri
(CLI) oruri
(Python). Redis connection strings use the following format: -
For connecting with Redis connection properties:
REDIS_HOST
- The hostname of the target Redis database, represented by--host
(CLI) orhost
(Python).REDIS_PORT
- The database’s port number, represented by--port
(CLI) orport
(Python).REDIS_DATABASE
- The database number of the target database, represented by--database
(CLI) ordatabase
(Python).REDIS_USERNAME
- The username for the database, represented by--username
(CLI) orusername
(Python).REDIS_PASSWORD
- The user’s password, represented by--password
(CLI) orpassword
(Python).REDIS_KEY_PREFIX
- A string to prepend to each element’selement_id
, represented by--key-prefix
(CLI) orkey_prefix
(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.