vellum-ai 0.14.48__py3-none-any.whl → 0.14.50__py3-none-any.whl

vellum_ee/workflows/display/tests/workflow_serialization/test_basic_tool_calling_node_serialization.py

@@ -0,0 +1,177 @@
+from deepdiff import DeepDiff
+
+from vellum_ee.workflows.display.workflows.get_vellum_workflow_display_class import get_workflow_display
+
+from tests.workflows.basic_tool_calling_node.workflow import BasicToolCallingNodeWorkflow
+
+
+def test_serialize_workflow():
+    # GIVEN a Workflow that uses a generic node
+    # WHEN we serialize it
+    workflow_display = get_workflow_display(workflow_class=BasicToolCallingNodeWorkflow)
+
+    serialized_workflow: dict = workflow_display.serialize()
+    # THEN we should get a serialized representation of the Workflow
+    assert serialized_workflow.keys() == {
+        "workflow_raw_data",
+        "input_variables",
+        "state_variables",
+        "output_variables",
+    }
+
+    # AND its input variables should be what we expect
+    input_variables = serialized_workflow["input_variables"]
+    assert len(input_variables) == 0
+
+    # AND its output variables should be what we expect
+    output_variables = serialized_workflow["output_variables"]
+    assert len(output_variables) == 2
+    assert not DeepDiff(
+        [
+            {"id": "8e7c0147-930d-4b7f-b6b1-6d79641cd3eb", "key": "text", "type": "STRING"},
+            {"id": "01a07e6d-7269-4f45-8b44-ef0227a2e88d", "key": "chat_history", "type": "CHAT_HISTORY"},
+        ],
+        output_variables,
+        ignore_order=True,
+    )
+
+    # AND its raw data should be what we expect
+    workflow_raw_data = serialized_workflow["workflow_raw_data"]
+    tool_calling_node = workflow_raw_data["nodes"][1]
+    assert tool_calling_node == {
+        "id": "21f29cac-da87-495f-bba1-093d423f4e46",
+        "label": "GetCurrentWeatherNode",
+        "type": "GENERIC",
+        "display_data": {
+            "position": {"x": 0.0, "y": 0.0},
+            "comment": {"value": "\n    A tool calling node that calls the get_current_weather function.\n    "},
+        },
+        "base": {
+            "name": "ToolCallingNode",
+            "module": ["vellum", "workflows", "nodes", "experimental", "tool_calling_node", "node"],
+        },
+        "definition": {
+            "name": "GetCurrentWeatherNode",
+            "module": ["tests", "workflows", "basic_tool_calling_node", "workflow"],
+        },
+        "trigger": {"id": "2414743b-b1dd-4552-8abf-9b7481df9762", "merge_behavior": "AWAIT_ATTRIBUTES"},
+        "ports": [{"id": "3cd6d78c-9dad-42aa-ad38-31f67057c379", "name": "default", "type": "DEFAULT"}],
+        "adornments": None,
+        "attributes": [
+            {
+                "id": "44420e39-966f-4c59-bdf8-6365a61c5d2a",
+                "name": "ml_model",
+                "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": "gpt-4o-mini"}},
+            },
+            {
+                "id": "669cfb4b-8c25-460e-8952-b63d91302cbc",
+                "name": "blocks",
+                "value": {
+                    "type": "CONSTANT_VALUE",
+                    "value": {
+                        "type": "JSON",
+                        "value": [
+                            {
+                                "block_type": "CHAT_MESSAGE",
+                                "state": None,
+                                "cache_config": None,
+                                "chat_role": "SYSTEM",
+                                "chat_source": None,
+                                "chat_message_unterminated": None,
+                                "blocks": [
+                                    {
+                                        "block_type": "RICH_TEXT",
+                                        "state": None,
+                                        "cache_config": None,
+                                        "blocks": [
+                                            {
+                                                "block_type": "PLAIN_TEXT",
+                                                "state": None,
+                                                "cache_config": None,
+                                                "text": "You are a weather expert",
+                                            }
+                                        ],
+                                    }
+                                ],
+                            },
+                            {
+                                "block_type": "CHAT_MESSAGE",
+                                "state": None,
+                                "cache_config": None,
+                                "chat_role": "USER",
+                                "chat_source": None,
+                                "chat_message_unterminated": None,
+                                "blocks": [
+                                    {
+                                        "block_type": "RICH_TEXT",
+                                        "state": None,
+                                        "cache_config": None,
+                                        "blocks": [
+                                            {
+                                                "block_type": "VARIABLE",
+                                                "state": None,
+                                                "cache_config": None,
+                                                "input_variable": "question",
+                                            }
+                                        ],
+                                    }
+                                ],
+                            },
+                        ],
+                    },
+                },
+            },
+            {
+                "id": "78324739-ff89-47a5-902b-10da0cb95c6d",
+                "name": "functions",
+                "value": {
+                    "type": "CONSTANT_VALUE",
+                    "value": {
+                        "type": "JSON",
+                        "value": [
+                            {
+                                "state": None,
+                                "cache_config": None,
+                                "name": "get_current_weather",
+                                "description": None,
+                                "parameters": {
+                                    "type": "object",
+                                    "properties": {"location": {"type": "string"}, "unit": {"type": "string"}},
+                                    "required": ["location", "unit"],
+                                },
+                                "forced": None,
+                                "strict": None,
+                            }
+                        ],
+                    },
+                },
+            },
+            {
+                "id": "0f6dc102-3460-4963-91fa-7ba85d65ef7a",
+                "name": "prompt_inputs",
+                "value": {
+                    "type": "CONSTANT_VALUE",
+                    "value": {"type": "JSON", "value": {"question": "What's the weather like in San Francisco?"}},
+                },
+            },
+            {
+                "id": "5c041b7d-732c-4773-a93a-32211f2af0b3",
+                "name": "max_tool_calls",
+                "value": {"type": "CONSTANT_VALUE", "value": {"type": "NUMBER", "value": 1.0}},
+            },
+        ],
+        "outputs": [
+            {
+                "id": "e62bc785-a914-4066-b79e-8c89a5d0ec6c",
+                "name": "text",
+                "type": "STRING",
+                "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": ""}},
+            },
+            {
+                "id": "4674f1d9-e3af-411f-8a55-40a3a3ab5394",
+                "name": "chat_history",
+                "type": "CHAT_HISTORY",
+                "value": {"type": "CONSTANT_VALUE", "value": {"type": "JSON", "value": []}},
+            },
+        ],
+    }

