Skip to content

Commit 7263449

Browse files
authored
Partition Endpoint: link to available quickstart notebook (#724)
1 parent c0358d7 commit 7263449

File tree

4 files changed

+20
-1
lines changed

4 files changed

+20
-1
lines changed

api-reference/partition/overview.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ import Pricing from '/snippets/general-shared-text/pricing-platform.mdx';
2626

2727
## Quickstart
2828

29+
<Tip>
30+
To use the Unstructured Python SDK instead of `curl` for the following quickstart,
31+
[skip ahead](/api-reference/partition/quickstart) to the SDK version instead.
32+
</Tip>
33+
2934
This example uses the [curl](https://curl.se/) utility on your local machine to call the Unstructured Partition Endpoint. It sends a source (input) file from your local machine to the Unstructured Partition Endpoint which then delivers the processed data to a destination (output) location, also on your local machine. Data is processed on Unstructured-hosted compute resources.
3035

3136
If you do not have a source file readily available, you could use for example a sample PDF file containing the text of the United States Constitution,

api-reference/partition/quickstart.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22
title: Unstructured API Quickstart
33
---
44

5-
<Tip>Just need to copy the sample code? [Skip ahead](#sample-code) to it now!</Tip>
5+
<Tip>
6+
Do you want to run this quickstart without modifying your local machine?
7+
[Skip ahead](https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/Unstructured_Partition_Endpoint_Quickstart.ipynb) to run this quickstart as a notebook on Google Colab now!
8+
9+
Do you want to just copy the sample code for use on your local machine? [Skip ahead](#sample-code) to the code now!
10+
</Tip>
611

712
<iframe
813
width="560"

examplecode/notebooks.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ description: "Notebooks contain complete working sample code for end-to-end solu
66
---
77

88
<CardGroup cols={2}>
9+
<Card title="Unstructured Partition Endpoint Quickstart" href="https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/Unstructured_Partition_Endpoint_Quickstart.ipynb">
10+
<br/>
11+
This notebook calls the Unstructured Python SDK to have Unstructured process a local file by using the Unstructured Partition Endpoint.
12+
<br/>
13+
``Unstructured API`` ``Partition Endpoint`` ``Local file``
14+
<br/>
15+
</Card>
916
<Card title="Preserving Table Structure for Better Retrieval" href="https://colab.research.google.com/drive/1__axq0MRDR9i1M_uEW-pR8aKYH_Qk1hj?usp=sharing">
1017
<br/>
1118
This notebook explores using Unstructured API to process financial documents while preserving tabular structure in a way that's usable by downstream applications.

welcome.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ You can use Unstructured through a user interface (UI), an API, or both. Read on
8585
allowfullscreen
8686
></iframe>
8787

88+
<Icon icon="note-sticky" />&nbsp;&nbsp;[Run this quickstart as a notebook on Google Colab instead](https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/Unstructured_Partition_Endpoint_Quickstart.ipynb).
89+
8890
<Icon icon="code" />&nbsp;&nbsp;[Get the sample code for this video](/api-reference/partition/quickstart#sample-code).
8991

9092
<Icon icon="gear" />&nbsp;&nbsp;[Get the full setup instructions for this video](/api-reference/partition/quickstart).

0 commit comments

Comments
 (0)