Skip to content
Merged
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
4 changes: 4 additions & 0 deletions api-reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: Overview
---

<Tip>
To start using the Unstructured API right away, skip ahead to the [quickstart](/api-reference/partition/quickstart) now!
</Tip>

The Unstructured API consists of two parts:

- The [Unstructured Workflow Endpoint](/api-reference/workflow/overview) enables a full range of partitioning, chunking, embedding, and
Expand Down
4 changes: 4 additions & 0 deletions api-reference/partition/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
title: Overview
---

<Tip>
To start using the Unstructured Partition Endpoint right away, skip ahead to the [quickstart](/api-reference/partition/quickstart) now!
</Tip>

The Unstructured Partition Endpoint, part of the [Unstructured API](/api-reference/overview), is intended for rapid prototyping of Unstructured's
various partitioning strategies, with limited support for chunking. It is designed to work only with processing of local files, one file
at a time. Use the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) for production-level scenarios, file processing in
Expand Down
1 change: 1 addition & 0 deletions api-reference/partition/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Unstructured API Quickstart
sidebarTitle: Quickstart
---

<Tip>
Expand Down
5 changes: 5 additions & 0 deletions api-reference/workflow/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
title: Overview
---

<Tip>
To start using the Unstructured Workflow Endpoint right away, skip ahead to the [quickstart](#quickstart),
which uses the Unstructured Python SDK from a remote hosted Google Colab notebook.
</Tip>

The [Unstructured UI](/ui/overview) features a no-code user interface for transforming your unstructured data into data that is ready
for retrieval-augmented generation (RAG).

Expand Down
3 changes: 3 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"group": "Sources",
"pages": [
"ui/sources/overview",
"ui/sources/dropbox-source-quickstart",
"ui/sources/azure-blob-storage",
"ui/sources/box",
"ui/sources/confluence",
Expand Down Expand Up @@ -67,6 +68,7 @@
"group": "Destinations",
"pages": [
"ui/destinations/overview",
"ui/destinations/pinecone-destination-quickstart",
"ui/destinations/astradb",
"ui/destinations/azure-ai-search",
"ui/destinations/couchbase",
Expand Down Expand Up @@ -215,6 +217,7 @@
"group": "Partition Endpoint",
"pages": [
"api-reference/partition/overview",
"api-reference/partition/quickstart",
"api-reference/partition/post-requests",
"api-reference/partition/sdk-python",
"api-reference/partition/sdk-jsts",
Expand Down
15 changes: 13 additions & 2 deletions snippets/quickstarts/platform.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,20 @@ The following quickstart shows you how to use the Unstructured UI to process rem
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](/ui/connectors#sources).

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](/ui/sources/dropbox-source-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](/ui/supported-file-types). If you do not have any files available, you can download some from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/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](/ui/connectors#destinations).

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](/ui/destinations/pinecone-destination-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.

<iframe
width="560"
height="315"
Expand All @@ -26,7 +37,7 @@ import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-si
![Sources in the sidebar](/img/ui/Sources-Sidebar.png)
1. From your Unstructured dashboard, in the sidebar, click **Connectors**.
2. Click **Sources**.
3. Cick **New** or **Create Connector**.
3. Click **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**.
Expand All @@ -38,7 +49,7 @@ import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-si
![Destinations in the sidebar](/img/ui/Destinations-Sidebar.png)
1. In the sidebar, click **Connectors**.
2. Click **Destinations**.
3. Cick **New** or **Create Connector**.
3. Click **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**.
Expand Down
7 changes: 7 additions & 0 deletions ui/destinations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
title: Overview
---

<Tip>
If you do not have a destination location for Unstructured to send its processed data, skip over to the
[Pinecone destination connector quickstart](/ui/destinations/pinecone-destination-quickstart). 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.
</Tip>

import FirstTimeUIDestinationConnector from '/snippets/general-shared-text/first-time-ui-destination-connector.mdx';

<FirstTimeUIDestinationConnector />
Expand Down
1 change: 1 addition & 0 deletions ui/destinations/pinecone-destination-quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Pinecone destination connector quickstart
sidebarTitle: Quickstart
---

Unstructured can connect to several types of [destinations](/ui/connectors#destinations). In this quickstart, you create a [Pinecone](https://www.pinecone.io) destination connector that you can add to your Unstructured [workflows](/ui/workflows).
Expand Down
8 changes: 3 additions & 5 deletions ui/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,9 @@ import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-si
allowfullscreen
></iframe>

Learn more 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).
4. 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).

---

Expand Down
1 change: 1 addition & 0 deletions ui/sources/dropbox-source-quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Dropbox source connector quickstart
sidebarTitle: Quickstart
---

Unstructured can connect to several types of [sources](/ui/connectors#sources). In this quickstart, you create a [Dropbox](https://www.dropbox.com/) source connector that you can add to your Unstructured [workflows](/ui/workflows).
Expand Down
7 changes: 7 additions & 0 deletions ui/sources/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
title: Overview
---

<Tip>
If you do not have a source location to store your documents for Unstructured to process, skip over to the
[Dropbox source connector quickstart](/ui/sources/dropbox-source-quickstart). 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.
</Tip>

import FirstTimeUISourceConnector from '/snippets/general-shared-text/first-time-ui-source-connector.mdx';

<FirstTimeUISourceConnector />
Expand Down