vellum-ai 0.3.10__py3-none-any.whl → 0.3.12__py3-none-any.whl

vellum/types/array_variable_value_item.py

@@ -9,6 +9,7 @@ import typing_extensions
 from .chat_history_variable_value import ChatHistoryVariableValue
 from .error_variable_value import ErrorVariableValue
 from .function_call_variable_value import FunctionCallVariableValue
+from .image_variable_value import ImageVariableValue
 from .json_variable_value import JsonVariableValue
 from .number_variable_value import NumberVariableValue
 from .search_results_variable_value import SearchResultsVariableValue
@@ -78,6 +79,15 @@ class ArrayVariableValueItem_FunctionCall(FunctionCallVariableValue):
         allow_population_by_field_name = True
 
 
+class ArrayVariableValueItem_Image(ImageVariableValue):
+    type: typing_extensions.Literal["IMAGE"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
 ArrayVariableValueItem = typing.Union[
     ArrayVariableValueItem_String,
     ArrayVariableValueItem_Number,
@@ -86,4 +96,5 @@ ArrayVariableValueItem = typing.Union[
     ArrayVariableValueItem_SearchResults,
     ArrayVariableValueItem_Error,
     ArrayVariableValueItem_FunctionCall,
+    ArrayVariableValueItem_Image,
 ]

vellum/types/chat_message.py

@@ -17,6 +17,9 @@ class ChatMessage(pydantic.BaseModel):
     text: typing.Optional[str]
     role: ChatMessageRole
     content: typing.Optional[ChatMessageContent]
+    source: typing.Optional[str] = pydantic.Field(
+        description="An optional identifier representing who or what generated this message."
+    )
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/chat_message_request.py

@@ -17,6 +17,9 @@ class ChatMessageRequest(pydantic.BaseModel):
     text: typing.Optional[str]
     role: ChatMessageRole
     content: typing.Optional[ChatMessageContentRequest]
+    source: typing.Optional[str] = pydantic.Field(
+        description="An optional identifier representing who or what generated this message."
+    )
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/execution_array_vellum_value.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 ExecutionArrayVellumValue(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    name: str
+    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/execution_chat_history_vellum_value.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 .chat_message import ChatMessage
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class ExecutionChatHistoryVellumValue(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    name: str
+    value: typing.Optional[typing.List[ChatMessage]]
+
+    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/execution_error_vellum_value.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 .vellum_error import VellumError
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class ExecutionErrorVellumValue(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    name: str
+    value: typing.Optional[VellumError]
+
+    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/execution_function_call_vellum_value.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 ExecutionFunctionCallVellumValue(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    name: str
+    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/execution_json_vellum_value.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 ExecutionJsonVellumValue(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    name: str
+    value: typing.Optional[typing.Dict[str, typing.Any]]
+
+    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/execution_number_vellum_value.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 ExecutionNumberVellumValue(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    name: str
+    value: typing.Optional[float]
+
+    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/execution_search_results_vellum_value.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 .search_result import SearchResult
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class ExecutionSearchResultsVellumValue(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    name: str
+    value: typing.Optional[typing.List[SearchResult]]
+
+    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/execution_string_vellum_value.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 ExecutionStringVellumValue(pydantic.BaseModel):
+    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    name: str
+    value: typing.Optional[str]
+
+    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/execution_vellum_value.py

@@ -0,0 +1,100 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import typing_extensions
+
+from .execution_array_vellum_value import ExecutionArrayVellumValue
+from .execution_chat_history_vellum_value import ExecutionChatHistoryVellumValue
+from .execution_error_vellum_value import ExecutionErrorVellumValue
+from .execution_function_call_vellum_value import ExecutionFunctionCallVellumValue
+from .execution_json_vellum_value import ExecutionJsonVellumValue
+from .execution_number_vellum_value import ExecutionNumberVellumValue
+from .execution_search_results_vellum_value import ExecutionSearchResultsVellumValue
+from .execution_string_vellum_value import ExecutionStringVellumValue
+
+
+class ExecutionVellumValue_String(ExecutionStringVellumValue):
+    type: typing_extensions.Literal["STRING"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class ExecutionVellumValue_Number(ExecutionNumberVellumValue):
+    type: typing_extensions.Literal["NUMBER"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class ExecutionVellumValue_Json(ExecutionJsonVellumValue):
+    type: typing_extensions.Literal["JSON"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class ExecutionVellumValue_ChatHistory(ExecutionChatHistoryVellumValue):
+    type: typing_extensions.Literal["CHAT_HISTORY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class ExecutionVellumValue_SearchResults(ExecutionSearchResultsVellumValue):
+    type: typing_extensions.Literal["SEARCH_RESULTS"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class ExecutionVellumValue_Error(ExecutionErrorVellumValue):
+    type: typing_extensions.Literal["ERROR"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class ExecutionVellumValue_Array(ExecutionArrayVellumValue):
+    type: typing_extensions.Literal["ARRAY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class ExecutionVellumValue_FunctionCall(ExecutionFunctionCallVellumValue):
+    type: typing_extensions.Literal["FUNCTION_CALL"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+ExecutionVellumValue = typing.Union[
+    ExecutionVellumValue_String,
+    ExecutionVellumValue_Number,
+    ExecutionVellumValue_Json,
+    ExecutionVellumValue_ChatHistory,
+    ExecutionVellumValue_SearchResults,
+    ExecutionVellumValue_Error,
+    ExecutionVellumValue_Array,
+    ExecutionVellumValue_FunctionCall,
+]

vellum/types/fulfilled_workflow_node_result_event.py

@@ -23,7 +23,9 @@ class FulfilledWorkflowNodeResultEvent(pydantic.BaseModel):
     node_result_id: str
     ts: typing.Optional[dt.datetime]
     data: typing.Optional[WorkflowNodeResultData]
+    source_execution_id: typing.Optional[str]
     output_values: typing.Optional[typing.List[NodeOutputCompiledValue]]
+    mocked: typing.Optional[bool]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/generate_request.py

@@ -17,7 +17,7 @@ class GenerateRequest(pydantic.BaseModel):
         description="Key/value pairs for each template variable defined in the deployment's prompt."
     )
     chat_history: typing.Optional[typing.List[ChatMessageRequest]] = pydantic.Field(
-        description="Optionally provide a list of chat messages that'll be used in place of the special {$chat_history} variable, if included in the prompt."
+        description="Optionally provide a list of chat messages that'll be used in place of the special chat_history variable, if included in the prompt."
     )
     external_ids: typing.Optional[typing.List[str]] = pydantic.Field(
         description="Optionally include a unique identifier for each generation, as represented outside of Vellum. Note that this should generally be a list of length one."

vellum/types/image_variable_value.py

@@ -0,0 +1,33 @@
+# 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 .vellum_image import VellumImage
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class ImageVariableValue(pydantic.BaseModel):
+    """
+    A base Vellum primitive value representing an image.
+    """
+
+    value: typing.Optional[VellumImage]
+
+    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/initiated_workflow_node_result_event.py

@@ -23,6 +23,7 @@ class InitiatedWorkflowNodeResultEvent(pydantic.BaseModel):
     node_result_id: str
     ts: typing.Optional[dt.datetime]
     data: typing.Optional[WorkflowNodeResultData]
+    source_execution_id: typing.Optional[str]
     input_values: typing.Optional[typing.List[NodeInputVariableCompiledValue]]
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/prompt_template_block_properties.py

@@ -18,6 +18,7 @@ except ImportError:
 class PromptTemplateBlockProperties(pydantic.BaseModel):
     chat_role: typing.Optional[ChatMessageRole]
     chat_message_unterminated: typing.Optional[bool]
+    chat_source: typing.Optional[str]
     template: typing.Optional[str]
     template_type: typing.Optional[VellumVariableType]
     function_name: typing.Optional[str]

vellum/types/prompt_template_block_properties_request.py

@@ -18,6 +18,7 @@ except ImportError:
 class PromptTemplateBlockPropertiesRequest(pydantic.BaseModel):
     chat_role: typing.Optional[ChatMessageRole]
     chat_message_unterminated: typing.Optional[bool]
+    chat_source: typing.Optional[str]
     template: typing.Optional[str]
     template_type: typing.Optional[VellumVariableType]
     function_name: typing.Optional[str]

vellum/types/rejected_workflow_node_result_event.py

@@ -23,6 +23,7 @@ class RejectedWorkflowNodeResultEvent(pydantic.BaseModel):
     node_result_id: str
     ts: typing.Optional[dt.datetime]
     data: typing.Optional[WorkflowNodeResultData]
+    source_execution_id: typing.Optional[str]
     error: WorkflowEventError
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/streaming_workflow_node_result_event.py

@@ -23,6 +23,7 @@ class StreamingWorkflowNodeResultEvent(pydantic.BaseModel):
     node_result_id: str
     ts: typing.Optional[dt.datetime]
     data: typing.Optional[WorkflowNodeResultData]
+    source_execution_id: typing.Optional[str]
     output: typing.Optional[NodeOutputCompiledValue]
     output_index: typing.Optional[int]
 

vellum/types/workflow_execution_event_error_code.py

@@ -9,6 +9,7 @@ T_Result = typing.TypeVar("T_Result")
 class WorkflowExecutionEventErrorCode(str, enum.Enum):
     """
     - `WORKFLOW_INITIALIZATION` - WORKFLOW_INITIALIZATION
+    - `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED
     - `NODE_EXECUTION_COUNT_LIMIT_REACHED` - NODE_EXECUTION_COUNT_LIMIT_REACHED
     - `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
     - `NODE_EXECUTION` - NODE_EXECUTION
@@ -18,6 +19,7 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
     """
 
     WORKFLOW_INITIALIZATION = "WORKFLOW_INITIALIZATION"
+    WORKFLOW_CANCELLED = "WORKFLOW_CANCELLED"
     NODE_EXECUTION_COUNT_LIMIT_REACHED = "NODE_EXECUTION_COUNT_LIMIT_REACHED"
     INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR"
     NODE_EXECUTION = "NODE_EXECUTION"
@@ -28,6 +30,7 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
     def visit(
         self,
         workflow_initialization: typing.Callable[[], T_Result],
+        workflow_cancelled: typing.Callable[[], T_Result],
         node_execution_count_limit_reached: typing.Callable[[], T_Result],
         internal_server_error: typing.Callable[[], T_Result],
         node_execution: typing.Callable[[], T_Result],
@@ -37,6 +40,8 @@ class WorkflowExecutionEventErrorCode(str, enum.Enum):
     ) -> T_Result:
         if self is WorkflowExecutionEventErrorCode.WORKFLOW_INITIALIZATION:
             return workflow_initialization()
+        if self is WorkflowExecutionEventErrorCode.WORKFLOW_CANCELLED:
+            return workflow_cancelled()
         if self is WorkflowExecutionEventErrorCode.NODE_EXECUTION_COUNT_LIMIT_REACHED:
             return node_execution_count_limit_reached()
         if self is WorkflowExecutionEventErrorCode.INTERNAL_SERVER_ERROR:

vellum/types/workflow_execution_event_type.py

@@ -8,8 +8,8 @@ T_Result = typing.TypeVar("T_Result")
 
 class WorkflowExecutionEventType(str, enum.Enum):
     """
-    - `NODE` - Node
-    - `WORKFLOW` - Workflow
+    - `NODE` - NODE
+    - `WORKFLOW` - WORKFLOW
     """
 
     NODE = "NODE"

vellum/types/workflow_result_event.py

@@ -4,6 +4,7 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from .execution_vellum_value import ExecutionVellumValue
 from .workflow_event_error import WorkflowEventError
 from .workflow_node_result_event_state import WorkflowNodeResultEventState
 from .workflow_output import WorkflowOutput
@@ -22,6 +23,7 @@ class WorkflowResultEvent(pydantic.BaseModel):
     output: typing.Optional[WorkflowResultEventOutputData]
     error: typing.Optional[WorkflowEventError]
     outputs: typing.Optional[typing.List[WorkflowOutput]]
+    inputs: typing.Optional[typing.List[ExecutionVellumValue]]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

{vellum_ai-0.3.10.dist-info → vellum_ai-0.3.12.dist-info}/METADATA

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