The following quickstart shows you how to use the Unstructured UI to process a single file that is stored on your local machine.
This approach is ideal for rapid testing and prototyping of Unstructured ETL+ workflows, across the full range of Unstructured features,
against a single representative file.To process files (or data) in remote locations instead, skip ahead to the remote quickstart.
If you do not already have an Unstructured account, sign up for free.
After you sign up, you are automatically signed in to your new Unstructured Starter account, at https://platform.unstructured.io.
The following quickstart shows you how to use the Unstructured UI to process remote files (or data).The requirements are as follows.
A compatible source (input) location that contains your data for Unstructured to process. See the list of supported source types.If your source (input) location is not in this list, or if you do not yet have any source locations for Unstructured to process, stop here and
skip over to the Dropbox source connector quickstart instead. This quickstart
guides you through the process of creating a free Dropbox account, uploading your files to Dropbox,
and creating a source connector to connect Unstructured to those files.
For document-based source locations, compatible files in that location. See the list of supported file types. If you do not have any files available, you can download some from the example-docs folder in the Unstructured repo on GitHub.
A compatible destination (output) location for Unstructured to put the processed data. See the list of supported destination types.If your destination (output) location is not in this list, or if you do not yet have any destination locations for Unstructured to send its processed data, stop here and
skip over to the Pinecone destination connector quickstart instead. This quickstart
guides you through the process of creating a free Pinecone account
and creating a destination connector to connect Unstructured to a Pinecone dense serverless index within your Pinecone account.
1
Sign up and sign in
If you do not already have an Unstructured account, sign up for free.
After you sign up, you are automatically signed in to your new Unstructured Starter account, at https://platform.unstructured.io.
If you have an Unstructured Starter or Team account and are not already signed in, sign in to your account at https://platform.unstructured.io.
For an Enterprise account, see your Unstructured account administrator for instructions,
or email Unstructured Support at support@unstructured.io.
2
Set the source (input) location
From your Unstructured dashboard, in the sidebar, click Connectors.
Click Sources.
Click New or Create Connector.
For Name, enter some unique name for this connector.
In the Provider area, click the source location type that matches yours.
Click Continue.
Fill in the fields with the appropriate settings. Learn more.
If a Continue button appears, click it, and fill in any additional settings fields.
Click Save and Test.
3
Set the destination (output) location
In the sidebar, click Connectors.
Click Destinations.
Click New or Create Connector.
For Name, enter some unique name for this connector.
In the Provider area, click the destination location type that matches yours.
Click Continue.
Fill in the fields with the appropriate settings. Learn more.
If a Continue button appears, click it, and fill in any additional settings fields.
Click Save and Test.
4
Define the workflow
In the sidebar, click Workflows.
Click New Workflow.
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.
For Workflow Name, enter some unique name for this workflow.
In the Sources dropdown list, select your source location from Step 3.
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.
Click Continue.
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 only new documents that are added to the source location, or existing documents that are updated in the source location, since the last workflow run to be processed on future runs. Previously processed documents are not processed again. However:
Even if this box is unchecked, a renamed file is always treated as a new file, regardless of whether the file’s original contents have changed.
Even if this box is unchecked, a file that is removed but is added back later with the same file name is processed on future runs only if the file’s contents have changed since the file was originally processed.
Click Continue.
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.
Click Complete.
5
Process the documents
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.
Next to your workflow from Step 5, click Run.
6
Monitor the processing job
In the sidebar, click Jobs.
In the list of jobs, wait for the job’s Status to change to Finished.
Click the row for the job.
After Overview displays Finished, go to the next Step.
7
View the processed data
Go to your destination location to view the processed data.