Skip to content

Commit d5a5c21

Browse files
authored
API walkthrough notebook links (#763)
1 parent 56f7ebc commit d5a5c21

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

api-reference/workflow/overview.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: Overview
33
---
44

55
<Tip>
6-
To start using the Unstructured Workflow Endpoint right away, skip ahead to the [quickstart](#quickstart),
6+
To start using the Unstructured Workflow Endpoint right away, skip ahead to the [quickstart](#quickstart) or
7+
[walkthrough](#walkthrough),
78
which uses the Unstructured Python SDK from a remote hosted Google Colab notebook.
89
</Tip>
910

@@ -22,7 +23,7 @@ scenarios as well as for documentation, reporting, and recovery needs.
2223

2324
Choose one of the following options to get started with the Unstructured Workflow Endpoint:
2425

25-
- Follow the [quickstart](#quickstart), which uses the Unstructured Python SDK from a remote hosted Google Colab notebook.
26+
- Follow the [quickstart](#quickstart) or [walkthrough](#walkthrough), which uses the Unstructured Python SDK from a remote hosted Google Colab notebook.
2627
- Start using the [Unstructred Python SDK](#unstructured-python-sdk).
2728
- Start using a [REST](#rest-endpoints) client, such as `curl` or Postman.
2829

@@ -32,6 +33,12 @@ import SharedPlatformAPI from '/snippets/quickstarts/platform-api.mdx';
3233

3334
<SharedPlatformAPI />
3435

36+
## Walkthrough
37+
38+
import WorkflowAPIWalkthrough from '/snippets/quickstarts/walkthrough-api.mdx';
39+
40+
<WorkflowAPIWalkthrough />
41+
3542
## Unstructured Python SDK
3643

3744
Watch the following 4-minute video to learn how to use the Python SDK to call the Unstructured Workflow Endpoint to

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 API Walkthrough" href="https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/Unstructured_API_Walkthrough.ipynb">
10+
<br/>
11+
This walkthrough provides you with deep, hands-on experience with the Unstructured API. As you follow along, you will learn how to use many of the Unstructured API's features for partitioning, enriching, chunking, and embedding.
12+
<br/>
13+
``Unstructured API`` ``Workflows`` ``Workflow Endpoint`` ``Local File``
14+
<br/>
15+
</Card>
916
<Card title="Everything (from) Everywhere All at Once" href="https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/RAG_From_Multiple_Data_Sources_FileTypes.ipynb">
1017
<br/>
1118
Set up an AI assistant that answers questions by querying your company's scattered data. Retrieve context from contracts in Azure, sales decks in OneDrive, and emails in Outlook through a single RAG pipeline.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This walkthrough uses the Unstructured Python SDK to provide you with deep, hands-on experience with Unstructured end-to-end.
2+
As you follow along, you will learn how to use many of the Unstructured Workflow Endpoint's features for partitioning, enriching, chunking, and embedding.
3+
The Python code for this walkthough is in a remote hosted Google Colab notebook. Data is processed on Unstructured-hosted compute resources.
4+
5+
To run this walkthrough, open the [notebook](https://colab.research.google.com/github/Unstructured-IO/notebooks/blob/main/notebooks/Unstructured_API_Walkthrough.ipynb) and begin following the notebook's on-screen instructions.

0 commit comments

Comments
 (0)