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

vellum/types/rejected_execute_workflow_workflow_result_event.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 .workflow_event_error import WorkflowEventError
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class RejectedExecuteWorkflowWorkflowResultEvent(pydantic.BaseModel):
+    """
+    The unsuccessful response from the Workflow execution containing an error specifying what went wrong.
+    """
+
+    id: str
+    ts: dt.datetime
+    error: WorkflowEventError
+
+    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/scenario_input_type_enum.py

@@ -8,8 +8,8 @@ T_Result = typing.TypeVar("T_Result")
 
 class ScenarioInputTypeEnum(str, enum.Enum):
     """
-    - `TEXT` - Text
-    - `CHAT_HISTORY` - Chat History
+    - `TEXT` - TEXT
+    - `CHAT_HISTORY` - CHAT_HISTORY
     """
 
     TEXT = "TEXT"

vellum/types/search_results_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing_extensions
+
+SearchResultsEnum = typing_extensions.Literal["SEARCH_RESULTS"]

vellum/types/search_results_variable_value.py

@@ -0,0 +1,29 @@
+# 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 SearchResultsVariableValue(pydantic.BaseModel):
+    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/slim_deployment_read.py

@@ -0,0 +1,48 @@
+# 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 SlimDeploymentRead(pydantic.BaseModel):
+    id: str
+    created: dt.datetime
+    label: str = pydantic.Field(description="A human-readable label for the deployment")
+    name: str = pydantic.Field(description="A name that uniquely identifies this deployment within its workspace")
+    status: typing.Optional[EntityStatus] = pydantic.Field(
+        description=("The current status of the deployment\n" "\n" "- `ACTIVE` - Active\n" "- `ARCHIVED` - Archived\n")
+    )
+    environment: typing.Optional[EnvironmentEnum] = pydantic.Field(
+        description=(
+            "The environment this deployment is used in\n"
+            "\n"
+            "- `DEVELOPMENT` - Development\n"
+            "- `STAGING` - Staging\n"
+            "- `PRODUCTION` - Production\n"
+        )
+    )
+    last_deployed_on: dt.datetime
+    input_variables: typing.List[VellumVariable]
+
+    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/slim_workflow_deployment.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 SlimWorkflowDeployment(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 will produce when it is 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/string_chat_message_content.py

@@ -0,0 +1,32 @@
+# 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 StringChatMessageContent(pydantic.BaseModel):
+    """
+    A string value that is used in a chat message.
+    """
+
+    value: 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/string_chat_message_content_request.py

@@ -0,0 +1,32 @@
+# 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 StringChatMessageContentRequest(pydantic.BaseModel):
+    """
+    A string value that is used in a chat message.
+    """
+
+    value: 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/string_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing_extensions
+
+StringEnum = typing_extensions.Literal["STRING"]

vellum/types/string_input_request.py

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

vellum/types/variable_value.py

@@ -0,0 +1,102 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import typing_extensions
+
+from .array_variable_value import ArrayVariableValue
+from .chat_history_variable_value import ChatHistoryVariableValue
+from .error_variable_value import ErrorVariableValue
+from .function_call_variable_value import FunctionCallVariableValue
+from .json_variable_value import JsonVariableValue
+from .number_variable_value import NumberVariableValue
+from .search_results_variable_value import SearchResultsVariableValue
+from .string_variable_value import StringVariableValue
+
+
+class VariableValue_String(StringVariableValue):
+    type: typing_extensions.Literal["STRING"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class VariableValue_Number(NumberVariableValue):
+    type: typing_extensions.Literal["NUMBER"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class VariableValue_Json(JsonVariableValue):
+    type: typing_extensions.Literal["JSON"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class VariableValue_ChatHistory(ChatHistoryVariableValue):
+    type: typing_extensions.Literal["CHAT_HISTORY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class VariableValue_SearchResults(SearchResultsVariableValue):
+    type: typing_extensions.Literal["SEARCH_RESULTS"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class VariableValue_Error(ErrorVariableValue):
+    type: typing_extensions.Literal["ERROR"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class VariableValue_Array(ArrayVariableValue):
+    type: typing_extensions.Literal["ARRAY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class VariableValue_FunctionCall(FunctionCallVariableValue):
+    type: typing_extensions.Literal["FUNCTION_CALL"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+VariableValue = typing.Union[
+    VariableValue_String,
+    VariableValue_Number,
+    VariableValue_Json,
+    VariableValue_ChatHistory,
+    VariableValue_SearchResults,
+    VariableValue_Error,
+    VariableValue_Array,
+    VariableValue_FunctionCall,
+]
+
+VariableValue_Array.update_forward_refs()

vellum/types/vellum_image.py

@@ -0,0 +1,29 @@
+# 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 VellumImage(pydantic.BaseModel):
+    src: str
+    metadata: 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/vellum_image_request.py

@@ -0,0 +1,29 @@
+# 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 VellumImageRequest(pydantic.BaseModel):
+    src: str
+    metadata: 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/vellum_variable_type.py

@@ -16,6 +16,7 @@ class VellumVariableType(str, enum.Enum):
     - `ERROR` - ERROR
     - `ARRAY` - ARRAY
     - `FUNCTION_CALL` - FUNCTION_CALL
+    - `IMAGE` - IMAGE
     """
 
     STRING = "STRING"
@@ -26,6 +27,7 @@ class VellumVariableType(str, enum.Enum):
     ERROR = "ERROR"
     ARRAY = "ARRAY"
     FUNCTION_CALL = "FUNCTION_CALL"
+    IMAGE = "IMAGE"
 
     def visit(
         self,
@@ -37,6 +39,7 @@ class VellumVariableType(str, enum.Enum):
         error: typing.Callable[[], T_Result],
         array: typing.Callable[[], T_Result],
         function_call: typing.Callable[[], T_Result],
+        image: typing.Callable[[], T_Result],
     ) -> T_Result:
         if self is VellumVariableType.STRING:
             return string()
@@ -54,3 +57,5 @@ class VellumVariableType(str, enum.Enum):
             return array()
         if self is VellumVariableType.FUNCTION_CALL:
             return function_call()
+        if self is VellumVariableType.IMAGE:
+            return image()

vellum/types/workflow_output.py

@@ -0,0 +1,111 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+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
+from .workflow_output_image import WorkflowOutputImage
+from .workflow_output_json import WorkflowOutputJson
+from .workflow_output_number import WorkflowOutputNumber
+from .workflow_output_search_results import WorkflowOutputSearchResults
+from .workflow_output_string import WorkflowOutputString
+
+
+class WorkflowOutput_String(WorkflowOutputString):
+    type: typing_extensions.Literal["STRING"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class WorkflowOutput_Number(WorkflowOutputNumber):
+    type: typing_extensions.Literal["NUMBER"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class WorkflowOutput_Json(WorkflowOutputJson):
+    type: typing_extensions.Literal["JSON"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class WorkflowOutput_ChatHistory(WorkflowOutputChatHistory):
+    type: typing_extensions.Literal["CHAT_HISTORY"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class WorkflowOutput_SearchResults(WorkflowOutputSearchResults):
+    type: typing_extensions.Literal["SEARCH_RESULTS"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class WorkflowOutput_Error(WorkflowOutputError):
+    type: typing_extensions.Literal["ERROR"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        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"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+class WorkflowOutput_Image(WorkflowOutputImage):
+    type: typing_extensions.Literal["IMAGE"]
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+
+
+WorkflowOutput = typing.Union[
+    WorkflowOutput_String,
+    WorkflowOutput_Number,
+    WorkflowOutput_Json,
+    WorkflowOutput_ChatHistory,
+    WorkflowOutput_SearchResults,
+    WorkflowOutput_Error,
+    WorkflowOutput_Array,
+    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 .variable_value import VariableValue
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class WorkflowOutputArray(pydantic.BaseModel):
+    """
+    An array of outputs from a Workflow execution.
+    """
+
+    id: str
+    name: str = pydantic.Field(description="The output's name, as defined in the workflow")
+    value: typing.List[VariableValue]
+
+    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_output_chat_history.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 .chat_message import ChatMessage
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class WorkflowOutputChatHistory(pydantic.BaseModel):
+    """
+    A chat history output from a Workflow execution.
+    """
+
+    id: str
+    name: str = pydantic.Field(description="The output's name, as defined in the workflow")
+    value: 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/workflow_output_error.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 .vellum_error import VellumError
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class WorkflowOutputError(pydantic.BaseModel):
+    """
+    An error output from a Workflow execution.
+    """
+
+    id: str
+    name: str = pydantic.Field(description="The output's name, as defined in the workflow")
+    value: 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}