vellum-ai 0.10.6__py3-none-any.whl → 0.10.8__py3-none-any.whl

vellum/client/resources/test_suites/client.py

@@ -232,25 +232,21 @@ class TestSuitesClient:
             api_key="YOUR_API_KEY",
         )
         response = client.test_suites.test_suite_test_cases_bulk(
-            id="string",
+            id="id",
             request=[
                 TestSuiteTestCaseCreateBulkOperationRequest(
-                    id="string",
+                    id="id",
                     data=CreateTestSuiteTestCaseRequest(
-                        label="string",
                         input_values=[
                             NamedTestCaseStringVariableValueRequest(
-                                value="string",
-                                name="string",
+                                name="name",
                             )
                         ],
                         evaluation_values=[
                             NamedTestCaseStringVariableValueRequest(
-                                value="string",
-                                name="string",
+                                name="name",
                             )
                         ],
-                        external_id="string",
                     ),
                 )
             ],
@@ -571,25 +567,21 @@ class AsyncTestSuitesClient:
 
         async def main() -> None:
             response = await client.test_suites.test_suite_test_cases_bulk(
-                id="string",
+                id="id",
                 request=[
                     TestSuiteTestCaseCreateBulkOperationRequest(
-                        id="string",
+                        id="id",
                         data=CreateTestSuiteTestCaseRequest(
-                            label="string",
                             input_values=[
                                 NamedTestCaseStringVariableValueRequest(
-                                    value="string",
-                                    name="string",
+                                    name="name",
                                 )
                             ],
                             evaluation_values=[
                                 NamedTestCaseStringVariableValueRequest(
-                                    value="string",
-                                    name="string",
+                                    name="name",
                                 )
                             ],
-                            external_id="string",
                         ),
                     )
                 ],

vellum/client/resources/workflows/client.py

@@ -47,18 +47,6 @@ class WorkflowsClient:
         ------
         typing.Iterator[bytes]
 
-
-        Examples
-        --------
-        from vellum import Vellum
-
-        client = Vellum(
-            api_key="YOUR_API_KEY",
-        )
-        client.workflows.pull(
-            id="string",
-            format="json",
-        )
         """
         with self._client_wrapper.httpx_client.stream(
             f"v1/workflows/{jsonable_encoder(id)}/pull",
@@ -196,26 +184,6 @@ class AsyncWorkflowsClient:
         ------
         typing.AsyncIterator[bytes]
 
-
-        Examples
-        --------
-        import asyncio
-
-        from vellum import AsyncVellum
-
-        client = AsyncVellum(
-            api_key="YOUR_API_KEY",
-        )
-
-
-        async def main() -> None:
-            await client.workflows.pull(
-                id="string",
-                format="json",
-            )
-
-
-        asyncio.run(main())
         """
         async with self._client_wrapper.httpx_client.stream(
             f"v1/workflows/{jsonable_encoder(id)}/pull",

vellum/client/types/__init__.py

@@ -197,6 +197,7 @@ from .metadata_filter_rule_combinator import MetadataFilterRuleCombinator
 from .metadata_filter_rule_request import MetadataFilterRuleRequest
 from .metadata_filters_request import MetadataFiltersRequest
 from .metric_definition_execution import MetricDefinitionExecution
+from .metric_definition_history_item import MetricDefinitionHistoryItem
 from .metric_definition_input import MetricDefinitionInput
 from .metric_node_result import MetricNodeResult
 from .ml_model_read import MlModelRead
@@ -685,6 +686,7 @@ __all__ = [
     "MetadataFilterRuleRequest",
     "MetadataFiltersRequest",
     "MetricDefinitionExecution",
+    "MetricDefinitionHistoryItem",
     "MetricDefinitionInput",
     "MetricNodeResult",
     "MlModelRead",

vellum/client/types/metric_definition_history_item.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+from ..core.pydantic_utilities import UniversalBaseModel
+from .array_vellum_value import ArrayVellumValue
+import pydantic
+import typing
+from .vellum_variable import VellumVariable
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import update_forward_refs
+
+
+class MetricDefinitionHistoryItem(UniversalBaseModel):
+    id: str
+    label: str = pydantic.Field()
+    """
+    A human-readable label for the metric
+    """
+
+    name: str = pydantic.Field()
+    """
+    A name that uniquely identifies this metric within its workspace
+    """
+
+    description: str
+    input_variables: typing.List[VellumVariable]
+    output_variables: typing.List[VellumVariable]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow
+
+
+update_forward_refs(ArrayVellumValue, MetricDefinitionHistoryItem=MetricDefinitionHistoryItem)

vellum/types/metric_definition_history_item.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.metric_definition_history_item import *

vellum/workflows/events/node.py

@@ -1,13 +1,14 @@
-from typing import Any, Dict, Generic, Literal, Type, Union
+from typing import Any, Dict, Generic, Iterable, List, Literal, Optional, Set, Type, Union
 
-from pydantic import field_serializer
+from pydantic import ConfigDict, SerializerFunctionWrapHandler, field_serializer, model_serializer
+from pydantic.main import IncEx
 
 from vellum.core.pydantic_utilities import UniversalBaseModel
-
 from vellum.workflows.errors import VellumError
 from vellum.workflows.expressions.accessor import AccessorExpression
 from vellum.workflows.nodes.bases import BaseNode
 from vellum.workflows.outputs.base import BaseOutput
+from vellum.workflows.ports.port import Port
 from vellum.workflows.references.node import NodeReference
 from vellum.workflows.types.generics import OutputsType
 
@@ -21,6 +22,15 @@ class _BaseNodeExecutionBody(UniversalBaseModel):
     def serialize_node_definition(self, node_definition: Type, _info: Any) -> Dict[str, Any]:
         return serialize_type_encoder(node_definition)
 
+    # Couldn't get this to work with model_config.exclude_none or model_config.exclude_defaults
+    # so we're excluding null invoked_ports manually here for now
+    @model_serializer(mode="wrap", when_used="json")
+    def serialize_model(self, handler: SerializerFunctionWrapHandler) -> Any:
+        serialized = super().serialize_model(handler)  # type: ignore[call-arg, arg-type]
+        if "invoked_ports" in serialized and serialized["invoked_ports"] is None:
+            del serialized["invoked_ports"]
+        return serialized
+
 
 class _BaseNodeEvent(BaseEvent):
     body: _BaseNodeExecutionBody
@@ -31,6 +41,7 @@ class _BaseNodeEvent(BaseEvent):
 
 
 NodeInputName = Union[NodeReference, AccessorExpression]
+InvokedPorts = Optional[Set["Port"]]
 
 
 class NodeExecutionInitiatedBody(_BaseNodeExecutionBody):
@@ -52,11 +63,18 @@ class NodeExecutionInitiatedEvent(_BaseNodeEvent):
 
 class NodeExecutionStreamingBody(_BaseNodeExecutionBody):
     output: BaseOutput
+    invoked_ports: InvokedPorts = None
 
     @field_serializer("output")
     def serialize_output(self, output: BaseOutput, _info: Any) -> Dict[str, Any]:
         return default_serializer(output)
 
+    @field_serializer("invoked_ports")
+    def serialize_invoked_ports(self, invoked_ports: InvokedPorts, _info: Any) -> Optional[List[Dict[str, Any]]]:
+        if not invoked_ports:
+            return None
+        return [default_serializer(port) for port in invoked_ports]
+
 
 class NodeExecutionStreamingEvent(_BaseNodeEvent):
     name: Literal["node.execution.streaming"] = "node.execution.streaming"
@@ -66,14 +84,25 @@ class NodeExecutionStreamingEvent(_BaseNodeEvent):
     def output(self) -> BaseOutput:
         return self.body.output
 
+    @property
+    def invoked_ports(self) -> InvokedPorts:
+        return self.body.invoked_ports
+
 
 class NodeExecutionFulfilledBody(_BaseNodeExecutionBody, Generic[OutputsType]):
     outputs: OutputsType
+    invoked_ports: InvokedPorts = None
 
     @field_serializer("outputs")
     def serialize_outputs(self, outputs: OutputsType, _info: Any) -> Dict[str, Any]:
         return default_serializer(outputs)
 
+    @field_serializer("invoked_ports")
+    def serialize_invoked_ports(self, invoked_ports: InvokedPorts, _info: Any) -> Optional[List[Dict[str, Any]]]:
+        if invoked_ports is None:
+            return None
+        return [default_serializer(port) for port in invoked_ports]
+
 
 class NodeExecutionFulfilledEvent(_BaseNodeEvent, Generic[OutputsType]):
     name: Literal["node.execution.fulfilled"] = "node.execution.fulfilled"
@@ -83,6 +112,10 @@ class NodeExecutionFulfilledEvent(_BaseNodeEvent, Generic[OutputsType]):
     def outputs(self) -> OutputsType:
         return self.body.outputs
 
+    @property
+    def invoked_ports(self) -> InvokedPorts:
+        return self.body.invoked_ports
+
 
 class NodeExecutionRejectedBody(_BaseNodeExecutionBody):
     error: VellumError

vellum/workflows/events/tests/test_event.py

@@ -6,7 +6,14 @@ from uuid import UUID
 from deepdiff import DeepDiff
 
 from vellum.workflows.errors.types import VellumError, VellumErrorCode
-from vellum.workflows.events.node import NodeExecutionInitiatedBody, NodeExecutionInitiatedEvent
+from vellum.workflows.events.node import (
+    NodeExecutionFulfilledBody,
+    NodeExecutionFulfilledEvent,
+    NodeExecutionInitiatedBody,
+    NodeExecutionInitiatedEvent,
+    NodeExecutionStreamingBody,
+    NodeExecutionStreamingEvent,
+)
 from vellum.workflows.events.types import NodeParentContext, WorkflowParentContext
 from vellum.workflows.events.workflow import (
     WorkflowExecutionFulfilledBody,
@@ -93,10 +100,9 @@ module_root = name_parts[: name_parts.index("events")]
                     node_definition=MockNode,
                     span_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
                     parent=WorkflowParentContext(
-                        workflow_definition=MockWorkflow,
-                        span_id=UUID("123e4567-e89b-12d3-a456-426614174000")
-                    )
-                )
+                        workflow_definition=MockWorkflow, span_id=UUID("123e4567-e89b-12d3-a456-426614174000")
+                    ),
+                ),
             ),
             {
                 "id": "123e4567-e89b-12d3-a456-426614174000",
@@ -126,10 +132,10 @@ module_root = name_parts[: name_parts.index("events")]
                         },
                         "type": "WORKFLOW",
                         "parent": None,
-                        "span_id": "123e4567-e89b-12d3-a456-426614174000"
+                        "span_id": "123e4567-e89b-12d3-a456-426614174000",
                     },
                     "type": "WORKFLOW_NODE",
