vellum-ai 1.11.2__py3-none-any.whl → 1.13.5__py3-none-any.whl

vellum/client/resources/integrations/raw_client.py

@@ -12,6 +12,7 @@ from ...core.request_options import RequestOptions
 from ...errors.bad_request_error import BadRequestError
 from ...errors.forbidden_error import ForbiddenError
 from ...errors.not_found_error import NotFoundError
+from ...errors.too_many_requests_error import TooManyRequestsError
 from ...types.components_schemas_composio_execute_tool_response import ComponentsSchemasComposioExecuteToolResponse
 from ...types.components_schemas_composio_tool_definition import ComponentsSchemasComposioToolDefinition
 from ...types.integration_read import IntegrationRead
@@ -31,6 +32,7 @@ class RawIntegrationsClient:
         integration_provider: str,
         tool_name: str,
         *,
+        toolkit_version: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ComponentsSchemasComposioToolDefinition]:
         """
@@ -45,6 +47,9 @@ class RawIntegrationsClient:
         tool_name : str
             The tool's unique name, as specified by the integration provider
 
+        toolkit_version : typing.Optional[str]
+            The version of the toolkit to use. Pass 'latest' to get the latest version, or a specific version string to pin it. If not provided, uses the provider's default.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -57,6 +62,9 @@ class RawIntegrationsClient:
             f"integrations/v1/providers/{jsonable_encoder(integration_provider)}/integrations/{jsonable_encoder(integration_name)}/tools/{jsonable_encoder(tool_name)}",
             base_url=self._client_wrapper.get_environment().default,
             method="GET",
+            params={
+                "toolkit_version": toolkit_version,
+            },
             request_options=request_options,
         )
         try:
@@ -92,6 +100,9 @@ class RawIntegrationsClient:
         tool_name: str,
         *,
         arguments: typing.Dict[str, typing.Optional[typing.Any]],
+        toolkit_version: typing.Optional[str] = OMIT,
+        integration: typing.Optional[str] = OMIT,
+        tool: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ComponentsSchemasComposioExecuteToolResponse]:
         """
@@ -108,6 +119,12 @@ class RawIntegrationsClient:
 
         arguments : typing.Dict[str, typing.Optional[typing.Any]]
 
+        toolkit_version : typing.Optional[str]
+
+        integration : typing.Optional[str]
+
+        tool : typing.Optional[str]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -122,6 +139,9 @@ class RawIntegrationsClient:
             method="POST",
             json={
                 "arguments": arguments,
+                "toolkit_version": toolkit_version,
+                "integration": integration,
+                "tool": tool,
                 "provider": "COMPOSIO",
             },
             headers={
@@ -173,6 +193,17 @@ class RawIntegrationsClient:
                         ),
                     ),
                 )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
@@ -299,6 +330,7 @@ class AsyncRawIntegrationsClient:
         integration_provider: str,
         tool_name: str,
         *,
+        toolkit_version: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ComponentsSchemasComposioToolDefinition]:
         """
@@ -313,6 +345,9 @@ class AsyncRawIntegrationsClient:
         tool_name : str
             The tool's unique name, as specified by the integration provider
 
+        toolkit_version : typing.Optional[str]
+            The version of the toolkit to use. Pass 'latest' to get the latest version, or a specific version string to pin it. If not provided, uses the provider's default.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -325,6 +360,9 @@ class AsyncRawIntegrationsClient:
             f"integrations/v1/providers/{jsonable_encoder(integration_provider)}/integrations/{jsonable_encoder(integration_name)}/tools/{jsonable_encoder(tool_name)}",
             base_url=self._client_wrapper.get_environment().default,
             method="GET",
+            params={
+                "toolkit_version": toolkit_version,
+            },
             request_options=request_options,
         )
         try:
@@ -360,6 +398,9 @@ class AsyncRawIntegrationsClient:
         tool_name: str,
         *,
         arguments: typing.Dict[str, typing.Optional[typing.Any]],
+        toolkit_version: typing.Optional[str] = OMIT,
+        integration: typing.Optional[str] = OMIT,
+        tool: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ComponentsSchemasComposioExecuteToolResponse]:
         """
@@ -376,6 +417,12 @@ class AsyncRawIntegrationsClient:
 
         arguments : typing.Dict[str, typing.Optional[typing.Any]]
 
