Redis

Batch process all your records to store structured outputs in Redis.

The requirements are as follows.

• 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.

The Redis connector dependencies.

pip install "unstructured-ingest[redis]"

You might also need to install additional dependencies, depending on your needs. Learn more.

The following environment variables:

• For connecting with a Redis connection string, REDIS_URI, represented by --uri (CLI) or uri (Python). Redis connection strings use the following format:

  Copy

  Ask AI

  <protocol>://<username>:<password>@<hostname>:<port>?ssl=<true|false>&db=<db_number>
  

• For connecting with Redis connection properties:

  • REDIS_HOST - The hostname of the target Redis database, represented by --host (CLI) or host (Python).
  • REDIS_PORT - The database’s port number, represented by --port (CLI) or port (Python).
  • REDIS_DATABASE - The database number of the target database, represented by --database (CLI) or database (Python).
  • REDIS_USERNAME - The username for the database, represented by --username (CLI) or username (Python).
  • REDIS_PASSWORD - The user’s password, represented by --password (CLI) or password (Python).
  • REDIS_KEY_PREFIX - A string to prepend to each element’s element_id, represented by --key-prefix (CLI) or key_prefix (Python).

Now call the Unstructured CLI or Python SDK. The source connector can be any of the ones supported.

This example uses the local source connector.

This example sends files to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page.

# Chunking and embedding are optional.

# Use a Redis connection string:
unstructured-ingest \
  local \
    --input-path $LOCAL_FILE_INPUT_DIR \
    --chunking-strategy by_title \
    --embedding-provider huggingface \
    --partition-by-api \
    --api-key $UNSTRUCTURED_API_KEY \
    --partition-endpoint $UNSTRUCTURED_API_URL \
    --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \
  redis \
    --uri $REDIS_URI,
    --no-ssl \
    --key-prefix $REDIS_KEY_PREFIX \
    --batch-size 100

# Use Redis connection properties:
unstructured-ingest \
  local \
    --input-path $LOCAL_FILE_INPUT_DIR \
    --chunking-strategy by_title \
    --embedding-provider huggingface \
    --partition-by-api \
    --api-key $UNSTRUCTURED_API_KEY \
    --partition-endpoint $UNSTRUCTURED_API_URL \
    --additional-partition-args="{\"split_pdf_page\":\"true\", \"split_pdf_allow_failed\":\"true\", \"split_pdf_concurrency_level\": 15}" \
  redis \
    --host $REDIS_HOST \
    --port 14453
    --database 0 \
    --username $REDIS_USERNAME \
    --password $REDIS_PASSWORD \
    --no-ssl \
    --key-prefix $REDIS_KEY_PREFIX \
    --batch-size 100

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) 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)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_API_URL

• To send files to the Unstructured Partition Endpoint for processing, specify --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)
  • The environment variables UNSTRUCTURED_API_KEY and UNSTRUCTURED_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, for example, if you are using a self-hosted instance of the Unstructured API.

  The default API URL for Unstructured Ingest is 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.