-                    "span_id": "123e4567-e89b-12d3-a456-426614174000"
+                    "span_id": "123e4567-e89b-12d3-a456-426614174000",
                 },
             },
         ),
@@ -164,7 +170,7 @@ module_root = name_parts[: name_parts.index("events")]
                         "value": "foo",
                     },
                 },
-                "parent": None
+                "parent": None,
             },
         ),
         (
@@ -233,6 +239,78 @@ module_root = name_parts[: name_parts.index("events")]
                 "parent": None,
             },
         ),
+        (
+            NodeExecutionStreamingEvent(
+                id=UUID("123e4567-e89b-12d3-a456-426614174000"),
+                timestamp=datetime(2024, 1, 1, 12, 0, 0),
+                trace_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
+                span_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
+                body=NodeExecutionStreamingBody(
+                    node_definition=MockNode,
+                    output=BaseOutput(
+                        name="example",
+                        value="foo",
+                    ),
+                ),
+            ),
+            {
+                "id": "123e4567-e89b-12d3-a456-426614174000",
+                "api_version": "2024-10-25",
+                "timestamp": "2024-01-01T12:00:00",
+                "trace_id": "123e4567-e89b-12d3-a456-426614174000",
+                "span_id": "123e4567-e89b-12d3-a456-426614174000",
+                "name": "node.execution.streaming",
+                "body": {
+                    "node_definition": {
+                        "name": "MockNode",
+                        "module": module_root + ["events", "tests", "test_event"],
+                    },
+                    "output": {
+                        "name": "example",
+                        "value": "foo",
+                    },
+                },
+                "parent": None,
+            },
+        ),
+        (
+            NodeExecutionFulfilledEvent(
+                id=UUID("123e4567-e89b-12d3-a456-426614174000"),
+                timestamp=datetime(2024, 1, 1, 12, 0, 0),
+                trace_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
+                span_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
+                body=NodeExecutionFulfilledBody(
+                    node_definition=MockNode,
+                    outputs=MockNode.Outputs(
+                        example="foo",
+                    ),
+                    invoked_ports={MockNode.Ports.default},
+                ),
+            ),
+            {
+                "id": "123e4567-e89b-12d3-a456-426614174000",
+                "api_version": "2024-10-25",
+                "timestamp": "2024-01-01T12:00:00",
+                "trace_id": "123e4567-e89b-12d3-a456-426614174000",
+                "span_id": "123e4567-e89b-12d3-a456-426614174000",
+                "name": "node.execution.fulfilled",
+                "body": {
+                    "node_definition": {
+                        "name": "MockNode",
+                        "module": module_root + ["events", "tests", "test_event"],
+                    },
+                    "outputs": {
+                        "example": "foo",
+                    },
+                    "invoked_ports": [
+                        {
+                            "name": "default",
+                        }
+                    ],
+                },
+                "parent": None,
+            },
+        ),
     ],
     ids=[
         "workflow.execution.initiated",
@@ -240,7 +318,9 @@ module_root = name_parts[: name_parts.index("events")]
         "workflow.execution.streaming",
         "workflow.execution.fulfilled",
         "workflow.execution.rejected",
+        "node.execution.streaming",
+        "node.execution.fulfilled",
     ],
 )
 def test_event_serialization(event, expected_json):
