vellum-ai 1.11.2__py3-none-any.whl → 1.13.5__py3-none-any.whl

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

@@ -41,273 +41,144 @@ def test_serialize_workflow():
     function_attributes = next(
         attribute for attribute in tool_calling_node["attributes"] if attribute["name"] == "functions"
     )
-    assert function_attributes == {
-        "id": "102d8447-5232-4e96-8192-9b1ca0f02650",
-        "name": "functions",
-        "value": {
-            "type": "CONSTANT_VALUE",
+    assert function_attributes["id"] == "102d8447-5232-4e96-8192-9b1ca0f02650"
+    assert function_attributes["name"] == "functions"
+    assert function_attributes["value"]["type"] == "CONSTANT_VALUE"
+    assert function_attributes["value"]["value"]["type"] == "JSON"
+    inline_workflow_tool = function_attributes["value"]["value"]["value"][0]
+    assert inline_workflow_tool["type"] == "INLINE_WORKFLOW"
+    assert inline_workflow_tool["name"] == "BasicInlineSubworkflowWorkflow"
+    assert (
+        inline_workflow_tool["description"] == "\n    A workflow that gets the weather for a given city and date.\n    "
+    )
+    assert inline_workflow_tool["exec_config"]["input_variables"] == [
+        {
+            "id": "fa73da37-34c3-47a9-be58-69cc6cdbfca5",
+            "key": "city",
+            "type": "STRING",
+            "default": None,
+            "required": True,
+            "extensions": {"color": None},
+            "schema": {"type": "string"},
+        },
+        {
+            "id": "aba1e6e0-dfa7-4c15-a4e6-aec6feebfaca",
+            "key": "date",
+            "type": "STRING",
+            "default": None,
+            "required": True,
+            "extensions": {"color": None},
+            "schema": {"type": "string"},
+        },
+    ]
+    assert inline_workflow_tool["exec_config"]["output_variables"] == [
+        {
+            "id": "99afb757-2782-465d-ab55-80ccf50552b9",
+            "key": "temperature",
+            "type": "NUMBER",
+        },
+        {
+            "id": "7444a019-081a-4e10-a528-3249299159f7",
+            "key": "reasoning",
+            "type": "STRING",
+        },
+    ]
+    assert inline_workflow_tool["exec_config"]["state_variables"] == []
+    inline_workflow_data = inline_workflow_tool["exec_config"]["workflow_raw_data"]
+    assert inline_workflow_data["display_data"] == {"viewport": {"x": 0.0, "y": 0.0, "zoom": 1.0}}
+    assert inline_workflow_data["definition"] == {
+        "name": "BasicInlineSubworkflowWorkflow",
+        "module": [
+            "tests",
+            "workflows",
+            "basic_tool_calling_node_inline_workflow",
+            "workflow",
+        ],
+    }
+    assert inline_workflow_data["output_values"] == [
+        {
+            "output_variable_id": "99afb757-2782-465d-ab55-80ccf50552b9",
             "value": {
-                "type": "JSON",
-                "value": [
-                    {
-                        "type": "INLINE_WORKFLOW",
-                        "name": "BasicInlineSubworkflowWorkflow",
-                        "description": "\n    A workflow that gets the weather for a given city and date.\n    ",  # noqa: E501
-                        "exec_config": {
-                            "workflow_raw_data": {
-                                "nodes": [
-                                    {
-                                        "id": "6358dcfe-b162-4e19-99ca-401d1ada9bdc",
-                                        "type": "ENTRYPOINT",
-                                        "inputs": [],
-                                        "data": {
-                                            "label": "Entrypoint Node",
-                                            "source_handle_id": "c344fdee-282b-40c9-8c97-6dd08830948c",
-                                        },
-                                        "display_data": {"position": {"x": 0.0, "y": -50.0}},
-                                        "base": None,
-                                        "definition": None,
-                                    },
-                                    {
-                                        "id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
-                                        "label": "Start Node",
-                                        "type": "GENERIC",
-                                        "should_file_merge": True,
-                                        "display_data": {"position": {"x": 200.0, "y": -50.0}},
-                                        "base": {
-                                            "name": "BaseNode",
-                                            "module": ["vellum", "workflows", "nodes", "bases", "base"],
-                                        },
-                                        "definition": {
-                                            "name": "StartNode",
-                                            "module": [
-                                                "tests",
-                                                "workflows",
-                                                "basic_tool_calling_node_inline_workflow",
-                                                "workflow",
-                                            ],
-                                        },
-                                        "trigger": {
-                                            "id": "8a7854a7-a595-44ce-8197-1f9cd2c78f10",
-                                            "merge_behavior": "AWAIT_ATTRIBUTES",
-                                        },
-                                        "ports": [
-                                            {
-                                                "id": "ee444f1a-b126-4480-8eb2-d22506640763",
-                                                "name": "default",
-                                                "type": "DEFAULT",
-                                            }
-                                        ],
-                                        "adornments": None,
-                                        "attributes": [
-                                            {
-                                                "id": "b5e2d415-4368-43c1-826c-ff6511bf6942",
-                                                "name": "city",
-                                                "value": {
-                                                    "type": "WORKFLOW_INPUT",
-                                                    "input_variable_id": "fa73da37-34c3-47a9-be58-69cc6cdbfca5",
-                                                },
-                                            },
-                                            {
-                                                "id": "5b3ed6d0-8cd6-41b6-ad55-d380b41f943b",
-                                                "name": "date",
-                                                "value": {
-                                                    "type": "WORKFLOW_INPUT",
-                                                    "input_variable_id": "aba1e6e0-dfa7-4c15-a4e6-aec6feebfaca",
-                                                },
-                                            },
-                                        ],
-                                        "outputs": [
-                                            {
-                                                "id": "272eccdb-6903-4f32-8159-8bfb87c65c2e",
-                                                "name": "temperature",
-                                                "type": "NUMBER",
-                                                "value": None,
-                                            },
-                                            {
-                                                "id": "8616509d-fecb-4bbf-afdc-bd4c5de35ce7",
-                                                "name": "reasoning",
-                                                "type": "STRING",
-                                                "value": None,
-                                            },
-                                        ],
-                                    },
-                                    {
-                                        "id": "0779b232-82ab-4dbe-a340-6a85e6ab3368",
-                                        "type": "TERMINAL",
-                                        "data": {
-                                            "label": "Final Output",
-                                            "name": "temperature",
-                                            "target_handle_id": "9e077063-c394-4c7b-b0c6-e6686df67984",
-                                            "output_id": "99afb757-2782-465d-ab55-80ccf50552b9",
-                                            "output_type": "NUMBER",
-                                            "node_input_id": "7761c5e1-cc2e-43ab-bfd2-f66c3d47b3b9",
-                                        },
-                                        "inputs": [
-                                            {
-                                                "id": "7761c5e1-cc2e-43ab-bfd2-f66c3d47b3b9",
-                                                "key": "node_input",
-                                                "value": {
-                                                    "rules": [
-                                                        {
-                                                            "type": "NODE_OUTPUT",
-                                                            "data": {
-                                                                "node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",  # noqa: E501
-                                                                "output_id": "272eccdb-6903-4f32-8159-8bfb87c65c2e",  # noqa: E501
-                                                            },
-                                                        }
-                                                    ],
-                                                    "combinator": "OR",
-                                                },
-                                            }
-                                        ],
-                                        "display_data": {"position": {"x": 400.0, "y": -175.0}},
-                                        "base": {
-                                            "name": "FinalOutputNode",
-                                            "module": [
-                                                "vellum",
-                                                "workflows",
-                                                "nodes",
-                                                "displayable",
-                                                "final_output_node",
-                                                "node",
-                                            ],
-                                        },
-                                        "definition": None,
-                                    },
-                                    {
-                                        "id": "31b74695-3f1c-47cf-8be8-a4d86cc589e8",
-                                        "type": "TERMINAL",
-                                        "data": {
-                                            "label": "Final Output",
-                                            "name": "reasoning",
-                                            "target_handle_id": "8b525943-6c27-414b-a329-e29c0b217f72",
-                                            "output_id": "7444a019-081a-4e10-a528-3249299159f7",
-                                            "output_type": "STRING",
-                                            "node_input_id": "c1833b54-95b6-4365-8e57-51b09c8e2606",
-                                        },
-                                        "inputs": [
-                                            {
-                                                "id": "c1833b54-95b6-4365-8e57-51b09c8e2606",
-                                                "key": "node_input",
-                                                "value": {
-                                                    "rules": [
-                                                        {
-                                                            "type": "NODE_OUTPUT",
-                                                            "data": {
-                                                                "node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",  # noqa: E501
-                                                                "output_id": "8616509d-fecb-4bbf-afdc-bd4c5de35ce7",  # noqa: E501
-                                                            },
-                                                        }
-                                                    ],
-                                                    "combinator": "OR",
-                                                },
-                                            }
-                                        ],
-                                        "display_data": {"position": {"x": 400.0, "y": 75.0}},
-                                        "base": {
-                                            "name": "FinalOutputNode",
-                                            "module": [
-                                                "vellum",
-                                                "workflows",
-                                                "nodes",
-                                                "displayable",
-                                                "final_output_node",
-                                                "node",
-                                            ],
-                                        },
-                                        "definition": None,
-                                    },
-                                ],
-                                "edges": [
-                                    {
-                                        "id": "1c333b1c-a1b7-437e-9dfc-bdca8db2cff5",
-                                        "source_node_id": "6358dcfe-b162-4e19-99ca-401d1ada9bdc",
-                                        "source_handle_id": "c344fdee-282b-40c9-8c97-6dd08830948c",
-                                        "target_node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
-                                        "target_handle_id": "8a7854a7-a595-44ce-8197-1f9cd2c78f10",
-                                        "type": "DEFAULT",
-                                    },
-                                    {
-                                        "id": "3c5d8990-48f5-42e1-893e-bc8308d2110a",
-                                        "source_node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
-                                        "source_handle_id": "ee444f1a-b126-4480-8eb2-d22506640763",
-                                        "target_node_id": "0779b232-82ab-4dbe-a340-6a85e6ab3368",
-                                        "target_handle_id": "9e077063-c394-4c7b-b0c6-e6686df67984",
-                                        "type": "DEFAULT",
-                                    },
-                                    {
-                                        "id": "de0b8090-a26e-4e09-9173-9f7400a5be4c",
-                                        "source_node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
-                                        "source_handle_id": "ee444f1a-b126-4480-8eb2-d22506640763",
-                                        "target_node_id": "31b74695-3f1c-47cf-8be8-a4d86cc589e8",
-                                        "target_handle_id": "8b525943-6c27-414b-a329-e29c0b217f72",
-                                        "type": "DEFAULT",
-                                    },
-                                ],
-                                "display_data": {"viewport": {"x": 0.0, "y": 0.0, "zoom": 1.0}},
-                                "definition": {
-                                    "name": "BasicInlineSubworkflowWorkflow",
-                                    "module": [
-                                        "tests",
-                                        "workflows",
-                                        "basic_tool_calling_node_inline_workflow",
-                                        "workflow",
-                                    ],
-                                },
-                                "output_values": [
-                                    {
-                                        "output_variable_id": "99afb757-2782-465d-ab55-80ccf50552b9",
-                                        "value": {
-                                            "type": "NODE_OUTPUT",
-                                            "node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
-                                            "node_output_id": "272eccdb-6903-4f32-8159-8bfb87c65c2e",
-                                        },
-                                    },
-                                    {
-                                        "output_variable_id": "7444a019-081a-4e10-a528-3249299159f7",
-                                        "value": {
-                                            "type": "NODE_OUTPUT",
-                                            "node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
-                                            "node_output_id": "8616509d-fecb-4bbf-afdc-bd4c5de35ce7",
-                                        },
-                                    },
-                                ],
-                            },
-                            "input_variables": [
-                                {
-                                    "id": "fa73da37-34c3-47a9-be58-69cc6cdbfca5",
-                                    "key": "city",
-                                    "type": "STRING",
-                                    "default": None,
-                                    "required": True,
-                                    "extensions": {"color": None},
-                                },
-                                {
-                                    "id": "aba1e6e0-dfa7-4c15-a4e6-aec6feebfaca",
-                                    "key": "date",
-                                    "type": "STRING",
-                                    "default": None,
-                                    "required": True,
-                                    "extensions": {"color": None},
-                                },
-                            ],
-                            "state_variables": [],
-                            "output_variables": [
-                                {
-                                    "id": "99afb757-2782-465d-ab55-80ccf50552b9",
-                                    "key": "temperature",
-                                    "type": "NUMBER",
-                                },
-                                {
-                                    "id": "7444a019-081a-4e10-a528-3249299159f7",
-                                    "key": "reasoning",
-                                    "type": "STRING",
-                                },
-                            ],
-                        },
-                    }
-                ],
+                "type": "NODE_OUTPUT",
+                "node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
+                "node_output_id": "272eccdb-6903-4f32-8159-8bfb87c65c2e",
             },
         },
+        {
+            "output_variable_id": "7444a019-081a-4e10-a528-3249299159f7",
+            "value": {
+                "type": "NODE_OUTPUT",
+                "node_id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
+                "node_output_id": "8616509d-fecb-4bbf-afdc-bd4c5de35ce7",
+            },
+        },
+    ]
+    inner_start_node = next(
+        node for node in inline_workflow_data["nodes"] if node["type"] == "GENERIC" and node["label"] == "Start Node"
+    )
+    assert inner_start_node == {
+        "id": "07a83d1a-7948-4a23-9f46-9a60382d3a48",
+        "label": "Start Node",
+        "type": "GENERIC",
+        "should_file_merge": True,
+        "display_data": {"position": {"x": 200.0, "y": -50.0}},
+        "base": {
+            "name": "BaseNode",
+            "module": ["vellum", "workflows", "nodes", "bases", "base"],
+        },
+        "definition": {
+            "name": "StartNode",
+            "module": [
+                "tests",
+                "workflows",
+                "basic_tool_calling_node_inline_workflow",
+                "workflow",
+            ],
+        },
+        "trigger": {
+            "id": "8a7854a7-a595-44ce-8197-1f9cd2c78f10",
+            "merge_behavior": "AWAIT_ATTRIBUTES",
+        },
+        "ports": [
+            {
+                "id": "ee444f1a-b126-4480-8eb2-d22506640763",
+                "name": "default",
+                "type": "DEFAULT",
+            }
+        ],
+        "adornments": None,
+        "attributes": [
+            {
+                "id": "b5e2d415-4368-43c1-826c-ff6511bf6942",
+                "name": "city",
+                "value": {
+                    "type": "WORKFLOW_INPUT",
+                    "input_variable_id": "fa73da37-34c3-47a9-be58-69cc6cdbfca5",
+                },
+            },
+            {
+                "id": "5b3ed6d0-8cd6-41b6-ad55-d380b41f943b",
+                "name": "date",
+                "value": {
+                    "type": "WORKFLOW_INPUT",
+                    "input_variable_id": "aba1e6e0-dfa7-4c15-a4e6-aec6feebfaca",
+                },
+            },
+        ],
+        "outputs": [
+            {
+                "id": "272eccdb-6903-4f32-8159-8bfb87c65c2e",
+                "name": "temperature",
+                "type": "NUMBER",
+                "value": None,
+                "schema": {"type": "number"},
+            },
+            {
+                "id": "8616509d-fecb-4bbf-afdc-bd4c5de35ce7",
+                "name": "reasoning",
+                "type": "STRING",
+                "value": None,
+                "schema": {"type": "string"},
+            },
+        ],
     }

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

@@ -0,0 +1,84 @@
+from vellum_ee.workflows.display.workflows.get_vellum_workflow_display_class import get_workflow_display
+
+from tests.workflows.basic_tool_calling_node_inline_workflow_tool_wrapper.workflow import (
+    BasicToolCallingNodeInlineWorkflowToolWrapperWorkflow,
+)
+
+
+def test_serialize_workflow__inline_workflow_with_tool_wrapper():
+    """
+    Tests that an inline workflow with tool wrapper serializes correctly with definition containing inputs and examples.
+    """
+
+    # GIVEN a workflow that uses an inline workflow with tool wrapper
+    workflow_class = BasicToolCallingNodeInlineWorkflowToolWrapperWorkflow
+
+    # WHEN we serialize it
+    workflow_display = get_workflow_display(workflow_class=workflow_class)
+    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 include both query and context
+    input_variables = serialized_workflow["input_variables"]
+    assert len(input_variables) == 2
+    input_keys = {var["key"] for var in input_variables}
+    assert input_keys == {"query", "context"}
+
+    # AND its output variables should be what we expect
+    output_variables = serialized_workflow["output_variables"]
+    assert len(output_variables) == 2
+    output_keys = {var["key"] for var in output_variables}
+    assert output_keys == {"text", "chat_history"}
+
+    # AND the inline workflow tool should have the definition attribute serialized
+    workflow_raw_data = serialized_workflow["workflow_raw_data"]
+    tool_calling_node = workflow_raw_data["nodes"][1]
+    function_attributes = next(
+        attribute for attribute in tool_calling_node["attributes"] if attribute["name"] == "functions"
+    )
+    assert function_attributes["value"]["type"] == "CONSTANT_VALUE"
+    assert function_attributes["value"]["value"]["type"] == "JSON"
+    inline_workflow_tool = function_attributes["value"]["value"]["value"][0]
+
+    # AND the inline workflow tool should have the correct type
+    assert inline_workflow_tool["type"] == "INLINE_WORKFLOW"
+    assert inline_workflow_tool["name"] == "BasicInlineSubworkflowWorkflow"
+
+    # AND the inline workflow tool should have a definition attribute (like code tool)
+    assert "definition" in inline_workflow_tool
+    definition = inline_workflow_tool["definition"]
+
+    # AND the definition should match the expected structure with inputs and examples
+    context_var = next(var for var in input_variables if var["key"] == "context")
+    context_input_variable_id = context_var["id"]
+
+    assert definition == {
+        "state": None,
+        "cache_config": None,
+        "name": "basic_inline_subworkflow_workflow",
+        "description": "\n    A workflow that gets the weather for a given city and date with context.\n    ",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "city": {"type": "string"},
+                "date": {"type": "string"},
+            },
+            "required": ["city", "date"],
+            "examples": [{"city": "San Francisco", "date": "2025-01-01"}],
+        },
+        "inputs": {
+            "context": {
+                "type": "WORKFLOW_INPUT",
+                "input_variable_id": context_input_variable_id,
+            }
+        },
+        "forced": None,
+        "strict": None,
+    }

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

