From 00dcb49b6d1d44b6bcead4708ccfba2bc224f583 Mon Sep 17 00:00:00 2001 From: Paul Cornell Date: Mon, 17 Mar 2025 17:21:54 -0700 Subject: [PATCH 1/2] Ingest: add simplified getting started steps (account, API key, API URL) --- ingestion/ingest-cli.mdx | 21 +++++++++++++++++++++ ingestion/python-ingest.mdx | 21 +++++++++++++++++++++ 2 files changed, 42 insertions(+) diff --git a/ingestion/ingest-cli.mdx b/ingestion/ingest-cli.mdx index 94e3d602..d96b87d7 100644 --- a/ingestion/ingest-cli.mdx +++ b/ingestion/ingest-cli.mdx @@ -11,6 +11,27 @@ The Unstructured Ingest CLI enables you to use command-line scripts to send file For information about the Unstructured API, see the [Unstructured API Overview](/api-reference/workflow/overview). +## Getting started + +import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-simple-api-only.mdx'; + +You can use the Unstructured Ingest CLI to process files locally, or you can use the Ingest CLI to send files in batches to Unstructured for processing. + +Local processing does not use an Unstructured API key or API URL. + +Using the Ingest CLI to send files in batches to Unstructured for processing is more robust but requires an Unstructured API key and API URL, as follows: + + + +3. The Unstructured API URL is `...`. + + + If the Unstructured API is hosted on your own compute infrastructure, the process + for generating Unstructured API keys, and the Unstructured API URL that you use, are different. + For details, contact Unstructured Sales at + [sales@unstructured.io](mailto:sales@unstructured.io). + + ## Installation One approach to get started quickly with the Unstructured Ingest CLI is to install Python and then run the following command: diff --git a/ingestion/python-ingest.mdx b/ingestion/python-ingest.mdx index 1c004186..c3a67baf 100644 --- a/ingestion/python-ingest.mdx +++ b/ingestion/python-ingest.mdx @@ -23,6 +23,27 @@ The following 3-minute video shows how to use the Unstructured Ingest Python lib allowfullscreen > +## Getting started + +import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-simple-api-only.mdx'; + +You can use the Unstructured Ingest Python library to process files locally, or you can use the Ingest Python library to send files in batches to Unstructured for processing. + +Local processing does not use an Unstructured API key or API URL. + +Using the Ingest Python library to send files in batches to Unstructured for processing is more robust but requires an Unstructured API key and API URL, as follows: + + + +3. The Unstructured API URL is `...`. + + + If the Unstructured API is hosted on your own compute infrastructure, the process + for generating Unstructured API keys, and the Unstructured API URL that you use, are different. + For details, contact Unstructured Sales at + [sales@unstructured.io](mailto:sales@unstructured.io). + + ## Installation One approach to get started quickly with the Unstructured Ingest Python library is to install Python and then run the following command: From 4258c903162fcc5e8252563bb87707d595d672f2 Mon Sep 17 00:00:00 2001 From: Paul Cornell Date: Mon, 17 Mar 2025 18:10:50 -0700 Subject: [PATCH 2/2] Adding API URL and URL default behavior --- ingestion/ingest-cli.mdx | 4 +++- ingestion/python-ingest.mdx | 4 +++- .../partition-by-api-oss.mdx | 13 ++++++++++++- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/ingestion/ingest-cli.mdx b/ingestion/ingest-cli.mdx index d96b87d7..932f2e7c 100644 --- a/ingestion/ingest-cli.mdx +++ b/ingestion/ingest-cli.mdx @@ -23,7 +23,9 @@ Using the Ingest CLI to send files in batches to Unstructured for processing is -3. The Unstructured API URL is `...`. +3. The default Unstructured API URL for Unstructured Ingest is `https://api.unstructuredapp.io/general/v0/general`, which is the API URL for the [Unstructured Partition Endpoint](/api-reference/partition/overview). + You must specify this API URL in your + scripts only if you are not using this default, for example, if you are calling a version of the Unstructured API that is hosted on your own compute infrastructure. If the Unstructured API is hosted on your own compute infrastructure, the process diff --git a/ingestion/python-ingest.mdx b/ingestion/python-ingest.mdx index c3a67baf..3d6854c9 100644 --- a/ingestion/python-ingest.mdx +++ b/ingestion/python-ingest.mdx @@ -35,7 +35,9 @@ Using the Ingest Python library to send files in batches to Unstructured for pro -3. The Unstructured API URL is `...`. +3. The default Unstructured API URL for Unstructured Ingest is `https://api.unstructuredapp.io/general/v0/general`, which is the API URL for the [Unstructured Partition Endpoint](/api-reference/partition/overview). + You must specify this API URL in your + code only if you are not using this default, for example, if you are calling a version of the Unstructured API that is hosted on your own compute infrastructure. If the Unstructured API is hosted on your own compute infrastructure, the process diff --git a/snippets/ingest-configuration-shared/partition-by-api-oss.mdx b/snippets/ingest-configuration-shared/partition-by-api-oss.mdx index 9e232aac..a824a6bd 100644 --- a/snippets/ingest-configuration-shared/partition-by-api-oss.mdx +++ b/snippets/ingest-configuration-shared/partition-by-api-oss.mdx @@ -16,4 +16,15 @@ For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you - `--partition-endpoint $UNSTRUCTURED_API_URL` (CLI) or `partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")` (Python) - The environment variables `UNSTRUCTURED_API_KEY` and `UNSTRUCTURED_API_URL`, representing your API key and API URL, respectively. - [Get an API key and API URL](/api-reference/partition/overview). \ No newline at end of file + + You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, for example, if you are using a version of the Unstructured API that is hosted on your own compute infrastructure. + + The default API URL for Unstructured Ingest is `https://api.unstructuredapp.io/general/v0/general`, which is the API URL for the [Unstructured Partition Endpoint](/api-reference/partition/overview). + + If you do not have an API key, [get one now](/api-reference/partition/overview). + + If the Unstructured API is hosted on your own compute infrastructure, the process + for generating Unstructured API keys, and the Unstructured API URL that you use, are different. + For details, contact Unstructured Sales at + [sales@unstructured.io](mailto:sales@unstructured.io). + \ No newline at end of file