vellum_ee/workflows/display/utils/expressions.py

@@ -253,7 +253,7 @@ def serialize_value(display_context: "WorkflowDisplayContext", value: Any) -> Js
                 "type": "CONSTANT_VALUE",
                 "value": {
                     "type": "JSON",
-                    "items": constant_values,
+                    "value": constant_values,
                 },
             }
         else:
@@ -262,8 +262,27 @@ def serialize_value(display_context: "WorkflowDisplayContext", value: Any) -> Js
                 "items": cast(JsonArray, serialized_items),  # list[JsonObject] -> JsonArray
             }
 
-    if isinstance(value, dict) and any(isinstance(v, BaseDescriptor) for v in value.values()):
-        raise ValueError("Nested references are not supported.")
+    if isinstance(value, dict):
+        serialized_entries = [
+            {"key": key, "value": serialize_value(display_context, val)} for key, val in value.items()
+        ]
+
+        # Check if all entries have constant values
+        if all(entry["value"]["type"] == "CONSTANT_VALUE" for entry in serialized_entries):
+            constant_entries = {}
+            for entry in serialized_entries:
+                entry_value = entry["value"]["value"]
+                constant_entries[entry["key"]] = entry_value["value"]
+
+            return {
+                "type": "CONSTANT_VALUE",
+                "value": {
+                    "type": "JSON",
+                    "value": constant_entries,
+                },
+            }
+        else:
+            return {"type": "DICTIONARY_REFERENCE", "entries": cast(JsonArray, serialized_entries)}
 
     if not isinstance(value, BaseDescriptor):
         vellum_value = primitive_to_vellum_value(value)