+        toolkit_version : typing.Optional[str]
+
+        integration : typing.Optional[str]
+
+        tool : typing.Optional[str]
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -390,6 +437,9 @@ class AsyncRawIntegrationsClient:
             method="POST",
             json={
                 "arguments": arguments,
+                "toolkit_version": toolkit_version,
+                "integration": integration,
+                "tool": tool,
                 "provider": "COMPOSIO",
             },
             headers={
@@ -441,6 +491,17 @@ class AsyncRawIntegrationsClient:
                         ),
                     ),
                 )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)

vellum/client/resources/workflow_deployments/client.py

@@ -11,6 +11,7 @@ from ...types.workflow_deployment_event_executions_response import WorkflowDeplo
 from ...types.workflow_deployment_history_item import WorkflowDeploymentHistoryItem
 from ...types.workflow_deployment_read import WorkflowDeploymentRead
 from ...types.workflow_deployment_release import WorkflowDeploymentRelease
+from ...types.workflow_event import WorkflowEvent
 from ...types.workflow_event_execution_read import WorkflowEventExecutionRead
 from ...types.workflow_release_tag_read import WorkflowReleaseTagRead
 from .raw_client import AsyncRawWorkflowDeploymentsClient, RawWorkflowDeploymentsClient
@@ -121,6 +122,79 @@ class WorkflowDeploymentsClient:
         _response = self._raw_client.retrieve(id, request_options=request_options)
         return _response.data
 
+    def execute_stream(
+        self,
+        id: str,
+        *,
+        inputs: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        trigger: typing.Optional[str] = OMIT,
+        release_tag: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        previous_execution_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Iterator[WorkflowEvent]:
+        """
+        Executes a deployed Workflow and streams back its results.
+
+        Parameters
+        ----------
+        id : str
+            Either the Workflow Deployment's ID or its unique name
+
+        inputs : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A mapping from input name to value.
+
+        trigger : typing.Optional[str]
+            The name or ID of a workflow trigger to use for this execution. If not specified, then a default manual trigger will be chosen.
+
+        release_tag : typing.Optional[str]
+            Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
+
+        external_id : typing.Optional[str]
+            Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace.
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
+
+        previous_execution_id : typing.Optional[str]
+            The ID of a previous workflow execution to reference for context.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Yields
+        ------
+        typing.Iterator[WorkflowEvent]
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+        response = client.workflow_deployments.execute_stream(
+            id="my-workflow",
+            inputs={"question": "What is the capital of France?"},
+        )
+        for chunk in response:
+            yield chunk
+        """
+        with self._raw_client.execute_stream(
+            id,
+            inputs=inputs,
+            trigger=trigger,
+            release_tag=release_tag,
+            external_id=external_id,
+            metadata=metadata,
+            previous_execution_id=previous_execution_id,
+            request_options=request_options,
+        ) as r:
+            yield from r.data
+
     def list_workflow_deployment_event_executions(
         self,
         id: str,
@@ -594,6 +668,88 @@ class AsyncWorkflowDeploymentsClient:
         _response = await self._raw_client.retrieve(id, request_options=request_options)
         return _response.data
 
+    async def execute_stream(
+        self,
+        id: str,
+        *,
+        inputs: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        trigger: typing.Optional[str] = OMIT,
+        release_tag: typing.Optional[str] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        previous_execution_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.AsyncIterator[WorkflowEvent]:
+        """
+        Executes a deployed Workflow and streams back its results.
+
+        Parameters
+        ----------
+        id : str
+            Either the Workflow Deployment's ID or its unique name
+
+        inputs : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A mapping from input name to value.
+
+        trigger : typing.Optional[str]
+            The name or ID of a workflow trigger to use for this execution. If not specified, then a default manual trigger will be chosen.
+
+        release_tag : typing.Optional[str]
+            Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
+
+        external_id : typing.Optional[str]
+            Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace.
+
+        metadata : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
+
+        previous_execution_id : typing.Optional[str]
+            The ID of a previous workflow execution to reference for context.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Yields
+        ------
+        typing.AsyncIterator[WorkflowEvent]
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_version="YOUR_API_VERSION",
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            response = await client.workflow_deployments.execute_stream(
+                id="my-workflow",
+                inputs={"question": "What is the capital of France?"},
+            )
+            async for chunk in response:
+                yield chunk
+
+
+        asyncio.run(main())
+        """
+        async with self._raw_client.execute_stream(
+            id,
+            inputs=inputs,
+            trigger=trigger,
+            release_tag=release_tag,
+            external_id=external_id,
+            metadata=metadata,
+            previous_execution_id=previous_execution_id,
+            request_options=request_options,
+        ) as r:
+            async for _chunk in r.data:
+                yield _chunk
+
     async def list_workflow_deployment_event_executions(
         self,
         id: str,