If you’re new to Unstructured, read this note first.

Before you can create a destination connector, you must first sign in to your Unstructured account:

  • If you do not already have an Unstructured account, go to https://unstructured.io/contact and fill out the online form to indicate your interest.
  • If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created.
    If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.

After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key. To learn how, watch this 40-second how-to video.

After you create the destination connector, add it along with a source connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.

You can also create destination connectors with the Unstructured user interface (UI). Learn how.

If you need help, reach out to the community on Slack, or contact us directly.

You are now ready to start creating a destination connector! Keep reading to learn how.

Send processed data from Unstructured to Redis.

The requirements are as follows.

To create a Redis destination connector, see the following examples.

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import (
    CreateDestinationConnector,
    DestinationConnectorType,
    RedisDestinationConnectorConfigInput
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.destinations.create_destination(
        request=CreateDestinationRequest(
            create_destination_connector=CreateDestinationConnector(
                name="<name>",
                type=DestinationConnectorType.REDIS,
                config=RedisDestinationConnectorConfigInput(
                    database="<database>",
                    ssl=<True|False>,
                    batch_size=<batch-size>,
                    key_prefix="<key-prefix>",

                    # For URI authentication:
                    uri="<uri>"
                
                    # For password authentication:
                    host="<host>",
                    port=<port>,
                    username="<username>",
                    password="<password>"   
                )
            )
        )
    )

    print(response.destination_connector_information)

Replace the preceding placeholders as follows:

  • <name> (required) - A unique name for this connector.
  • <uri> For URI authentication, the connection URI for the target database user and password, hostname, and port number. Use the format of redis://<username>:<password>@<hostname>:<port-number>. If SSL encryption is enabled for the database, use rediss:// instead of redis://.
  • <host> (required for password authentication): The target database’s hostname.
  • <port>: For password authentication, the database’s port number. The default is 6379 unless otherwise specified.
  • <username> (required for password authentication): The name of the database user (not the logged in user).
  • <password> (required for password authentication): The database user’s password.
  • <database>: The number (index) for the target database. The default is 0 unless otherwise specified.
  • For ssl, true to enable SSL encryption for the connection. Set to true only if SSL is already set up and enabled for the target database. The default is true unless otherwise specified.
  • <key-prefix>: A string to prepend to each element’s element_id. This is useful for distinguishing between different data sets in the same Redis instance. The default is an empty string.
  • <batch-size>: The maximum number of records to upload in a single batch. The default is 100 unless otherwise specified.

​
Learn more