From 59297cfb3ce3d05e4ac49830f92b36f4afab91bc Mon Sep 17 00:00:00 2001 From: Paul Cornell Date: Fri, 11 Jul 2025 11:07:07 -0700 Subject: [PATCH] Workflow Endpoint: Auto and VLM partitioner node example updates --- api-reference/workflow/workflows.mdx | 30 +++++++++++++--------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/api-reference/workflow/workflows.mdx b/api-reference/workflow/workflows.mdx index 6f8c63eb..b0d75ff4 100644 --- a/api-reference/workflow/workflows.mdx +++ b/api-reference/workflow/workflows.mdx @@ -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_api_key": None, "model": "", @@ -1043,8 +1042,8 @@ A **Partitioner** node has a `type` of `partition`. }, "format_html": , "unique_element_ids": , - "is_dynamic": , - "allow_fast": + "is_dynamic": True, + "allow_fast": True } ) ``` @@ -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_api_key": null, "model": "", @@ -1066,8 +1064,8 @@ A **Partitioner** node has a `type` of `partition`. }, "format_html": , "unique_element_ids": , - "is_dynamic": , - "allow_fast": + "is_dynamic": true, + "allow_fast": true } } ``` @@ -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 @@ -1120,8 +1118,8 @@ Fields for `settings` include: }, "format_html": , "unique_element_ids": , - "is_dynamic": , - "allow_fast": + "is_dynamic": False, + "allow_fast": True|False } ) ``` @@ -1142,7 +1140,7 @@ Fields for `settings` include: }, "format_html": , "unique_element_ids": , - "is_dynamic": , + "is_dynamic": false, "allow_fast": } } @@ -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