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

Before you can create a source 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 source connector, add it along with a destination 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 source 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 source connector! Keep reading to learn how.

Ingest your files into Unstructured from Google Cloud Storage.

The requirements are as follows.

  • A Google Cloud service account. Create a service account.

  • A service account key for the service account. See Create a service account key in Create and delete service account keys.

    To ensure maximum compatibility across Unstructured service offerings, you should give the service account key information to Unstructured as a single-line string that contains the contents of the downloaded service account key file (and not the service account key file itself). To print this single-line string without line breaks, suitable for copying, you can run one of the following commands from your Terminal or Command Prompt. In this command, replace <path-to-downloaded-key-file> with the path to the service account key file that you downloaded by following the preceding instructions.

    • For macOS or Linux: 
      tr -d '\n' < <path-to-downloaded-key-file>
    • For Windows: 
      (Get-Content -Path "<path-to-downloaded-key-file>" -Raw).Replace("`r`n", "").Replace("`n", "")

  • The URI for a Google Cloud Storage bucket. This URI consists of the target bucket name, plus any target folder within the bucket, expressed as gs://<bucket-name>[/folder-name]. Create a bucket.

    This bucket must have, at minimum, one of the following roles applied to the target Google Cloud service account:

    • Storage Object Viewer for bucket read access.
    • Storage Object User for bucket write access.
    • The Storage Object Admin role provides read and write access, plus access to additional bucket operations.

    To apply one of these roles to a service account for a bucket, see Add a principal to a bucket-level policy in Set and manage IAM policies on buckets.

To create a Google Cloud Storage source connector, see the following examples.

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import (
    CreateSourceConnector,
    SourceConnectorType,
    GCSSourceConnectorConfigInput
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type=SourceConnectorType.GCS,
                config=GCSSourceConnectorConfigInput(
                    service_account_key="<service-account-key>",
                    remote_url="<remote-url>",
                    recursive=<True|False>
                )
            )
        )
    )

    print(response.source_connector_information)

Replace the preceding placeholders as follows:

  • <name> (required) - A unique name for this connector.
  • <service-account-key> (required) - The contents of a service account key file, expressed as a single string without line breaks, for a Google Cloud service account that has the required access permissions to the bucket.
  • <remote-url> (required) - The URI for the Google Cloud Storage bucket and any target folder path within the bucket. This URI takes the format gs://<bucket-name>[/folder-name].
  • For recursive (source connector only), set to true to ingest data recursively from any subfolders, starting from the path specified by <remote-url>. The default is false if not otherwise specified.