Skip to content

Commit 21d307c

Browse files
authored
[Hold] Account updates (#713)
1 parent 85b9c8a commit 21d307c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+502
-617
lines changed

api-reference/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import Pricing from '/snippets/general-shared-text/pricing-platform.mdx';
4141

4242
## Get support
4343

44-
Should you require any assistance or have any questions regarding the Unstructured API, please [contact us directly](https://unstructured.io/contact).
44+
For technical support for Unstructured accounts, email Unstructured Support at [[email protected]](mailto:support@unstructured.io).
4545

4646
## Learn more
4747

api-reference/partition/examples.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ representing your Unstructured API key. [Get your API key](/api-reference/partit
88

99
Also, you'll need to set an environment variable named `UNSTRUCTURED_API_URL` to the
1010
value of the Unstructured API URL for your account. This API URL was provided to you when your Unstructured account was created.
11-
If you do not have this API URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
11+
If you do not have this API URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
1212

1313
<Note>
1414
For the Unstructured Python SDK, the API URL is set to `https://api.unstructuredapp.io/general/v0/general` by default.

api-reference/partition/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ available for download from [https://constitutioncenter.org/media/files/constitu
3636
From your terminal or Command Prompt, set the following two environment variables.
3737

3838
- Replace `<your-unstructured-api-url>` with the Unstructured Partition Endpoint URL. This URL was provided to you when your Unstructured account was created.
39-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
39+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
4040

4141
<Note>
4242
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`.

api-reference/partition/post-requests.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s
3030
<GetStartedSimpleAPIOnly/>
3131

3232
The API URL was provided to you when your Unstructured account was created.
33-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
33+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
3434

3535
<Note>
36-
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`. However,
37-
this URL might not necessarily work for your account.
36+
The default URL for the Unstructured Partition Endpoint is `https://api.unstructuredapp.io/general/v0/general`.
37+
However, you should always use the API URL that was provided to you when your Unstructured account was created.
3838
</Note>
3939

4040
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.

api-reference/partition/quickstart.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ title: Unstructured API Quickstart
44

55
<Tip>Just need to copy the sample code? [Skip ahead](#sample-code) to it now!</Tip>
66

7+
<iframe
8+
width="560"
9+
height="315"
10+
src="https://www.youtube.com/embed/0EogKNU_BPU"
11+
title="YouTube video player"
12+
frameborder="0"
13+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
14+
allowfullscreen
15+
></iframe>
16+
717
The following code shows how to use the [Unstructured Python SDK](/api-reference/partition/sdk-python)
818
to have Unstructured process one or more local files by using
919
the [Unstructured Partition Endpoint](/api-reference/partition/overview).

api-reference/troubleshooting/api-key-url.mdx

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ API error occurred: Status 404
3636
## Suggested solutions
3737

3838
For the API URL, this URL was provided to you when your Unstructured account was created.
39-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
39+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
4040

4141
<Note>
4242
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 [[email protected]
4848

4949
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:
5050

51-
1. Sign in to your Unstructured account:
51+
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).
5252

53-
- 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.
54-
- 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.
55-
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
53+
<Note>
54+
For an **Enterprise** account, see your Unstructured account administrator for instructions,
55+
or email Unstructured Support at [[email protected]](mailto:[email protected]).
56+
</Note>
5657

57-
2. Get your Unstructured API key:
58+
2. Get your Unstructured API key:<br/>
5859

59-
a. In the Unstructured UI, click **API Keys** on the sidebar.<br/>
60-
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.<br/>
61-
62-
3. If you want or need to generate a new Unstructured API key at this point:
60+
a. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.<br/>
6361

64-
a. Click **Generate API Key**.<br/>
65-
b. Follow the on-screen instructions to finish generating the key.<br/>
66-
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.<br/>
62+
<Note>
63+
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
64+
for. Each API key works with one and only one organizational workspace. [Learn more](/ui/account/workspaces#create-an-api-key-for-a-workspace).
65+
</Note>
6766

68-
<Note>
69-
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
70-
might be different. For guidance, email Unstructured Sales at [[email protected]](mailto:[email protected]).
71-
</Note>
67+
b. Click **Generate API Key**.<br/>
68+
c. Follow the on-screen instructions to finish generating the key.<br/>
69+
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.<br/>
7270

7371
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:
7472

75-
1. Sign in to your Unstructured account:
73+
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).
74+
75+
<Note>
76+
For an **Enterprise** account, see your Unstructured account administrator for instructions,
77+
or email Unstructured Support at [[email protected]](mailto:[email protected]).
78+
</Note>
79+
80+
2. After you sign in to your Unstructured **Starter** account, click **API Keys** on the sidebar.<br/>
7681

77-
- 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.
78-
- 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.
79-
If you do not have this URL, contact Unstructured Sales at [[email protected]](mailto:[email protected]).
82+
<Note>
83+
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.
84+
</Note>
8085

81-
2. In the Unstructured UI, click **API Keys** on the sidebar.
8286
3. Note the API URL for the **Unstructured Workflow Endpoint** or the **Unstructured Partition Endpoint**, depending on whether you want to call the
8387
[Unstructured Workflow Endpoint](/api-reference/workflow/overview) or the [Unstructured Partition Endpoint](/api-reference/partition/overview), respectively.
8488

85-
<Note>
86-
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
87-
might be different. For guidance, email Unstructured Sales at [[email protected]](mailto:[email protected]).
88-
</Note>
89-
9089
If you still believe you have the correct API URL and API key, try the following steps:
9190

9291
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
116115
- 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.
117116
- 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.
118117

119-
3. If you are still getting this issue, [contact us directly](https://unstructured.io/contact).
118+
3. If you are still getting this issue, email Unstructured Support at [[email protected]](mailto:support@unstructured.io).
120119

api-reference/workflow/overview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ import GetStartedSimpleAPIOnly from '/snippets/general-shared-text/get-started-s
9191
Calls made by the Unstructured Python SDK's `unstructured_client` functions for creating, listing, updating,
9292
and deleting connectors, workflows, and jobs in the Unstructured UI all use the Unstructured Workflow Endpoint URL.
9393
This URL was provided to you when your Unstructured account was created.
94-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
94+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
9595

9696
<Note>
9797
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,
131131
get this API key, see the [quickstart](#quickstart), earlier on this page.
132132

133133
Note that you should always use the URL that was provided to you when your Unstructured account was created.
134-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
134+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
135135
</Tip>
136136

137137
### curl and Postman
@@ -144,7 +144,7 @@ export UNSTRUCTURED_API_KEY="<your-unstructured-api-key>"
144144
```
145145

146146
For the API URL, this URL was provided to you when your Unstructured account was created.
147-
If you do not have this URL, contact Unstructured Sales at [sales@unstructured.io](mailto:sales@unstructured.io).
147+
If you do not have this URL, email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io).
148148

149149
<Note>
150150
The default URL for the Unstructured Worfklow Endpoint is `https://platform.unstructuredapp.io/api/v1`.

docs.json

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -299,39 +299,39 @@
299299
]
300300
},
301301
{
302-
"tab": "Self-hosted",
302+
"tab": "Enterprise",
303303
"groups": [
304304
{
305-
"group": "Self-hosting",
305+
"group": "Enterprise",
306306
"pages": [
307-
"self-hosted/overview"
307+
"enterprise/overview"
308308
]
309309
},
310310
{
311311
"group": "Security and compliance",
312312
"pages": [
313-
"self-hosted/security-compliance/overview"
313+
"enterprise/security-compliance/overview"
314314
]
315315
},
316316
{
317317
"group": "AWS",
318318
"pages": [
319-
"self-hosted/aws/overview",
320-
"self-hosted/aws/onboard"
319+
"enterprise/aws/overview",
320+
"enterprise/aws/onboard"
321321
]
322322
},
323323
{
324324
"group": "Azure",
325325
"pages": [
326-
"self-hosted/azure/overview",
327-
"self-hosted/azure/onboard"
326+
"enterprise/azure/overview",
327+
"enterprise/azure/onboard"
328328
]
329329
},
330330
{
331331
"group": "GCP",
332332
"pages": [
333-
"self-hosted/gcp/overview",
334-
"self-hosted/gcp/onboard"
333+
"enterprise/gcp/overview",
334+
"enterprise/gcp/onboard"
335335
]
336336
}
337337
]
@@ -524,12 +524,12 @@
524524
"global": {
525525
"anchors": [
526526
{
527-
"anchor": "Contact Us",
528-
"href": "https://unstructured.io/contact",
527+
"anchor": "Account support (e-mail)",
528+
"href": "mailto:support@unstructured.io",
529529
"icon": "person-circle-question"
530530
},
531531
{
532-
"anchor": "Community",
532+
"anchor": "Open source support (Slack)",
533533
"href": "https://short.unstructured.io/pzw05l7",
534534
"icon": "slack"
535535
},
@@ -544,28 +544,33 @@
544544
"icon": "newspaper"
545545
},
546546
{
547-
"anchor": "Product",
547+
"anchor": "Product info",
548548
"href": "https://unstructured.io/",
549549
"icon": "square-terminal"
550550
},
551551
{
552-
"anchor": "Trust Portal",
552+
"anchor": "Trust portal",
553553
"href": "https://trust.unstructured.io/",
554554
"icon": {
555555
"name": "file-certificate",
556556
"style": "thin"
557557
}
558558
},
559559
{
560-
"anchor": "Meta-Prompt (Titles)",
560+
"anchor": "Contact Sales (e-mail)",
561+
"href": "mailto:[email protected]",
562+
"icon": "person"
563+
},
564+
{
565+
"anchor": "Meta-prompt (titles)",
561566
"href": "https://docs.unstructured.io/llms.txt",
562567
"icon": {
563568
"name": "microchip-ai",
564569
"style": "thin"
565570
}
566571
},
567572
{
568-
"anchor": "Meta-Prompt (Full)",
573+
"anchor": "Meta-prompt (full)",
569574
"href": "https://docs.unstructured.io/llms-full.txt",
570575
"icon": {
571576
"name": "microchip-ai",
@@ -749,6 +754,10 @@
749754
"source": "/platform-api/partition-api/:slug*",
750755
"destination": "/api-reference/partition/:slug*"
751756
},
757+
{
758+
"source": "/self-hosted/:slug*",
759+
"destination": "/enterprise/:slug*"
760+
},
752761
{
753762
"source": "/ui/billing",
754763
"destination": "/ui/account/billing"

self-hosted/aws/onboard.mdx renamed to enterprise/aws/onboard.mdx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
2-
title: AWS self-hosted onboarding checklist
2+
title: Unstructured Enterprise in-VPC on Amazon Web Services (AWS) - onboarding checklist
33
sidebarTitle: Onboarding
44
---
55

66
<Note>
7-
To proceed with a self-hosted deployment, your organization must first sign a self-hosting agreement with Unstructured.
7+
The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview).
88

9-
If you have not yet signed this agreement, stop here, and begin the self-hosting agreement process by contacting your Unstructured sales representative, emailing
10-
Unstructured Sales at [[email protected]](mailto:[email protected]), or filling out the [contact form](https://unstructured.io/contact)
11-
on the Unstructured website.
9+
For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative,
10+
or email Unstructured Sales at [[email protected]](mailto:[email protected]).
1211
</Note>
1312

14-
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
13+
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
1514
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:
1615

1716
- [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
2019
## Questions? Need help?
2120

2221
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,
23-
email Unstructured Sales at [[email protected]](mailto:[email protected]), or fill out the
24-
[contact form](https://unstructured.io/contact) on the Unstructured website, and a member of the Unstructured sales or technical enablement teams
22+
email Unstructured Sales at [[email protected]](mailto:[email protected]), and a member of the Unstructured sales or technical enablement teams
2523
will get back to you as soon as possible.
2624

2725
## Do it all for me

enterprise/aws/overview.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Unstructured Enterprise in-VPC on Amazon Web Services (AWS) - overview
3+
sidebarTitle: Overview
4+
---
5+
6+
<Note>
7+
The following information applies only to in-VPC deployments of [Unstructured Enterprise](/enterprise/overview).
8+
9+
For dedicated instance deployments of Unstructured Enterprise, contact your Unstructured sales representative,
10+
or email Unstructured Sales at [[email protected]](mailto:[email protected]).
11+
</Note>
12+
13+
## Getting started
14+
15+
To get started with an Enterpise deployment, your organization must first sign an Enterprise agreement with Unstructured.
16+
This agreement outlines the terms and conditions for your organization to use Unstructured.
17+
18+
To begin the Enterprise agreement process, contact your Unstructured sales representative, or email Unstructured Sales at [[email protected]](mailto:[email protected]).
19+
20+
After your organization has signed the Enterprise agreement, a member of the Unstructured technical enablement team will reach out to you to begin the
21+
deployment onboarding process. To streamline this process, you are encouraged to begin setting up your target environment as soon as possible. To do this,
22+
see the [onboarding checkist](/enterprise/aws/onboard).
23+
24+
## Questions? Need help?
25+
26+
Contact your Unstructured sales representative, or email Unstructured Sales at [[email protected]](mailto:[email protected]), and a member of the Unstructured sales or support teams
27+
will get back to you as soon as possible.

0 commit comments

Comments
 (0)