Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions snippets/general-shared-text/get-started-single-file-ui.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
If you do not already have an Unstructured account, [sign up for free](https://unstructured.io/?modal=try-for-free).
After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io).

Do the following:

1. After you are signed in, the **Start** page appears.
2. In the **Welcome** area, do one of the following:

- Click one of the sample files, such as **realestate.pdf**, to have Unstructured parse and transform that sample file.
- Click **Browse files**, and then browse to and select one of your own files, to have Unstructured parse and transform it.

3. After Unstructured has finished parsing and transforming the file (a process known as
[partitioning](/ui/partitioning)), you will see the file's contents in the
center and Unstructured's results on the right.
4. The view on the right shows a formatted view of Unstructured's results, which is designed for human
readability. To see the underlying JSON view of the results, which is designed for RAG and agentic AI,
click **JSON** at the top of the view on the right side of the screen.
[Learn about what's in the JSON view](/ui/document-elements).

You can also do the following:

- To download the results as a local JSON file, click the download icon to the left of the **Formatted** and **JSON** buttons.
- To have Unstructured partition a different file, click **Add new file** on the left, and then browse to and select the target file.
- To view the results for a file that was previously partitioned during this session, click the file's name in the **Recent files** list on the left.
- To return to the **Start** page, click the **X** (close) button at the top left of the page, next to **Transform**.
- To have Unstructured do more than just partitioning, such as
[chunking](/ui/chunking),
[enriching](/ui/enriching/overview),
and [embedding](/ui/embedding),
click **Edit in Workflow Editor** at the top right of the page, or [skip over to the walkthrough](/ui/walkthrough).
- To get an associated code snippet that you can use to have Unstructured parse and transform a file programmatically instead of by using the Unstructured user interface,
click the down arrow next to **Copy curl command** at the top right of the page, and then do one of the following:

- Click **Show options** to see the associated`curl`, Unstructured Python SDK, and Unstructured JavaScript/TypeScript SDK code snippets. Then do one of the following:

- Click the **Copy** icon in the top right corner to copy the active code snippet to your system's clipboard.
- Click **My API keys** to get your Unstructured API key, which is necessary when calling Unstructured programmatically.
- Click **API Documentation** to learn how to set up, customize, and run the code.

- Click **Copy curl command** to copy the `curl` code snippet to your system's clipboard without viewing the code snippet first.
- Click **Copy Python SDK code** to copy the Unstructured Python SDK code snippet to your system's clipboard without viewing the code snippet first.
- Click **Copy JavaScript code** to copy the Unstructured JavaScript/TypeScript SDK code snippet to your system's clipboard without viewing the code snippet first.

<Icon icon="arrow-up" />&nbsp;&nbsp;[Learn how to add chunking, enrichments, and embeddings after partitioning](/ui/walkthrough).

<Icon icon="person-chalkboard" />&nbsp;&nbsp;[Learn more about the Unstructured user interface](/ui/overview).
28 changes: 2 additions & 26 deletions ui/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,9 @@ sidebarTitle: Quickstarts

## Local file quickstart

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.
import GetStartedSingleFileUI from '/snippets/general-shared-text/get-started-single-file-ui.mdx';

To process files (or data) in remote locations instead, skip ahead to the [remote quickstart](#remote-quickstart).

import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-simple-ui-only.mdx';

<GetStartedSimpleUIOnly />

3. After you sign in, watch the following 2-minute video:

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/11Q2_5a-tZM"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

4. To keep enhancing your workflow, skip ahead to the [walkthrough](/ui/walkthrough).

5. To move beyond local file processing, you can try the following [remote quickstart](#remote-quickstart), or skip over to the [Dropbox source connector quickstart](/ui/sources/dropbox-source-quickstart) instead.

You can also learn about Unstructured [source connectors](/ui/sources/overview), [destination connectors](/ui/destinations/overview), [workflows](/ui/workflows), [jobs](/ui/jobs), and [managing your account](/ui/account/overview).
<GetStartedSingleFileUI />

---

Expand Down
18 changes: 2 additions & 16 deletions welcome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,23 +51,9 @@ You can use Unstructured through a user interface (UI), an API, or both. Read on

## <Icon icon="desktop" /> Unstructured UI quickstart

1. If you do not already have an Unstructured account, [sign up for free](https://unstructured.io/?modal=try-for-free).
After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io).
2. Watch the following 2-minute video:
import GetStartedSingleFileUI from '/snippets/general-shared-text/get-started-single-file-ui.mdx';

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/11Q2_5a-tZM"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

<Icon icon="arrow-up" />&nbsp;&nbsp;[Keep enhancing your workflow](/ui/walkthrough).

<Icon icon="person-chalkboard" />&nbsp;&nbsp;[Learn more](/ui/overview).
<GetStartedSingleFileUI />

---

Expand Down