vellum-ai 0.14.5__py3-none-any.whl → 0.14.7__py3-none-any.whl

vellum/client/types/vellum_document_request.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class VellumDocumentRequest(UniversalBaseModel):
+    src: str
+    metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+
+    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

vellum/client/types/vellum_value.py

@@ -7,6 +7,7 @@ from .number_vellum_value import NumberVellumValue
 from .json_vellum_value import JsonVellumValue
 from .image_vellum_value import ImageVellumValue
 from .audio_vellum_value import AudioVellumValue
+from .document_vellum_value import DocumentVellumValue
 from .function_call_vellum_value import FunctionCallVellumValue
 from .error_vellum_value import ErrorVellumValue
 from .chat_history_vellum_value import ChatHistoryVellumValue
@@ -21,6 +22,7 @@ VellumValue = typing.Union[
     JsonVellumValue,
     ImageVellumValue,
     AudioVellumValue,
+    DocumentVellumValue,
     FunctionCallVellumValue,
     ErrorVellumValue,
     "ArrayVellumValue",

vellum/client/types/vellum_value_request.py

@@ -7,6 +7,7 @@ from .number_vellum_value_request import NumberVellumValueRequest
 from .json_vellum_value_request import JsonVellumValueRequest
 from .image_vellum_value_request import ImageVellumValueRequest
 from .audio_vellum_value_request import AudioVellumValueRequest
+from .document_vellum_value_request import DocumentVellumValueRequest
 from .function_call_vellum_value_request import FunctionCallVellumValueRequest
 from .error_vellum_value_request import ErrorVellumValueRequest
 from .chat_history_vellum_value_request import ChatHistoryVellumValueRequest
@@ -21,6 +22,7 @@ VellumValueRequest = typing.Union[
     JsonVellumValueRequest,
     ImageVellumValueRequest,
     AudioVellumValueRequest,
+    DocumentVellumValueRequest,
     FunctionCallVellumValueRequest,
     ErrorVellumValueRequest,
     "ArrayVellumValueRequest",

vellum/client/types/vellum_variable_type.py

@@ -14,6 +14,7 @@ VellumVariableType = typing.Union[
         "FUNCTION_CALL",
         "IMAGE",
         "AUDIO",
+        "DOCUMENT",
         "NULL",
     ],
     typing.Any,

vellum/client/types/workflow_sandbox_example.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class WorkflowSandboxExample(UniversalBaseModel):
+    id: str
+    label: str
+    description: typing.Optional[str] = None
+    icon_name: typing.Optional[str] = None
+
+    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

vellum/resources/workflow_sandboxes/types/__init__.py

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

vellum/resources/workflow_sandboxes/types/list_workflow_sandbox_examples_request_tag.py

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

vellum/types/document_chat_message_content.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.document_chat_message_content import *

vellum/types/document_chat_message_content_request.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.document_chat_message_content_request import *

vellum/types/document_vellum_value.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.document_vellum_value import *

vellum/types/document_vellum_value_request.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.document_vellum_value_request import *

vellum/types/paginated_workflow_sandbox_example_list.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.paginated_workflow_sandbox_example_list import *

vellum/types/vellum_document.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.vellum_document import *

vellum/types/vellum_document_request.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.vellum_document_request import *

vellum/types/workflow_sandbox_example.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.workflow_sandbox_example import *

vellum/workflows/exceptions.py

@@ -17,3 +17,21 @@ class NodeException(Exception):
     @staticmethod
     def of(workflow_error: WorkflowError) -> "NodeException":
         return NodeException(message=workflow_error.message, code=workflow_error.code)
+
+
+class WorkflowInitializationException(Exception):
+    def __init__(self, message: str, code: WorkflowErrorCode = WorkflowErrorCode.INVALID_INPUTS):
+        self.message = message
+        self.code = code
+        super().__init__(message)
+
+    @property
+    def error(self) -> WorkflowError:
+        return WorkflowError(
+            message=self.message,
+            code=self.code,
+        )
+
+    @staticmethod
+    def of(workflow_error: WorkflowError) -> "WorkflowInitializationException":
+        return WorkflowInitializationException(message=workflow_error.message, code=workflow_error.code)

vellum/workflows/inputs/base.py

@@ -1,9 +1,11 @@
-from typing import Any, Iterator, Tuple, Type
+from typing import Any, Iterator, Tuple, Type, Union, get_args, get_origin
 from typing_extensions import dataclass_transform
 
 from pydantic import GetCoreSchemaHandler
 from pydantic_core import core_schema
 
+from vellum.workflows.errors.types import WorkflowErrorCode
+from vellum.workflows.exceptions import WorkflowInitializationException
 from vellum.workflows.references import ExternalInputReference, WorkflowInputReference
 from vellum.workflows.references.input import InputReference
 from vellum.workflows.types.utils import get_class_attr_names, infer_types
@@ -40,7 +42,20 @@ class BaseInputs(metaclass=_BaseInputsMeta):
     __parent_class__: Type = type(None)
 
     def __init__(self, **kwargs: Any) -> None:
+        for name, field_type in self.__class__.__annotations__.items():
+            if name not in kwargs and name not in vars(self.__class__):
+                origin = get_origin(field_type)
+                args = get_args(field_type)
+                if not (origin is Union and type(None) in args):
+                    raise WorkflowInitializationException(
+                        message="Required input variables should have defined value",
+                        code=WorkflowErrorCode.INVALID_INPUTS,
+                    )
+
         for name, value in kwargs.items():
+            field_type = self.__class__.__annotations__.get(name)
+            if field_type:
+                self._validate_input(value, field_type)
             setattr(self, name, value)
 
     def __iter__(self) -> Iterator[Tuple[InputReference, Any]]:
@@ -48,6 +63,17 @@ class BaseInputs(metaclass=_BaseInputsMeta):
             if hasattr(self, input_descriptor.name):
                 yield (input_descriptor, getattr(self, input_descriptor.name))
 
+    def _validate_input(self, value: Any, field_type: Any) -> None:
+        if value is None:
+            # Check if field_type is Optional
+            origin = get_origin(field_type)
+            args = get_args(field_type)
+            if not (origin is Union and type(None) in args):
+                raise WorkflowInitializationException(
+                    message="Required input variables should have defined value",
+                    code=WorkflowErrorCode.INVALID_INPUTS,
+                )
+
     @classmethod
     def __get_pydantic_core_schema__(
         cls, source_type: Type[Any], handler: GetCoreSchemaHandler

vellum/workflows/inputs/tests/test_inputs.py

@@ -0,0 +1,49 @@
+import pytest
+from typing import Optional
+
+from vellum.workflows.errors import WorkflowErrorCode
+from vellum.workflows.exceptions import WorkflowInitializationException
+from vellum.workflows.inputs import BaseInputs
+
+
+def test_base_inputs_happy_path():
+    # GIVEN some input class with required and optional fields
+    class TestInputs(BaseInputs):
+        required_string: str
+        required_int: int
+        optional_string: Optional[str]
+
+    # WHEN we assign the inputs some valid values
+    inputs = TestInputs(required_string="hello", required_int=42, optional_string=None)
+
+    # THEN the inputs should have the correct values
+    assert inputs.required_string == "hello"
+    assert inputs.required_int == 42
+    assert inputs.optional_string is None
+
+
+def test_base_inputs_empty_value():
+    # GIVEN some input class with required and optional string fields
+    class TestInputs(BaseInputs):
+        required_string: str
+        optional_string: Optional[str]
+
+    # WHEN we try to omit a required field
+    with pytest.raises(WorkflowInitializationException) as exc_info:
+        TestInputs(optional_string="ok")  # type: ignore
+
+    # THEN it should raise a NodeException with the correct error message and code
+    assert exc_info.value.code == WorkflowErrorCode.INVALID_INPUTS
+    assert "Required input variables should have defined value" in str(exc_info.value)
+
+
+def test_base_inputs_with_default():
+    # GIVEN some input class with a field that has a default value
+    class TestInputs(BaseInputs):
+        string_with_default: str = "default_value"
+
+    # WHEN we create an instance without providing the field
+    inputs = TestInputs()
+
+    # THEN it should use the default value
+    assert inputs.string_with_default == "default_value"

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

@@ -70,7 +70,7 @@ class InlineSubworkflowNode(
     subworkflow_inputs: ClassVar[Union[EntityInputsInterface, BaseInputs, Type[undefined]]] = undefined
 
     def run(self) -> Iterator[BaseOutput]:
-        with execution_context(parent_context=get_parent_context() or self._context.parent_context):
+        with execution_context(parent_context=get_parent_context()):
             subworkflow = self.subworkflow(
                 parent_state=self.state,
                 context=WorkflowContext(vellum_client=self._context.vellum_client),

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

@@ -16,10 +16,9 @@ from typing import (
     overload,
 )
 
-from vellum.workflows.context import execution_context, get_parent_context
+from vellum.workflows.context import ExecutionContext, execution_context, get_execution_context
 from vellum.workflows.descriptors.base import BaseDescriptor
 from vellum.workflows.errors.types import WorkflowErrorCode
-from vellum.workflows.events.types import ParentContext
 from vellum.workflows.exceptions import NodeException
 from vellum.workflows.inputs.base import BaseInputs
 from vellum.workflows.nodes.bases.base_adornment_node import BaseAdornmentNode
@@ -76,13 +75,13 @@ class MapNode(BaseAdornmentNode[StateType], Generic[StateType, MapNodeItemType])
         fulfilled_iterations: List[bool] = []
         for index, item in enumerate(self.items):
             fulfilled_iterations.append(False)
-            parent_context = get_parent_context() or self._context.parent_context
+            current_execution_context = get_execution_context()
             thread = Thread(
                 target=self._context_run_subworkflow,
                 kwargs={
                     "item": item,
                     "index": index,
-                    "parent_context": parent_context,
+                    "current_execution_context": current_execution_context,
                 },
             )
             if self.max_concurrency is None:
@@ -143,10 +142,11 @@ class MapNode(BaseAdornmentNode[StateType], Generic[StateType, MapNodeItemType])
             yield BaseOutput(name=output_name, value=output_list)
 
     def _context_run_subworkflow(
-        self, *, item: MapNodeItemType, index: int, parent_context: Optional[ParentContext] = None
+        self, *, item: MapNodeItemType, index: int, current_execution_context: ExecutionContext
     ) -> None:
-        parent_context = parent_context or self._context.parent_context
-        with execution_context(parent_context=parent_context):
+        parent_context = current_execution_context.parent_context
+        trace_id = current_execution_context.trace_id
+        with execution_context(parent_context=parent_context, trace_id=trace_id):
             self._run_subworkflow(item=item, index=index)
 
     def _run_subworkflow(self, *, item: MapNodeItemType, index: int) -> None:

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

@@ -27,7 +27,7 @@ class TryNode(BaseAdornmentNode[StateType], Generic[StateType]):
         error: Optional[WorkflowError] = None
 
     def run(self) -> Iterator[BaseOutput]:
-        parent_context = get_parent_context() or self._context.parent_context
+        parent_context = get_parent_context()
         with execution_context(parent_context=parent_context):
             subworkflow = self.subworkflow(
                 parent_state=self.state,

vellum/workflows/nodes/displayable/bases/base_prompt_node/node.py

@@ -67,11 +67,11 @@ class BasePromptNode(BaseNode, Generic[StateType]):
     def _handle_api_error(self, e: ApiError):
         if e.status_code and e.status_code >= 400 and e.status_code < 500 and isinstance(e.body, dict):
             raise NodeException(
-                message=e.body.get("detail", "Failed to execute prompt"),
+                message=e.body.get("detail", "Failed to execute Prompt"),
                 code=WorkflowErrorCode.INVALID_INPUTS,
             ) from e
 
         raise NodeException(
-            message="Failed to execute prompt",
+            message="Failed to execute Prompt",
             code=WorkflowErrorCode.INTERNAL_ERROR,
         ) from e

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

@@ -19,7 +19,7 @@ from vellum.client import RequestOptions
 from vellum.client.types.chat_message_request import ChatMessageRequest
 from vellum.client.types.prompt_settings import PromptSettings
 from vellum.workflows.constants import OMIT
-from vellum.workflows.context import get_parent_context
+from vellum.workflows.context import get_execution_context
 from vellum.workflows.errors import WorkflowErrorCode
 from vellum.workflows.events.types import default_serializer
 from vellum.workflows.exceptions import NodeException
@@ -61,11 +61,13 @@ class BaseInlinePromptNode(BasePromptNode[StateType], Generic[StateType]):
 
     def _get_prompt_event_stream(self) -> Iterator[AdHocExecutePromptEvent]:
         input_variables, input_values = self._compile_prompt_inputs()
-        parent_context = get_parent_context()
+        current_context = get_execution_context()
+        parent_context = current_context.parent_context
+        trace_id = current_context.trace_id
         request_options = self.request_options or RequestOptions()
 
         request_options["additional_body_parameters"] = {
-            "execution_context": {"parent_context": parent_context},
+            "execution_context": {"parent_context": parent_context, "trace_id": trace_id},
             **request_options.get("additional_body_parameters", {}),
         }
         normalized_functions = (

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

@@ -15,7 +15,7 @@ from vellum import (
 from vellum.client import RequestOptions
 from vellum.client.types.chat_message_request import ChatMessageRequest
 from vellum.workflows.constants import LATEST_RELEASE_TAG, OMIT
-from vellum.workflows.context import get_parent_context
+from vellum.workflows.context import get_execution_context
 from vellum.workflows.errors import WorkflowErrorCode
 from vellum.workflows.events.types import default_serializer
 from vellum.workflows.exceptions import NodeException
@@ -55,11 +55,12 @@ class BasePromptDeploymentNode(BasePromptNode, Generic[StateType]):
         merge_behavior = MergeBehavior.AWAIT_ANY
 
     def _get_prompt_event_stream(self) -> Iterator[ExecutePromptEvent]:
-        current_parent_context = get_parent_context()
-        parent_context = current_parent_context.model_dump() if current_parent_context else None
+        current_context = get_execution_context()
+        trace_id = current_context.trace_id
+        parent_context = current_context.parent_context.model_dump() if current_context.parent_context else None
         request_options = self.request_options or RequestOptions()
         request_options["additional_body_parameters"] = {
-            "execution_context": {"parent_context": parent_context},
+            "execution_context": {"parent_context": parent_context, "trace_id": trace_id},
             **request_options.get("additional_body_parameters", {}),
         }
         return self._context.vellum_client.execute_prompt_stream(

vellum/workflows/nodes/displayable/inline_prompt_node/tests/test_node.py

@@ -146,22 +146,22 @@ def test_inline_prompt_node__function_definitions(vellum_adhoc_prompt_client):
         (
             ApiError(status_code=404, body={"message": "Model not found"}),
             WorkflowErrorCode.INVALID_INPUTS,
-            "Failed to execute prompt",
+            "Failed to execute Prompt",
         ),
         (
             ApiError(status_code=404, body="Model not found"),
             WorkflowErrorCode.INTERNAL_ERROR,
-            "Failed to execute prompt",
+            "Failed to execute Prompt",
         ),
         (
             ApiError(status_code=None, body={"detail": "Model not found"}),
             WorkflowErrorCode.INTERNAL_ERROR,
-            "Failed to execute prompt",
+            "Failed to execute Prompt",
         ),
         (
             ApiError(status_code=500, body={"detail": "Model not found"}),
             WorkflowErrorCode.INTERNAL_ERROR,
-            "Failed to execute prompt",
+            "Failed to execute Prompt",
         ),
     ],
     ids=["404", "invalid_dict", "invalid_body", "no_status_code", "500"],

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

@@ -12,10 +12,11 @@ from vellum import (
     WorkflowRequestNumberInputRequest,
     WorkflowRequestStringInputRequest,
 )
+from vellum.client.core.api_error import ApiError
 from vellum.client.types.chat_message_request import ChatMessageRequest
 from vellum.core import RequestOptions
 from vellum.workflows.constants import LATEST_RELEASE_TAG, OMIT
-from vellum.workflows.context import get_parent_context
+from vellum.workflows.context import get_execution_context
 from vellum.workflows.errors import WorkflowErrorCode
 from vellum.workflows.errors.types import workflow_event_error_to_workflow_error
 from vellum.workflows.events.types import default_serializer
@@ -120,24 +121,45 @@ class SubworkflowDeploymentNode(BaseNode[StateType], Generic[StateType]):
         return compiled_inputs
 
     def run(self) -> Iterator[BaseOutput]:
-        current_parent_context = get_parent_context()
-        parent_context = current_parent_context.model_dump(mode="json") if current_parent_context else None
+        current_context = get_execution_context()
+        parent_context = (
+            current_context.parent_context.model_dump(mode="json") if current_context.parent_context else None
+        )
         request_options = self.request_options or RequestOptions()
         request_options["additional_body_parameters"] = {
-            "execution_context": {"parent_context": parent_context},
+            "execution_context": {"parent_context": parent_context, "trace_id": current_context.trace_id},
             **request_options.get("additional_body_parameters", {}),
         }
-        subworkflow_stream = self._context.vellum_client.execute_workflow_stream(
-            inputs=self._compile_subworkflow_inputs(),
-            workflow_deployment_id=str(self.deployment) if isinstance(self.deployment, UUID) else None,
-            workflow_deployment_name=self.deployment if isinstance(self.deployment, str) else None,
-            release_tag=self.release_tag,
-            external_id=self.external_id,
-            event_types=["WORKFLOW"],
-            metadata=self.metadata,
-            request_options=request_options,
-        )
-        # for some reason execution context isn't showing as an option? ^ failing mypy
+
+        try:
+            deployment_id = str(self.deployment) if isinstance(self.deployment, UUID) else None
+            deployment_name = self.deployment if isinstance(self.deployment, str) else None
+        except AttributeError:
+            raise NodeException(
+                code=WorkflowErrorCode.NODE_EXECUTION,
+                message="Expected subworkflow deployment attribute to be either a UUID or STR, got None instead",
+            )
+
+        try:
+            subworkflow_stream = self._context.vellum_client.execute_workflow_stream(
+                inputs=self._compile_subworkflow_inputs(),
+                workflow_deployment_id=deployment_id,
+                workflow_deployment_name=deployment_name,
+                release_tag=self.release_tag,
+                external_id=self.external_id,
+                event_types=["WORKFLOW"],
+                metadata=self.metadata,
+                request_options=request_options,
+            )
+        except ApiError as e:
+            self._handle_api_error(e)
+
+        # We don't use the INITIATED event anyway, so we can just skip it
+        # and use the exception handling to catch other api level errors
+        try:
+            next(subworkflow_stream)
+        except ApiError as e:
+            self._handle_api_error(e)
 
         outputs: Optional[List[WorkflowOutput]] = None
         fulfilled_output_names: Set[str] = set()
@@ -185,3 +207,15 @@ class SubworkflowDeploymentNode(BaseNode[StateType], Generic[StateType]):
                     name=output.name,
                     value=output.value,
                 )
+
+    def _handle_api_error(self, e: ApiError):
+        if e.status_code and e.status_code >= 400 and e.status_code < 500 and isinstance(e.body, dict):
+            raise NodeException(
+                message=e.body.get("detail", "Failed to execute Subworkflow Deployment"),
+                code=WorkflowErrorCode.INVALID_INPUTS,
+            ) from e
+
+        raise NodeException(
+            message="Failed to execute Subworkflow Deployment",
+            code=WorkflowErrorCode.INTERNAL_ERROR,
+        ) from e