vellum_ee/workflows/display/utils/vellum.py

@@ -1,5 +1,6 @@
 from typing import TYPE_CHECKING, Any, Literal, Optional, Union
 
+from vellum.client.core.api_error import ApiError
 from vellum.client.core.pydantic_utilities import UniversalBaseModel
 from vellum.client.types.array_vellum_value import ArrayVellumValue
 from vellum.client.types.vellum_value import VellumValue
@@ -117,13 +118,18 @@ def create_node_input_value_pointer_rule(
         workflow_input_display = display_context.global_workflow_input_displays[value]
         return InputVariablePointer(data=InputVariableData(input_variable_id=str(workflow_input_display.id)))
     if isinstance(value, VellumSecretReference):
-        workspace_secret = display_context.client.workspace_secrets.retrieve(
-            id=value.name,
-        )
+        try:
+            workspace_secret = display_context.client.workspace_secrets.retrieve(
+                id=value.name,
+            )
+            workspace_secret_id: Optional[str] = str(workspace_secret.id)
+        except ApiError:
+            workspace_secret_id = None
+
         return WorkspaceSecretPointer(
             data=WorkspaceSecretData(
                 type="STRING",
-                workspace_secret_id=str(workspace_secret.id),
+                workspace_secret_id=workspace_secret_id,
             ),
         )
     if isinstance(value, ExecutionCountReference):

vellum_ee/workflows/display/workflows/base_workflow_display.py

@@ -153,20 +153,8 @@ class BaseWorkflowDisplay(Generic[WorkflowType]):
             "definition": None,
         }
 
-        # Add all the nodes in the workflow
-        for node in self._workflow.get_nodes():
-            node_display = self.display_context.node_displays[node]
-
-            try:
-                serialized_node = node_display.serialize(self.display_context)
-            except NotImplementedError as e:
-                self.add_error(e)
-                continue
-
-            serialized_nodes[node_display.node_id] = serialized_node
-
-        # Add all unused nodes in the workflow
-        for node in self._workflow.get_unused_nodes():
+        # Add all the nodes in the workflows
+        for node in self._workflow.get_all_nodes():
             node_display = self.display_context.node_displays[node]
 
             try:
@@ -417,16 +405,7 @@ class BaseWorkflowDisplay(Generic[WorkflowType]):
 
         port_displays: PortDisplays = {}
 
-        for node in self._workflow.get_nodes():
-            self._enrich_node_displays(
-                node=node,
-                node_displays=node_displays,
-                global_node_displays=global_node_displays,
-                global_node_output_displays=global_node_output_displays,
-                port_displays=port_displays,
-            )
-
-        for node in self._workflow.get_unused_nodes():
+        for node in self._workflow.get_all_nodes():
             self._enrich_node_displays(
                 node=node,
                 node_displays=node_displays,

vellum_ee/workflows/display/workflows/tests/test_workflow_display.py

@@ -466,7 +466,7 @@ def test_serialize_workflow__array_values():
     assert "value" in array_output
     assert array_output["value"] == {
         "type": "CONSTANT_VALUE",
-        "value": {"type": "JSON", "items": ["item1", "item2", "item3"]},
+        "value": {"type": "JSON", "value": ["item1", "item2", "item3"]},
     }
 
     nested_array_outputs = [val for val in outputs if isinstance(val, dict) and val["name"] == "nested_array_value"]
@@ -477,7 +477,7 @@ def test_serialize_workflow__array_values():
     assert "value" in nested_array_output
     assert nested_array_output["value"] == {
         "type": "CONSTANT_VALUE",
-        "value": {"type": "JSON", "items": [["item1", "item2", "item3"], ["item4", "item5", "item6"]]},
+        "value": {"type": "JSON", "value": [["item1", "item2", "item3"], ["item4", "item5", "item6"]]},
     }
 
     mixed_array_outputs = [val for val in outputs if isinstance(val, dict) and val["name"] == "mixed_array_value"]
@@ -488,7 +488,7 @@ def test_serialize_workflow__array_values():
     assert "value" in mixed_array_output
     assert mixed_array_output["value"] == {
         "type": "CONSTANT_VALUE",
-        "value": {"type": "JSON", "items": [["item1"], "item2", "item3"]},
+        "value": {"type": "JSON", "value": [["item1"], "item2", "item3"]},
     }
 
 
@@ -587,3 +587,187 @@ def test_serialize_workflow__array_reference():
             },
         ],
     }
