Zendesk

Connect Zendesk to your preprocessing pipeline, and use the Unstructured CLI or Python to batch process all your documents and store structured outputs locally on your filesystem.

The requirements are as follows.

• A Zendesk account.
• Your Zendesk subdomain.
• The login email address for your Zendesk account.
• An API token (not an OAuth token) for your login email address.

The Zendesk connector dependencies:

pip install "unstructured-ingest[zendesk]"

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

The following environment variables:

• ZENDESK_SUBDOMAIN - The subdomain for your Zendesk account, represented by --subdomain (CLI) or subdomain (Python).
• ZENDESK_EMAIL - The login email address for your Zendesk account, represented by --email (CLI) or email (Python).
• ZENDESK_API_TOKEN - The API token (not OAuth token) for your login email address, represented by --api-token (CLI) or api_token (Python).

Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. The destination connector can be any of the ones supported. This example uses the local destination connector.

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

#!/usr/bin/env bash

# Chunking and embedding are optional.

unstructured-ingest \
  zendesk \
    --subdomain $ZENDESK_SUBDOMAIN \
    --email $ZENDESK_EMAIL \
    --api-token $ZENDESK_API_TOKEN \
    --batch-size 2 \
    --item-type tickets \
    --output-dir $LOCAL_FILE_OUTPUT_DIR \
    --partition-by-api \
    --api-key $UNSTRUCTURED_API_KEY \
    --partition-endpoint $UNSTRUCTURED_API_URL \
    --chunking-strategy by_title \
    --embedding-provider huggingface

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.

  Get an API key and API URL.