-    assert not DeepDiff(json.loads(event.model_dump_json()), expected_json)
+    assert not DeepDiff(event.model_dump(mode="json"), expected_json)

vellum/workflows/events/types.py

@@ -103,4 +103,4 @@ class BaseEvent(UniversalBaseModel):
     api_version: Literal["2024-10-25"] = "2024-10-25"
     trace_id: UUID
     span_id: UUID
-    parent: Optional['ParentContext'] = None
+    parent: Optional[ParentContext] = None

vellum/workflows/nodes/core/inline_subworkflow_node/node.py

@@ -18,6 +18,7 @@ class InlineSubworkflowNode(BaseSubworkflowNode[StateType], Generic[StateType, W
     Used to execute a Subworkflow defined inline.
 
     subworkflow: Type["BaseWorkflow[WorkflowInputsType, InnerStateType]"] - The Subworkflow to execute
+    subworkflow_inputs: ClassVar[EntityInputsInterface] = {}
     """
 
     subworkflow: Type["BaseWorkflow[WorkflowInputsType, InnerStateType]"]

vellum/workflows/nodes/core/templating_node/node.py

@@ -82,6 +82,11 @@ class TemplatingNode(BaseNode[StateType], Generic[StateType, _OutputType], metac
     jinja_custom_filters: Mapping[str, Callable[[Union[str, bytes]], bool]] = _DEFAULT_JINJA_CUSTOM_FILTERS
 
     class Outputs(BaseNode.Outputs):
+        """
+        The outputs of the TemplatingNode.
+
+        result: _OutputType - The result of the template rendering
+        """
         # We use our mypy plugin to override the _OutputType with the actual output type
         # for downstream references to this output.
         result: _OutputType  # type: ignore[valid-type]

vellum/workflows/nodes/displayable/api_node/node.py

@@ -8,7 +8,7 @@ from vellum.workflows.references.vellum_secret import VellumSecretReference
 class APINode(BaseAPINode):
     """
     Used to execute an API call. This node exists to be backwards compatible with Vellum's API Node, and for most cases,
-    you should extend from `APINode` directly.
+    you should extend from `BaseAPINode` directly.
 
     url: str - The URL to send the request to.
     method: APIRequestMethod - The HTTP method to use for the request.

vellum/workflows/nodes/displayable/bases/prompt_deployment_node.py

@@ -11,7 +11,6 @@ from vellum import (
     RawPromptExecutionOverridesRequest,
     StringInputRequest,
 )
-
 from vellum.workflows.constants import LATEST_RELEASE_TAG, OMIT
 from vellum.workflows.errors import VellumErrorCode
 from vellum.workflows.exceptions import NodeException
@@ -26,7 +25,7 @@ class BasePromptDeploymentNode(BasePromptNode, Generic[StateType]):
     prompt_inputs: EntityInputsInterface - The inputs for the Prompt
     deployment: Union[UUID, str] - Either the Prompt Deployment's UUID or its name.
     release_tag: str - The release tag to use for the Prompt Execution
-    external_id: Optional[str] - The external ID to use for the Prompt Execution
+    external_id: Optional[str] - Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment.
     expand_meta: Optional[PromptDeploymentExpandMetaRequest] - Expandable execution fields to include in the response
     raw_overrides: Optional[RawPromptExecutionOverridesRequest] - The raw overrides to use for the Prompt Execution
     expand_raw: Optional[Sequence[str]] - Expandable raw fields to include in the response

vellum/workflows/nodes/displayable/code_execution_node/node.py

@@ -67,9 +67,8 @@ class CodeExecutionNode(BaseNode[StateType], Generic[StateType, _OutputType], me
 
     filepath: str - The path to the script to execute.
     code_inputs: EntityInputsInterface - The inputs for the custom script.
-    output_type: VellumVariableType = "STRING" - The type of the output from the custom script.
     runtime: CodeExecutionRuntime = "PYTHON_3_12" - The runtime to use for the custom script.
-    packages: Optional[Sequence[CodeExecutionPackageRequest]] = None - The packages to use for the custom script.
+    packages: Optional[Sequence[CodeExecutionPackage]] = None - The packages to use for the custom script.
     request_options: Optional[RequestOptions] = None - The request options to use for the custom script.
     """
 

vellum/workflows/nodes/displayable/code_execution_node/utils.py

@@ -2,9 +2,20 @@ import os
 from typing import Union
 
 
+def get_project_root() -> str:
+    current_dir = os.getcwd()
+    while current_dir != '/':
+        if ".git" in os.listdir(current_dir):
+            return current_dir
+        current_dir = os.path.dirname(current_dir)
+    raise FileNotFoundError("Project root not found.")
+
 def read_file_from_path(filepath: str) -> Union[str, None]:
-    if not os.path.exists(filepath):
+    project_root = get_project_root()
+    relative_filepath = os.path.join(project_root, filepath)
+
+    if not os.path.exists(relative_filepath):
         return None
 
-    with open(filepath) as file:
+    with open(relative_filepath, 'r') as file:
         return file.read()

vellum/workflows/nodes/displayable/conditional_node/node.py

@@ -1,4 +1,4 @@
-from typing import Iterable
+from typing import Set
 
 from vellum.workflows.nodes.bases import BaseNode
 from vellum.workflows.outputs.base import BaseOutputs
@@ -15,7 +15,7 @@ class ConditionalNode(BaseNode):
     """
 
     class Ports(NodePorts):
-        def __call__(self, outputs: BaseOutputs, state: BaseState) -> Iterable[Port]:
+        def __call__(self, outputs: BaseOutputs, state: BaseState) -> Set[Port]:    
             all_ports = [port for port in self.__class__]
             enforce_single_invoked_port = validate_ports(all_ports)
 

vellum/workflows/nodes/displayable/inline_prompt_node/node.py

@@ -9,16 +9,23 @@ from vellum.workflows.types.generics import StateType
 
 class InlinePromptNode(BaseInlinePromptNode[StateType]):
     """
-    Used to execute an Inline Prompt and surface a string output for convenience.
+    Used to execute a Prompt defined inline.
 
     prompt_inputs: EntityInputsInterface - The inputs for the Prompt
     ml_model: str - Either the ML Model's UUID or its name.
-    blocks: List[PromptBlockRequest] - The blocks that make up the Prompt
+    blocks: List[PromptBlock] - The blocks that make up the Prompt
+    functions: Optional[List[FunctionDefinition]] - The functions to include in the Prompt
     parameters: PromptParameters - The parameters for the Prompt
-    expand_meta: Optional[AdHocExpandMetaRequest] - Set of expandable execution fields to include in the response
+    expand_meta: Optional[AdHocExpandMeta] - Expandable execution fields to include in the response
+    request_options: Optional[RequestOptions] - The request options to use for the Prompt Execution
     """
 
     class Outputs(BaseInlinePromptNode.Outputs):
+        """
+        The outputs of the InlinePromptNode.
+
+        text: str - The result of the Prompt Execution
+        """
         text: str
 
     def run(self) -> Iterator[BaseOutput]:

vellum/workflows/nodes/displayable/prompt_deployment_node/node.py

@@ -14,7 +14,7 @@ class PromptDeploymentNode(BasePromptDeploymentNode[StateType]):
     prompt_inputs: EntityInputsInterface - The inputs for the Prompt
     deployment: Union[UUID, str] - Either the Prompt Deployment's UUID or its name.
     release_tag: str - The release tag to use for the Prompt Execution
-    external_id: Optional[str] - The external ID to use for the Prompt Execution
+    external_id: Optional[str] - Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment.
     expand_meta: Optional[PromptDeploymentExpandMetaRequest] - Expandable execution fields to include in the response
     raw_overrides: Optional[RawPromptExecutionOverridesRequest] - The raw overrides to use for the Prompt Execution
     expand_raw: Optional[Sequence[str]] - Expandable raw fields to include in the response
@@ -23,6 +23,11 @@ class PromptDeploymentNode(BasePromptDeploymentNode[StateType]):
     """
 
     class Outputs(BasePromptDeploymentNode.Outputs):
+        """
+        The outputs of the PromptDeploymentNode.
+
+        text: str - The result of the Prompt Execution
+        """
         text: str
 
     def run(self) -> Iterator[BaseOutput]:

vellum/workflows/nodes/displayable/subworkflow_deployment_node/node.py

@@ -12,7 +12,6 @@ from vellum import (
     WorkflowRequestStringInputRequest,
 )
 from vellum.core import RequestOptions
-
 from vellum.workflows.constants import LATEST_RELEASE_TAG, OMIT
 from vellum.workflows.errors import VellumErrorCode
 from vellum.workflows.exceptions import NodeException
@@ -28,7 +27,7 @@ class SubworkflowDeploymentNode(BaseSubworkflowNode[StateType], Generic[StateTyp
     subworkflow_inputs: EntityInputsInterface - The inputs for the Subworkflow
     deployment: Union[UUID, str] - Either the Workflow Deployment's UUID or its name.
     release_tag: str = LATEST_RELEASE_TAG - The release tag to use for the Workflow Execution
-    external_id: Optional[str] = OMIT - The external ID to use for the Workflow Execution
+    external_id: Optional[str] = OMIT - Optionally include a unique identifier for tracking purposes. Must be unique within a given Workflow Deployment.
     expand_meta: Optional[WorkflowExpandMetaRequest] = OMIT - Expandable execution fields to include in the respownse
     metadata: Optional[Dict[str, Optional[Any]]] = OMIT - The metadata to use for the Workflow Execution
     request_options: Optional[RequestOptions] = None - The request options to use for the Workflow Execution

vellum/workflows/nodes/displayable/tests/test_text_prompt_deployment_node.py

@@ -8,7 +8,6 @@ from vellum import (
     PromptOutput,
     StringVellumValue,
 )
-
 from vellum.workflows.constants import OMIT
 from vellum.workflows.inputs import BaseInputs
 from vellum.workflows.nodes import PromptDeploymentNode
@@ -65,7 +64,7 @@ def test_text_prompt_deployment_node__basic(vellum_client):
     assert text_output.name == "text"
     assert text_output.value == "Hello, world!"
 
-    # AND we should have made the expected call to Vellum search
+    # AND we should have made the expected call to stream the prompt execution
     vellum_client.execute_prompt_stream.assert_called_once_with(
         expand_meta=OMIT,
         expand_raw=OMIT,

vellum/workflows/ports/node_ports.py

@@ -33,7 +33,7 @@ class _NodePortsMeta(type):
 
 
 class NodePorts(metaclass=_NodePortsMeta):
-    def __call__(self, outputs: BaseOutputs, state: BaseState) -> Iterable[Port]:
+    def __call__(self, outputs: BaseOutputs, state: BaseState) -> Set[Port]:
         """
         Invokes the appropriate ports based on the fulfilled outputs and state.
         """
@@ -67,7 +67,7 @@ class NodePorts(metaclass=_NodePortsMeta):
 
         return invoked_ports
 
-    def __lt__(self, output: BaseOutput) -> Iterable[Port]:
+    def __lt__(self, output: BaseOutput) -> Set[Port]:
         """
         Invokes the appropriate ports based on the streamed output
         """

vellum/workflows/ports/port.py

@@ -1,5 +1,8 @@
 from typing import TYPE_CHECKING, Any, Iterator, List, Optional, Type
 
+from pydantic import GetCoreSchemaHandler
+from pydantic_core import core_schema
+
 from vellum.workflows.descriptors.base import BaseDescriptor
 from vellum.workflows.edges.edge import Edge
 from vellum.workflows.graph import Graph, GraphTarget
@@ -73,3 +76,14 @@ class Port:
 
         value = self._condition.resolve(state)
         return bool(value)
+
+    def serialize(self) -> dict:
+        return {
+            "name": self.name,
+        }
+
+    @classmethod
+    def __get_pydantic_core_schema__(
+        cls, source_type: Type[Any], handler: GetCoreSchemaHandler
+    ) -> core_schema.CoreSchema:
+        return core_schema.is_instance_schema(cls)

vellum/workflows/references/__init__.py

@@ -4,6 +4,7 @@ from .lazy import LazyReference
 from .node import NodeReference
 from .output import OutputReference
 from .state_value import StateValueReference
+from .vellum_secret import VellumSecretReference
 from .workflow_input import WorkflowInputReference
 
 __all__ = [
@@ -13,5 +14,6 @@ __all__ = [
     "NodeReference",
     "OutputReference",
     "StateValueReference",
+    "VellumSecretReference",
     "WorkflowInputReference",
 ]