vellum-ai 0.0.20__py3-none-any.whl → 0.0.25__py3-none-any.whl

vellum/types/slim_document.py

@@ -13,17 +13,15 @@ from .slim_document_status_enum import SlimDocumentStatusEnum
 
 
 class SlimDocument(pydantic.BaseModel):
-    id: str = pydantic.Field(description=("Vellum-generated ID that uniquely identifies this document.\n"))
+    id: str = pydantic.Field(description="Vellum-generated ID that uniquely identifies this document.")
     external_id: typing.Optional[str] = pydantic.Field(
-        description=("The external ID that was originally provided when uploading the document.\n")
+        description="The external ID that was originally provided when uploading the document."
     )
     last_uploaded_at: str = pydantic.Field(
-        description=("A timestamp representing when this document was most recently uploaded.\n")
+        description="A timestamp representing when this document was most recently uploaded."
     )
     label: str = pydantic.Field(
-        description=(
-            'Human-friendly name for this document. <span style="white-space: nowrap">`<= 1000 characters`</span> \n'
-        )
+        description='Human-friendly name for this document. <span style="white-space: nowrap">`<= 1000 characters`</span> '
     )
     processing_state: typing.Optional[ProcessingStateEnum] = pydantic.Field(
         description=(
@@ -46,9 +44,7 @@ class SlimDocument(pydantic.BaseModel):
         description=("The document's current status.\n" "\n" "* `ACTIVE` - Active\n")
     )
     keywords: typing.Optional[typing.List[str]] = pydantic.Field(
-        description=(
-            "A list of keywords associated with this document. Originally provided when uploading the document.\n"
-        )
+        description="A list of keywords associated with this document. Originally provided when uploading the document."
     )
     document_to_document_indexes: typing.List[DocumentDocumentToDocumentIndex]
 

vellum/types/submit_completion_actual_request.py

@@ -10,27 +10,17 @@ from ..core.datetime_utils import serialize_datetime
 
 class SubmitCompletionActualRequest(pydantic.BaseModel):
     id: typing.Optional[str] = pydantic.Field(
-        description=(
-            "The Vellum-generated ID of a previously generated completion. Must provide either this or external_id.\n"
-        )
+        description="The Vellum-generated ID of a previously generated completion. Must provide either this or external_id."
     )
     external_id: typing.Optional[str] = pydantic.Field(
-        description=(
-            "The external ID that was originally provided when generating the completion that you'd now like to submit actuals for. Must provide either this or id.\n"
-        )
-    )
-    text: typing.Optional[str] = pydantic.Field(
-        description=("Text representing what the completion _should_ have been.\n")
+        description="The external ID that was originally provided when generating the completion that you'd now like to submit actuals for. Must provide either this or id."
     )
+    text: typing.Optional[str] = pydantic.Field(description="Text representing what the completion _should_ have been.")
     quality: typing.Optional[float] = pydantic.Field(
-        description=(
-            "A number between 0 and 1 representing the quality of the completion. 0 is the worst, 1 is the best.\n"
-        )
+        description="A number between 0 and 1 representing the quality of the completion. 0 is the worst, 1 is the best."
     )
     timestamp: typing.Optional[str] = pydantic.Field(
-        description=(
-            "Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes.\n"
-        )
+        description="Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes."
     )
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/terminal_node_chat_history_result.py

@@ -10,7 +10,7 @@ from .chat_message import ChatMessage
 
 
 class TerminalNodeChatHistoryResult(pydantic.BaseModel):
-    name: str = pydantic.Field(description=("The unique name given to the terminal node that produced this output.\n"))
+    name: str = pydantic.Field(description="The unique name given to the terminal node that produced this output.")
     value: typing.List[ChatMessage]
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/terminal_node_json_result.py

@@ -9,7 +9,7 @@ from ..core.datetime_utils import serialize_datetime
 
 
 class TerminalNodeJsonResult(pydantic.BaseModel):
-    name: str = pydantic.Field(description=("The unique name given to the terminal node that produced this output.\n"))
+    name: str = pydantic.Field(description="The unique name given to the terminal node that produced this output.")
     value: typing.Dict[str, typing.Any]
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/terminal_node_result_output.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import typing
 
-import pydantic
 import typing_extensions
 
 from .terminal_node_chat_history_result import TerminalNodeChatHistoryResult
@@ -36,7 +35,6 @@ class TerminalNodeResultOutput_ChatHistory(TerminalNodeChatHistoryResult):
         allow_population_by_field_name = True
 
 
-TerminalNodeResultOutput = typing_extensions.Annotated[
-    typing.Union[TerminalNodeResultOutput_String, TerminalNodeResultOutput_Json, TerminalNodeResultOutput_ChatHistory],
-    pydantic.Field(discriminator="type"),
+TerminalNodeResultOutput = typing.Union[
+    TerminalNodeResultOutput_String, TerminalNodeResultOutput_Json, TerminalNodeResultOutput_ChatHistory
 ]

vellum/types/terminal_node_string_result.py

@@ -9,7 +9,7 @@ from ..core.datetime_utils import serialize_datetime
 
 
 class TerminalNodeStringResult(pydantic.BaseModel):
-    name: str = pydantic.Field(description=("The unique name given to the terminal node that produced this output.\n"))
+    name: str = pydantic.Field(description="The unique name given to the terminal node that produced this output.")
     value: str
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/test_suite_test_case.py

@@ -11,18 +11,14 @@ from .evaluation_params import EvaluationParams
 
 class TestSuiteTestCase(pydantic.BaseModel):
     test_case_id: typing.Optional[str] = pydantic.Field(
-        description=(
-            "The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended.\n"
-        )
+        description="The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended."
     )
-    label: typing.Optional[str] = pydantic.Field(description=("A human-friendly label for the test case.\n"))
+    label: typing.Optional[str] = pydantic.Field(description="A human-friendly label for the test case.")
     input_values: typing.Dict[str, typing.Any] = pydantic.Field(
-        description=("Key/value pairs for each input variable that the Test Suite expects.\n")
+        description="Key/value pairs for each input variable that the Test Suite expects."
     )
     evaluation_params: EvaluationParams = pydantic.Field(
-        description=(
-            "Parameters to use when evaluating the test case, specific to the test suite's evaluation metric.\n"
-        )
+        description="Parameters to use when evaluating the test case, specific to the test suite's evaluation metric."
     )
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/upload_document_response.py

@@ -9,7 +9,7 @@ from ..core.datetime_utils import serialize_datetime
 
 
 class UploadDocumentResponse(pydantic.BaseModel):
-    document_id: str = pydantic.Field(description=("The ID of the newly created document.\n"))
+    document_id: str = pydantic.Field(description="The ID of the newly created document.")
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/workflow_event_error.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .workflow_execution_event_error_code import WorkflowExecutionEventErrorCode
+
+
+class WorkflowEventError(pydantic.BaseModel):
+    message: str
+    code: WorkflowExecutionEventErrorCode
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/workflow_execution_event_error_code.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class WorkflowExecutionEventErrorCode(str, enum.Enum):
+    """
+    * `WORKFLOW_INITIALIZATION` - WORKFLOW_INITIALIZATION
+    * `NODE_EXECUTION` - NODE_EXECUTION
+    * `NODE_EXECUTION_COUNT_LIMIT_REACHED` - NODE_EXECUTION_COUNT_LIMIT_REACHED
+    """
+
+    WORKFLOW_INITIALIZATION = "WORKFLOW_INITIALIZATION"
+    NODE_EXECUTION = "NODE_EXECUTION"
+    NODE_EXECUTION_COUNT_LIMIT_REACHED = "NODE_EXECUTION_COUNT_LIMIT_REACHED"
+
+    def visit(
+        self,
+        workflow_initialization: typing.Callable[[], T_Result],
+        node_execution: typing.Callable[[], T_Result],
+        node_execution_count_limit_reached: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is WorkflowExecutionEventErrorCode.WORKFLOW_INITIALIZATION:
+            return workflow_initialization()
+        if self is WorkflowExecutionEventErrorCode.NODE_EXECUTION:
+            return node_execution()
+        if self is WorkflowExecutionEventErrorCode.NODE_EXECUTION_COUNT_LIMIT_REACHED:
+            return node_execution_count_limit_reached()

vellum/types/workflow_node_result_data.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import typing
 
-import pydantic
 import typing_extensions
 
 from .conditional_node_result import ConditionalNodeResult
@@ -63,14 +62,11 @@ class WorkflowNodeResultData_Terminal(TerminalNodeResult):
         allow_population_by_field_name = True
 
 
-WorkflowNodeResultData = typing_extensions.Annotated[
-    typing.Union[
-        WorkflowNodeResultData_Prompt,
-        WorkflowNodeResultData_Sandbox,
-        WorkflowNodeResultData_Deployment,
-        WorkflowNodeResultData_Search,
-        WorkflowNodeResultData_Conditional,
-        WorkflowNodeResultData_Terminal,
-    ],
-    pydantic.Field(discriminator="type"),
+WorkflowNodeResultData = typing.Union[
+    WorkflowNodeResultData_Prompt,
+    WorkflowNodeResultData_Sandbox,
+    WorkflowNodeResultData_Deployment,
+    WorkflowNodeResultData_Search,
+    WorkflowNodeResultData_Conditional,
+    WorkflowNodeResultData_Terminal,
 ]

vellum/types/workflow_node_result_event.py

@@ -6,18 +6,19 @@ import typing
 import pydantic
 
 from ..core.datetime_utils import serialize_datetime
+from .workflow_event_error import WorkflowEventError
 from .workflow_node_result_data import WorkflowNodeResultData
-from .workflow_node_result_event_state_enum import WorkflowNodeResultEventStateEnum
+from .workflow_node_result_event_state import WorkflowNodeResultEventState
 
 
 class WorkflowNodeResultEvent(pydantic.BaseModel):
     id: str
     node_id: str
     node_result_id: str
-    state: WorkflowNodeResultEventStateEnum
+    state: WorkflowNodeResultEventState
     ts: typing.Optional[str]
     data: typing.Optional[WorkflowNodeResultData]
-    error: typing.Optional[str]
+    error: typing.Optional[WorkflowEventError]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/{workflow_node_result_event_state_enum.py → workflow_node_result_event_state.py}

@@ -6,7 +6,7 @@ import typing
 T_Result = typing.TypeVar("T_Result")
 
 
-class WorkflowNodeResultEventStateEnum(str, enum.Enum):
+class WorkflowNodeResultEventState(str, enum.Enum):
     """
     * `INITIATED` - INITIATED
     * `STREAMING` - STREAMING
@@ -26,11 +26,11 @@ class WorkflowNodeResultEventStateEnum(str, enum.Enum):
         fulfilled: typing.Callable[[], T_Result],
         rejected: typing.Callable[[], T_Result],
     ) -> T_Result:
-        if self is WorkflowNodeResultEventStateEnum.INITIATED:
+        if self is WorkflowNodeResultEventState.INITIATED:
             return initiated()
-        if self is WorkflowNodeResultEventStateEnum.STREAMING:
+        if self is WorkflowNodeResultEventState.STREAMING:
             return streaming()
-        if self is WorkflowNodeResultEventStateEnum.FULFILLED:
+        if self is WorkflowNodeResultEventState.FULFILLED:
             return fulfilled()
-        if self is WorkflowNodeResultEventStateEnum.REJECTED:
+        if self is WorkflowNodeResultEventState.REJECTED:
             return rejected()

vellum/types/workflow_request_chat_history_input_request.py

@@ -11,9 +11,7 @@ from .chat_message_request import ChatMessageRequest
 
 class WorkflowRequestChatHistoryInputRequest(pydantic.BaseModel):
     name: str = pydantic.Field(
-        description=(
-            'The variable\'s name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> \n'
-        )
+        description='The variable\'s name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> '
     )
     value: typing.List[ChatMessageRequest]
 

vellum/types/workflow_request_input_request.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import typing
 
-import pydantic
 import typing_extensions
 
 from .workflow_request_chat_history_input_request import WorkflowRequestChatHistoryInputRequest
@@ -36,9 +35,6 @@ class WorkflowRequestInputRequest_ChatHistory(WorkflowRequestChatHistoryInputReq
         allow_population_by_field_name = True
 
 
-WorkflowRequestInputRequest = typing_extensions.Annotated[
-    typing.Union[
-        WorkflowRequestInputRequest_String, WorkflowRequestInputRequest_Json, WorkflowRequestInputRequest_ChatHistory
-    ],
-    pydantic.Field(discriminator="type"),
+WorkflowRequestInputRequest = typing.Union[
+    WorkflowRequestInputRequest_String, WorkflowRequestInputRequest_Json, WorkflowRequestInputRequest_ChatHistory
 ]

vellum/types/workflow_request_json_input_request.py

@@ -10,9 +10,7 @@ from ..core.datetime_utils import serialize_datetime
 
 class WorkflowRequestJsonInputRequest(pydantic.BaseModel):
     name: str = pydantic.Field(
-        description=(
-            'The variable\'s name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> \n'
-        )
+        description='The variable\'s name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> '
     )
     value: typing.Dict[str, typing.Any]
 

vellum/types/workflow_request_string_input_request.py

@@ -10,9 +10,7 @@ from ..core.datetime_utils import serialize_datetime
 
 class WorkflowRequestStringInputRequest(pydantic.BaseModel):
     name: str = pydantic.Field(
-        description=(
-            'The variable\'s name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> \n'
-        )
+        description='The variable\'s name, as defined in the Workflow. <span style="white-space: nowrap">`non-empty`</span> '
     )
     value: str
 

vellum/types/workflow_result_event.py

@@ -6,14 +6,17 @@ import typing
 import pydantic
 
 from ..core.datetime_utils import serialize_datetime
-from .workflow_result_event_state_enum import WorkflowResultEventStateEnum
+from .workflow_event_error import WorkflowEventError
+from .workflow_node_result_event_state import WorkflowNodeResultEventState
+from .workflow_result_event_output_data import WorkflowResultEventOutputData
 
 
 class WorkflowResultEvent(pydantic.BaseModel):
     id: str
-    state: WorkflowResultEventStateEnum
+    state: WorkflowNodeResultEventState
     ts: str
-    error: typing.Optional[str]
+    output: typing.Optional[WorkflowResultEventOutputData]
+    error: typing.Optional[WorkflowEventError]
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/workflow_result_event_output_data.py

@@ -0,0 +1,40 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+import typing
+
+import typing_extensions
+
+from .workflow_result_event_output_data_chat_history import WorkflowResultEventOutputDataChatHistory
+from .workflow_result_event_output_data_json import WorkflowResultEventOutputDataJson
+from .workflow_result_event_output_data_string import WorkflowResultEventOutputDataString
+
+
+class WorkflowResultEventOutputData_String(WorkflowResultEventOutputDataString):
+    type: typing_extensions.Literal["STRING"]
+
+    class Config:
+        frozen = True
+        allow_population_by_field_name = True
+
+
+class WorkflowResultEventOutputData_Json(WorkflowResultEventOutputDataJson):
+    type: typing_extensions.Literal["JSON"]
+
+    class Config:
+        frozen = True
+        allow_population_by_field_name = True
+
+
+class WorkflowResultEventOutputData_ChatHistory(WorkflowResultEventOutputDataChatHistory):
+    type: typing_extensions.Literal["CHAT_HISTORY"]
+
+    class Config:
+        frozen = True
+        allow_population_by_field_name = True
+
+
+WorkflowResultEventOutputData = typing.Union[
+    WorkflowResultEventOutputData_String, WorkflowResultEventOutputData_Json, WorkflowResultEventOutputData_ChatHistory
+]

vellum/types/workflow_result_event_output_data_chat_history.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .chat_message import ChatMessage
+from .workflow_node_result_event_state import WorkflowNodeResultEventState
+
+
+class WorkflowResultEventOutputDataChatHistory(pydantic.BaseModel):
+    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[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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/workflow_result_event_output_data_json.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .workflow_node_result_event_state import WorkflowNodeResultEventState
+
+
+class WorkflowResultEventOutputDataJson(pydantic.BaseModel):
+    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.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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/workflow_result_event_output_data_string.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .workflow_node_result_event_state import WorkflowNodeResultEventState
+
+
+class WorkflowResultEventOutputDataString(pydantic.BaseModel):
+    name: str
+    state: WorkflowNodeResultEventState
+    node_id: str
+    delta: typing.Optional[str] = pydantic.Field(
+        description="The newly output string value, meant to be concatenated with all previous. Will be non-null for events of state STREAMING."
+    )
+    value: typing.Optional[str] = pydantic.Field(
+        description="The entire string value. Will be non-null for events of state FULFILLED."
+    )
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/workflow_stream_event.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import typing
 
-import pydantic
 import typing_extensions
 
 from .workflow_execution_node_result_event import WorkflowExecutionNodeResultEvent
@@ -27,6 +26,4 @@ class WorkflowStreamEvent_Node(WorkflowExecutionNodeResultEvent):
         allow_population_by_field_name = True
 
 
-WorkflowStreamEvent = typing_extensions.Annotated[
-    typing.Union[WorkflowStreamEvent_Workflow, WorkflowStreamEvent_Node], pydantic.Field(discriminator="type")
-]
+WorkflowStreamEvent = typing.Union[WorkflowStreamEvent_Workflow, WorkflowStreamEvent_Node]

{vellum_ai-0.0.20.dist-info → vellum_ai-0.0.25.dist-info}/METADATA

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