diff --git a/api-reference/overview.mdx b/api-reference/overview.mdx index 17fd87d5..a8e2a602 100644 --- a/api-reference/overview.mdx +++ b/api-reference/overview.mdx @@ -41,7 +41,7 @@ import Pricing from '/snippets/general-shared-text/pricing-platform.mdx'; ## Get support -Should you require any assistance or have any questions regarding the Unstructured API, please [contact us directly](https://unstructured.io/contact). +For technical support for Unstructured accounts, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). ## Learn more diff --git a/api-reference/partition/examples.mdx b/api-reference/partition/examples.mdx index 2d77df1c..6f8a630b 100644 --- a/api-reference/partition/examples.mdx +++ b/api-reference/partition/examples.mdx @@ -8,7 +8,7 @@ representing your Unstructured API key. [Get your API key](/api-reference/partit Also, you'll need to set an environment variable named `UNSTRUCTURED_API_URL` to the value of the Unstructured API URL for your account. This API URL was provided to you when your Unstructured account was created. -If you do not have this API URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +If you do not have this API URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). For the Unstructured Python SDK, the API URL is set to `https://api.unstructuredapp.io/general/v0/general` by default. diff --git a/api-reference/partition/overview.mdx b/api-reference/partition/overview.mdx index 73b1cb11..4864aff4 100644 --- a/api-reference/partition/overview.mdx +++ b/api-reference/partition/overview.mdx @@ -36,7 +36,7 @@ available for download from [https://constitutioncenter.org/media/files/constitu From your terminal or Command Prompt, set the following two environment variables. - Replace `` with the Unstructured Partition Endpoint URL. This URL was provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`. diff --git a/api-reference/partition/post-requests.mdx b/api-reference/partition/post-requests.mdx index 25b6209c..a8933962 100644 --- a/api-reference/partition/post-requests.mdx +++ b/api-reference/partition/post-requests.mdx @@ -30,11 +30,11 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s The API URL was provided to you when your Unstructured account was created. -If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). - The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`. However, - this URL might not necessarily work for your account. + The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`. + However, you should always use the API URL that was provided to you when your Unstructured account was created. Let's start with a simple example in which you use [curl](https://curl.se/) to send a local PDF file (`*.pdf`) to partition via the Unstructured Partition Endpoint. diff --git a/api-reference/partition/quickstart.mdx b/api-reference/partition/quickstart.mdx index 67bceda4..69cf401c 100644 --- a/api-reference/partition/quickstart.mdx +++ b/api-reference/partition/quickstart.mdx @@ -4,6 +4,16 @@ title: Unstructured API Quickstart Just need to copy the sample code? [Skip ahead](#sample-code) to it now! + + The following code shows how to use the [Unstructured Python SDK](/api-reference/partition/sdk-python) to have Unstructured process one or more local files by using the [Unstructured Partition Endpoint](/api-reference/partition/overview). diff --git a/api-reference/troubleshooting/api-key-url.mdx b/api-reference/troubleshooting/api-key-url.mdx index d226c823..577a6c0e 100644 --- a/api-reference/troubleshooting/api-key-url.mdx +++ b/api-reference/troubleshooting/api-key-url.mdx @@ -36,7 +36,7 @@ API error occurred: Status 404 ## Suggested solutions For the API URL, this URL was provided to you when your Unstructured account was created. -If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`. @@ -48,45 +48,44 @@ If you do not have this URL, contact Unstructured Sales at [sales@unstructured.i For the API key, the same API key works for both the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) and the [Unstructured Partition Endpoint](/api-reference/partition/overview). To access your key: -1. Sign in to your Unstructured account: +1. If you are not already signed in, sign in to your Unstructured **Starter** or **Team** account at [https://platform.unstructured.io](https://platform.unstructured.io). - - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + For an **Enterprise** account, see your Unstructured account administrator for instructions, + or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). + -2. Get your Unstructured API key: +2. Get your Unstructured API key:
- a. In the Unstructured UI, click **API Keys** on the sidebar.
- b. Click the **Copy** icon next to your target key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
- -3. If you want or need to generate a new Unstructured API key at this point: + a. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.
- a. Click **Generate API Key**.
- b. Follow the on-screen instructions to finish generating the key.
- c. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
+ + For a **Team** or **Enterprise** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key + for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace). + - - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, of if you are using a [self-hosted](/self-hosted/overview) deployment of Unstructured, the process for getting your API key - might be different. For guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - + b. Click **Generate API Key**.
+ c. Follow the on-screen instructions to finish generating the key.
+ d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
For the API URL, note the value of the Unstructured API URL for the Endpoint that you want to call. To access these API URLs: -1. Sign in to your Unstructured account: +1. If you are not already signed in, sign in to your Unstructured **Starter** or **Team** account at [https://platform.unstructured.io](https://platform.unstructured.io). + + + For an **Enterprise** account, see your Unstructured account administrator for instructions, + or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). + + +2. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.
- - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + For a **Team** or **Enterprise** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to get the API URL for. + -2. In the Unstructured UI, click **API Keys** on the sidebar. 3. Note the API URL for the **Unstructured Workflow Endpoint** or the **Unstructured Partition Endpoint**, depending on whether you want to call the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) or the [Unstructured Partition Endpoint](/api-reference/partition/overview), respectively. - - If you signed up through the [For Enterprise](https://unstructured.io/enterprise) page, of if you are using a [self-hosted](/self-hosted/overview) deployment of Unstructured, your API URL - might be different. For guidance, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - - If you still believe you have the correct API URL and API key, try the following steps: 1. Check your script or code to see where the API URL and API key are specified, as follows: @@ -116,5 +115,5 @@ If you still believe you have the correct API URL and API key, try the following - Run the command for your operating system to list all environment variables. Make sure the API key and API URL are listed and are set to the right ones. Make sure the names and cases of these environment variables match the ones in your script or code exactly. - If you use an integrated development environment (IDE) to run your script or code, check the IDE's documentation for how to specify and load environment variables at run time or debug time. Make sure the names and cases of these environment variables match the ones in your script or code exactly. -3. If you are still getting this issue, [contact us directly](https://unstructured.io/contact). +3. If you are still getting this issue, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). diff --git a/api-reference/workflow/overview.mdx b/api-reference/workflow/overview.mdx index 3f37b153..712825cb 100644 --- a/api-reference/workflow/overview.mdx +++ b/api-reference/workflow/overview.mdx @@ -91,7 +91,7 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s Calls made by the Unstructured Python SDK's `unstructured_client` functions for creating, listing, updating, and deleting connectors, workflows, and jobs in the Unstructured UI all use the Unstructured Workflow Endpoint URL. This URL was provided to you when your Unstructured account was created. -If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`. @@ -131,7 +131,7 @@ utilities, tools, programming languages, packages, and libraries. The examples, get this API key, see the [quickstart](#quickstart), earlier on this page. Note that you should always use the URL that was provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). ### curl and Postman @@ -144,7 +144,7 @@ export UNSTRUCTURED_API_KEY="" ``` For the API URL, this URL was provided to you when your Unstructured account was created. -If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`. diff --git a/docs.json b/docs.json index f3e12836..733e16ec 100644 --- a/docs.json +++ b/docs.json @@ -299,39 +299,39 @@ ] }, { - "tab": "Self-hosted", + "tab": "Enterprise", "groups": [ { - "group": "Self-hosting", + "group": "Enterprise", "pages": [ - "self-hosted/overview" + "enterprise/overview" ] }, { "group": "Security and compliance", "pages": [ - "self-hosted/security-compliance/overview" + "enterprise/security-compliance/overview" ] }, { "group": "AWS", "pages": [ - "self-hosted/aws/overview", - "self-hosted/aws/onboard" + "enterprise/aws/overview", + "enterprise/aws/onboard" ] }, { "group": "Azure", "pages": [ - "self-hosted/azure/overview", - "self-hosted/azure/onboard" + "enterprise/azure/overview", + "enterprise/azure/onboard" ] }, { "group": "GCP", "pages": [ - "self-hosted/gcp/overview", - "self-hosted/gcp/onboard" + "enterprise/gcp/overview", + "enterprise/gcp/onboard" ] } ] @@ -524,12 +524,12 @@ "global": { "anchors": [ { - "anchor": "Contact Us", - "href": "https://unstructured.io/contact", + "anchor": "Account support (e-mail)", + "href": "mailto:support@unstructured.io", "icon": "person-circle-question" }, { - "anchor": "Community", + "anchor": "Open source support (Slack)", "href": "https://short.unstructured.io/pzw05l7", "icon": "slack" }, @@ -544,12 +544,12 @@ "icon": "newspaper" }, { - "anchor": "Product", + "anchor": "Product info", "href": "https://unstructured.io/", "icon": "square-terminal" }, { - "anchor": "Trust Portal", + "anchor": "Trust portal", "href": "https://trust.unstructured.io/", "icon": { "name": "file-certificate", @@ -557,7 +557,12 @@ } }, { - "anchor": "Meta-Prompt (Titles)", + "anchor": "Contact Sales (e-mail)", + "href": "mailto:sales@unstructured.io", + "icon": "person" + }, + { + "anchor": "Meta-prompt (titles)", "href": "https://docs.unstructured.io/llms.txt", "icon": { "name": "microchip-ai", @@ -565,7 +570,7 @@ } }, { - "anchor": "Meta-Prompt (Full)", + "anchor": "Meta-prompt (full)", "href": "https://docs.unstructured.io/llms-full.txt", "icon": { "name": "microchip-ai", @@ -749,6 +754,10 @@ "source": "/platform-api/partition-api/:slug*", "destination": "/api-reference/partition/:slug*" }, + { + "source": "/self-hosted/:slug*", + "destination": "/enterprise/:slug*" + }, { "source": "/ui/billing", "destination": "/ui/account/billing" diff --git a/self-hosted/aws/onboard.mdx b/enterprise/aws/onboard.mdx similarity index 94% rename from self-hosted/aws/onboard.mdx rename to enterprise/aws/onboard.mdx index c69f9554..1c2970b2 100644 --- a/self-hosted/aws/onboard.mdx +++ b/enterprise/aws/onboard.mdx @@ -1,17 +1,16 @@ --- -title: AWS self-hosted onboarding checklist +title: Unstructured Enterprise in-VPC on Amazon Web Services (AWS) - onboarding checklist sidebarTitle: Onboarding --- - To proceed with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. + The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview). - If you have not yet signed this agreement, stop here, and begin the self-hosting agreement process by contacting your Unstructured sales representative, emailing - Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or filling out the [contact form](https://unstructured.io/contact) - on the Unstructured website. + For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative, + or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). -After your organization has signed the self-hosting agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the +After your organization has signed the Enterprise agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. Choose one of the following setup options: - [Do it all for me](#do-it-all-for-me): Have Unstructured set up the required infrastructure in your AWS account and then deploy the Unstructured UI and API into that newly created infrastructure. @@ -20,8 +19,7 @@ deployment onboarding process. To streamline this process, you are encouraged to ## Questions? Need help? If you have questions or need help as you go, contact your Unstructured sales representative or technical enablement contact. If you do not know who they are, -email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or technical enablement teams +email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or technical enablement teams will get back to you as soon as possible. ## Do it all for me diff --git a/enterprise/aws/overview.mdx b/enterprise/aws/overview.mdx new file mode 100644 index 00000000..1e1b7380 --- /dev/null +++ b/enterprise/aws/overview.mdx @@ -0,0 +1,27 @@ +--- +title: Unstructured Enterprise in-VPC on Amazon Web Services (AWS) - overview +sidebarTitle: Overview +--- + + + The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview). + + For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative, + or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + +## Getting started + +To get started with an Enterpise deployment, your organization must first sign an Enterprise agreement with Unstructured. +This agreement outlines the terms and conditions for your organization to use Unstructured. + +To begin the Enterprise agreement process, contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + +After your organization has signed the Enterprise agreement, a member of the Unstructured technical enablement team will reach out to you to begin the +deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, +see the [onboarding checkist](/enterprise/aws/onboard). + +## Questions? Need help? + +Contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or support teams +will get back to you as soon as possible. \ No newline at end of file diff --git a/self-hosted/azure/onboard.mdx b/enterprise/azure/onboard.mdx similarity index 93% rename from self-hosted/azure/onboard.mdx rename to enterprise/azure/onboard.mdx index ce1cd3a4..d1eebcba 100644 --- a/self-hosted/azure/onboard.mdx +++ b/enterprise/azure/onboard.mdx @@ -1,17 +1,16 @@ --- -title: Azure self-hosted onboarding checklist +title: Unstructured Enterprise in-VPC on Azure - onboarding checklist sidebarTitle: Onboarding --- - To proceed with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. + The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview). - If you have not yet signed this agreement, stop here, and begin the self-hosting agreement process by contacting your Unstructured sales representative, emailing - Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or filling out the [contact form](https://unstructured.io/contact) - on the Unstructured website. + For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative, + or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). -After your organization has signed the self-hosting agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the +After your organization has signed the Enterprise agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. Choose one of the following setup options: - [Do it all for me](#do-it-all-for-me): Have Unstructured set up the required infrastructure in your AWS account and then deploy the Unstructured UI and API into that newly created infrastructure. @@ -20,8 +19,7 @@ deployment onboarding process. To streamline this process, you are encouraged to ## Questions? Need help? If you have questions or need help as you go, contact your Unstructured sales representative or technical enablement contact. If you do not know who they are, -email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or technical enablement teams +email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or technical enablement teams will get back to you as soon as possible. ## Do it all for me diff --git a/enterprise/azure/overview.mdx b/enterprise/azure/overview.mdx new file mode 100644 index 00000000..aa091f0d --- /dev/null +++ b/enterprise/azure/overview.mdx @@ -0,0 +1,27 @@ +--- +title: Unstructured Enterprise in-VPC on Azure - overview +sidebarTitle: Overview +--- + + + The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview). + + For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative, + or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + +## Getting started + +To get started with an Enterprise deployment, your organization must first sign an Enterprise agreement with Unstructured. +This agreement outlines the terms and conditions for your organization to use Unstructured. + +To begin the Enterprise agreement process, contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + +After your organization has signed the Enterprise agreement, a member of the Unstructured technical enablement team will reach out to you to begin the +deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, +see the [onboarding checkist](/enterprise/azure/onboard). + +## Questions? Need help? + +Contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or support teams +will get back to you as soon as possible. \ No newline at end of file diff --git a/enterprise/bare-metal/onboard.mdx b/enterprise/bare-metal/onboard.mdx new file mode 100644 index 00000000..50b390ff --- /dev/null +++ b/enterprise/bare-metal/onboard.mdx @@ -0,0 +1,23 @@ +--- +title: Unstructured on your own hardware - onboarding checklist +sidebarTitle: Onboarding +--- + + + The following information applies only to bare metal deployments of [Unstructured Enterprise](/enterprise/overview). + + For dedicated instance or in-VPC deployments of Unstructured Enterprise, contact your Unstructured sales representative, + or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + +After your organization has signed the bare metal agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the +deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, you +must first set up your hardware as follows. + +## Questions? Need help? + +If you have questions or need help as you go, contact your Unstructured sales representative or technical enablement contact. If you do not know who they are, +email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or technical enablement teams +will get back to you as soon as possible. + +## Onboarding checklist \ No newline at end of file diff --git a/enterprise/bare-metal/overview.mdx b/enterprise/bare-metal/overview.mdx new file mode 100644 index 00000000..d0c956bc --- /dev/null +++ b/enterprise/bare-metal/overview.mdx @@ -0,0 +1,27 @@ +--- +title: Unstructured on your own hardware - overview +sidebarTitle: Overview +--- + + + The following information applies only to bare metal deployments of [Unstructured Enterprise](/enterprise/overview). + + For dedicated instance or in-VPC deployments of Unstructured Enterprise, contact your Unstructured sales representative, + or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + +## Getting started + +To get started with a bare metal deployment, your organization must first sign a bare metal agreement with Unstructured. +This agreement outlines the terms and conditions for your organization to use Unstructured. + +To begin the bare metal agreement process, contact your Unstructured sales representatives, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + +After your organization has signed the bare metal agreement, a member of the Unstructured technical enablement team will reach out to you to begin the +deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, +see the [onboarding checkist](/enterprise/bare-metal/onboard). + +## Questions? Need help? + +Contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or support teams +will get back to you as soon as possible. \ No newline at end of file diff --git a/self-hosted/gcp/onboard.mdx b/enterprise/gcp/onboard.mdx similarity index 94% rename from self-hosted/gcp/onboard.mdx rename to enterprise/gcp/onboard.mdx index bf044b75..7f596974 100644 --- a/self-hosted/gcp/onboard.mdx +++ b/enterprise/gcp/onboard.mdx @@ -1,17 +1,16 @@ --- -title: GCP self-hosted onboarding checklist +title: Unstructured Enterprise in-VPC on Google Cloud Platform (GCP) - onboarding checklist sidebarTitle: Onboarding --- - To proceed with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. + The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview). - If you have not yet signed this agreement, stop here, and begin the self-hosting agreement process by contacting your Unstructured sales representative, emailing - Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or filling out the [contact form](https://unstructured.io/contact) - on the Unstructured website. + For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative, + or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). -After your organization has signed the self-hosting agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the +After your organization has signed the Enterprise agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. Choose one of the following setup options: - [Do it all for me](#do-it-all-for-me): Have Unstructured set up the required infrastructure in your AWS account and then deploy the Unstructured UI and API into that newly created infrastructure. @@ -20,8 +19,7 @@ deployment onboarding process. To streamline this process, you are encouraged to ## Questions? Need help? If you have questions or need help as you go, contact your Unstructured sales representative or technical enablement contact. If you do not know who they are, -email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or technical enablement teams +email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or technical enablement teams will get back to you as soon as possible. ## Do it all for me diff --git a/enterprise/gcp/overview.mdx b/enterprise/gcp/overview.mdx new file mode 100644 index 00000000..b79c4f12 --- /dev/null +++ b/enterprise/gcp/overview.mdx @@ -0,0 +1,27 @@ +--- +title: Unstructured Enterprise in-VPC on Google Cloud Platform (GCP) - overview +sidebarTitle: Overview +--- + + + The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview). + + For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative, + or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + +## Getting started + +To get started with an Enterprise deployment, your organization must first sign an Enterprise agreement with Unstructured. +This agreement outlines the terms and conditions for your organization to use Unstructured in an Enterprise environment. + +To begin the Enterprise agreement process, contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + +After your organization has signed the Enterprise agreement, a member of the Unstructured technical enablement team will reach out to you to begin the +deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, +see the [onboarding checkist](/enterprise/gcp/onboard). + +## Questions? Need help? + +Contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or support teams +will get back to you as soon as possible. \ No newline at end of file diff --git a/enterprise/overview.mdx b/enterprise/overview.mdx new file mode 100644 index 00000000..e4c47184 --- /dev/null +++ b/enterprise/overview.mdx @@ -0,0 +1,46 @@ +--- +title: Unstructured Enterprise +sidebarTitle: Overview +--- + +Unstructured offers _enterprise_ deployments, which allow you to use an Unstructured Enterprise account to run the [Unstructured user interface](/ui/overview) (UI) +and the [Unstructured API](/api-reference/overview) as follows: + +-   Within a **dedicated instance** deployment - Hosted within a virtual private cloud (VPC) running inside Unstructured's cloud infrastructure. +-   Within an **in-VPC** deployment - Hosted within your own VPC on your own cloud infrastructure. + +Unstructured Enterprise accounts allow for multiple users and offer multiple workspaces. These enterprise deployments isolate your Unstructured Enterprise account +from all other Unstructured accounts. Enterprise deployments also allow for robust customization of Unstructured's features for your unique needs. + +- To sign up for Unstructured Enterprise, [contact Unstructured Sales](https://unstructured.io/contact). +- To switch from an existing Unstructured Starter or Team account to Enterprise, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + +Unstructured Enterprise deployments provide benefits such as the following: + +- _Security, privacy, and ownership_: Your organization might have strict data security requirements to keep your data and models within a virtual private cloud (VPC). +- _Compliance and data sovereignty_: Certain industries and locales might have regulatory requirements that require data to be processed and for data and models to be stored in specific cloud provider regions. +- _Customization_: Enterprise deployments allow for more customization and control options over your environments. +- _Testing and development_: Enterprise deployments can be useful for multi-environment testing and development purposes, allowing you to experiment with Unstructured in a testing environment without affecting your production environment. + +## Getting started + +To get started with an Enterprise deployment, your organization must first sign an Enterprise agreement with Unstructured. +This agreement outlines the terms and conditions for your organization's use of Unstructured. + +To begin the Enterprise agreement process, contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + +After your organization has signed the Enterprise agreement, a member of the Unstructured technical enablement team will reach out to you to begin the +deployment onboarding process. + +- For a dedicated instance deployment, a member of the Unstructured technical enablement team will reach out to you with the unique URL to log in to + the Unstructured UI, along with any next steps that you need to take. +- For an in-VPC deployment, your organization will work with a member of the Unstructured technical enablement team to deploy Unstructured + into your own cloud instrastructure. You are encouraged to begin setting up your target environment as soon as possible. To do this, + see the onboarding requirements for your [AWS](/enterprise/aws/onboard), [Azure](/enterprise/azure/onboard), or + [GCP](/enterprise/gcp/onboard) account. + +## Questions? Need help? + +Contact your Unstructured sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), and a member of the Unstructured sales or support teams +will get back to you as soon as possible. + diff --git a/self-hosted/security-compliance/overview.mdx b/enterprise/security-compliance/overview.mdx similarity index 100% rename from self-hosted/security-compliance/overview.mdx rename to enterprise/security-compliance/overview.mdx diff --git a/examplecode/tools/firecrawl.mdx b/examplecode/tools/firecrawl.mdx index ef6c2b9c..c459e7e8 100644 --- a/examplecode/tools/firecrawl.mdx +++ b/examplecode/tools/firecrawl.mdx @@ -29,9 +29,9 @@ The following sections describe how to get these requirements. Before you begin, you must have an Unstructured account and an Unstructured API key, as follows: -import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-simple-ui-only.mdx'; +import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-simple-api-only.mdx'; - + ### Firecrawl account and API key @@ -408,7 +408,7 @@ Unstructured elements and metadata, add vector embeddings to the elements, and t - 1. Sign in to your Unstructured account. + 1. If you are not already signed in, sign in to your Unstructured account. 2. On the sidebar, click **Connectors**. 3. With **Sources** selected, **New**. 4. Enter some name for the source connector, such as `s3-firecrawl-source`. diff --git a/examplecode/tools/vectorshift.mdx b/examplecode/tools/vectorshift.mdx index f8975536..5c5b2053 100644 --- a/examplecode/tools/vectorshift.mdx +++ b/examplecode/tools/vectorshift.mdx @@ -32,7 +32,7 @@ Also: - [Sign up for an OpenAI account](https://platform.openai.com/signup), and [get your OpenAI API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key). - [Sign up for a VectorShift Starter account](https://app.vectorshift.ai/api/signup). -- Sign up for an Unstructured account: +- If you do not already have an Unstructured account, sign up for one: @@ -43,7 +43,7 @@ Also: Although you can use any [supported file type](/ui/supported-file-types) or data in any [supported source type](/ui/sources/overview) for the input into Pinecone, this demonstration uses [the text of the United States Constitution in PDF format](https://constitutioncenter.org/media/files/constitution.pdf). - 1. Sign in to your Unstructured account. + 1. If you are not already signed in, sign in to your Unstructured account. 2. [Create a source connector](/ui/sources/overview), if you do not already have one, to connect Unstructured to the source location where the PDF file is stored. 3. [Create a Pinecone destination connector](/ui/destinations/pinecone), if you do not already have one, to connect Unstructured to your Pinecone serverless index. 4. [Create a workflow](/ui/workflows#create-a-workflow) that references this source connector and destination connector. diff --git a/open-source/ingestion/ingest-cli.mdx b/open-source/ingestion/ingest-cli.mdx index 09c029af..b23d4d87 100644 --- a/open-source/ingestion/ingest-cli.mdx +++ b/open-source/ingestion/ingest-cli.mdx @@ -24,7 +24,7 @@ Using the Ingest CLI to send files in batches to Unstructured for processing is 3. The Unstructured API URL for Unstructured Ingest was provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). The default URL for Unstructured Ingest is the same as the default URL for the Unstructured Partition Endpoint: `https://api.unstructuredapp.io/general/v0/general`. diff --git a/open-source/ingestion/python-ingest.mdx b/open-source/ingestion/python-ingest.mdx index 360e5907..968d0372 100644 --- a/open-source/ingestion/python-ingest.mdx +++ b/open-source/ingestion/python-ingest.mdx @@ -36,7 +36,7 @@ Using the Ingest Python library to send files in batches to Unstructured for pro 3. The Unstructured API URL for Unstructured Ingest was provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). The default URL for Unstructured Ingest is the same as the default URL for the Unstructured Partition Endpoint: `https://api.unstructuredapp.io/general/v0/general`. diff --git a/open-source/introduction/overview.mdx b/open-source/introduction/overview.mdx index afa683ff..57aa7b09 100644 --- a/open-source/introduction/overview.mdx +++ b/open-source/introduction/overview.mdx @@ -75,7 +75,10 @@ import Pricing from '/snippets/general-shared-text/pricing-platform.mdx'; +## Questions? Need help? +- For questions and technical support for the Unstructured open source library, use our [Slack community](https://short.unstructured.io/pzw05l7). +- If you need help with your Unstructured account, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). diff --git a/self-hosted/aws/overview.mdx b/self-hosted/aws/overview.mdx deleted file mode 100644 index 7243b1de..00000000 --- a/self-hosted/aws/overview.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Self-hosting Unstructured on Amazon Web Services (AWS) -sidebarTitle: Overview ---- - -## Getting started - -To get started with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. -This agreement outlines the terms and conditions for your organization to use Unstructured in a self-hosted environment. - -To begin the self-hosting agreement process, contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website. - -After your organization has signed the self-hosting agreement, a member of the Unstructured technical enablement team will reach out to you to begin the -deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, -see the [onboarding checkist](/self-hosted/aws/onboard). - -## Questions? Need help? - -Contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or support teams -will get back to you as soon as possible. \ No newline at end of file diff --git a/self-hosted/azure/overview.mdx b/self-hosted/azure/overview.mdx deleted file mode 100644 index 5624a86f..00000000 --- a/self-hosted/azure/overview.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Self-hosting Unstructured on Azure -sidebarTitle: Overview ---- - -## Getting started - -To get started with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. -This agreement outlines the terms and conditions for your organization to use Unstructured in a self-hosted environment. - -To begin the self-hosting agreement process, contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website. - -After your organization has signed the self-hosting agreement, a member of the Unstructured technical enablement team will reach out to you to begin the -deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, -see the [onboarding checkist](/self-hosted/azure/onboard). - -## Questions? Need help? - -Contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or support teams -will get back to you as soon as possible. \ No newline at end of file diff --git a/self-hosted/bare-metal/onboard.mdx b/self-hosted/bare-metal/onboard.mdx deleted file mode 100644 index 8701c36e..00000000 --- a/self-hosted/bare-metal/onboard.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Bare metal self-hosted onboarding checklist -sidebarTitle: Onboarding ---- - - - To proceed with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. - - If you have not yet signed this agreement, stop here, and begin the self-hosting agreement process by emailing - Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the [contact form](https://unstructured.io/contact) - on the Unstructured website. - - -After your organization has signed the self-hosting agreement with Unstructured, a member of the Unstructured technical enablement team will reach out to you to begin the -deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, you -must first set up your hardware as follows. - -## Questions? Need help? - -If you have questions or need help as you go, contact your Unstructured sales representative or technical enablement contact. If you do not know who they are, -email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or technical enablement teams -will get back to you as soon as possible. - -## Onboarding checklist \ No newline at end of file diff --git a/self-hosted/bare-metal/overview.mdx b/self-hosted/bare-metal/overview.mdx deleted file mode 100644 index 71c0a206..00000000 --- a/self-hosted/bare-metal/overview.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Self-hosting Unstructured on your own hardware -sidebarTitle: Overview ---- - -## Getting started - -To get started with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. -This agreement outlines the terms and conditions for your organization to use Unstructured in a self-hosted environment. - -To begin the self-hosting agreement process, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website. - -After your organization has signed the self-hosting agreement, a member of the Unstructured technical enablement team will reach out to you to begin the -deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, -see the [onboarding checkist](/self-hosted/bare-metal/onboard). - -## Questions? Need help? - -Email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or support teams -will get back to you as soon as possible. \ No newline at end of file diff --git a/self-hosted/gcp/overview.mdx b/self-hosted/gcp/overview.mdx deleted file mode 100644 index 6463dbb7..00000000 --- a/self-hosted/gcp/overview.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Self-hosting Unstructured on Google Cloud Platform (GCP) -sidebarTitle: Overview ---- - -## Getting started - -To get started with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. -This agreement outlines the terms and conditions for your organization to use Unstructured in a self-hosted environment. - -To begin the self-hosting agreement process, contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website. - -After your organization has signed the self-hosting agreement, a member of the Unstructured technical enablement team will reach out to you to begin the -deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, -see the [onboarding checkist](/self-hosted/gcp/onboard). - -## Questions? Need help? - -Contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or support teams -will get back to you as soon as possible. \ No newline at end of file diff --git a/self-hosted/overview.mdx b/self-hosted/overview.mdx deleted file mode 100644 index fcf1197b..00000000 --- a/self-hosted/overview.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Self-hosting Unstructured -sidebarTitle: Overview ---- - -Unstructured offers _self-hosted_ deployments, which allow you to run the [Unstructured user interface](/ui/overview) (UI) -and the [Unstructured API](/api-reference/overview) on infrastructure that you maintain in your -[Amazon Web Services (AWS)](/self-hosted/aws/overview), [Azure](/self-hosted/azure/overview), or -[Google Cloud Platform (GCP)](/self-hosted/gcp/overview) account. - -Running Unstructured on your own cloud-based infrastructure provides benefits such as the following: - -- _Security, privacy, and ownership_: Your organization might have strict data security requirements to keep your data and models within a virtual private cloud (VPC). -- _Compliance and data sovereignty_: Certain industries and locales might have regulatory requirements that require data to be processed and for data and models to be stored in specific cloud provider regions. -- _Customization_: Self-hosted deployments allow for more customization and control options over your environments. -- _Testing and development_: Self-hosted deployments can be useful for multi-environment testing and development purposes, allowing you to experiment with Unstructured in a testing environment without affecting your production environment. - -## Getting started - -To get started with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured. -This agreement outlines the terms and conditions for your organization to use Unstructured in a self-hosted environment. - -To begin the self-hosting agreement process, contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website. - -After your organization has signed the self-hosting agreement, a member of the Unstructured technical enablement team will reach out to you to begin the -deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this, -see the onboarding requirements for your [AWS](/self-hosted/aws/onboard), [Azure](/self-hosted/azure/onboard), or -[GCP](/self-hosted/gcp/onboard) account. - -## Questions? Need help? - -Contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or fill out the -[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or support teams -will get back to you as soon as possible. - diff --git a/snippets/general-shared-text/enterprise-self-hosted-differences.mdx b/snippets/general-shared-text/enterprise-self-hosted-differences.mdx index f3199511..52d57c43 100644 --- a/snippets/general-shared-text/enterprise-self-hosted-differences.mdx +++ b/snippets/general-shared-text/enterprise-self-hosted-differences.mdx @@ -1,5 +1,4 @@ - If you signed up for Unstructured through the [For Enterprise](https://unstructured.io/enterprise) page, or if you are using a [self-hosted](/self-hosted/overview) deployment of Unstructured - or an Unstructured [organizational account](/ui/account/organizations), the following information - might apply differently to you. For details, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + If you are using an Unstructured **Team** or **Enterprise** account, the following information + might apply differently to you. For instructions, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). \ No newline at end of file diff --git a/snippets/general-shared-text/first-time-api-destination-connector.mdx b/snippets/general-shared-text/first-time-api-destination-connector.mdx index 425da3a6..e8c814f1 100644 --- a/snippets/general-shared-text/first-time-api-destination-connector.mdx +++ b/snippets/general-shared-text/first-time-api-destination-connector.mdx @@ -3,12 +3,24 @@ Before you can create a destination connector, you must first sign in to your Unstructured account: - - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + - If you do not already have an Unstructured account, you can sign up for one at + [https://unstructured.io/developers](https://unstructured.io/developers). + After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io). + To sign up for a **Team** or **Enterprise** account instead, [contact Unstructured Sales](https://unstructured.io/contact), or [learn more](/api-reference/overview#pricing). + - If you already have an Unstructured **Starter** or **Team** account and are not already signed in, sign in to your account at + [https://platform.unstructured.io](https://platform.unstructured.io). For an **Enterprise** account, see your Unstructured account administrator for instructions, + or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). - After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get your Unstructured API key. - To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M). + After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get your Unstructured API key. + + 1. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.
+ + For a **Team** or **Enterprise** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key + for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace). + + 2. Click **Generate API Key**.
+ 3. Follow the on-screen instructions to finish generating the key.
+ 4. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
After you create the destination connector, add it along with a [source connector](/api-reference/workflow/sources/overview) to a [workflow](/api-reference/workflow/overview#workflows). @@ -20,8 +32,7 @@ You can also create destination connectors with the Unstructured user interface (UI). [Learn how](/ui/destinations/overview). - If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or - [contact us](https://unstructured.io/contact) directly. + If you need help, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). You are now ready to start creating a destination connector! Keep reading to learn how. \ No newline at end of file diff --git a/snippets/general-shared-text/first-time-api-source-connector.mdx b/snippets/general-shared-text/first-time-api-source-connector.mdx index 8662aa8c..bee16cec 100644 --- a/snippets/general-shared-text/first-time-api-source-connector.mdx +++ b/snippets/general-shared-text/first-time-api-source-connector.mdx @@ -3,12 +3,24 @@ Before you can create a source connector, you must first sign in to your Unstructured account: - - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + - If you do not already have an Unstructured account, you can sign up for one at + [https://unstructured.io/developers](https://unstructured.io/developers). + After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io). + To sign up for a **Team** or **Enterprise** account instead, [contact Unstructured Sales](https://unstructured.io/contact), or [learn more](/api-reference/overview#pricing). + - If you already have an Unstructured **Starter** or **Team** account and are not already signed in, sign in to your account at + [https://platform.unstructured.io](https://platform.unstructured.io). For an **Enterprise** account, see your Unstructured account administrator for instructions, + or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). - After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get your Unstructured API key. - To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M). + After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get your Unstructured API key, as follows: + + 1. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.
+ + For a **Team** or **Enterprise** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key + for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace). + + 2. Click **Generate API Key**.
+ 3. Follow the on-screen instructions to finish generating the key.
+ 4. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
After you create the source connector, add it along with a [destination connector](/api-reference/workflow/destinations/overview) to a [workflow](/api-reference/workflow/overview#workflows). @@ -20,8 +32,7 @@ You can also create source connectors with the Unstructured user interface (UI). [Learn how](/ui/sources/overview). - If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or - [contact us](https://unstructured.io/contact) directly. + If you need help, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). You are now ready to start creating a source connector! Keep reading to learn how. \ No newline at end of file diff --git a/snippets/general-shared-text/first-time-ui-destination-connector.mdx b/snippets/general-shared-text/first-time-ui-destination-connector.mdx index cee6a383..cf8a2117 100644 --- a/snippets/general-shared-text/first-time-ui-destination-connector.mdx +++ b/snippets/general-shared-text/first-time-ui-destination-connector.mdx @@ -3,22 +3,24 @@ Before you can create a destination connector, you must first sign in to your Unstructured account: - - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + - If you do not already have an Unstructured account, you can sign up for one at + [https://unstructured.io/developers](https://unstructured.io/developers). After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io). + To sign up for a **Team** or **Enterprise** account instead, [contact Unstructured Sales](https://unstructured.io/contact), or [learn more](/ui/overview#how-am-i-billed%3F). + - If you already have an Unstructured **Starter** or **Team** account and are not already signed in, sign in to your account at + [https://platform.unstructured.io](https://platform.unstructured.io). For an **Enterprise** account, see your Unstructured account administrator for instructions, + or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to create your destination connector. After you create the destination connector, add it along with a [source connector](/ui/sources/overview) to a [workflow](/ui/workflows). Then run the worklow as a - [job](/ui/jobs). To learn how, try out the [hands-on UI quickstart](/ui/quickstart) or watch the 4-minute + [job](/ui/jobs). To learn how, try out the [hands-on UI quickstart](/ui/quickstart#remote-quickstart) or watch the 4-minute [video tutorial](https://www.youtube.com/watch?v=Wn2FfHT6H-o). You can also create destination connectors with the Unstructured API. [Learn how](/api-reference/workflow/destinations/overview). - If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or - [contact us](https://unstructured.io/contact) directly. + If you need help, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). You are now ready to start creating a destination connector! Keep reading to learn how. \ No newline at end of file diff --git a/snippets/general-shared-text/first-time-ui-source-connector.mdx b/snippets/general-shared-text/first-time-ui-source-connector.mdx index 467a2bec..5008845c 100644 --- a/snippets/general-shared-text/first-time-ui-source-connector.mdx +++ b/snippets/general-shared-text/first-time-ui-source-connector.mdx @@ -3,22 +3,24 @@ Before you can create a source connector, you must first sign in to your Unstructured account: - - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + - If you do not already have an Unstructured account, you can sign up for one at + [https://unstructured.io/developers](https://unstructured.io/developers). After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io). + To sign up for a **Team** or **Enterprise** account instead, [contact Unstructured Sales](https://unstructured.io/contact), or [learn more](/ui/overview#how-am-i-billed%3F). + - If you already have an Unstructured **Starter** or **Team** account and are not already signed in, sign in to your account at + [https://platform.unstructured.io](https://platform.unstructured.io). For an **Enterprise** account, see your Unstructured account administrator for instructions, + or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). After you sign in, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to create your source connector. After you create the source connector, add it along with a [destination connector](/ui/destinations/overview) to a [workflow](/ui/workflows). Then run the worklow as a - [job](/ui/jobs). To learn how, try out the [hands-on UI quickstart](/ui/quickstart) or watch the 4-minute + [job](/ui/jobs). To learn how, try out the [hands-on UI quickstart](/ui/quickstart#remote-quickstart) or watch the 4-minute [video tutorial](https://www.youtube.com/watch?v=Wn2FfHT6H-o). You can also create source connectors with the Unstructured API. [Learn how](/api-reference/workflow/sources/overview). - If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or - [contact us](https://unstructured.io/contact) directly. + If you need help, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). You are now ready to start creating a source connector! Keep reading to learn how. \ No newline at end of file diff --git a/snippets/general-shared-text/get-started-simple-api-only.mdx b/snippets/general-shared-text/get-started-simple-api-only.mdx index 69424eca..608fe4b9 100644 --- a/snippets/general-shared-text/get-started-simple-api-only.mdx +++ b/snippets/general-shared-text/get-started-simple-api-only.mdx @@ -1,12 +1,26 @@ -1. Sign in to your Unstructured account: +1. If you do not already have an Unstructured account, sign up for one at [https://unstructured.io/developers](https://unstructured.io/developers). + After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io). - - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. After you sign in, the Unstructured user interface (UI) then appears, and you can start using it right away. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + + To sign up for a **Team** or **Enterprise** account instead, [contact Unstructured Sales](https://unstructured.io/contact), or [learn more](/api-reference/overview#pricing). + -2. Get your Unstructured API key: +2. If you have an Unstructured **Starter** or **Team** account and are not already signed in, sign in to your account at [https://platform.unstructured.io](https://platform.unstructured.io). + + + For an **Enterprise** account, see your Unstructured account administrator for instructions, + or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). + + +3. Get your Unstructured API key:
+ + a. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.
+ + + For a **Team** or **Enterprise** account, before you click **API Keys**, make sure you have selected the organizational workspace you want to create an API key + for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace). + - a. In the Unstructured UI, click **API Keys** on the sidebar.
b. Click **Generate API Key**.
c. Follow the on-screen instructions to finish generating the key.
d. Click the **Copy** icon next to your new key to add the key to your system's clipboard. If you lose this key, simply return and click the **Copy** icon again.
\ No newline at end of file diff --git a/snippets/general-shared-text/get-started-simple-ui-only.mdx b/snippets/general-shared-text/get-started-simple-ui-only.mdx index f6ef8ec5..08d1094c 100644 --- a/snippets/general-shared-text/get-started-simple-ui-only.mdx +++ b/snippets/general-shared-text/get-started-simple-ui-only.mdx @@ -1,3 +1,13 @@ -- If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. -- If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. After you sign in, the Unstructured user interface (UI) then appears, and you can start using it right away. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). \ No newline at end of file +1. If you do not already have an Unstructured account, sign up for one at [https://unstructured.io/developers](https://unstructured.io/developers). + After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io). + + + To sign up for a **Team** or **Enterprise** account instead, [contact Unstructured Sales](https://unstructured.io/contact), or [learn more](/ui/overview#how-am-i-billed%3F). + + +2. If you have an Unstructured **Starter** or **Team** account and are not already signed in, sign in to your account at [https://platform.unstructured.io](https://platform.unstructured.io). + + + For an **Enterprise** account, see your Unstructured account administrator for instructions, + or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). + \ No newline at end of file diff --git a/snippets/general-shared-text/pricing-platform.mdx b/snippets/general-shared-text/pricing-platform.mdx index a77a5d4a..07b2392f 100644 --- a/snippets/general-shared-text/pricing-platform.mdx +++ b/snippets/general-shared-text/pricing-platform.mdx @@ -1,12 +1,20 @@ -Unstructured offers three account pricing plans: +Unstructured offers several account types with different pricing plans: -- **SaaS Cloud-hosted** - Processing happens on Unstructured's software-as-a-service (SaaS) cloud infrastructure in a multi-tenant environment. -- **Private SaaS** - Processing also happens on Unstructured's SaaS cloud infrastructure, but your data stays protected in a dedicated cloud environment, maintaining strict data privacy. -- **VPC** - Sometimes referred to as [self-hosted](/self-hosted/overview), an instance of the Unstructured SaaS is deployed into your own virtual private cloud (VPC), providing complete data ownership and infrastructure control, full customization, and dedicated technical support. +-   **Starter** - A single user, with a single workspace, hosted alongside other accounts on Unstructured's cloud infrastructure. +-   **Team** - Multiple users and workspaces, hosted alongside other accounts on Unstructured's cloud instrastructure. +-   **Enterprise** - Multiple users and workspaces, isolated from all other accounts, with two hosting options for additional security and control: + + -   **Dedicated instance** - Hosted within a virtual private cloud (VPC) running inside Unstructured's cloud infrastructure. + -   **In-VPC** - Hosted within your own VPC on your own cloud infrastructure. + + **Enterprise** accounts also allow for robust customization of Unstructured's features for your unique needs. For more details, see the [Unstructured Pricing](https://unstructured.io/pricing) page. -Some of these plans are billed on a per-page basis. +To upgrade your account from **Starter** to **Team**, or from **Team** to **Enterprise**, +email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + +Some of these plans have billing details that are determined on a per-page basis. import SharedPagesBilling from '/snippets/general-shared-text/pages-billing.mdx'; diff --git a/snippets/ingest-configuration-shared/chunking-configuration.mdx b/snippets/ingest-configuration-shared/chunking-configuration.mdx index 03be606d..0bd87150 100644 --- a/snippets/ingest-configuration-shared/chunking-configuration.mdx +++ b/snippets/ingest-configuration-shared/chunking-configuration.mdx @@ -21,6 +21,6 @@ A common chunking configuration is a critical element in the data processing pip * `chunk_overlap_all`: Applies overlap to chunks formed from whole elements as well as those formed by text-splitting oversized elements. The overlap length is taken from the `chunk_overlap` value. -* `chunking_endpoint`: If `chunk_by_api` is set to `True`, chunking requests are sent to this Unstructured API URL. By default, this URL is the Unstructured Partition Endpoint URL: `https://api.unstructuredapp.io/general/v0/general`. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +* `chunking_endpoint`: If `chunk_by_api` is set to `True`, chunking requests are sent to this Unstructured API URL. By default, this URL is the Unstructured Partition Endpoint URL: `https://api.unstructuredapp.io/general/v0/general`. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). * `chunking_strategy`: One of `basic` or `by_title`. When omitted, no chunking is performed. The `basic` strategy maximally fills each chunk with whole elements, up the specified size limits as specified by `max_characters` and `new_after_n_chars`. A single element that exceeds this length is divided into two or more chunks using text-splitting. A `Table` element is never combined with any other element and appears as a chunk of its own or as a sequence of `TableChunk` elements splitting is required. The `by_title` behaviors are the same except that section and optionally page boundaries are respected such that two consecutive elements from different sections appear in separate chunks. \ No newline at end of file diff --git a/snippets/ingest-configuration-shared/partition-by-api-oss.mdx b/snippets/ingest-configuration-shared/partition-by-api-oss.mdx index c25d6585..0c437319 100644 --- a/snippets/ingest-configuration-shared/partition-by-api-oss.mdx +++ b/snippets/ingest-configuration-shared/partition-by-api-oss.mdx @@ -17,14 +17,13 @@ For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you - The environment variables `UNSTRUCTURED_API_KEY` and `UNSTRUCTURED_API_URL`, representing your API key and API URL, respectively. - 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 [self-hosted](/self-hosted/overview) instance of the Unstructured API. + You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, which applies to **Starter** and **Team** accounts. - 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). However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). + 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). However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). If you do not have an API key, [get one now](/api-reference/partition/overview). - If the Unstructured API is self-hosted, the process + If you are using an **Enterprise** account, 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). + For instructions, see your Unstructured account administrator, or email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). \ No newline at end of file diff --git a/snippets/quickstarts/platform.mdx b/snippets/quickstarts/platform.mdx index bef4ec5b..e1307593 100644 --- a/snippets/quickstarts/platform.mdx +++ b/snippets/quickstarts/platform.mdx @@ -1,4 +1,4 @@ -This quickstart uses a no-code, point-and-click user interface in your web browser to get all of your data RAG-ready. Data is processed on Unstructured-hosted compute resources. +The following quickstart shows you how to use the Unstructured UI to process remote files (or data). The requirements are as follows. diff --git a/snippets/quickstarts/single-file-ui.mdx b/snippets/quickstarts/single-file-ui.mdx deleted file mode 100644 index 04475535..00000000 --- a/snippets/quickstarts/single-file-ui.mdx +++ /dev/null @@ -1,195 +0,0 @@ -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. - -The file is first processed on Unstructured-hosted compute resources. The UI then shows the processed data that Unstructured generates for that file. -You can download that processed data as a `.json` file to your local machine. - -This approach enables rapid, local, run-adjust-repeat prototyping of end-to-end Unstructured ETL+ workflows with a full range of Unstructured features. -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. - -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: - -| File type | -|---| -| `.bmp` | -| `.csv` | -| `.doc` | -| `.docx` | -| `.email` | -| `.epub` | -| `.heic` | -| `.html` | -| `.jpg` | -| `.md` | -| `.odt` | -| `.org` | -| `.pdf` | -| `.pot` | -| `.potm` | -| `.ppt` | -| `.pptm` | -| `.pptx` | -| `.rst` | -| `.rtf` | -| `.sgl` | -| `.tiff` | -| `.txt` | -| `.tsv` | -| `.xls` | -| `.xlsx` | -| `.xml` | - - - 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). - - 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) - for how to set up and run production-ready Unstructured ETL+ workflows at scale. - - -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 -from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub. - - - -import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-simple-ui-only.mdx'; -import EnrichmentImagesTablesHiResOnly from '/snippets/general-shared-text/enrichment-images-tables-hi-res-only.mdx'; - - - - - - - 1. In the Unstructured UI, on the sidebar, click **Workflows**. - - ![Workflows in the sidebar](/img/ui/Workflows-Sidebar.png) - - 2. Click **New Workflow**. - 3. Select **Build it Myself**, if it is not already selected. - 4. Click **Continue**. The visual workflow editor appears. - - ![Visual workflow designer](/img/ui/Workflow-Single-File-Design.png) - - The workflow is represented visually as a series of directed acyclic graph (DAG) nodes. Each node represents a - step in the workflow. The workflow proceeds end to end from left to right. By default, the workflow starts with three nodes: - - - **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. - 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. - - **Partitioner**: This node represents the [partitioning](/ui/partitioning) step, which extracts content from unstructured files and data and outputs it as structured - [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 - your local machine and outputs it as a series of structured document elements in JSON format. - - **Destination**: This node represents the location where you want Unstructured to put the processed files or data. - 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. - - - - 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. - The file must have a size of 10 MB or less and one of the file types listed at the beginning of this quickstart. - - 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. - - Alternatively, you can use a sample file that Unstructured offers. To do this, click the **Source** node, and then in the **Source** pane, with - **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 - select it, click the eyes button next to the file. - - 2. Above the **Source** node, click **Test**. - - ![Testing a single local file workflow](/img/ui/Workflow-Test-Source.png) - - Unstructured displays a visual representation of the file and begins processing its contents, sending it through each of the workflow's nodes in sequence. - Depending on the file's size and the workflow's complexity, this processing could take several minutes. - - After Unstructured has finished its processing, the processed data appears in the **Test output** pane, as a series of structured elements in JSON format. - - ![Viewing single local file output](/img/ui/Workflow-Test-Single-File-Output.png) - - 3. In the **Test output** pane, you can: - - - Search through the processed, JSON-formatted representation of the file by using the **Search JSON** box. - - Download the full JSON as a `.json` file to your local machine by clicking **Download full JSON**. - - 4. When you are done, click the **Close** button in the **Test output** pane. - - - - 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: - - ![Adding a node to the workflow](/img/ui/Workflow-Add-Node.png) - - - - - Add an **Enrichment** node after the **Partitioner** node, to apply enrichments to the partitioned data such as image summaries, table summaries, table-to-HTML transforms, and - named entity recognition (NER). To do this, click the add (**+**) button to the right of the **Partitioner** node, and then click **Enrich > Enrichment**. - 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). - - - - - Add a **Chunker** node after the **Enrichment** node, to chunk the enriched data into smaller pieces for your retrieval-augmented generation (RAG) applications. - To do this, click the add (**+**) button to the right of the **Enrichment** node, and then click **Enrich > Chunker**. Click the new **Chunker** node and - specify its settings. For help, click the **FAQ** button in the **Chunker** node's pane. [Learn more about chunking and chunker settings](/ui/chunking). - - Add an **Embedder** node after the **Chunker** node, to generate vector embeddings for performing vector-based searches. To do this, click the add (**+**) button to the - right of the **Chunker** node, and then click **Transform > Embedder**. Click the new **Embedder** node and specify its settings. For help, click the **FAQ** button - in the **Embedder** node's pane. [Learn more about embedding and embedding settings](/ui/embedding). - - 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. - - 3. Keep repeating this step as many times as you want, until you get the results you want. - - - - After you get the results you want, you have the option of moving your workflow into production. To do this, complete the following instructions. - - - The following instructions have you create a new workflow that is suitable for production. - 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. - - - 1. With your workflow remaining open in the visual workflow editor, open a new tab in your web browser, and in this new tab, - sign in to your Unstructured account: - - - If you do not already have an Unstructured account, go to [https://unstructured.io/contact](https://unstructured.io/contact) and fill out the online form to indicate your interest. - - If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. - If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). - - 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. - - ![Connectors button on the sidebar](/img/ui/Sources-Sidebar.png) - - 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. - 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. - 5. In the visual workflow editor, click **Source**. - 6. In the **Source** pane, with **Details** selected, on the **Connectors** tab, select the source connector that you just created. - 7. Click the **Destination** node. - 8. In the **Destination** pane, with **Details** selected, select the destination connector that you just created. - 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. - 10. Click **Save**. - 11. To run the workflow: - - a. Make sure to click **Save** first.
- b. Click the **Close** button next to the workflow's name in the top navigation bar.
- c. On the sidebar, click **Workflows**.
- d. In the list of available workflows, click the **Run** button for the workflow that you just saved.
- e. On the sidebar, click **Jobs**.
- - ![Viewing the list of available jobs](/img/ui/Select-Job.png) - - f. In the list of available jobs, click the job that you just ran.
- g. After the job status shows **Finished**, go to the your destination location to see the processed files or data that Unstructured put there. - - 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. - - \ No newline at end of file diff --git a/ui/account/api-key-url.mdx b/ui/account/api-key-url.mdx index 6ca0a669..bad05dfe 100644 --- a/ui/account/api-key-url.mdx +++ b/ui/account/api-key-url.mdx @@ -16,15 +16,20 @@ You need an API key whenever you want to call the Unstructured API's You do not need an API key to use the [Unstructured user interface](/ui/overview) (UI) to create or manage connectors, workflows, or jobs in your Unstructured account, or to manage your Unstructured account. + + For an Unstructured **Team** or **Enterprise** account, before you click **API Keys**, make sure you have selected the + [organizational workspace](/ui/account/workspaces) you want to access API keys and API URLs for. + + ## View available API keys -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. On the sidebar, click **API Keys**. 3. Existing API keys are listed on the **API Keys** tab. ## Create a new API key -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. On the sidebar, click **API Keys**. 3. On the **API Keys** tab, click **Generate New Key**. 4. Enter some descriptive name for the API key, and then click **Save**. @@ -36,7 +41,7 @@ name, value, or any other settings. ## Get an existing API key's value -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. On the sidebar, click **API Keys**. 3. On the **API Keys** tab, in the list of available keys, click the **Copy** icon for the target key. The key's value is copied to your system's clipboard. @@ -49,7 +54,7 @@ If you are concerned that an unauthorized user or other entity might have this A You might want to temporarily disable an existing API key that you suspect is causing some kind of issue or might be compromised in some way. However, you might want the option to re-enable it after you solve your issues or determine that it was not compromised. -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. On the sidebar, click **API Keys**. 3. On the **API Keys** tab, in the list of available keys, switch the **Status** toggle on or off for the target API key to enable or disable that key, respectively. @@ -72,7 +77,7 @@ To rotate an old, existing API key before you permanently delete it: To permanently delete an existing API key: -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. On the sidebar, click **API Keys**. 3. On the **API Keys** tab, in the list of available keys, click the **Options** vertical ellipsis for the target API key. 4. Click **Delete**. @@ -84,6 +89,6 @@ In some cases, you might need to specify a particular API URL to call one of the Unstructured API's [Unstructured Workflow Endpoint](/api-reference/workflow/overview) or [Unstructured Partition Endpoint](/api-reference/partition/overview). -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. On the sidebar, click **API Keys**. 3. On the **API Keys** tab, the available API URLs are listed. \ No newline at end of file diff --git a/ui/account/billing.mdx b/ui/account/billing.mdx index 13fab4bf..039b16c0 100644 --- a/ui/account/billing.mdx +++ b/ui/account/billing.mdx @@ -11,7 +11,7 @@ sidebarTitle: Billing Unstructured billing how-to -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. Click the **Billing** tab. 4. Click **Manage Payment Method**, follow the on-screen instructions to enter or update your payment details, and then click **Save card**. diff --git a/ui/account/organizations.mdx b/ui/account/organizations.mdx index 16547db9..7ef123f5 100644 --- a/ui/account/organizations.mdx +++ b/ui/account/organizations.mdx @@ -3,9 +3,9 @@ title: Organizational accounts --- - The following information applies only to Unstructured organizational accounts. To request an organizational account to be created, - contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), - or complete the online [Unstructured contact form](https://unstructured.io/contact). + The following information applies only to Unstructured **Team** and **Enterprise** accounts. To upgrade from an Unstructured **Starter** account + to a **Team** or **Enterprise** account, contact your Unstructured sales representative, or + email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). An _organizational account_ is an Unstructured account that allows multiple users to access Unstructured resources and share billing. @@ -144,8 +144,7 @@ Each user must be explicitly added to the organizational accounts—and work ## Create an organizational account Only authorized Unstructured representatives can create organizational accounts. To request an organizational account to be created, contact your Unstructured -sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or complete the online -[Unstructured contact form](https://unstructured.io/contact). +sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). ## Access an organizational account @@ -228,5 +227,4 @@ To add a user to an organizational account as a member: Only authorized Unstructured representatives can delete organizational accounts. To request an organizational account to be permanently deleted, contact your Unstructured -sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or complete the online -[Unstructured contact form](https://unstructured.io/contact). \ No newline at end of file +sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). \ No newline at end of file diff --git a/ui/account/overview.mdx b/ui/account/overview.mdx index 2c5094dd..772a0a80 100644 --- a/ui/account/overview.mdx +++ b/ui/account/overview.mdx @@ -3,11 +3,12 @@ title: Accounts overview sidebarTitle: Overview --- -After you sign up for an Unstructured account, you can manage your account's [billing](/ui/account/billing) and +After you sign in to your Unstructured account, you can manage your account's [billing](/ui/account/billing) and get your account's [usage](/ui/account/usage) details. You can also create and manage your account's [API keys](/ui/account/api-key-url)—and get any [API URLs](/ui/account/api-key-url) as needed—to work programmatically with your Unstructured account through the [Unstructured API](/api-reference/overview). An Unstructured [organizational account](/ui/account/organizations) is a special kind of account that can manage multiple -[workspaces](/ui/account/workspaces) and use [roles](/ui/account/roles) to manage user access to the account and its workspaces. \ No newline at end of file +[workspaces](/ui/account/workspaces) and use [roles](/ui/account/roles) to manage user access to the account and its workspaces. +Unstructured organizational accounts apply only to Unstructured **Team** and **Enterprise** accounts. \ No newline at end of file diff --git a/ui/account/roles.mdx b/ui/account/roles.mdx index 9619e06f..48c21f92 100644 --- a/ui/account/roles.mdx +++ b/ui/account/roles.mdx @@ -4,9 +4,10 @@ sidebarTitle: Roles --- - The following information applies only to Unstructured [organizational accounts](/ui/account/organizations). To request an organizational account to be created, - contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), - or complete the online [Unstructured contact form](https://unstructured.io/contact). + The following information applies only to Unstructured [organizational accounts](/ui/account/organizations), which are + available only for Unstructured **Team** and **Enterprise** accounts. To upgrade from an Unstructured **Starter** account + to a **Team** or **Enterprise** account, contact your Unstructured sales representative, or + email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). _Roles_ in Unstructured are part of the _role-based access control_ (RBAC) system that manages permissions for members of diff --git a/ui/account/usage.mdx b/ui/account/usage.mdx index 84038fd0..b3f0ef00 100644 --- a/ui/account/usage.mdx +++ b/ui/account/usage.mdx @@ -11,7 +11,7 @@ To view usage details for your Unstructured account, do the following: Unstructured billing how-to -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. At the bottom of the sidebar, click your user icon, and then click **Account Settings**. 3. Click the **Usage History** tab. diff --git a/ui/account/workspaces.mdx b/ui/account/workspaces.mdx index 37a03c00..de8d975e 100644 --- a/ui/account/workspaces.mdx +++ b/ui/account/workspaces.mdx @@ -4,9 +4,10 @@ sidebarTitle: Workspaces --- - The following information applies only to Unstructured [organizational accounts](/ui/account/organizations). To request an organizational account to be created, - contact your Unstructured sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), - or complete the online [Unstructured contact form](https://unstructured.io/contact). + The following information applies only to Unstructured [organizational accounts](/ui/account/organizations), which are + available only for Unstructured **Team** and **Enterprise** accounts. To upgrade from an Unstructured **Starter** account + to a **Team** or **Enterprise** account, contact your Unstructured sales representative, or + email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). A _workspace_ is a collection of resources such as connectors, workflows, jobs, and API keys. @@ -100,8 +101,7 @@ To create a workspace, you must first have an available Unstructured [organizati Currently, only Unstructured representatives can create organizational accounts. To request an organizational account to be created, contact your Unstructured -sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or complete the online -[Unstructured contact form](https://unstructured.io/contact). +sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). Your user must have the **Super Admin** [role](/ui/account/roles) in the intended workspace's parent organizational account to create workspaces in that organizational account. @@ -109,7 +109,7 @@ sales representative, email Unstructured Sales at [sales@unstructured.io](mailto (A user always has one and only one personal workspace within their personal account. You cannot create additional workspaces in personal accounts.) -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that you want to add a workspace to. 3. In the sidebar, above your user icon, click the **Settings** (gear) icon. 4. Click **View All Workspaces**. @@ -126,7 +126,7 @@ sales representative, email Unstructured Sales at [sales@unstructured.io](mailto ## Access a workspace -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to access. 3. In the workspace selector, select the name of the workspace that you want to access. @@ -149,7 +149,7 @@ To add a user to a workspace as a member: 1. Make sure the account user that you want to add has already been added as a member of the workspace's parent organizational account. [Learn how](/ui/account/organizations#add-a-member-to-an-organization). -2. Sign in to your Unstructured account. +2. If you are not already signed in, sign in to your Unstructured account. 3. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to add a member to. 4. In the workspace selector, select the name of the workspace that you want to add a member to. 5. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -167,7 +167,7 @@ To add a user to a workspace as a member: workspace to change the roles for that workspace's members. -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace for the member you want to change roles for. 3. In the workspace selector, select the name of the workspace that contains the member you want to change roles for. 4. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -195,7 +195,7 @@ To add a user to a workspace as a member: (A user cannot be removed from their personal workspace within their personal account.) -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to remove a member from. 3. In the workspace selector, select the name of the workspace that you want to remove a member from. 4. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -216,7 +216,7 @@ To make programmatic API calls to a workspace instead of using the UI, an API ke An API key can be used only with the workspace for which it was created. -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to create an API key for. 3. In the workspace selector, select the name of the workspace that you want to create an API key for. 4. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -242,7 +242,7 @@ An API key is valid only for the workspace for which it was created. workspace to delete API keys from that workspace. -1. Sign in to your Unstructured account. +1. If you are not already signed in, sign in to your Unstructured account. 2. In the top navigation bar, in the organizational account selector, select the name of the organizational account that contains the workspace you want to delete an API key for. 3. In the workspace selector, select the name of the workspace that you want to delete an API key for. 4. In the sidebar, above your user icon, click the **Settings** (gear) icon. @@ -268,5 +268,4 @@ An API key is valid only for the workspace for which it was created. Only authorized Unstructured representatives can delete workspaces. To request a workspace to be permanently deleted, contact your Unstructured -sales representative, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io), or complete the online -[Unstructured contact form](https://unstructured.io/contact). \ No newline at end of file +sales representative, or email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). \ No newline at end of file diff --git a/ui/overview.mdx b/ui/overview.mdx index e419bc80..d1f0031e 100644 --- a/ui/overview.mdx +++ b/ui/overview.mdx @@ -2,9 +2,11 @@ title: Overview --- -The Unstructured user interface (UI) is a no-code user interface, pay-as-you-go platform for transforming your unstructured data into data that is ready for retrieval-augmented generation (RAG). +To start using the Unstructured UI right away, skip ahead to the [quickstarts](/ui/quickstart) now! + +## What is the Unstructured UI? -To start using the Unstructured UI right away, skip ahead to the [quickstart](/ui/quickstart). +The Unstructured user interface (UI) is a no-code user interface, pay-as-you-go platform for transforming your unstructured data into data that is ready for retrieval-augmented generation (RAG). Here is a screenshot of the Unstructured UI **Start** page: @@ -24,7 +26,6 @@ This 90-second video provides a brief overview of the Unstructured UI:   [Read the announcement](https://unstructured.io/blog/introducing-unstructured-platform-the-enterprise-etl-platform-for-the-genai-tech-stackintroducing-unstructured-platform-beta-the-enterprise-etl-platform-for-the-genai-tech-stack). - ## How does it work? To get your data RAG-ready, Unstructured moves it through the following process: @@ -115,10 +116,8 @@ import Pricing from '/snippets/general-shared-text/pricing-platform.mdx'; Skip ahead to the [quickstart](/ui/quickstart). -## How do I get help? - -[Contact us directly](https://unstructured.io/contact), or join our [Slack community](https://short.unstructured.io/pzw05l7). - -For enterprise support, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +## Questions? Need help? +- For general questions about Unstructured products and pricing, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +- For technical support for Unstructured accounts, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). diff --git a/ui/quickstart.mdx b/ui/quickstart.mdx index 0f0633ad..007a59cc 100644 --- a/ui/quickstart.mdx +++ b/ui/quickstart.mdx @@ -3,29 +3,37 @@ title: Unstructured UI quickstarts sidebarTitle: Quickstarts --- -This page contains two quickstarts to help you get started with the Unstructured user interface (UI). +## Local file quickstart -- The [local quickstart](#local-quickstart) is an ideal starting point and requires no prior setup. It shows you how to use the Unstructured UI to process a single file that is stored on your local machine. - This approach is ideal for rapid testing and prototyping of Unstructured ETL+ workflows, across the full range of Unstructured features, against a single representative file. -- The [remote quickstart](#remote-quickstart) takes a bit longer, but it shows you how to use the UI to set up and run Unstructured ETL+ workflows against files and data stored in - remote source file and object stores, websites, databases, and vector stores. Unstructured delivers the resulting processed data to remote destination file and object stores, databases, and vector stores. - This approach is ideal for production use cases, where you want to process large volumes of files and data in a scalable and efficient manner. +The following quickstart shows you how to use the Unstructured UI to process a single file that is stored on your local machine. +This approach is ideal for rapid testing and prototyping of Unstructured ETL+ workflows, across the full range of Unstructured features, +against a single representative file. - - If you're not sure which quickstart to use, we recommend starting with the [local quickstart](#local-quickstart). - - The local quickstart is a fast and easy way to learn about - Unstructured. When you're happy with the results from the workflow that you create there, it is straightforward to turn it into a production-ready workflow with - all of the settings that you want already in place! - +To process files (or data) in remote locations instead, skip ahead to the [remote quickstart](#remote-quickstart). -## Local quickstart +import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-simple-ui-only.mdx'; -import SharedSingleFileUI from '/snippets/quickstarts/single-file-ui.mdx'; + - +3. After you sign in, watch the following 2-minute video: -- To learn more, read [Skip the Setup. Get Straight to the Results with Our Redesigned Interactive Workflow Builder](https://unstructured.io/blog/skip-the-setup-get-straight-to-the-results-with-our-redesigned-interactive-workflow-builder). + + +Learn more about Unstructured [source connectors](/ui/sources/overview), +[destination connectors](/ui/destinations/overview), +[workflows](/ui/workflows), +[jobs](/ui/jobs), and +[managing your account](/ui/account/overview). + +--- ## Remote quickstart @@ -33,6 +41,10 @@ import SharedPlatform from '/snippets/quickstarts/platform.mdx'; - +Learn more about Unstructured [source connectors](/ui/sources/overview), +[destination connectors](/ui/destinations/overview), +[workflows](/ui/workflows), +[jobs](/ui/jobs), and +[managing your account](/ui/account/overview). diff --git a/welcome.mdx b/welcome.mdx index 86ab756b..7190a4b3 100644 --- a/welcome.mdx +++ b/welcome.mdx @@ -1,13 +1,15 @@ --- -title: Unstructured -sidebarTitle: Overview +title: Welcome to Unstructured! +sidebarTitle: Welcome! --- -![ETL plus for GenAI data banner](/img/welcome/ETL-For-GenAI-Data.png) +To start using Unstructured right away, skip ahead to the [UI quickstart](#unstructured-ui-quickstart) or [API quickstart](#unstructured-api-quickstart) now! + +## What is Unstructured? Unstructured provides a platform and tools to ingest and process unstructured documents for retrieval-augmented generation (RAG), agentic AI, and model fine-tuning. -This 60-second video describes more about what Unstructured does and its benefits: +This 60-second video describes more about what Unstructured does and its benefits (no sound): -This 40-second video demonstrates a simple use case that Unstructured helps solve: +This 40-second video demonstrates a simple use case that Unstructured helps solve (no sound): -This one-minute video shows why using Unstructured is preferable to building your own similar solution: +This 60-second video shows why using Unstructured is preferable to building your own similar solution: -Unstructured offers the Unstructured user interface (UI) and the Unstructured API. Read on to learn more. - -## Unstructured user interface (UI) - -No-code UI. Production-ready. [Learn more](/ui/overview). +You can use Unstructured through a user interface (UI), an API, or both. Read on to learn more. -Here is a screenshot of the Unstructured UI **Start** page: +--- -![Partial view of the Unstructured UI](/img/ui/Start-Screen-Partial.png) +## Unstructured UI quickstart -This 90-second video provides a brief overview of the Unstructured UI: +1. If you do not already have an Unstructured account, sign up for one at [https://unstructured.io/developers](https://unstructured.io/developers). + After you sign up, you are automatically signed in to your new Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io). +2. Watch the following 2-minute video: -To start using the Unstructured UI right away, skip ahead to the [quickstart](#unstructured-ui-quickstart). +  [Learn more](/ui/overview). -## Unstructured API - -Use scripts or code. Production-ready. [Learn more](/api-reference/overview). - -The Unstructured API consists of two parts: - -- The [Unstructured Workflow Endpoint](/api-reference/workflow/overview) enables a full range of partitioning, chunking, embedding, and - enrichment options for your files and data. It is designed to batch-process files and data in remote locations; send processed results to - various storage, databases, and vector stores; and use the latest and highest-performing models on the market today. It has built-in logic - to deliver the highest quality results at the lowest cost. [Learn more](/api-reference/workflow/overview). -- The [Unstructured Partition Endpoint](/api-reference/partition/overview) is intended for rapid prototyping of Unstructured's - various partitioning strategies, with limited support for chunking. It is designed to work only with processing of local files, one file - at a time. Use the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) for production-level scenarios, file processing in - batches, files and data in remote locations, generating embeddings, applying post-transform enrichments, using the latest and - highest-performing models, and for the highest quality results at the lowest cost. [Learn more](/api-reference/partition/overview). - -Here is a screenshot of some Python code that calls the Unstructured Workflow Endpoint: - -![Python code that calls the Unstructured Workflow Endpoint](/img/ui/Python-Workflow-Code-Partial.png) +--- -To start using the Unstructured Workflow Endpoint right away, skip ahead to the [quickstart](#unstructured-workflow-endpoint-quickstart). +## Unstructured API quickstart ---- +1. If you do not already have an Unstructured account, sign up for one at [https://unstructured.io/developers](https://unstructured.io/developers). + After you sign up, you are automatically signed in to your Unstructured **Starter** account, at [https://platform.unstructured.io](https://platform.unstructured.io). +2. Watch the following 3-minute video: -## Supported file types + -The Unstructured user interface (UI) and Unstructured API support processing of the following file types: +  [Get the sample code for this video](/api-reference/partition/quickstart#sample-code). -import SupportedFileTypes from '/snippets/general-shared-text/supported-file-types-platform.mdx'; +  [Get the full setup instructions for this video](/api-reference/partition/quickstart). - +  [Learn more](/api-reference/overview). --- -## Pricing - -To use the Unstructured UI or call the Unstructured API, you must have an Unstructured account. +## Pricing import Pricing from '/snippets/general-shared-text/pricing-platform.mdx'; @@ -111,32 +101,8 @@ import Pricing from '/snippets/general-shared-text/pricing-platform.mdx'; --- -## Unstructured UI quickstart - -import SharedSingleFileUI from '/snippets/quickstarts/single-file-ui.mdx'; - - - -- [Learn more about the Unstructured UI](/ui/overview). --   Also, read [Skip the Setup. Get Straight to the Results with Our Redesigned Interactive Workflow Builder](https://unstructured.io/blog/skip-the-setup-get-straight-to-the-results-with-our-redesigned-interactive-workflow-builder). - ---- - -import LocalToLocalPythonIngestLibrary from '/snippets/ingestion/local-to-local.v2.py.mdx'; -import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-dependencies.mdx'; - -## Unstructured Workflow Endpoint quickstart - -import SharedPlatformAPI from '/snippets/quickstarts/platform-api.mdx'; - - - -[Learn more about the Unstructured API](/api-reference/overview). - ---- - -## Get in touch +## Questions? Need help? -If you can't find the information you're looking for in the documentation, or if you need help, -[contact us directly](https://unstructured.io/contact), -or [join our Slack](https://short.unstructured.io/pzw05l7) where our team and community can help you. +- For general questions about Unstructured products and pricing, email Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io). +- For technical support for Unstructured accounts, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). +- For technical support for the Unstructured open source library, use our [Slack community](https://short.unstructured.io/pzw05l7). \ No newline at end of file