Unstructured

1. Go to https://platform.unstructured.io and use your email address, Google account, or GitHub account to sign up for an Unstructured account (if you do not already have one) and sign into the account at the same time. The Unstructured user interface (UI) appears, and you can start using it right away.

2. If you also want to use the Unstructured API later, you must get your API key first:

   a. In the Unstructured UI, click API Keys on the sidebar.
   b. Click Generate API Key.
   c. Follow the on-screen instructions to finish generating the key.
   d. Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
   

1. From your Unstructured dashboard, in the sidebar, click Connectors.
2. Click Sources.
3. Cick New or Create Connector.
4. For Name, enter some unique name for this connector.
5. In the Provider area, click the source location type that matches yours.
6. Click Continue.
7. Fill in the fields with the appropriate settings. Learn more.
8. If a Continue button appears, click it, and fill in any additional settings fields.
9. Click Save and Test.

1. In the sidebar, click Connectors.
2. Click Destinations.
3. Cick New or Create Connector.
4. For Name, enter some unique name for this connector.
5. In the Provider area, click the destination location type that matches yours.
6. Click Continue.
7. Fill in the fields with the appropriate settings. Learn more.
8. If a Continue button appears, click it, and fill in any additional settings fields.
9. Click Save and Test.

1. In the sidebar, click Workflows.

2. Click New Workflow.

3. Next to Build it for Me, click Create Workflow.

   If a radio button appears instead of Build it for Me, select it, and then click Continue.

4. For Workflow Name, enter some unique name for this workflow.

5. In the Sources dropdown list, select your source location from Step 3.

6. In the Destinations dropdown list, select your destination location from Step 4.

   You can select multiple source and destination locations. Files will be ingested from all of the selected source locations, and the processed data will be delivered to all of the selected destination locations.

7. Click Continue.

8. The Reprocess All box applies only to blob storage connectors such as the Amazon S3, Azure Blob Storage, and Google Cloud Storage connectors:

   • Checking this box reprocesses all documents in the source location on every workflow run.
   • Unchecking this box causes new documents that have been added to the source location, as well as existing documents in the source location that have had their contents or titles changed, since the last workflow run to be processed on future runs. Other previously processed documents are not processed again.

9. Click Continue.

10. If you want this workflow to run on a schedule, in the Repeat Run dropdown list, select one of the scheduling options, and fill in the scheduling settings. Otherwise, select Don’t repeat.

11. Click Complete.

1. If you did not choose to run this workflow on a schedule in Step 5, you can run the workflow now: on the sidebar, click Workflows.
2. Next to your workflow from Step 5, click Run.

1. In the sidebar, click Jobs.
2. In the list of jobs, wait for the job’s Status to change to Finished.
3. Click the row for the job.
4. After Overview displays Finished, go to the next Step.

Go to your destination location to view the processed data.

1. Go to https://platform.unstructured.io and use your email address, Google account, or GitHub account to sign up for an Unstructured account (if you do not already have one) and sign into the account at the same time. The Unstructured user interface (UI) appears.

2. Get your Unstructured API key:

   a. In the Unstructured UI, click API Keys on the sidebar.
   b. Click Generate API Key.
   c. Follow the on-screen instructions to finish generating the key.
   d. Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
   

This quickstart uses an Amazon S3 bucket as both the source location and the destination location. (You can use other source and destination types that are supported by Unstructured. If you use a different source or destination type, or if you use a different S3 bucket for the destination location, you will need to modify the quickstart notebook accordingly.)

Inside of the S3 bucket, a folder named input represents the source location. This is where your files to be processed will be stored. The S3 URI to the source location will be s3://<your-bucket-name>/input.

Inside of the same S3 bucket, a folder inside named output represents the destination location. This is where Unstructured will put the processed data. The S3 URI to the destination location will be s3://<your-bucket-name>/output.

Learn how to create an S3 bucket and set it up for Unstructured. (Do not run the Python SDK code or REST commands at the end of those setup instructions.)

After your S3 bucket is created and set up, follow the instructions in this quickstart notebook.

After you run the quickstart notebook, go to your destination location to view the processed data.