vellum-ai 0.8.6__py3-none-any.whl → 0.8.7__py3-none-any.whl

vellum/client.py

@@ -449,6 +449,7 @@ class Vellum:
         workflow_deployment_name: 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,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ExecuteWorkflowResponse:
         """
@@ -474,6 +475,9 @@ class Vellum:
         external_id : typing.Optional[str]
             Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
 
+        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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -509,6 +513,7 @@ class Vellum:
                 "workflow_deployment_name": workflow_deployment_name,
                 "release_tag": release_tag,
                 "external_id": external_id,
+                "metadata": metadata,
             },
             request_options=request_options,
             omit=OMIT,
@@ -567,6 +572,7 @@ class Vellum:
         release_tag: typing.Optional[str] = OMIT,
         external_id: typing.Optional[str] = OMIT,
         event_types: typing.Optional[typing.Sequence[WorkflowExecutionEventType]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Iterator[WorkflowStreamEvent]:
         """
@@ -595,6 +601,9 @@ class Vellum:
         event_types : typing.Optional[typing.Sequence[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.
 
+        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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -629,6 +638,7 @@ class Vellum:
             release_tag="string",
             external_id="string",
             event_types=["NODE"],
+            metadata={"string": {"key": "value"}},
         )
         for chunk in response:
             yield chunk
@@ -645,6 +655,7 @@ class Vellum:
                 "release_tag": release_tag,
                 "external_id": external_id,
                 "event_types": event_types,
+                "metadata": metadata,
             },
             request_options=request_options,
             omit=OMIT,
@@ -1632,6 +1643,7 @@ class AsyncVellum:
         workflow_deployment_name: 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,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ExecuteWorkflowResponse:
         """
@@ -1657,6 +1669,9 @@ class AsyncVellum:
         external_id : typing.Optional[str]
             Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
 
+        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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1700,6 +1715,7 @@ class AsyncVellum:
                 "workflow_deployment_name": workflow_deployment_name,
                 "release_tag": release_tag,
                 "external_id": external_id,
+                "metadata": metadata,
             },
             request_options=request_options,
             omit=OMIT,
@@ -1758,6 +1774,7 @@ class AsyncVellum:
         release_tag: typing.Optional[str] = OMIT,
         external_id: typing.Optional[str] = OMIT,
         event_types: typing.Optional[typing.Sequence[WorkflowExecutionEventType]] = OMIT,
+        metadata: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.AsyncIterator[WorkflowStreamEvent]:
         """
@@ -1786,6 +1803,9 @@ class AsyncVellum:
         event_types : typing.Optional[typing.Sequence[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.
 
+        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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1825,6 +1845,7 @@ class AsyncVellum:
                 release_tag="string",
                 external_id="string",
                 event_types=["NODE"],
+                metadata={"string": {"key": "value"}},
             )
             async for chunk in response:
                 yield chunk
@@ -1844,6 +1865,7 @@ class AsyncVellum:
                 "release_tag": release_tag,
                 "external_id": external_id,
                 "event_types": event_types,
+                "metadata": metadata,
             },
             request_options=request_options,
             omit=OMIT,

vellum/core/client_wrapper.py

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

{vellum_ai-0.8.6.dist-info → vellum_ai-0.8.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.8.6
+Version: 0.8.7
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0

{vellum_ai-0.8.6.dist-info → vellum_ai-0.8.7.dist-info}/RECORD

@@ -1,8 +1,8 @@
 vellum/__init__.py,sha256=sYfFTNke8uuFbEl3rRMDj2DIsxjSxRicUW_uxEx9ftI,30024
-vellum/client.py,sha256=3r_Zn6F459GgFC9La9__-66TIj7DywjwxLOYkpUZ9QY,99406
+vellum/client.py,sha256=kUF5BvbURnGFgxkJC-ql8GZ6lRX7_i3h3EQNCC_SRIo,101036
 vellum/core/__init__.py,sha256=FzSvKbXjuM18Hdk3iGK-jsGY_DfouyRS659thZV5c1Y,1394
 vellum/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-vellum/core/client_wrapper.py,sha256=pZfHMc9b9Qi6o9LjtXQhbEX4jvauDYLw0qwU58Ecn3s,1897
+vellum/core/client_wrapper.py,sha256=RpTIosTnX7hFWiqTFmJqDkLpt_WlOMc8YTxVl366zNY,1897
 vellum/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 vellum/core/file.py,sha256=vliNmlB7PbDfi4EKiVPNq5QaGXJ4zlDBGupv7Qciy7g,1520
 vellum/core/http_client.py,sha256=rZSidd9LazCjduvdBhZ7GDs4iGfn-OAfRGsDXB1z8f4,18882
@@ -481,7 +481,7 @@ vellum/types/workflow_result_event_output_data_search_results.py,sha256=U34IK7Zv
 vellum/types/workflow_result_event_output_data_string.py,sha256=tM3kgh6tEhD0dFEb_7UU0-UspeN4pUdINCcCrD64W74,1228
 vellum/types/workflow_stream_event.py,sha256=Wn3Yzuy9MqWAeo8tEaXDTKDEbJoA8DdYdMVq8EKuhu8,361
 vellum/version.py,sha256=jq-1PlAYxN9AXuaZqbYk9ak27SgE2lw9Ia5gx1b1gVI,76
-vellum_ai-0.8.6.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
-vellum_ai-0.8.6.dist-info/METADATA,sha256=JU-e72-3-FyVgJcJCVN7BgAl4YkGsOG_S8xZ4i59vRY,4394
-vellum_ai-0.8.6.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-vellum_ai-0.8.6.dist-info/RECORD,,
+vellum_ai-0.8.7.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
+vellum_ai-0.8.7.dist-info/METADATA,sha256=Ch6_D1ekSO1Mv1wB8Zp4OHo0oQ6lvCaR5nmCiHqPX_A,4394
+vellum_ai-0.8.7.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+vellum_ai-0.8.7.dist-info/RECORD,,