From dd2a151543a8f44a25bfdd00134302d02b39c35a Mon Sep 17 00:00:00 2001 From: Matt Robinson Date: Tue, 27 Jun 2023 19:54:15 -0400 Subject: [PATCH] Docs/unstructured api key (#6781) ### Summary The Unstructured API will soon begin requiring API keys. This PR updates the Unstructured integrations docs with instructions on how to generate Unstructured API keys. ### Reviewers @rlancemartin @eyurtsev @hwchase17 --- .../extras/ecosystem/integrations/unstructured.mdx | 14 +++++++++----- .../integrations/unstructured_file.ipynb | 3 +-- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/extras/ecosystem/integrations/unstructured.mdx b/docs/extras/ecosystem/integrations/unstructured.mdx index fb3ba2a50..8a6699e25 100644 --- a/docs/extras/ecosystem/integrations/unstructured.mdx +++ b/docs/extras/ecosystem/integrations/unstructured.mdx @@ -23,11 +23,15 @@ its dependencies running locally. If you want to get up and running with less set up, you can simply run `pip install unstructured` and use `UnstructuredAPIFileLoader` or `UnstructuredAPIFileIOLoader`. That will process your document using the hosted Unstructured API. -Note that currently (as of 1 May 2023) the Unstructured API is open, but it will soon require -an API. The [Unstructured documentation page](https://unstructured-io.github.io/) will have -instructions on how to generate an API key once they're available. Check out the instructions -[here](https://github.com/Unstructured-IO/unstructured-api#dizzy-instructions-for-using-the-docker-image) -if you'd like to self-host the Unstructured API or run it locally. + + +The Unstructured API requires API keys to make requests. +You can generate a free API key [here](https://www.unstructured.io/api-key) and start using it today! +Checkout the README [here](https://github.com/Unstructured-IO/unstructured-api) here to get started making API calls. +We'd love to hear your feedback, let us know how it goes in our [community slack](https://join.slack.com/t/unstructuredw-kbe4326/shared_invite/zt-1x7cgo0pg-PTptXWylzPQF9xZolzCnwQ). +And stay tuned for improvements to both quality and performance! +Check out the instructions +[here](https://github.com/Unstructured-IO/unstructured-api#dizzy-instructions-for-using-the-docker-image) if you'd like to self-host the Unstructured API or run it locally. ## Wrappers diff --git a/docs/extras/modules/data_connection/document_loaders/integrations/unstructured_file.ipynb b/docs/extras/modules/data_connection/document_loaders/integrations/unstructured_file.ipynb index 5a56752d0..a7e6d88da 100644 --- a/docs/extras/modules/data_connection/document_loaders/integrations/unstructured_file.ipynb +++ b/docs/extras/modules/data_connection/document_loaders/integrations/unstructured_file.ipynb @@ -226,7 +226,6 @@ ] }, { - "attachments": {}, "cell_type": "markdown", "id": "8de9ef16", "metadata": {}, @@ -303,7 +302,7 @@ "source": [ "## Unstructured API\n", "\n", - "If you want to get up and running with less set up, you can simply run `pip install unstructured` and use `UnstructuredAPIFileLoader` or `UnstructuredAPIFileIOLoader`. That will process your document using the hosted Unstructured API. Note that currently (as of 11 May 2023) the Unstructured API is open, but it will soon require an API. The [Unstructured documentation](https://unstructured-io.github.io/) page will have instructions on how to generate an API key once they’re available. Check out the instructions [here](https://github.com/Unstructured-IO/unstructured-api#dizzy-instructions-for-using-the-docker-image) if you’d like to self-host the Unstructured API or run it locally." + "If you want to get up and running with less set up, you can simply run `pip install unstructured` and use `UnstructuredAPIFileLoader` or `UnstructuredAPIFileIOLoader`. That will process your document using the hosted Unstructured API. You can generate a free Unstructured API key [here](https://www.unstructured.io/api-key/). The [Unstructured documentation](https://unstructured-io.github.io/) page will have instructions on how to generate an API key once they’re available. Check out the instructions [here](https://github.com/Unstructured-IO/unstructured-api#dizzy-instructions-for-using-the-docker-image) if you’d like to self-host the Unstructured API or run it locally." ] }, {