+
+
+def test_serialize_workflow__dict_values():
+    # GIVEN a node with a dictionary value
+    class MyNode(BaseNode):
+        class Outputs(BaseNode.Outputs):
+            dict_value = {"key1": "value1", "key2": "value2"}
+            nested_dict_value = {
+                "key1": {"nested_key1": "value1", "nested_key2": "value2"},
+                "key2": {"nested_key1": "value1", "nested_key2": "value2"},
+            }
+            mixed_dict_value = {"key1": "value1", "key2": {"key3": "value3", "key4": "value4"}}
+
+    # AND a workflow that uses these outputs
+    class MyWorkflow(BaseWorkflow):
+        graph = MyNode
+
+        class Outputs(BaseWorkflow.Outputs):
+            dict_output = MyNode.Outputs.dict_value
+
+    # WHEN we serialize it
+    workflow_display = get_workflow_display(workflow_class=MyWorkflow)
+    data = workflow_display.serialize()
+
+    # THEN it should serialize as a CONSTANT_VALUE
+    assert isinstance(data["workflow_raw_data"], dict)
+    assert isinstance(data["workflow_raw_data"]["nodes"], list)
+    my_node = next(
+        node for node in data["workflow_raw_data"]["nodes"] if isinstance(node, dict) and node["type"] == "GENERIC"
+    )
+
+    assert isinstance(my_node["outputs"], list)
+    outputs = my_node["outputs"]
+
+    dict_output = next(val for val in outputs if isinstance(val, dict) and val["name"] == "dict_value")
+    assert isinstance(dict_output, dict)
+    assert "value" in dict_output
+    assert dict_output["value"] == {
+        "type": "CONSTANT_VALUE",
+        "value": {"type": "JSON", "value": {"key1": "value1", "key2": "value2"}},
+    }
+
+    nested_dict_output = next(val for val in outputs if isinstance(val, dict) and val["name"] == "nested_dict_value")
+    assert isinstance(nested_dict_output, dict)
+    assert "value" in nested_dict_output
+    assert nested_dict_output["value"] == {
+        "type": "CONSTANT_VALUE",
+        "value": {
+            "type": "JSON",
+            "value": {
+                "key1": {"nested_key1": "value1", "nested_key2": "value2"},
+                "key2": {"nested_key1": "value1", "nested_key2": "value2"},
+            },
+        },
+    }
+
+    mixed_dict_output = next(val for val in outputs if isinstance(val, dict) and val["name"] == "mixed_dict_value")
+    assert isinstance(mixed_dict_output, dict)
+    assert "value" in mixed_dict_output
+    assert mixed_dict_output["value"] == {
+        "type": "CONSTANT_VALUE",
+        "value": {"type": "JSON", "value": {"key1": "value1", "key2": {"key3": "value3", "key4": "value4"}}},
+    }
+
+
+def test_serialize_workflow__dict_reference():
+    # GIVEN a node with a dictionary containing non-constant values (node references)
+    class FirstNode(BaseNode):
+        class Outputs(BaseNode.Outputs):
+            value1: str
+
+    class SecondNode(BaseNode):
+        class Outputs(BaseNode.Outputs):
+            # Dictionary containing a mix of constants and node references
+            mixed_dict = {
+                "key1": "constant1",
+                "key2": FirstNode.Outputs.value1,
+                "key3": "constant2",
+                "key4": FirstNode.Outputs.value1,
+            }
+            mixed_nested_dict = {
+                "key1": {"key1": "constant1", "key2": FirstNode.Outputs.value1},
+                "key2": {"key1": "constant2", "key2": FirstNode.Outputs.value1},
+            }
+
+    # AND a workflow that uses these outputs
+    class MyWorkflow(BaseWorkflow):
+        graph = FirstNode >> SecondNode
+
+        class Outputs(BaseWorkflow.Outputs):
+            mixed_dict_output = SecondNode.Outputs.mixed_dict
+            mixed_nested_dict_output = SecondNode.Outputs.mixed_nested_dict
+
+    # WHEN we serialize it
+    workflow_display = get_workflow_display(workflow_class=MyWorkflow)
+    data = workflow_display.serialize()
+
+    # THEN it should serialize as a CONSTANT_VALUE
+    assert isinstance(data["workflow_raw_data"], dict)
+    assert isinstance(data["workflow_raw_data"]["nodes"], list)
+    second_node = data["workflow_raw_data"]["nodes"][2]
+
+    assert isinstance(second_node, dict)
+    assert "outputs" in second_node
+    assert isinstance(second_node["outputs"], list)
+
+    outputs = second_node["outputs"]
+    mixed_dict_output = next(val for val in outputs if isinstance(val, dict) and val["name"] == "mixed_dict")
+    assert isinstance(mixed_dict_output, dict)
+    assert "value" in mixed_dict_output
+    assert mixed_dict_output["value"] == {
+        "type": "DICTIONARY_REFERENCE",
+        "entries": [
+            {"key": "key1", "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": "constant1"}}},
+            {
+                "key": "key2",
+                "value": {
+                    "type": "NODE_OUTPUT",
+                    "node_id": "13b4f5c0-e6aa-4ef9-9a1a-79476bc32500",
+                    "node_output_id": "50a6bc11-afb3-49f2-879c-b28f5e16d974",
+                },
+            },
+            {"key": "key3", "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": "constant2"}}},
+            {
+                "key": "key4",
+                "value": {
+                    "type": "NODE_OUTPUT",
+                    "node_id": "13b4f5c0-e6aa-4ef9-9a1a-79476bc32500",
+                    "node_output_id": "50a6bc11-afb3-49f2-879c-b28f5e16d974",
+                },
+            },
+        ],
+    }
+
+    mixed_nested_dict_output = next(
+        val for val in outputs if isinstance(val, dict) and val["name"] == "mixed_nested_dict"
+    )
+    assert isinstance(mixed_nested_dict_output, dict)
+    assert "value" in mixed_nested_dict_output
+    assert mixed_nested_dict_output["value"] == {
+        "type": "DICTIONARY_REFERENCE",
+        "entries": [
+            {
+                "key": "key1",
+                "value": {
+                    "type": "DICTIONARY_REFERENCE",
+                    "entries": [
+                        {
+                            "key": "key1",
+                            "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": "constant1"}},
+                        },
+                        {
+                            "key": "key2",
+                            "value": {
+                                "type": "NODE_OUTPUT",
+                                "node_id": "13b4f5c0-e6aa-4ef9-9a1a-79476bc32500",
+                                "node_output_id": "50a6bc11-afb3-49f2-879c-b28f5e16d974",
+                            },
+                        },
+                    ],
+                },
+            },
+            {
+                "key": "key2",
+                "value": {
+                    "type": "DICTIONARY_REFERENCE",
+                    "entries": [
+                        {
+                            "key": "key1",
+                            "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": "constant2"}},
+                        },
+                        {
+                            "key": "key2",
+                            "value": {
+                                "type": "NODE_OUTPUT",
+                                "node_id": "13b4f5c0-e6aa-4ef9-9a1a-79476bc32500",
+                                "node_output_id": "50a6bc11-afb3-49f2-879c-b28f5e16d974",
+                            },
+                        },
+                    ],
+                },
+            },
+        ],
+    }