vellum-ai 0.3.7__py3-none-any.whl → 0.3.9__py3-none-any.whl

vellum/types/subworkflow_node_result.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class SubworkflowNodeResult(pydantic.BaseModel):
+    """
+    A Node Result Event emitted from a Subworkflow Node.
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/terminal_node_array_result.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .array_variable_value_item import ArrayVariableValueItem
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class TerminalNodeArrayResult(pydantic.BaseModel):
+    id: typing.Optional[str]
+    name: str = pydantic.Field(description="The unique name given to the terminal node that produced this output.")
+    value: typing.Optional[typing.List[ArrayVariableValueItem]]
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/terminal_node_function_call_result.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .function_call import FunctionCall
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class TerminalNodeFunctionCallResult(pydantic.BaseModel):
+    id: typing.Optional[str]
+    name: str = pydantic.Field(description="The unique name given to the terminal node that produced this output.")
+    value: typing.Optional[FunctionCall]
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/terminal_node_result_output.py

@@ -6,8 +6,10 @@ import typing
 
 import typing_extensions
 
+from .terminal_node_array_result import TerminalNodeArrayResult
 from .terminal_node_chat_history_result import TerminalNodeChatHistoryResult
 from .terminal_node_error_result import TerminalNodeErrorResult
+from .terminal_node_function_call_result import TerminalNodeFunctionCallResult
 from .terminal_node_json_result import TerminalNodeJsonResult
 from .terminal_node_number_result import TerminalNodeNumberResult
 from .terminal_node_search_results_result import TerminalNodeSearchResultsResult
@@ -59,6 +61,24 @@ class TerminalNodeResultOutput_SearchResults(TerminalNodeSearchResultsResult):
         allow_population_by_field_name = True
 
 
+class TerminalNodeResultOutput_Array(TerminalNodeArrayResult):
+    type: typing_extensions.Literal["ARRAY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class TerminalNodeResultOutput_FunctionCall(TerminalNodeFunctionCallResult):
+    type: typing_extensions.Literal["FUNCTION_CALL"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
 class TerminalNodeResultOutput_Error(TerminalNodeErrorResult):
     type: typing_extensions.Literal["ERROR"]
 
@@ -74,5 +94,7 @@ TerminalNodeResultOutput = typing.Union[
     TerminalNodeResultOutput_Json,
     TerminalNodeResultOutput_ChatHistory,
     TerminalNodeResultOutput_SearchResults,
+    TerminalNodeResultOutput_Array,
+    TerminalNodeResultOutput_FunctionCall,
     TerminalNodeResultOutput_Error,
 ]

vellum/types/vellum_error_code_enum.py

@@ -11,17 +11,20 @@ class VellumErrorCodeEnum(str, enum.Enum):
     - `INVALID_REQUEST` - INVALID_REQUEST
     - `PROVIDER_ERROR` - PROVIDER_ERROR
     - `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
+    - `USER_DEFINED_ERROR` - USER_DEFINED_ERROR
     """
 
     INVALID_REQUEST = "INVALID_REQUEST"
     PROVIDER_ERROR = "PROVIDER_ERROR"
     INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR"
+    USER_DEFINED_ERROR = "USER_DEFINED_ERROR"
 
     def visit(
         self,
         invalid_request: typing.Callable[[], T_Result],
         provider_error: typing.Callable[[], T_Result],
         internal_server_error: typing.Callable[[], T_Result],
+        user_defined_error: typing.Callable[[], T_Result],
     ) -> T_Result:
         if self is VellumErrorCodeEnum.INVALID_REQUEST:
             return invalid_request()
@@ -29,3 +32,5 @@ class VellumErrorCodeEnum(str, enum.Enum):
             return provider_error()
         if self is VellumErrorCodeEnum.INTERNAL_SERVER_ERROR:
             return internal_server_error()
+        if self is VellumErrorCodeEnum.USER_DEFINED_ERROR:
+            return user_defined_error()

vellum/types/workflow_deployment_read.py

@@ -0,0 +1,57 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .entity_status import EntityStatus
+from .environment_enum import EnvironmentEnum
+from .vellum_variable import VellumVariable
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class WorkflowDeploymentRead(pydantic.BaseModel):
+    id: str
+    name: str = pydantic.Field(
+        description="A name that uniquely identifies this workflow deployment within its workspace"
+    )
+    label: str = pydantic.Field(description="A human-readable label for the workflow deployment")
+    status: typing.Optional[EntityStatus] = pydantic.Field(
+        description=(
+            "The current status of the workflow deployment\n" "\n" "- `ACTIVE` - Active\n" "- `ARCHIVED` - Archived\n"
+        )
+    )
+    environment: typing.Optional[EnvironmentEnum] = pydantic.Field(
+        description=(
+            "The environment this workflow deployment is used in\n"
+            "\n"
+            "- `DEVELOPMENT` - Development\n"
+            "- `STAGING` - Staging\n"
+            "- `PRODUCTION` - Production\n"
+        )
+    )
+    created: dt.datetime
+    last_deployed_on: dt.datetime
+    input_variables: typing.List[VellumVariable] = pydantic.Field(
+        description="The input variables this Workflow Deployment expects to receive values for when it is executed."
+    )
+    output_variables: typing.List[VellumVariable] = pydantic.Field(
+        description="The output variables this Workflow Deployment produces values for when it's executed."
+    )
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/workflow_execution_event_error_code.py

