Skip to content

Commit 7a91546

Browse files
authored
Workflow Endpoint: Auto and VLM partitioner node example updates (#686)
1 parent 9f90775 commit 7a91546

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

api-reference/workflow/workflows.mdx

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1030,10 +1030,9 @@ A **Partitioner** node has a `type` of `partition`.
10301030
```python
10311031
auto_partitioner_workflow_node = WorkflowNode(
10321032
name="Partitioner",
1033-
subtype="unstructured_api",
1033+
subtype="vlm",
10341034
type="partition",
10351035
settings={
1036-
"strategy": "auto",
10371036
"provider": "<provider>",
10381037
"provider_api_key": None,
10391038
"model": "<model>",
@@ -1043,8 +1042,8 @@ A **Partitioner** node has a `type` of `partition`.
10431042
},
10441043
"format_html": <True|False>,
10451044
"unique_element_ids": <True|False>,
1046-
"is_dynamic": <True|False>,
1047-
"allow_fast": <True|False>
1045+
"is_dynamic": True,
1046+
"allow_fast": True
10481047
}
10491048
)
10501049
```
@@ -1053,10 +1052,9 @@ A **Partitioner** node has a `type` of `partition`.
10531052
```json
10541053
{
10551054
"name": "Partitioner",
1056-
"type": "partition",
1057-
"subtype": "unstructured_api",
1055+
"type": "vlm",
1056+
"subtype": "partition",
10581057
"settings": {
1059-
"strategy": "auto",
10601058
"provider": "<provider>",
10611059
"provider_api_key": null,
10621060
"model": "<model>",
@@ -1066,8 +1064,8 @@ A **Partitioner** node has a `type` of `partition`.
10661064
},
10671065
"format_html": <true|false>,
10681066
"unique_element_ids": <true|false>,
1069-
"is_dynamic": <true|false>,
1070-
"allow_fast": <true|false>
1067+
"is_dynamic": true,
1068+
"allow_fast": true
10711069
}
10721070
}
10731071
```
@@ -1098,8 +1096,8 @@ Fields for `settings` include:
10981096
- `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.
10991097
- `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.
11001098
- `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.
1101-
- `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.
1102-
- `allow_fast`: _Optional_. True (the default) to allow routing of pages to Fast as needed for better overall performance and cost savings.
1099+
- `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.
1100+
- `allow_fast`: _Required_. True to allow routing of pages to Fast as needed for better overall performance and cost savings.
11031101

11041102
#### VLM strategy
11051103

@@ -1120,8 +1118,8 @@ Fields for `settings` include:
11201118
},
11211119
"format_html": <True|False>,
11221120
"unique_element_ids": <True|False>,
1123-
"is_dynamic": <True|False>,
1124-
"allow_fast": <True|False>
1121+
"is_dynamic": False,
1122+
"allow_fast": True|False
11251123
}
11261124
)
11271125
```
@@ -1142,7 +1140,7 @@ Fields for `settings` include:
11421140
},
11431141
"format_html": <true|false>,
11441142
"unique_element_ids": <true|false>,
1145-
"is_dynamic": <true|false>,
1143+
"is_dynamic": false,
11461144
"allow_fast": <true|false>
11471145
}
11481146
}
@@ -1173,8 +1171,8 @@ Fields for `settings` include:
11731171
- `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.
11741172
- `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.
11751173
- `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.
1176-
- `is_dynamic`: _Optional_. This setting has no effect for the VLM strategy. The default is false.
1177-
- `allow_fast`: _Optional_. This setting has no effect for the VLM strategy. The default is true.
1174+
- `is_dynamic`: _Required_. False to use the VLM strategy.
1175+
- `allow_fast`: _Optional_. True (the default) to allow routing of pages to Fast as needed for better overall performance and cost savings.
11781176

11791177
#### High Res strategy
11801178

0 commit comments

Comments
 (0)