diff --git a/api-reference/overview.mdx b/api-reference/overview.mdx index a8e2a602..a5747456 100644 --- a/api-reference/overview.mdx +++ b/api-reference/overview.mdx @@ -2,6 +2,10 @@ title: Overview --- + + To start using the Unstructured API right away, skip ahead to the [quickstart](/api-reference/partition/quickstart) now! + + The Unstructured API consists of two parts: - The [Unstructured Workflow Endpoint](/api-reference/workflow/overview) enables a full range of partitioning, chunking, embedding, and diff --git a/api-reference/partition/overview.mdx b/api-reference/partition/overview.mdx index 73a92685..2031077b 100644 --- a/api-reference/partition/overview.mdx +++ b/api-reference/partition/overview.mdx @@ -2,6 +2,10 @@ title: Overview --- + + To start using the Unstructured Partition Endpoint right away, skip ahead to the [quickstart](/api-reference/partition/quickstart) now! + + 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 diff --git a/api-reference/partition/quickstart.mdx b/api-reference/partition/quickstart.mdx index 77af15c4..6e94d26e 100644 --- a/api-reference/partition/quickstart.mdx +++ b/api-reference/partition/quickstart.mdx @@ -1,5 +1,6 @@ --- title: Unstructured API Quickstart +sidebarTitle: Quickstart --- diff --git a/api-reference/workflow/overview.mdx b/api-reference/workflow/overview.mdx index 712825cb..72c67dd5 100644 --- a/api-reference/workflow/overview.mdx +++ b/api-reference/workflow/overview.mdx @@ -2,6 +2,11 @@ title: Overview --- + + 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. + + 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). diff --git a/docs.json b/docs.json index 733e16ec..af2fe5d8 100644 --- a/docs.json +++ b/docs.json @@ -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", @@ -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", @@ -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", diff --git a/snippets/quickstarts/platform.mdx b/snippets/quickstarts/platform.mdx index e1307593..210c394e 100644 --- a/snippets/quickstarts/platform.mdx +++ b/snippets/quickstarts/platform.mdx @@ -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. + -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). --- diff --git a/ui/sources/dropbox-source-quickstart.mdx b/ui/sources/dropbox-source-quickstart.mdx index 12744248..81dd4cfd 100644 --- a/ui/sources/dropbox-source-quickstart.mdx +++ b/ui/sources/dropbox-source-quickstart.mdx @@ -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). diff --git a/ui/sources/overview.mdx b/ui/sources/overview.mdx index 4477ccd3..ab494303 100644 --- a/ui/sources/overview.mdx +++ b/ui/sources/overview.mdx @@ -2,6 +2,13 @@ title: Overview --- + + 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. + + import FirstTimeUISourceConnector from '/snippets/general-shared-text/first-time-ui-source-connector.mdx';