Skip to content

Workflow Endpoint: Auto and VLM partitioner node example updates #686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2025
Merged

Workflow Endpoint: Auto and VLM partitioner node example updates #686

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 14 additions & 16 deletions api-reference/workflow/workflows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1030,10 +1030,9 @@ A **Partitioner** node has a `type` of `partition`.
```python
auto_partitioner_workflow_node = WorkflowNode(
name="Partitioner",
subtype="unstructured_api",
subtype="vlm",
type="partition",
settings={
"strategy": "auto",
"provider": "<provider>",
"provider_api_key": None,
"model": "<model>",
Expand All @@ -1043,8 +1042,8 @@ A **Partitioner** node has a `type` of `partition`.
},
"format_html": <True|False>,
"unique_element_ids": <True|False>,
"is_dynamic": <True|False>,
"allow_fast": <True|False>
"is_dynamic": True,
"allow_fast": True
}
)
```
Expand All @@ -1053,10 +1052,9 @@ A **Partitioner** node has a `type` of `partition`.
```json
{
"name": "Partitioner",
"type": "partition",
"subtype": "unstructured_api",
"type": "vlm",
"subtype": "partition",
"settings": {
"strategy": "auto",
"provider": "<provider>",
"provider_api_key": null,
"model": "<model>",
Expand All @@ -1066,8 +1064,8 @@ A **Partitioner** node has a `type` of `partition`.
},
"format_html": <true|false>,
"unique_element_ids": <true|false>,
"is_dynamic": <true|false>,
"allow_fast": <true|false>
"is_dynamic": true,
"allow_fast": true
}
}
```
Expand Down Expand Up @@ -1098,8 +1096,8 @@ Fields for `settings` include:
- `prompt.text`: _Optional_. If the Auto partitioning strategy needs to use the VLM partitioning strategy, then use the specified prompt when calling the specified VLM. The default value is none, which means to rely on using Unstructured's internal default prompt when calling the VLM.
- `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.
- `unique_element_ids`: _Optional_. True (the default) to assign UUIDs to element IDs, which guarantees their uniqueness. This is useful for example when using them as primary keys in a database. False to assign a SHA-256 of the element's text as its element ID.
- `is_dynamic`: _Optional_. True (the default) to enable dynamic routing of pages to Fast, High Res, or VLM as needed for better overall performance and cost savings.
- `allow_fast`: _Optional_. True (the default) to allow routing of pages to Fast as needed for better overall performance and cost savings.
- `is_dynamic`: _Required_. True to enable dynamic routing of pages to Fast, High Res, or VLM as needed for better overall performance and cost savings.
- `allow_fast`: _Required_. True to allow routing of pages to Fast as needed for better overall performance and cost savings.

#### VLM strategy

Expand All @@ -1120,8 +1118,8 @@ Fields for `settings` include:
},
"format_html": <True|False>,
"unique_element_ids": <True|False>,
"is_dynamic": <True|False>,
"allow_fast": <True|False>
"is_dynamic": False,
"allow_fast": True|False
}
)
```
Expand All @@ -1142,7 +1140,7 @@ Fields for `settings` include:
},
"format_html": <true|false>,
"unique_element_ids": <true|false>,
"is_dynamic": <true|false>,
"is_dynamic": false,
"allow_fast": <true|false>
}
}
Expand Down Expand Up @@ -1173,8 +1171,8 @@ Fields for `settings` include:
- `prompt.text`: _Optional_. Use the specified prompt when calling the specified VLM. The default value is none, which means to rely on using Unstructured's internal default prompt when calling the VLM.
- `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.
- `unique_element_ids`: _Optional_. True (the default) to assign UUIDs to element IDs, which guarantees their uniqueness. This is useful for example when using them as primary keys in a database. False to assign a SHA-256 of the element's text as its element ID.
- `is_dynamic`: _Optional_. This setting has no effect for the VLM strategy. The default is false.
- `allow_fast`: _Optional_. This setting has no effect for the VLM strategy. The default is true.
- `is_dynamic`: _Required_. False to use the VLM strategy.
- `allow_fast`: _Optional_. True (the default) to allow routing of pages to Fast as needed for better overall performance and cost savings.

#### High Res strategy

Expand Down