vellum-ai 0.2.1__py3-none-any.whl → 0.3.2__py3-none-any.whl

vellum/types/node_output_compiled_value.py

@@ -0,0 +1,78 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import typing_extensions
+
+from .node_output_compiled_chat_history_value import NodeOutputCompiledChatHistoryValue
+from .node_output_compiled_error_value import NodeOutputCompiledErrorValue
+from .node_output_compiled_json_value import NodeOutputCompiledJsonValue
+from .node_output_compiled_number_value import NodeOutputCompiledNumberValue
+from .node_output_compiled_search_results_value import NodeOutputCompiledSearchResultsValue
+from .node_output_compiled_string_value import NodeOutputCompiledStringValue
+
+
+class NodeOutputCompiledValue_String(NodeOutputCompiledStringValue):
+    type: typing_extensions.Literal["STRING"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class NodeOutputCompiledValue_Number(NodeOutputCompiledNumberValue):
+    type: typing_extensions.Literal["NUMBER"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class NodeOutputCompiledValue_Json(NodeOutputCompiledJsonValue):
+    type: typing_extensions.Literal["JSON"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class NodeOutputCompiledValue_ChatHistory(NodeOutputCompiledChatHistoryValue):
+    type: typing_extensions.Literal["CHAT_HISTORY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class NodeOutputCompiledValue_SearchResults(NodeOutputCompiledSearchResultsValue):
+    type: typing_extensions.Literal["SEARCH_RESULTS"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class NodeOutputCompiledValue_Error(NodeOutputCompiledErrorValue):
+    type: typing_extensions.Literal["ERROR"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+NodeOutputCompiledValue = typing.Union[
+    NodeOutputCompiledValue_String,
+    NodeOutputCompiledValue_Number,
+    NodeOutputCompiledValue_Json,
+    NodeOutputCompiledValue_ChatHistory,
+    NodeOutputCompiledValue_SearchResults,
+    NodeOutputCompiledValue_Error,
+]

vellum/types/prompt_node_result.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class PromptNodeResult(pydantic.BaseModel):
+    """
+    A Node Result Event emitted from a Prompt Node.
+    """
+
     data: PromptNodeResultData
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/{workflow_output_array.py → rejected_workflow_node_result_event.py}

@@ -4,7 +4,8 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
-from .variable_value import VariableValue
+from .workflow_event_error import WorkflowEventError
+from .workflow_node_result_data import WorkflowNodeResultData
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -12,14 +13,17 @@ except ImportError:
     import pydantic  # type: ignore
 
 
-class WorkflowOutputArray(pydantic.BaseModel):
+class RejectedWorkflowNodeResultEvent(pydantic.BaseModel):
     """
-    An array of outputs from a Workflow execution.
+    An event that indicates that the node has rejected its execution.
     """
 
     id: str
-    name: str = pydantic.Field(description="The output's name, as defined in the workflow")
-    value: typing.List[VariableValue]
+    node_id: str
+    node_result_id: str
+    ts: typing.Optional[dt.datetime]
+    data: typing.Optional[WorkflowNodeResultData]
+    error: WorkflowEventError
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/sandbox_scenario.py

@@ -4,7 +4,6 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
-from .sandbox_metric_input_params import SandboxMetricInputParams
 from .scenario_input import ScenarioInput
 
 try:
@@ -17,7 +16,6 @@ class SandboxScenario(pydantic.BaseModel):
     label: typing.Optional[str]
     inputs: typing.List[ScenarioInput] = pydantic.Field(description="The inputs for the scenario")
     id: str = pydantic.Field(description="The id of the scenario")
-    metric_input_params: SandboxMetricInputParams
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/search_node_result.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class SearchNodeResult(pydantic.BaseModel):
+    """
+    A Node Result Event emitted from a Search Node.
+    """
+
     data: SearchNodeResultData
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/{evaluation_params.py → streaming_workflow_node_result_event.py}

@@ -4,6 +4,8 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from .node_output_compiled_value import NodeOutputCompiledValue
+from .workflow_node_result_data import WorkflowNodeResultData
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -11,10 +13,18 @@ except ImportError:
     import pydantic  # type: ignore
 
 
-class EvaluationParams(pydantic.BaseModel):
-    target: typing.Optional[str] = pydantic.Field(
-        description="The target value to compare the LLM output against. Typically what you expect or desire the LLM output to be."
-    )
+class StreamingWorkflowNodeResultEvent(pydantic.BaseModel):
+    """
+    An event that indicates that the node has execution is in progress.
+    """
+
+    id: str
+    node_id: str
+    node_result_id: str
+    ts: typing.Optional[dt.datetime]
+    data: typing.Optional[WorkflowNodeResultData]
+    output: typing.Optional[NodeOutputCompiledValue]
+    output_index: typing.Optional[int]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/templating_node_result.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class TemplatingNodeResult(pydantic.BaseModel):
+    """
+    A Node Result Event emitted from a Templating Node.
+    """
+
     data: TemplatingNodeResultData
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/terminal_node_result.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class TerminalNodeResult(pydantic.BaseModel):
+    """
+    A Node Result Event emitted from a Terminal Node.
+    """
+
     data: TerminalNodeResultData
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/workflow_execution_node_result_event.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class WorkflowExecutionNodeResultEvent(pydantic.BaseModel):
+    """
+    A NODE-level event emitted from the workflow's execution.
+    """
+
     execution_id: str
     run_id: typing.Optional[str]
     external_id: typing.Optional[str]

vellum/types/workflow_execution_workflow_result_event.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class WorkflowExecutionWorkflowResultEvent(pydantic.BaseModel):
+    """
+    A WORKFLOW-level event emitted from the workflow's execution.
+    """
+
     execution_id: str
     run_id: typing.Optional[str]
     external_id: typing.Optional[str]

vellum/types/workflow_node_result_event.py

@@ -1,39 +1,56 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
+from __future__ import annotations
+
 import typing
 
-from ..core.datetime_utils import serialize_datetime
-from .node_input_variable_compiled_value import NodeInputVariableCompiledValue
-from .workflow_event_error import WorkflowEventError
-from .workflow_node_result_data import WorkflowNodeResultData
-from .workflow_node_result_event_state import WorkflowNodeResultEventState
+import typing_extensions
+
+from .fulfilled_workflow_node_result_event import FulfilledWorkflowNodeResultEvent
+from .initiated_workflow_node_result_event import InitiatedWorkflowNodeResultEvent
+from .rejected_workflow_node_result_event import RejectedWorkflowNodeResultEvent
+from .streaming_workflow_node_result_event import StreamingWorkflowNodeResultEvent
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
+class WorkflowNodeResultEvent_Initiated(InitiatedWorkflowNodeResultEvent):
+    state: typing_extensions.Literal["INITIATED"]
 
-class WorkflowNodeResultEvent(pydantic.BaseModel):
-    id: str
-    node_id: str
-    node_result_id: str
-    state: WorkflowNodeResultEventState
-    ts: typing.Optional[dt.datetime]
-    data: typing.Optional[WorkflowNodeResultData]
-    error: typing.Optional[WorkflowEventError]
-    input_values: typing.Optional[typing.List[NodeInputVariableCompiledValue]]
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
 
-    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 WorkflowNodeResultEvent_Streaming(StreamingWorkflowNodeResultEvent):
+    state: typing_extensions.Literal["STREAMING"]
 
     class Config:
         frozen = True
         smart_union = True
-        json_encoders = {dt.datetime: serialize_datetime}
+        allow_population_by_field_name = True
+
+
+class WorkflowNodeResultEvent_Fulfilled(FulfilledWorkflowNodeResultEvent):
+    state: typing_extensions.Literal["FULFILLED"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class WorkflowNodeResultEvent_Rejected(RejectedWorkflowNodeResultEvent):
+    state: typing_extensions.Literal["REJECTED"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+WorkflowNodeResultEvent = typing.Union[
+    WorkflowNodeResultEvent_Initiated,
+    WorkflowNodeResultEvent_Streaming,
+    WorkflowNodeResultEvent_Fulfilled,
+    WorkflowNodeResultEvent_Rejected,
+]

vellum/types/workflow_output.py

@@ -6,7 +6,6 @@ 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
@@ -71,15 +70,6 @@ class WorkflowOutput_Error(WorkflowOutputError):
         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_FunctionCall(WorkflowOutputFunctionCall):
     type: typing_extensions.Literal["FUNCTION_CALL"]
 
@@ -105,7 +95,6 @@ WorkflowOutput = typing.Union[
     WorkflowOutput_ChatHistory,
     WorkflowOutput_SearchResults,
     WorkflowOutput_Error,
-    WorkflowOutput_Array,
     WorkflowOutput_FunctionCall,
     WorkflowOutput_Image,
 ]

vellum/types/workflow_result_event_output_data_chat_history.py

@@ -14,6 +14,10 @@ except ImportError:
 
 
 class WorkflowResultEventOutputDataChatHistory(pydantic.BaseModel):
+    """
+    A Chat History output streamed from a Workflow execution.
+    """
+
     id: typing.Optional[str]
     name: str
     state: WorkflowNodeResultEventState

vellum/types/workflow_result_event_output_data_error.py

@@ -14,6 +14,10 @@ except ImportError:
 
 
 class WorkflowResultEventOutputDataError(pydantic.BaseModel):
+    """
+    An Error output streamed from a Workflow execution.
+    """
+
     id: typing.Optional[str]
     name: str
     state: WorkflowNodeResultEventState

vellum/types/workflow_result_event_output_data_json.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class WorkflowResultEventOutputDataJson(pydantic.BaseModel):
+    """
+    A JSON output streamed from a Workflow execution.
+    """
+
     id: typing.Optional[str]
     name: str
     state: WorkflowNodeResultEventState

vellum/types/workflow_result_event_output_data_number.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class WorkflowResultEventOutputDataNumber(pydantic.BaseModel):
+    """
+    A number output streamed from a Workflow execution.
+    """
+
     id: typing.Optional[str]
     name: str
     state: WorkflowNodeResultEventState

vellum/types/workflow_result_event_output_data_search_results.py

@@ -14,6 +14,10 @@ except ImportError:
 
 
 class WorkflowResultEventOutputDataSearchResults(pydantic.BaseModel):
+    """
+    A Search Results output streamed from a Workflow execution.
+    """
+
     id: typing.Optional[str]
     name: str
     state: WorkflowNodeResultEventState

vellum/types/workflow_result_event_output_data_string.py

@@ -13,6 +13,10 @@ except ImportError:
 
 
 class WorkflowResultEventOutputDataString(pydantic.BaseModel):
+    """
+    A string output streamed from a Workflow execution.
+    """
+
     id: typing.Optional[str]
     name: str
     state: WorkflowNodeResultEventState

{vellum_ai-0.2.1.dist-info → vellum_ai-0.3.2.dist-info}/METADATA

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