Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions api-reference/partition/api-parameters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,21 @@ Need help getting started? Check out the [Examples page](/api-reference/partitio

Allowed values for `vlm_model_provider` and `vlm_model` pairs include the following:

import DeprecatedModelsAPI from '/snippets/general-shared-text/deprecated-models-api.mdx';

<DeprecatedModelsAPI />

| `vlm_model_provider` | `vlm_model` |
|----------------------|------------------------------------------------|
| `anthropic` | `claude-3-5-sonnet-20241022` |
| `anthropic_bedrock` | `claude-3-5-sonnet-20241022` |
| `anthropic` | `claude-sonnet-4-20250514` |
| `bedrock` | `us.amazon.nova-lite-v1:0` |
| `bedrock` | `us.amazon.nova-pro-v1:0` |
| `bedrock` | `us.anthropic.claude-3-5-sonnet-20241022-v2:0` |
| `bedrock` | `us.anthropic.claude-3-haiku-20240307-v1:0` |
| `bedrock` | `us.anthropic.claude-3-opus-20240229-v1:0` |
| `bedrock` | `us.anthropic.claude-3-sonnet-20240229-v1:0` |
| `bedrock` | `us.anthropic.claude-sonnet-4-20250514-v1:0` |
| `bedrock` | `us.meta.llama3-2-11b-instruct-v1:0` |
| `bedrock` | `us.meta.llama3-2-90b-instruct-v1:0` |
| `openai` | `gpt-4o` |
| `openai` | `gpt-5-mini-2025-08-07` |
| `vertexai` | `gemini-2.0-flash-001` |
58 changes: 44 additions & 14 deletions api-reference/workflow/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1030,6 +1030,8 @@ A **Partitioner** node has a `type` of `partition`.

#### Auto strategy

import DeprecatedModelsAPI from '/snippets/general-shared-text/deprecated-models-api.mdx';

<AccordionGroup>
<Accordion title="Python SDK">
```python
Expand Down Expand Up @@ -1074,22 +1076,36 @@ A **Partitioner** node has a `type` of `partition`.
Fields for `settings` include:

- `strategy`: _Required_. The partitioning strategy to use. This field must be set to `auto`.
- `provider`: _Optional_. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM provider. Allowed values include `auto`, `openai`, `anthropic`, and `bedrock`. The default value is `anthropic`.
- `provider`: _Optional_. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM provider. Allowed values include `anthropic`, `auto`, `bedrock`, `openai`, and `vertexai`. The default value is `anthropic`.
- `provider_api_key`: _Optional_. If specified, use a non-default API key for calls to the specified VLM provider as needed. The default is none, which means to rely on using Unstructured's internal default API key for the VLM provider.
- `model`: _Optional_. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM. The default value is `claude-3-5-sonnet-20241022`.
- `model`: _Optional_. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM. The default value is `claude-sonnet-4-20250514`.

<DeprecatedModelsAPI />

- For `anthropic`, available values for `model` are:

- `claude-3-7-sonnet-20250219`
- `claude-sonnet-4-20250514`
- `claude-sonnet-4-5-20250929`

- For `openai`, available values for `model` are `gpt-4o` and `gpt-4o-mini`.
- For `anthropic`, available values for `model` are `claude-3-5-sonnet-20241022` and `claude-3-7-sonnet-20250219`.
- For `bedrock`, available values for `model` are:

- `us.amazon.nova-lite-v1:0`
- `us.amazon.nova-pro-v1:0`
- `us.anthropic.claude-3-opus-20240229-v1:0`
- `us.anthropic.claude-3-haiku-20240307-v1:0`
- `us.anthropic.claude-3-sonnet-20240229-v1:0`
- `us.anthropic.claude-3-5-sonnet-20241022-v2:0`
- `us.meta.llama3-2-11b-instruct-v1:0`
- `us.meta.llama3-2-90b-instruct-v1:0`
- `us.anthropic.claude-3-7-sonnet-20250219-v1:0`
- `us.anthropic.claude-sonnet-4-20250514-v1:0`

- For `openai`, available values for `model` are:

- `gpt-4o`
- `gpt-5-mini-2025-08-07`

- For `vertexai`, available values for `model` are:

- `gemini-2.0-flash-001`

- `output_format`: _Output_. The format of the response. Allowed values include `text/html` and `application/json`. The default is `text/html`.
- `format_html`: _Optional_. If the Auto partitioning strategy needs to use the VLM partitioning strategy, true (the default) to apply Beautiful Soup's `prettify` method to the HTML that is generated by the VLM partitioner, which for example adds indentation for better readability.
Expand Down Expand Up @@ -1142,22 +1158,36 @@ Fields for `settings` include:

Fields for `settings` include:

- `provider`: _Optional_. Use the specified VLM provider. Allowed values include `auto`, `openai`, `anthropic`, and `bedrock`. The default value is `anthropic`.
- `provider`: _Optional_. Use the specified VLM provider. Allowed values include `anthropic`, `auto`, `bedrock`, `openai`, and `vertexai`. The default value is `anthropic`.
- `provider_api_key`: _Optional_. If specified, use a non-default API key for calls to the specified VLM provider as needed. The default is none, which means to rely on using Unstructured's internal default API key for the VLM provider.
- `model`: _Optional_. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM. The default value is `claude-3-5-sonnet-20241022`.
- `model`: _Optional_. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified VLM. The default value is `claude-sonnet-4-20250514`.

<DeprecatedModelsAPI />

- For `anthropic`, available values for `model` are:

- `claude-3-7-sonnet-20250219`
- `claude-sonnet-4-20250514`
- `claude-sonnet-4-5-20250929`

- For `openai`, available values for `model` are `gpt-4o` and `gpt-4o-mini`.
- For `anthropic`, available values for `model` are `claude-3-5-sonnet-20241022` and `claude-3-7-sonnet-20250219`.
- For `bedrock`, available values for `model` are:

- `us.amazon.nova-lite-v1:0`
- `us.amazon.nova-pro-v1:0`
- `us.anthropic.claude-3-opus-20240229-v1:0`
- `us.anthropic.claude-3-haiku-20240307-v1:0`
- `us.anthropic.claude-3-sonnet-20240229-v1:0`
- `us.anthropic.claude-3-5-sonnet-20241022-v2:0`
- `us.meta.llama3-2-11b-instruct-v1:0`
- `us.meta.llama3-2-90b-instruct-v1:0`
- `us.anthropic.claude-3-7-sonnet-20250219-v1:0`
- `us.anthropic.claude-sonnet-4-20250514-v1:0`

- For `openai`, available values for `model` are:

- `gpt-4o`
- `gpt-5-mini-2025-08-07`

- For `vertexai`, available values for `model` are:

- `gemini-2.0-flash-001`

- `output_format`: _Output_. The format of the response. Allowed values include `text/html` and `application/json`. The default is `text/html`.
- `format_html`: _Optional_. True (the default) to apply Beautiful Soup's `prettify` method to the HTML that is generated by the VLM partitioner, which for example adds indentation for better readability.
Expand Down
13 changes: 13 additions & 0 deletions snippets/general-shared-text/deprecated-models-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<Warning>
The following models are no longer available as of the following dates:

- For `anthropic`, `claude-3-5-sonnet-20241022`: October 22, 2025
- For `bedrock`, `us.anthropic.claude-3-5-sonnet-20241022-v2:0`: October 22, 2025

Unstructured recommends the following actions:

- For new workflows, do not use any of these models.
- For any workflow that uses any of these models, update that workflow as soon as possible to use a different model.

Workflows that attempt to use any of these models on or after its associated date will return errors.
</Warning>
13 changes: 13 additions & 0 deletions snippets/general-shared-text/deprecated-models-ui.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<Warning>
The following models are no longer available as of the following dates:

- Amazon Bedrock Claude Sonnet 3.5: October 22, 2025
- Anthropic Claude Sonnet 3.5: October 22, 2025

Unstructured recommends the following actions:

- For new workflows, do not use any of these models.
- For any workflow that uses any of these models, update that workflow as soon as possible to use a different model.

Workflows that attempt to use any of these models on or after its associated date will return errors.
</Warning>
3 changes: 3 additions & 0 deletions ui/enriching/image-descriptions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Any embeddings that are produced after these summaries are generated will be bas
## Generate image descriptions

import EnrichmentImageSummaryHiResOnly from '/snippets/general-shared-text/enrichment-image-summary-hi-res-only.mdx';
import DeprecatedModelsUI from '/snippets/general-shared-text/deprecated-models-ui.mdx';

To generate image descriptions, in an **Enrichment** node in a workflow, select **Image**, and then choose one of the available provider (and model) combinations that are shown.

Expand All @@ -69,4 +70,6 @@ To generate image descriptions, in an **Enrichment** node in a workflow, select
**Chunker** node before an image descriptions **Enrichment** node could cause incomplete or no image descriptions to be generated.
</Note>

<DeprecatedModelsUI />

<EnrichmentImageSummaryHiResOnly />
4 changes: 4 additions & 0 deletions ui/enriching/ner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,16 @@ prompt that is used to run NER. To do this, see the next section.

# Generate a list of entities and their relationships

import DeprecatedModelsUI from '/snippets/general-shared-text/deprecated-models-ui.mdx';

To generate a list of recognized entities and their relationships, in an **Enrichment** node in a workflow, specify the following:

<Note>
You can change a workflow's NER settings only through [Custom](/ui/workflows#create-a-custom-workflow) workflow settings.
</Note>

<DeprecatedModelsUI />

1. Select **Text**.
2. For **Model**, select one of the available models that are shown.
3. The selected model will follow a default set of instructions (called a _prompt_) to perform NER using a set of predefined entity types and relationships. To experiment
Expand Down
5 changes: 3 additions & 2 deletions ui/enriching/table-descriptions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Any embeddings that are produced after these summaries are generated will be bas
## Generate table descriptions

import EnrichmentTableSummaryHiResOnly from '/snippets/general-shared-text/enrichment-table-summary-hi-res-only.mdx';
import DeprecatedModelsUI from '/snippets/general-shared-text/deprecated-models-ui.mdx';

To generate table descriptions, in an **Enrichment** node in a workflow, select **Table**, and then choose one of the available provider (and model) combinations that are shown.

Expand All @@ -82,9 +83,9 @@ displayed, be sure to select **Table Description**.
**Chunker** node before a table descriptions **Enrichment** node could cause incomplete or no table descriptions to be generated.
</Note>

<EnrichmentTableSummaryHiResOnly />

<DeprecatedModelsUI />

<EnrichmentTableSummaryHiResOnly />

## Learn more

Expand Down
3 changes: 3 additions & 0 deletions ui/enriching/table-to-html.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ For workflows that use [chunking](/ui/chunking), note the following changes:
## Generate table-to-HTML output

import EnrichmentTableToHTMLHiResOnly from '/snippets/general-shared-text/enrichment-table-to-html-hi-res-only.mdx';
import DeprecatedModelsUI from '/snippets/general-shared-text/deprecated-models-ui.mdx';

To generate table-to-HTML output, in an **Enrichment** node in a workflow, for **Model**, select **OpenAI (GPT-4o)**.

Expand All @@ -86,6 +87,8 @@ Make sure after you choose this provider and model, that **Table to HTML** is al
**Chunker** node before a table-to-HTML output **Enrichment** node could cause incomplete or no table-to-HTML output to be generated.
</Note>

<DeprecatedModelsUI />

<EnrichmentTableToHTMLHiResOnly />

## Learn more
Expand Down
4 changes: 2 additions & 2 deletions ui/walkthrough.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ more complex content such as complex tables, multilanguage characters, and handw

a. Click the close (**X**) button above the output on the right side of the screen.<br/>
b. In the workflow designer, click the **Partitioner** node and then, in the node's settings pane's **Details** tab, select **VLM**.<br/>
c. Under **Select VLM Model**, under **Anthropic**, select **Claude 3.5 Sonnet**.<br/>
c. Under **Select VLM Model**, under **Anthropic**, select **Claude Sonnet 4**.<br/>
d. Click **Test**.<br/>

<Tip>
Expand Down Expand Up @@ -243,7 +243,7 @@ more complex content such as complex tables, multilanguage characters, and handw

a. Click the close (**X**) button above the output on the right side of the screen.<br/>
b. In the workflow designer, click the **Partitioner** node and then, in the node's settings pane's **Details** tab, select **VLM**.<br/>
c. Under **Select VLM Model**, under **Anthropic**, select **Claude 3.5 Sonnet**.<br/>
c. Under **Select VLM Model**, under **Anthropic**, select **Claude Sonnet 4**.<br/>
d. Click **Test**.<br/>

12. Notice how the output changes, now that you are using the **VLM** strategy:
Expand Down
5 changes: 5 additions & 0 deletions ui/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ If you did not previously set the workflow to run on a schedule, you can [run th
#### Custom workflow node types

import PlatformPartitioningStrategies from '/snippets/general-shared-text/platform-partitioning-strategies.mdx';
import DeprecatedModelsUI from '/snippets/general-shared-text/deprecated-models-ui.mdx';

<AccordionGroup>
<Accordion title="Partitioner node">
Expand All @@ -244,6 +245,8 @@ import PlatformPartitioningStrategies from '/snippets/general-shared-text/platfo

For **VLM**, you must also choose a VLM provider and model from among the available choices that are shown.

<DeprecatedModelsUI />

<Note>
When you use the **VLM** strategy with embeddings for PDF files of 200 or more pages, you might notice some errors when
these files are processed. These errors typically occur when these larger PDF files have lots of tables and high-resolution images.
Expand Down Expand Up @@ -299,6 +302,8 @@ import PlatformPartitioningStrategies from '/snippets/general-shared-text/platfo
<Accordion title="Enrichment node">
Choose one of the following:

<DeprecatedModelsUI />

<EnrichmentImagesTablesHiResOnly />

- **Image** to summarize images. Also select one of the available provider (and model) combinations that are shown.
Expand Down