@@ -14,6 +14,7 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
     - `NODE_EXECUTION` - NODE_EXECUTION
     - `LLM_PROVIDER` - LLM_PROVIDER
     - `INVALID_TEMPLATE` - INVALID_TEMPLATE
+    - `USER_DEFINED_ERROR` - USER_DEFINED_ERROR
     """
 
     WORKFLOW_INITIALIZATION = "WORKFLOW_INITIALIZATION"
@@ -22,6 +23,7 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
     NODE_EXECUTION = "NODE_EXECUTION"
     LLM_PROVIDER = "LLM_PROVIDER"
     INVALID_TEMPLATE = "INVALID_TEMPLATE"
+    USER_DEFINED_ERROR = "USER_DEFINED_ERROR"
 
     def visit(
         self,
@@ -31,6 +33,7 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
         node_execution: typing.Callable[[], T_Result],
         llm_provider: typing.Callable[[], T_Result],
         invalid_template: typing.Callable[[], T_Result],
+        user_defined_error: typing.Callable[[], T_Result],
     ) -> T_Result:
         if self is WorkflowExecutionEventErrorCode.WORKFLOW_INITIALIZATION:
             return workflow_initialization()
@@ -44,3 +47,5 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
             return llm_provider()
         if self is WorkflowExecutionEventErrorCode.INVALID_TEMPLATE:
             return invalid_template()
+        if self is WorkflowExecutionEventErrorCode.USER_DEFINED_ERROR:
+            return user_defined_error()

vellum/types/workflow_node_result_data.py

@@ -11,6 +11,7 @@ from .code_execution_node_result import CodeExecutionNodeResult
 from .conditional_node_result import ConditionalNodeResult
 from .prompt_node_result import PromptNodeResult
 from .search_node_result import SearchNodeResult
+from .subworkflow_node_result import SubworkflowNodeResult
 from .templating_node_result import TemplatingNodeResult
 from .terminal_node_result import TerminalNodeResult
 
@@ -78,6 +79,15 @@ class WorkflowNodeResultData_Terminal(TerminalNodeResult):
         allow_population_by_field_name = True
 
 
+class WorkflowNodeResultData_Subworkflow(SubworkflowNodeResult):
+    type: typing_extensions.Literal["SUBWORKFLOW"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
 WorkflowNodeResultData = typing.Union[
     WorkflowNodeResultData_Prompt,
     WorkflowNodeResultData_Search,
@@ -86,4 +96,5 @@ WorkflowNodeResultData = typing.Union[
     WorkflowNodeResultData_Conditional,
     WorkflowNodeResultData_Api,
     WorkflowNodeResultData_Terminal,
+    WorkflowNodeResultData_Subworkflow,
 ]

vellum/types/workflow_output.py

@@ -6,6 +6,7 @@ import typing
 
 import typing_extensions
 
+from .workflow_output_array import WorkflowOutputArray
 from .workflow_output_chat_history import WorkflowOutputChatHistory
 from .workflow_output_error import WorkflowOutputError
 from .workflow_output_function_call import WorkflowOutputFunctionCall
@@ -61,6 +62,15 @@ class WorkflowOutput_SearchResults(WorkflowOutputSearchResults):
         allow_population_by_field_name = True
 
 
+class WorkflowOutput_Array(WorkflowOutputArray):
+    type: typing_extensions.Literal["ARRAY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
 class WorkflowOutput_Error(WorkflowOutputError):
     type: typing_extensions.Literal["ERROR"]
 
@@ -94,6 +104,7 @@ WorkflowOutput = typing.Union[
     WorkflowOutput_Json,
     WorkflowOutput_ChatHistory,
     WorkflowOutput_SearchResults,
+    WorkflowOutput_Array,
     WorkflowOutput_Error,
     WorkflowOutput_FunctionCall,
     WorkflowOutput_Image,

vellum/types/workflow_output_array.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .array_variable_value_item import ArrayVariableValueItem
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class WorkflowOutputArray(pydantic.BaseModel):
+    """
+    An array output from a Workflow execution.
+    """
+
+    id: str
+    name: str = pydantic.Field(description="The output's name, as defined in the workflow")
+    value: typing.List[ArrayVariableValueItem]
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/workflow_request_chat_history_input_request.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class WorkflowRequestChatHistoryInputRequest(pydantic.BaseModel):
+    """
+    The input for a chat history variable in a Workflow.
+    """
+
     name: str = pydantic.Field(description="The variable's name, as defined in the Workflow.")
     value: typing.List[ChatMessageRequest]
 

vellum/types/workflow_request_json_input_request.py

@@ -12,6 +12,10 @@ except ImportError:
 
 
 class WorkflowRequestJsonInputRequest(pydantic.BaseModel):
+    """
+    The input for a JSON variable in a Workflow.
+    """
+
     name: str = pydantic.Field(description="The variable's name, as defined in the Workflow.")
     value: typing.Dict[str, typing.Any]
 

vellum/types/workflow_request_number_input_request.py

@@ -12,6 +12,10 @@ except ImportError:
 
 
 class WorkflowRequestNumberInputRequest(pydantic.BaseModel):
+    """
+    The input for a number variable in a Workflow.
+    """
+
     name: str = pydantic.Field(description="The variable's name, as defined in the Workflow.")
     value: float
 

vellum/types/workflow_request_string_input_request.py

@@ -12,6 +12,10 @@ except ImportError:
 
 
 class WorkflowRequestStringInputRequest(pydantic.BaseModel):
+    """
+    The input for a string variable in a Workflow.
+    """
+
     name: str = pydantic.Field(description="The variable's name, as defined in the Workflow.")
     value: str
 

vellum/types/workflow_result_event_output_data.py

@@ -6,8 +6,10 @@ import typing
 
 import typing_extensions
 
+from .workflow_result_event_output_data_array import WorkflowResultEventOutputDataArray
 from .workflow_result_event_output_data_chat_history import WorkflowResultEventOutputDataChatHistory
 from .workflow_result_event_output_data_error import WorkflowResultEventOutputDataError
+from .workflow_result_event_output_data_function_call import WorkflowResultEventOutputDataFunctionCall
 from .workflow_result_event_output_data_json import WorkflowResultEventOutputDataJson
 from .workflow_result_event_output_data_number import WorkflowResultEventOutputDataNumber
 from .workflow_result_event_output_data_search_results import WorkflowResultEventOutputDataSearchResults
@@ -59,6 +61,24 @@ class WorkflowResultEventOutputData_SearchResults(WorkflowResultEventOutputDataS
         allow_population_by_field_name = True
 
 
+class WorkflowResultEventOutputData_Array(WorkflowResultEventOutputDataArray):
+    type: typing_extensions.Literal["ARRAY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class WorkflowResultEventOutputData_FunctionCall(WorkflowResultEventOutputDataFunctionCall):
+    type: typing_extensions.Literal["FUNCTION_CALL"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
 class WorkflowResultEventOutputData_Error(WorkflowResultEventOutputDataError):
     type: typing_extensions.Literal["ERROR"]
 
@@ -74,5 +94,7 @@ WorkflowResultEventOutputData = typing.Union[
     WorkflowResultEventOutputData_Json,
     WorkflowResultEventOutputData_ChatHistory,
     WorkflowResultEventOutputData_SearchResults,
+    WorkflowResultEventOutputData_Array,
+    WorkflowResultEventOutputData_FunctionCall,
     WorkflowResultEventOutputData_Error,
 ]

vellum/types/workflow_result_event_output_data_array.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .array_variable_value_item import ArrayVariableValueItem
+from .workflow_node_result_event_state import WorkflowNodeResultEventState
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class WorkflowResultEventOutputDataArray(pydantic.BaseModel):
+    """
+    An Array output returned from a Workflow execution.
+    """
+
+    id: typing.Optional[str]
+    name: str
+    state: WorkflowNodeResultEventState
+    node_id: str
+    delta: typing.Optional[str] = pydantic.Field(
+        description="The newly output string value. Only relevant for string outputs with a state of STREAMING."
+    )
+    value: typing.Optional[typing.List[ArrayVariableValueItem]]
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/workflow_result_event_output_data_function_call.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from .function_call import FunctionCall
+from .workflow_node_result_event_state import WorkflowNodeResultEventState
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class WorkflowResultEventOutputDataFunctionCall(pydantic.BaseModel):
+    """
+    A Function Call output returned from a Workflow execution.
+    """
+
+    id: typing.Optional[str]
+    name: str
+    state: WorkflowNodeResultEventState
+    node_id: str
+    delta: typing.Optional[str] = pydantic.Field(
+        description="The newly output string value. Only relevant for string outputs with a state of STREAMING."
+    )
+    value: typing.Optional[FunctionCall]
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        json_encoders = {dt.datetime: serialize_datetime}

{vellum_ai-0.3.7.dist-info → vellum_ai-0.3.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.3.7
+Version: 0.3.9
 Summary: 
 Requires-Python: >=3.7,<4.0
 Classifier: Programming Language :: Python :: 3