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

vellum/__init__.py

@@ -13,9 +13,19 @@ from .types import (
     ArrayChatMessageContentItem_Image,
     ArrayChatMessageContentItem_String,
     ArrayChatMessageContentRequest,
+    ArrayEnum,
+    ArrayVariableValueItem,
+    ArrayVariableValueItem_ChatHistory,
+    ArrayVariableValueItem_Error,
+    ArrayVariableValueItem_FunctionCall,
+    ArrayVariableValueItem_Json,
+    ArrayVariableValueItem_Number,
+    ArrayVariableValueItem_SearchResults,
+    ArrayVariableValueItem_String,
     BlockTypeEnum,
     ChatHistoryEnum,
     ChatHistoryInputRequest,
+    ChatHistoryVariableValue,
     ChatMessage,
     ChatMessageContent,
     ChatMessageContentRequest,
@@ -134,6 +144,7 @@ from .types import (
     NamedTestCaseVariableValueRequest_Number,
     NamedTestCaseVariableValueRequest_SearchResults,
     NamedTestCaseVariableValueRequest_String,
+    NodeInputCompiledArrayValue,
     NodeInputCompiledChatHistoryValue,
     NodeInputCompiledErrorValue,
     NodeInputCompiledJsonValue,
@@ -141,21 +152,26 @@ from .types import (
     NodeInputCompiledSearchResultsValue,
     NodeInputCompiledStringValue,
     NodeInputVariableCompiledValue,
+    NodeInputVariableCompiledValue_Array,
     NodeInputVariableCompiledValue_ChatHistory,
     NodeInputVariableCompiledValue_Error,
     NodeInputVariableCompiledValue_Json,
     NodeInputVariableCompiledValue_Number,
     NodeInputVariableCompiledValue_SearchResults,
     NodeInputVariableCompiledValue_String,
+    NodeOutputCompiledArrayValue,
     NodeOutputCompiledChatHistoryValue,
     NodeOutputCompiledErrorValue,
+    NodeOutputCompiledFunctionValue,
     NodeOutputCompiledJsonValue,
     NodeOutputCompiledNumberValue,
     NodeOutputCompiledSearchResultsValue,
     NodeOutputCompiledStringValue,
     NodeOutputCompiledValue,
+    NodeOutputCompiledValue_Array,
     NodeOutputCompiledValue_ChatHistory,
     NodeOutputCompiledValue_Error,
+    NodeOutputCompiledValue_FunctionCall,
     NodeOutputCompiledValue_Json,
     NodeOutputCompiledValue_Number,
     NodeOutputCompiledValue_SearchResults,
@@ -163,6 +179,7 @@ from .types import (
     NormalizedLogProbs,
     NormalizedTokenLogProbs,
     NumberEnum,
+    NumberVariableValue,
     PaginatedSlimDeploymentReadList,
     PaginatedSlimDocumentList,
     PaginatedSlimWorkflowDeploymentList,
@@ -222,6 +239,7 @@ from .types import (
     SearchResultMergingRequest,
     SearchResultRequest,
     SearchResultsEnum,
+    SearchResultsVariableValue,
     SearchWeightsRequest,
     SlimDeploymentRead,
     SlimDocument,
@@ -241,6 +259,8 @@ from .types import (
     SubmitWorkflowExecutionActualRequest_ChatHistory,
     SubmitWorkflowExecutionActualRequest_Json,
     SubmitWorkflowExecutionActualRequest_String,
+    SubworkflowEnum,
+    SubworkflowNodeResult,
     TemplatingNodeChatHistoryResult,
     TemplatingNodeErrorResult,
     TemplatingNodeJsonResult,
@@ -256,15 +276,19 @@ from .types import (
     TemplatingNodeResultOutput_String,
     TemplatingNodeSearchResultsResult,
     TemplatingNodeStringResult,
+    TerminalNodeArrayResult,
     TerminalNodeChatHistoryResult,
     TerminalNodeErrorResult,
+    TerminalNodeFunctionCallResult,
     TerminalNodeJsonResult,
     TerminalNodeNumberResult,
     TerminalNodeResult,
     TerminalNodeResultData,
     TerminalNodeResultOutput,
+    TerminalNodeResultOutput_Array,
     TerminalNodeResultOutput_ChatHistory,
     TerminalNodeResultOutput_Error,
+    TerminalNodeResultOutput_FunctionCall,
     TerminalNodeResultOutput_Json,
     TerminalNodeResultOutput_Number,
     TerminalNodeResultOutput_SearchResults,
@@ -294,6 +318,7 @@ from .types import (
     VellumImageRequest,
     VellumVariable,
     VellumVariableType,
+    WorkflowDeploymentRead,
     WorkflowEventError,
     WorkflowExecutionActualChatHistoryRequest,
     WorkflowExecutionActualJsonRequest,
@@ -308,6 +333,7 @@ from .types import (
     WorkflowNodeResultData_Conditional,
     WorkflowNodeResultData_Prompt,
     WorkflowNodeResultData_Search,
+    WorkflowNodeResultData_Subworkflow,
     WorkflowNodeResultData_Templating,
     WorkflowNodeResultData_Terminal,
     WorkflowNodeResultEvent,
@@ -317,6 +343,7 @@ from .types import (
     WorkflowNodeResultEvent_Rejected,
     WorkflowNodeResultEvent_Streaming,
     WorkflowOutput,
+    WorkflowOutputArray,
     WorkflowOutputChatHistory,
     WorkflowOutputError,
     WorkflowOutputFunctionCall,
@@ -325,6 +352,7 @@ from .types import (
     WorkflowOutputNumber,
     WorkflowOutputSearchResults,
     WorkflowOutputString,
+    WorkflowOutput_Array,
     WorkflowOutput_ChatHistory,
     WorkflowOutput_Error,
     WorkflowOutput_FunctionCall,
@@ -344,14 +372,18 @@ from .types import (
     WorkflowRequestStringInputRequest,
     WorkflowResultEvent,
     WorkflowResultEventOutputData,
+    WorkflowResultEventOutputDataArray,
     WorkflowResultEventOutputDataChatHistory,
     WorkflowResultEventOutputDataError,
+    WorkflowResultEventOutputDataFunctionCall,
     WorkflowResultEventOutputDataJson,
     WorkflowResultEventOutputDataNumber,
     WorkflowResultEventOutputDataSearchResults,
     WorkflowResultEventOutputDataString,
+    WorkflowResultEventOutputData_Array,
     WorkflowResultEventOutputData_ChatHistory,
     WorkflowResultEventOutputData_Error,
+    WorkflowResultEventOutputData_FunctionCall,
     WorkflowResultEventOutputData_Json,
     WorkflowResultEventOutputData_Number,
     WorkflowResultEventOutputData_SearchResults,
@@ -389,10 +421,20 @@ __all__ = [
     "ArrayChatMessageContentItem_Image",
     "ArrayChatMessageContentItem_String",
     "ArrayChatMessageContentRequest",
+    "ArrayEnum",
+    "ArrayVariableValueItem",
+    "ArrayVariableValueItem_ChatHistory",
+    "ArrayVariableValueItem_Error",
+    "ArrayVariableValueItem_FunctionCall",
+    "ArrayVariableValueItem_Json",
+    "ArrayVariableValueItem_Number",
+    "ArrayVariableValueItem_SearchResults",
+    "ArrayVariableValueItem_String",
     "BadRequestError",
     "BlockTypeEnum",
     "ChatHistoryEnum",
     "ChatHistoryInputRequest",
+    "ChatHistoryVariableValue",
     "ChatMessage",
     "ChatMessageContent",
     "ChatMessageContentRequest",
@@ -515,6 +557,7 @@ __all__ = [
     "NamedTestCaseVariableValueRequest_Number",
     "NamedTestCaseVariableValueRequest_SearchResults",
     "NamedTestCaseVariableValueRequest_String",
+    "NodeInputCompiledArrayValue",
     "NodeInputCompiledChatHistoryValue",
     "NodeInputCompiledErrorValue",
     "NodeInputCompiledJsonValue",
@@ -522,21 +565,26 @@ __all__ = [
     "NodeInputCompiledSearchResultsValue",
     "NodeInputCompiledStringValue",
     "NodeInputVariableCompiledValue",
+    "NodeInputVariableCompiledValue_Array",
     "NodeInputVariableCompiledValue_ChatHistory",
     "NodeInputVariableCompiledValue_Error",
     "NodeInputVariableCompiledValue_Json",
     "NodeInputVariableCompiledValue_Number",
     "NodeInputVariableCompiledValue_SearchResults",
     "NodeInputVariableCompiledValue_String",
+    "NodeOutputCompiledArrayValue",
     "NodeOutputCompiledChatHistoryValue",
     "NodeOutputCompiledErrorValue",
+    "NodeOutputCompiledFunctionValue",
     "NodeOutputCompiledJsonValue",
     "NodeOutputCompiledNumberValue",
     "NodeOutputCompiledSearchResultsValue",
     "NodeOutputCompiledStringValue",
     "NodeOutputCompiledValue",
+    "NodeOutputCompiledValue_Array",
     "NodeOutputCompiledValue_ChatHistory",
     "NodeOutputCompiledValue_Error",
+    "NodeOutputCompiledValue_FunctionCall",
     "NodeOutputCompiledValue_Json",
     "NodeOutputCompiledValue_Number",
     "NodeOutputCompiledValue_SearchResults",
@@ -545,6 +593,7 @@ __all__ = [
     "NormalizedTokenLogProbs",
     "NotFoundError",
     "NumberEnum",
+    "NumberVariableValue",
     "PaginatedSlimDeploymentReadList",
     "PaginatedSlimDocumentList",
     "PaginatedSlimWorkflowDeploymentList",
@@ -604,6 +653,7 @@ __all__ = [
     "SearchResultMergingRequest",
     "SearchResultRequest",
     "SearchResultsEnum",
+    "SearchResultsVariableValue",
     "SearchWeightsRequest",
     "SlimDeploymentRead",
     "SlimDocument",
@@ -623,6 +673,8 @@ __all__ = [
     "SubmitWorkflowExecutionActualRequest_ChatHistory",
     "SubmitWorkflowExecutionActualRequest_Json",
     "SubmitWorkflowExecutionActualRequest_String",
+    "SubworkflowEnum",
+    "SubworkflowNodeResult",
     "TemplatingNodeChatHistoryResult",
     "TemplatingNodeErrorResult",
     "TemplatingNodeJsonResult",
@@ -638,15 +690,19 @@ __all__ = [
     "TemplatingNodeResultOutput_String",
     "TemplatingNodeSearchResultsResult",
     "TemplatingNodeStringResult",
+    "TerminalNodeArrayResult",
     "TerminalNodeChatHistoryResult",
     "TerminalNodeErrorResult",
+    "TerminalNodeFunctionCallResult",
     "TerminalNodeJsonResult",
     "TerminalNodeNumberResult",
     "TerminalNodeResult",
     "TerminalNodeResultData",
     "TerminalNodeResultOutput",
+    "TerminalNodeResultOutput_Array",
     "TerminalNodeResultOutput_ChatHistory",
     "TerminalNodeResultOutput_Error",
+    "TerminalNodeResultOutput_FunctionCall",
     "TerminalNodeResultOutput_Json",
     "TerminalNodeResultOutput_Number",
     "TerminalNodeResultOutput_SearchResults",
@@ -677,6 +733,7 @@ __all__ = [
     "VellumImageRequest",
     "VellumVariable",
     "VellumVariableType",
+    "WorkflowDeploymentRead",
     "WorkflowDeploymentsListRequestStatus",
     "WorkflowEventError",
     "WorkflowExecutionActualChatHistoryRequest",
@@ -692,6 +749,7 @@ __all__ = [
     "WorkflowNodeResultData_Conditional",
     "WorkflowNodeResultData_Prompt",
     "WorkflowNodeResultData_Search",
+    "WorkflowNodeResultData_Subworkflow",
     "WorkflowNodeResultData_Templating",
     "WorkflowNodeResultData_Terminal",
     "WorkflowNodeResultEvent",
@@ -701,6 +759,7 @@ __all__ = [
     "WorkflowNodeResultEvent_Rejected",
     "WorkflowNodeResultEvent_Streaming",
     "WorkflowOutput",
+    "WorkflowOutputArray",
     "WorkflowOutputChatHistory",
     "WorkflowOutputError",
     "WorkflowOutputFunctionCall",
@@ -709,6 +768,7 @@ __all__ = [
     "WorkflowOutputNumber",
     "WorkflowOutputSearchResults",
     "WorkflowOutputString",
+    "WorkflowOutput_Array",
     "WorkflowOutput_ChatHistory",
     "WorkflowOutput_Error",
     "WorkflowOutput_FunctionCall",
@@ -728,14 +788,18 @@ __all__ = [
     "WorkflowRequestStringInputRequest",
     "WorkflowResultEvent",
     "WorkflowResultEventOutputData",
+    "WorkflowResultEventOutputDataArray",
     "WorkflowResultEventOutputDataChatHistory",
     "WorkflowResultEventOutputDataError",
+    "WorkflowResultEventOutputDataFunctionCall",
     "WorkflowResultEventOutputDataJson",
     "WorkflowResultEventOutputDataNumber",
     "WorkflowResultEventOutputDataSearchResults",
     "WorkflowResultEventOutputDataString",
+    "WorkflowResultEventOutputData_Array",
     "WorkflowResultEventOutputData_ChatHistory",
     "WorkflowResultEventOutputData_Error",
+    "WorkflowResultEventOutputData_FunctionCall",
     "WorkflowResultEventOutputData_Json",
     "WorkflowResultEventOutputData_Number",
     "WorkflowResultEventOutputData_SearchResults",

vellum/client.py

@@ -100,7 +100,7 @@ class Vellum:
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
 
-            - external_id: typing.Optional[str].
+            - external_id: typing.Optional[str]. "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
 
             - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
 
@@ -175,7 +175,7 @@ class Vellum:
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
 
-            - external_id: typing.Optional[str].
+            - external_id: typing.Optional[str]. "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
 
             - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
 
@@ -251,7 +251,7 @@ class Vellum:
 
             - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
 
-            - external_id: typing.Optional[str]. Optionally include a unique identifier for monitoring purposes.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
         if workflow_deployment_id is not OMIT:
@@ -305,7 +305,7 @@ class Vellum:
 
             - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's deployment with their corresponding values.
 
-            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
 
             - event_types: typing.Optional[typing.List[WorkflowExecutionEventType]]. Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution.
         """
@@ -683,7 +683,7 @@ class AsyncVellum:
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
 
-            - external_id: typing.Optional[str].
+            - external_id: typing.Optional[str]. "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
 
             - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
 
@@ -758,7 +758,7 @@ class AsyncVellum:
 
             - release_tag: typing.Optional[str]. Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
 
-            - external_id: typing.Optional[str].
+            - external_id: typing.Optional[str]. "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
 
             - expand_meta: typing.Optional[PromptDeploymentExpandMetaRequestRequest]. The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
 
@@ -834,7 +834,7 @@ class AsyncVellum:
 
             - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's Deployment with their corresponding values.
 
-            - external_id: typing.Optional[str]. Optionally include a unique identifier for monitoring purposes.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.
         """
         _request: typing.Dict[str, typing.Any] = {"inputs": inputs}
         if workflow_deployment_id is not OMIT:
@@ -888,7 +888,7 @@ class AsyncVellum:
 
             - inputs: typing.List[WorkflowRequestInputRequest]. The list of inputs defined in the Workflow's deployment with their corresponding values.
 
-            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes.
+            - external_id: typing.Optional[str]. Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
 
             - event_types: typing.Optional[typing.List[WorkflowExecutionEventType]]. Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution.
         """

vellum/core/client_wrapper.py

@@ -16,7 +16,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "0.3.7",
+            "X-Fern-SDK-Version": "0.3.9",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

vellum/resources/deployments/client.py

@@ -43,7 +43,7 @@ class DeploymentsClient:
 
             - ordering: typing.Optional[str]. Which field to use when ordering the results.
 
-            - status: typing.Optional[DeploymentsListRequestStatus]. The current status of the deployment
+            - status: typing.Optional[DeploymentsListRequestStatus]. status
         ---
         from vellum.client import Vellum
 
@@ -164,7 +164,7 @@ class AsyncDeploymentsClient:
 
             - ordering: typing.Optional[str]. Which field to use when ordering the results.
 
-            - status: typing.Optional[DeploymentsListRequestStatus]. The current status of the deployment
+            - status: typing.Optional[DeploymentsListRequestStatus]. status
         ---
         from vellum.client import AsyncVellum
 

vellum/resources/workflow_deployments/client.py

@@ -8,6 +8,7 @@ from ...core.api_error import ApiError
 from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ...core.remove_none_from_dict import remove_none_from_dict
 from ...types.paginated_slim_workflow_deployment_list import PaginatedSlimWorkflowDeploymentList
+from ...types.workflow_deployment_read import WorkflowDeploymentRead
 from .types.workflow_deployments_list_request_status import WorkflowDeploymentsListRequestStatus
 
 try:
@@ -36,10 +37,8 @@ class WorkflowDeploymentsClient:
 
             - ordering: typing.Optional[str]. Which field to use when ordering the results.
 
-            - status: typing.Optional[WorkflowDeploymentsListRequestStatus]. The current status of the workflow deployment
-
-                                                                             - `ACTIVE` - Active
-                                                                             - `ARCHIVED` - Archived---
+            - status: typing.Optional[WorkflowDeploymentsListRequestStatus]. status
+        ---
         from vellum.client import Vellum
 
         client = Vellum(
@@ -62,6 +61,36 @@ class WorkflowDeploymentsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def retrieve(self, id: str) -> WorkflowDeploymentRead:
+        """
+        Used to retrieve a workflow deployment given its ID or name.
+
+        Parameters:
+            - id: str. Either the Workflow Deployment's ID or its unique name
+        ---
+        from vellum.client import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.workflow_deployments.retrieve(
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "GET",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/workflow-deployments/{id}"),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(WorkflowDeploymentRead, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
 
 class AsyncWorkflowDeploymentsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -83,10 +112,8 @@ class AsyncWorkflowDeploymentsClient:
 
             - ordering: typing.Optional[str]. Which field to use when ordering the results.
 
-            - status: typing.Optional[WorkflowDeploymentsListRequestStatus]. The current status of the workflow deployment
-
-                                                                             - `ACTIVE` - Active
-                                                                             - `ARCHIVED` - Archived---
+            - status: typing.Optional[WorkflowDeploymentsListRequestStatus]. status
+        ---
         from vellum.client import AsyncVellum
 
         client = AsyncVellum(
@@ -108,3 +135,33 @@ class AsyncWorkflowDeploymentsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def retrieve(self, id: str) -> WorkflowDeploymentRead:
+        """
+        Used to retrieve a workflow deployment given its ID or name.
+
+        Parameters:
+            - id: str. Either the Workflow Deployment's ID or its unique name
+        ---
+        from vellum.client import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+        await client.workflow_deployments.retrieve(
+            id="id",
+        )
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "GET",
+            urllib.parse.urljoin(f"{self._client_wrapper.get_environment().default}/", f"v1/workflow-deployments/{id}"),
+            headers=self._client_wrapper.get_headers(),
+            timeout=None,
+        )
+        if 200 <= _response.status_code < 300:
+            return pydantic.parse_obj_as(WorkflowDeploymentRead, _response.json())  # type: ignore
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)