@@ -45,21 +45,60 @@ def test_serialize_workflow():
         "id": "80ed138a-1127-4c77-ba27-a66a37c92717",
         "name": "functions",
         "value": {
-            "type": "CONSTANT_VALUE",
-            "value": {
-                "type": "JSON",
-                "value": [
-                    {
-                        "type": "MCP_SERVER",
-                        "name": "github",
-                        "description": "",
-                        "url": "https://api.githubcopilot.com/mcp/",
-                        "authorization_type": "BEARER_TOKEN",
-                        "bearer_token_value": "GITHUB_PERSONAL_ACCESS_TOKEN",
-                        "api_key_header_key": None,
-                        "api_key_header_value": None,
-                    }
-                ],
-            },
+            "type": "ARRAY_REFERENCE",
+            "items": [
+                {
+                    "type": "DICTIONARY_REFERENCE",
+                    "entries": [
+                        {
+                            "id": "85eb3714-5810-4935-9abe-a6112d4c406c",
+                            "key": "type",
+                            "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": "MCP_SERVER"}},
+                        },
+                        {
+                            "id": "c9cc0249-c8bd-4b67-9347-c0a210646bcc",
+                            "key": "name",
+                            "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": "github"}},
+                        },
+                        {
+                            "id": "b8f99ea6-ae33-4e62-b958-351e7e975bdc",
+                            "key": "description",
+                            "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": ""}},
+                        },
+                        {
+                            "id": "07d62347-5a1b-4b91-90f7-1e313238f2b2",
+                            "key": "url",
+                            "value": {
+                                "type": "CONSTANT_VALUE",
+                                "value": {"type": "STRING", "value": "https://api.githubcopilot.com/mcp/"},
+                            },
+                        },
+                        {
+                            "id": "b9ef2156-dd84-4a84-91ce-ce590fe2087b",
+                            "key": "authorization_type",
+                            "value": {"type": "CONSTANT_VALUE", "value": {"type": "STRING", "value": "BEARER_TOKEN"}},
+                        },
+                        {
+                            "id": "df799ea3-77bb-40a1-82a1-a5fe343ba68b",
+                            "key": "bearer_token_value",
+                            "value": {
+                                "type": "ENVIRONMENT_VARIABLE",
+                                "environment_variable": "GITHUB_PERSONAL_ACCESS_TOKEN",
+                            },
+                        },
+                        {
+                            "id": "6e940707-ffe9-4cfb-813e-ddc3a9204ba4",
+                            "key": "api_key_header_key",
+                            "value": {"type": "CONSTANT_VALUE", "value": {"type": "JSON", "value": None}},
+                        },
+                        {
+                            "id": "2e3db081-7596-4057-b977-be69971d7f87",
+                            "key": "api_key_header_value",
+                            "value": {"type": "CONSTANT_VALUE", "value": {"type": "JSON", "value": None}},
+                        },
+                    ],
+                    "definition": {"name": "MCPServer", "module": ["vellum", "workflows", "types", "definition"]},
+                }
+            ],
         },
     }

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

@@ -213,12 +213,26 @@ def test_serialize_workflow():
             },
         ],
         "outputs": [
-            {"id": "d0d0cd85-8546-4d90-bdc1-86c751ba04e5", "name": "text", "type": "STRING", "value": None},
+            {
+                "id": "a7ed5e04-2ddd-45f3-bb08-462068f17ad8",
+                "name": "json",
+                "type": "JSON",
+                "value": None,
+                "schema": {"type": "object", "additionalProperties": {}},
+            },
+            {
+                "id": "d0d0cd85-8546-4d90-bdc1-86c751ba04e5",
+                "name": "text",
+                "type": "STRING",
+                "value": None,
+                "schema": {"type": "string"},
+            },
             {
                 "id": "33a737c2-d347-48d4-bf62-e36c06aebf0c",
                 "name": "chat_history",
                 "type": "CHAT_HISTORY",
                 "value": None,
+                "schema": {"type": "array", "items": {"$ref": "#/$defs/vellum.client.types.chat_message.ChatMessage"}},
             },
         ],
     }