Skip to content

Commit 159cef9

Browse files
authored
fix: Remove WorkflowNodeType enum from Python SDK usage (#602)
1 parent cdafe96 commit 159cef9

File tree

2 files changed

+21
-29
lines changed

2 files changed

+21
-29
lines changed

api-reference/workflow/overview.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1557,7 +1557,6 @@ specify the settings for the workflow. For the specific settings to include, see
15571557
from unstructured_client.models.operations import CreateWorkflowRequest
15581558
from unstructured_client.models.shared import (
15591559
WorkflowNode,
1560-
WorkflowNodeType,
15611560
CreateWorkflow,
15621561
WorkflowType,
15631562
Schedule
@@ -1608,7 +1607,6 @@ specify the settings for the workflow. For the specific settings to include, see
16081607
from unstructured_client.models.operations import CreateWorkflowRequest
16091608
from unstructured_client.models.shared import (
16101609
WorkflowNode,
1611-
WorkflowNodeType,
16121610
CreateWorkflow,
16131611
WorkflowType,
16141612
Schedule
@@ -1856,7 +1854,6 @@ the request body (for `curl` or Postman), specify the settings for the workflow.
18561854
from unstructured_client.models.operations import UpdateWorkflowRequest
18571855
from unstructured_client.models.shared import (
18581856
WorkflowNode,
1859-
WorkflowNodeType,
18601857
UpdateWorkflow,
18611858
WorkflowType,
18621859
Schedule
@@ -1908,7 +1905,6 @@ the request body (for `curl` or Postman), specify the settings for the workflow.
19081905
from unstructured_client.models.operations import UpdateWorkflowRequest
19091906
from unstructured_client.models.shared import (
19101907
WorkflowNode,
1911-
WorkflowNodeType,
19121908
UpdateWorkflow,
19131909
WorkflowType,
19141910
Schedule

api-reference/workflow/workflows.mdx

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ specify the settings for the workflow, as follows:
3737
from unstructured_client import UnstructuredClient
3838
from unstructured_client.models.shared import (
3939
WorkflowNode,
40-
WorkflowNodeType,
4140
CreateWorkflow,
4241
WorkflowType,
4342
Schedule
@@ -51,17 +50,17 @@ specify the settings for the workflow, as follows:
5150

5251
workflow_node = WorkflowNode(
5352
name="<node-name>",
53+
type="<node-type>",
5454
subtype="<node-subtype>",
55-
type=WorkflowNodeType.<NODE-TYPE>,
5655
settings={
5756
"...": "..."
5857
}
5958
)
6059

6160
another_workflow_node = WorkflowNode(
6261
name="<node-name>",
62+
type="<node-type>",
6363
subtype="<node-subtype>",
64-
type=WorkflowNodeType.<NODE-TYPE>,
6564
settings={
6665
"...": "..."
6766
}
@@ -118,7 +117,6 @@ specify the settings for the workflow, as follows:
118117
from unstructured_client import UnstructuredClient
119118
from unstructured_client.models.shared import (
120119
WorkflowNode,
121-
WorkflowNodeType,
122120
CreateWorkflow,
123121
WorkflowType,
124122
Schedule
@@ -132,17 +130,17 @@ specify the settings for the workflow, as follows:
132130

133131
workflow_node = WorkflowNode(
134132
name="<node-name>",
133+
type="<node-type>",
135134
subtype="<node-subtype>",
136-
type=WorkflowNodeType.<NODE-TYPE>,
137135
settings={
138136
"...": "..."
139137
}
140138
)
141139

142140
another_workflow_node = WorkflowNode(
143141
name="<node-name>",
142+
type="<node-type>",
144143
subtype="<node-subtype>",
145-
type=WorkflowNodeType.<NODE-TYPE>,
146144
settings={
147145
"...": "..."
148146
}
@@ -396,7 +394,6 @@ In the request body, specify the settings for the workflow. For the specific set
396394
from unstructured_client import UnstructuredClient
397395
from unstructured_client.models.shared import (
398396
WorkflowNode,
399-
WorkflowNodeType,
400397
UpdateWorkflow,
401398
WorkflowType,
402399
Schedule,
@@ -459,7 +456,6 @@ In the request body, specify the settings for the workflow. For the specific set
459456
from unstructured_client import UnstructuredClient
460457
from unstructured_client.models.shared import (
461458
WorkflowNode,
462-
WorkflowNodeType,
463459
UpdateWorkflow,
464460
WorkflowType,
465461
Schedule,
@@ -585,7 +581,7 @@ flowchart LR
585581

586582
### Partitioner node
587583

588-
A **Partitioner** node has a `type` of `WorkflowNodeType.PARTITION` (for the Python SDK) or `partition` (for `curl` and Postman).
584+
A **Partitioner** node has a `type` of `partition`.
589585

590586
[Learn about the available partitioning strategies](/ui/partitioning).
591587

@@ -597,7 +593,7 @@ A **Partitioner** node has a `type` of `WorkflowNodeType.PARTITION` (for the Pyt
597593
auto_partitioner_workflow_node = WorkflowNode(
598594
name="Partitioner",
599595
subtype="vlm",
600-
type=WorkflowNodeType.PARTITION,
596+
type="partition",
601597
settings={
602598
"provider": "anthropic",
603599
"model": "claude-3-5-sonnet-20241022",
@@ -640,7 +636,7 @@ A **Partitioner** node has a `type` of `WorkflowNodeType.PARTITION` (for the Pyt
640636
vlm_partitioner_workflow_node = WorkflowNode(
641637
name="Partitioner",
642638
subtype="vlm",
643-
type=WorkflowNodeType.PARTITION,
639+
type="partition",
644640
settings={
645641
"provider": "<provider>",
646642
"model": "<model>",
@@ -704,7 +700,7 @@ Allowed values for `provider` and `model` include:
704700
high_res_paritioner_workflow_node = WorkflowNode(
705701
name="Partitioner",
706702
subtype="unstructured_api",
707-
type=WorkflowNodeType.PARTITION,
703+
type="partition",
708704
settings={
709705
"strategy": "hi_res",
710706
"include_page_breaks": <True|False>,
@@ -765,7 +761,7 @@ Allowed values for `provider` and `model` include:
765761
fast_partitioner_workflow_node = WorkflowNode(
766762
name="Partitioner",
767763
subtype="unstructured_api",
768-
type=WorkflowNodeType.PARTITION,
764+
type="partition",
769765
settings={
770766
"strategy": "fast",
771767
"include_page_breaks": <True|False>,
@@ -820,7 +816,7 @@ Allowed values for `provider` and `model` include:
820816

821817
### Chunker node
822818

823-
A **Chunker** node has a `type` of `WorkflowNodeType.CHUNK` (for the Python SDK) or `chunk` (for `curl` and Postman).
819+
A **Chunker** node has a `type` of `chunk`.
824820

825821
[Learn about the available chunking strategies](/ui/chunking).
826822

@@ -832,7 +828,7 @@ A **Chunker** node has a `type` of `WorkflowNodeType.CHUNK` (for the Python SDK)
832828
chunk_by_character_chunker_workflow_node = WorkflowNode(
833829
name="Chunker",
834830
subtype="chunk_by_character",
835-
type=WorkflowNodeType.CHUNK,
831+
type="chunk",
836832
settings={
837833
"include_orig_elements": <True|False>,
838834
"new_after_n_chars": <new-after-n-chars>,
@@ -871,7 +867,7 @@ A **Chunker** node has a `type` of `WorkflowNodeType.CHUNK` (for the Python SDK)
871867
chunk_by_title_chunker_workflow_node = WorkflowNode(
872868
name="Chunker",
873869
subtype="chunk_by_title",
874-
type=WorkflowNodeType.CHUNK,
870+
type="chunk",
875871
settings={
876872
"multipage_sections": <True|False>,
877873
"combine_text_under_n_chars": <combine-text-under-n-chars>,
@@ -914,7 +910,7 @@ A **Chunker** node has a `type` of `WorkflowNodeType.CHUNK` (for the Python SDK)
914910
chunk_by_page_chunker_workflow_node = WorkflowNode(
915911
name="Chunker",
916912
subtype="chunk_by_page",
917-
type=WorkflowNodeType.CHUNK,
913+
type="chunk",
918914
settings={
919915
"include_orig_elements": <True|False>,
920916
"new_after_n_chars": <new-after-n-chars>,
@@ -953,7 +949,7 @@ A **Chunker** node has a `type` of `WorkflowNodeType.CHUNK` (for the Python SDK)
953949
chunk_by_similarity_chunker_workflow_node = WorkflowNode(
954950
name="Chunker",
955951
subtype="chunk_by_similarity",
956-
type=WorkflowNodeType.CHUNK,
952+
type="chunk",
957953
settings={
958954
"include_orig_elements": <True|False>,
959955
"new_after_n_chars": <True|False>,
@@ -988,7 +984,7 @@ A **Chunker** node has a `type` of `WorkflowNodeType.CHUNK` (for the Python SDK)
988984

989985
### Enrichment node
990986

991-
An **Enrichment** node has a `type` of `WorkflowNodeType.PROMPTER` (for the Python SDK) or `prompter` (for `curl` and Postman).
987+
An **Enrichment** node has a `type` of `prompter`.
992988

993989
[Learn about the available enrichments](/ui/enriching/overview).
994990

@@ -1000,7 +996,7 @@ An **Enrichment** node has a `type` of `WorkflowNodeType.PROMPTER` (for the Pyth
1000996
image_description_enrichment_workflow_node = WorkflowNode(
1001997
name="Enrichment",
1002998
subtype="<subtype>",
1003-
type=WorkflowNodeType.PROMPTER,
999+
type="prompter",
10041000
settings={}
10051001
)
10061002
```
@@ -1032,7 +1028,7 @@ Allowed values for `<subtype>` include:
10321028
table_description_enrichment_workflow_node = WorkflowNode(
10331029
name="Enrichment",
10341030
subtype="<subtype>",
1035-
type=WorkflowNodeType.PROMPTER,
1031+
type="prompter",
10361032
settings={}
10371033
)
10381034
```
@@ -1064,7 +1060,7 @@ Allowed values for `<subtype>` include:
10641060
table_to_html_enrichment_workflow_node = WorkflowNode(
10651061
name="Enrichment",
10661062
subtype="openai_table2html",
1067-
type=WorkflowNodeType.PROMPTER,
1063+
type="prompter",
10681064
settings={}
10691065
)
10701066
```
@@ -1089,7 +1085,7 @@ Allowed values for `<subtype>` include:
10891085
ner_enrichment_workflow_node = WorkflowNode(
10901086
name="Enrichment",
10911087
subtype="openai_ner",
1092-
type=WorkflowNodeType.PROMPTER,
1088+
type="prompter",
10931089
settings={
10941090
"prompt_interface_overrides": {
10951091
"prompt": {
@@ -1120,7 +1116,7 @@ Allowed values for `<subtype>` include:
11201116

11211117
### Embedder node
11221118

1123-
An **Embedder** node has a `type` of `WorkflowNodeType.EMBED` (for the Python SDK) or `embed` (for `curl` and Postman).
1119+
An **Embedder** node has a `type` of `embed`.
11241120

11251121
[Learn about the available embedding providers and models](/ui/embedding).
11261122

@@ -1130,7 +1126,7 @@ An **Embedder** node has a `type` of `WorkflowNodeType.EMBED` (for the Python SD
11301126
embedder_workflow_node = WorkflowNode(
11311127
name="Embedder",
11321128
subtype="<subtype>",
1133-
type=WorkflowNodeType.EMBED,
1129+
type="embed",
11341130
settings={
11351131
"model_name": "<model-name>"
11361132
}

0 commit comments

Comments
 (0)