|
| 1 | +This quickstart uses a no-code, point-and-click user interface (UI) in your web browser to have Unstructured process a single file that is stored on your local machine. |
| 2 | + |
| 3 | +The file is first processed on Unstructured-hosted compute resources. The UI then shows the processed data that Unstructured generates for that file. |
| 4 | +You can download that processed data as a `.json` file to your local machine. |
| 5 | + |
| 6 | +This approach enables rapid, local, run-adjust-repeat prototyping of end-to-end Unstructured ETL+ workflows with a full range of Unstructured features. |
| 7 | +After you get the results you want, you can then attach remote source and destination connectors to both ends of your existing workflow to begin processing remote files and data at scale in production. |
| 8 | + |
| 9 | +To run this quickstart, you will need a local file with a size of 10 MB or less and one of the following file types: |
| 10 | + |
| 11 | +| File type | |
| 12 | +|---| |
| 13 | +| `.bmp` | |
| 14 | +| `.csv` | |
| 15 | +| `.doc` | |
| 16 | +| `.docx` | |
| 17 | +| `.email` | |
| 18 | +| `.epub` | |
| 19 | +| `.heic` | |
| 20 | +| `.html` | |
| 21 | +| `.jpg` | |
| 22 | +| `.md` | |
| 23 | +| `.odt` | |
| 24 | +| `.org` | |
| 25 | +| `.pdf` | |
| 26 | +| `.pot` | |
| 27 | +| `.potm` | |
| 28 | +| `.ppt` | |
| 29 | +| `.pptm` | |
| 30 | +| `.pptx` | |
| 31 | +| `.rst` | |
| 32 | +| `.rtf` | |
| 33 | +| `.sgl` | |
| 34 | +| `.tiff` | |
| 35 | +| `.txt` | |
| 36 | +| `.tsv` | |
| 37 | +| `.xls` | |
| 38 | +| `.xlsx` | |
| 39 | +| `.xml` | |
| 40 | + |
| 41 | +<Note> |
| 42 | + For processing remote files at scale in production, Unstructured supports many more files types than these. [See the list of supported file types](/ui/supported-file-types). |
| 43 | + |
| 44 | + Unstructured also supports processing files from remote object stores, and data from remote sources in websites, web apps, databases, and vector stores. For more information, see the [source connector overview](/ui/sources/overview) and the [remote quickstart](/ui/quickstart#remote-quickstart) |
| 45 | + for how to set up and run production-ready Unstructured ETL+ workflows at scale. |
| 46 | +</Note> |
| 47 | + |
| 48 | +If you do not have any files available, you can use one of the sample files that Unstructured offers in the UI. Or, you can download one or more sample files |
| 49 | +from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub. |
| 50 | + |
| 51 | +import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-simple-ui-only.mdx'; |
| 52 | + |
| 53 | +<Steps> |
| 54 | + <Step title="Sign up and sign in"> |
| 55 | + <GetStartedSimpleUIOnly /> |
| 56 | + </Step> |
| 57 | + <Step title="Create a workflow"> |
| 58 | + 1. In the Unstructured UI, on the sidebar, click **Workflows**. |
| 59 | + |
| 60 | +  |
| 61 | + |
| 62 | + 2. Click **New Workflow**. |
| 63 | + 3. Select **Build it Myself**, if it is not already selected. |
| 64 | + 4. Click **Continue**. The visual workflow editor appears. |
| 65 | + |
| 66 | +  |
| 67 | + |
| 68 | + The workflow is represented visually as a series of directed acyclic graph (DAG) nodes. Each node represents a |
| 69 | + step in the workflow. The workflow proceeds end to end from left to right. By default, the workflow starts with three nodes: |
| 70 | + |
| 71 | + - **Source**: This node represents the location where you have your files or data for Unstructured to process. For this quickstart, this node represents a single file on your local machine. |
| 72 | + After you get the results you want, you can update this node to represent files or data in a remote location at scale in production. |
| 73 | + - **Partitioner**: This node represents the [partitioning](/ui/partitioning) step, which extracts content from unstructured files and data and outputs it as structured |
| 74 | + [document elements](/ui/document-elements) for consistent representation across varying kinds of file and data types. For this quickstart, this node extracts the contents of a single file on |
| 75 | + your local machine and outputs it as a series of structured document elements in JSON format. |
| 76 | + - **Destination**: This node represents the location where you want Unstructured to put the processed files or data. |
| 77 | + After you get the results you want, you can update this node to have Unstructured put the processed files or data into a remote location at scale in production. |
| 78 | + |
| 79 | + </Step> |
| 80 | + <Step title="Process a local file"> |
| 81 | + 1. Drag the file that you want Unstructured to process from your local machine's file browser app and drop it into the **Source** node's **Drop file to test** area. |
| 82 | + The file must have a size of 10 MB or less and one of the file types listed at the beginning of this quickstart. |
| 83 | + |
| 84 | + If you are not able to drag and drop the file, you can click **Drop file to test** and then browse to and select the file instead. |
| 85 | + |
| 86 | + Alternatively, you can use a sample file that Unstructured offers. To do this, click the **Source** node, and then in the **Source** pane, with |
| 87 | + **Details** selected, on the **Local file** tab, click one of the files under **Or use a provided sample file**. To view the file's contents before you |
| 88 | + select it, click the eyes button next to the file. |
| 89 | + |
| 90 | + 2. Above the **Source** node, click **Test**. |
| 91 | + |
| 92 | +  |
| 93 | + |
| 94 | + Unstructured displays a visual representation of the file and begins processing its contents, sending it through each of the workflow's nodes in sequence. |
| 95 | + Depending on the file's size and the workflow's complexity, this processing could take several minutes. |
| 96 | + |
| 97 | + After Unstructured has finished its processing, the processed data appears in the **Test output** pane, as a series of structured elements in JSON format. |
| 98 | + |
| 99 | +  |
| 100 | + |
| 101 | + 3. In the **Test output** pane, you can: |
| 102 | + |
| 103 | + - Search through the processed, JSON-formatted representation of the file by using the **Search JSON** box. |
| 104 | + - Download the full JSON as a `.json` file to your local machine by clicking **Download full JSON**. |
| 105 | + |
| 106 | + 4. When you are done, click the **Close** button in the **Test output** pane. |
| 107 | + |
| 108 | + </Step> |
| 109 | + <Step title="Add more nodes to the workflow"> |
| 110 | + 1. You can now add more nodes to the workflow to do further testing of various Unstructured features and with the option of eventually moving the workflow into production. For example, you can: |
| 111 | + |
| 112 | +  |
| 113 | + |
| 114 | + - Add a **Chunker** node after the **Partitioner** node, to chunk the partitioned data into smaller pieces for your retrieval augmented generation (RAG) applications. |
| 115 | + To do this, click the add (**+**) button to the right of the **Partitioner** node, and then click **Enrich > Chunker**. Click the new **Chunker** node and |
| 116 | + specify its settings. For help, click the **FAQ** button in the **Chunker** node's pane. [Learn more about chunking and chunker settings](/ui/chunking). |
| 117 | + - Add an **Enrichment** node after the **Chunker** node, to apply enrichments to the chunked data such as image summaries, table summaries, table-to-HTML transforms, and |
| 118 | + named entity recognition (NER). To do this, click the add (**+**) button to the right of the **Chunker** node, and then click **Enrich > Enrichment**. |
| 119 | + Click the new **Enrichment** node and specify its settings. For help, click the **FAQ** button in the **Enrichment** node's pane. [Learn more about enrichments and enrichment settings](/ui/enriching/overview). |
| 120 | + - Add an **Embedder** node after the **Enrichment** node, to generate vector embeddings for performing vector-based searches. To do this, click the add (**+**) button to the |
| 121 | + right of the **Enrichment** node, and then click **Transform > Embedder**. Click the new **Embedder** node and specify its settings. For help, click the **FAQ** button |
| 122 | + in the **Embedder** node's pane. [Learn more about embedding and embedding settings](/ui/embedding). |
| 123 | + |
| 124 | + 2. Each time you add a node or change its settings, you can click **Test** above the **Source** node again to test the current workflow end to end and see the results of the changes, if any. |
| 125 | + |
| 126 | + 3. Keep repeating this step as many times as you want, until you get the results you want. |
| 127 | + |
| 128 | + </Step> |
| 129 | + <Step title="Next steps"> |
| 130 | + After you get the results you want, you have the option of moving your workflow into production. To do this, complete the following instructions. |
| 131 | + |
| 132 | + <Note> |
| 133 | + The following instructions have you create a new workflow that is suitable for production. |
| 134 | + This behavior is planned to be fixed in a future release, allowing you to update the workflow that you just created, rather than needing to create a new one. |
| 135 | + </Note> |
| 136 | + |
| 137 | + 1. With your workflow remaining open in the visual workflow editor, open a new tab in your web browser, and in this new tab, |
| 138 | + sign in to your Unstructured account, at [https://platform.unstructured.io](https://platform.unstructured.io). |
| 139 | + 2. In this new tab, create a [source connector](/ui/sources/overview) for your remote source location. This is the location in production where you have files or data in a file or object store, website, database, or vector store that you want Unstructured to process. |
| 140 | + |
| 141 | +  |
| 142 | + |
| 143 | + 3. Create a [destination connector](/ui/destinations/overview) for your remote destination location. This is the location in production where you want Unstructured to put the processed data as `.json` files in a file or object store, or as records in a database or vector store. |
| 144 | + 4. Create a workflow: on the sidebar, click **Workflows**, and then click **New Workflow**. Select **Build it Myself**, and then click **Continue** to open the visual workflow editor. |
| 145 | + 5. In the visual workflow editor, click **Source**. |
| 146 | + 6. In the **Source** pane, with **Details** selected, on the **Connectors** tab, select the source connector that you just created. |
| 147 | + 7. Click the **Destination** node. |
| 148 | + 8. In the **Destination** pane, with **Details** selected, select the destination connector that you just created. |
| 149 | + 9. Using your original workflow on the other tab as a guide, add any additional nodes to this new workflow as needed, and configure those new nodes' settings to match the other ones. |
| 150 | + 10. Click **Save**. |
| 151 | + 11. To run the workflow: |
| 152 | + |
| 153 | + a. Make sure to click **Save** first.<br/> |
| 154 | + b. Click the **Close** button next to the workflow's name in the top navigation bar.<br/> |
| 155 | + c. On the sidebar, click **Workflows**.<br/> |
| 156 | + d. In the list of available workflows, click the **Run** button for the workflow that you just saved.<br/> |
| 157 | + e. On the sidebar, click **Jobs**.<br/> |
| 158 | + |
| 159 | +  |
| 160 | + |
| 161 | + f. In the list of available jobs, click the job that you just ran.<br/> |
| 162 | + g. After the job status shows **Finished**, go to the your destination location to see the processed files or data that Unstructured put there. |
| 163 | + |
| 164 | + See also the [remote quickstart](/ui/quickstart#remote-quickstart) for more coverage about how to set up and run production-ready Unstructured ETL+ workflows at scale. |
| 165 | + </Step> |
| 166 | +</Steps> |
0 commit comments