vellum-ai 1.3.1__tar.gz → 1.3.2__tar.gz

{vellum_ai-1.3.1 → vellum_ai-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 1.3.1
+Version: 1.3.2
 Summary: 
 License: MIT
 Requires-Python: >=3.9,<4.0

vellum_ai-1.3.2/ee/vellum_ee/workflows/display/tests/workflow_serialization/test_web_search_node_serialization.py

@@ -0,0 +1,81 @@
+from vellum_ee.workflows.display.workflows.get_vellum_workflow_display_class import get_workflow_display
+
+from tests.workflows.web_search.workflow import WebSearchWorkflow
+
+
+def test_serialize_web_search_workflow():
+    # GIVEN a WebSearchWorkflow with a node that has various input types
+    # - query from workflow input
+    # - api_key from VellumSecretReference
+    # - num_results as a constant integer
+    # - location as a constant string
+
+    # WHEN we serialize the workflow through the display system
+    workflow_display = get_workflow_display(workflow_class=WebSearchWorkflow)
+    serialized_workflow: dict = workflow_display.serialize()
+
+    # THEN we should get a properly structured serialized workflow
+    assert serialized_workflow.keys() == {
+        "workflow_raw_data",
+        "input_variables",
+        "state_variables",
+        "output_variables",
+    }
+
+    # AND it should have input variables
+    input_variables = serialized_workflow["input_variables"]
+    assert len(input_variables) == 1
+    assert input_variables[0]["key"] == "search_query"
+    assert input_variables[0]["type"] == "STRING"
+
+    # AND it should have output variables
+    output_variables = serialized_workflow["output_variables"]
+    assert len(output_variables) == 2
+    output_keys = {var["key"] for var in output_variables}
+    assert output_keys == {"search_results", "result_urls"}
+
+    # AND the web search node should be serialized as a GENERIC type node
+    workflow_raw_data = serialized_workflow["workflow_raw_data"]
+    nodes = workflow_raw_data["nodes"]
+
+    web_search_node = next(
+        (
+            node
+            for node in nodes
+            if node and node.get("type") == "GENERIC" and node.get("base", {}).get("name") == "WebSearchNode"
+        ),
+        None,
+    )
+
+    assert web_search_node is not None, "WebSearchNode should be serialized as GENERIC type"
+
+    # AND it should have the correct base module reference
+    expected_base = {
+        "name": "WebSearchNode",
+        "module": ["vellum", "workflows", "nodes", "displayable", "web_search_node", "node"],
+    }
+    assert (
+        web_search_node["base"] == expected_base
+    ), f"Base mismatch. Expected: {expected_base}, Found: {web_search_node['base']}"
+
+    # AND it should have all four serializable attributes defined in our display class
+    web_search_attributes = web_search_node["attributes"]
+    attribute_names = {attr["name"] for attr in web_search_attributes}
+
+    # AND the attributes should match exactly what we defined in __serializable_inputs__
+    assert attribute_names == {"query", "api_key", "num_results", "location"}
+
+    # AND it should have all three expected outputs from WebSearchNode
+    assert {output["name"] for output in web_search_node["outputs"]} == {"text", "urls", "results"}
+
+    # AND each attribute should have the correct value type based on its source
+    attr_types_by_name = {attr["name"]: attr["value"]["type"] for attr in web_search_attributes}
+
+    # AND query should reference the workflow input
+    assert attr_types_by_name["query"] == "WORKFLOW_INPUT"
+    # AND api_key should reference a Vellum secret
+    assert attr_types_by_name["api_key"] == "VELLUM_SECRET"
+    # AND num_results should be a constant value
+    assert attr_types_by_name["num_results"] == "CONSTANT_VALUE"
+    # AND location should be a constant value
+    assert attr_types_by_name["location"] == "CONSTANT_VALUE"

{vellum_ai-1.3.1 → vellum_ai-1.3.2}/pyproject.toml

@@ -3,7 +3,7 @@ name = "vellum-ai"
 
 [tool.poetry]
 name = "vellum-ai"
-version = "1.3.1"
+version = "1.3.2"
 description = ""
 readme = "README.md"
 authors = []

{vellum_ai-1.3.1 → vellum_ai-1.3.2}/src/vellum/__init__.py

@@ -78,6 +78,7 @@ from .client.types import (
     ContainerImageContainerImageTag,
     ContainerImageRead,
     CreateTestSuiteTestCaseRequest,
+    CreateWorkflowEventRequest,
     DelimiterChunkerConfig,
     DelimiterChunkerConfigRequest,
     DelimiterChunking,
@@ -88,6 +89,7 @@ from .client.types import (
     DeploymentRead,
     DeploymentReleaseTagDeploymentHistoryItem,
     DeploymentReleaseTagRead,
+    DeprecatedPromptRequestInput,
     DockerServiceToken,
     DocumentChatMessageContent,
     DocumentChatMessageContentRequest,
@@ -624,6 +626,7 @@ from .client.types import (
     WorkflowExecutionWorkflowResultEvent,
     WorkflowExpandMetaRequest,
     WorkflowInitializationError,
+    WorkflowInput,
     WorkflowNodeResultData,
     WorkflowNodeResultEvent,
     WorkflowNodeResultEventState,
@@ -784,6 +787,7 @@ __all__ = [
     "ContainerImageContainerImageTag",
     "ContainerImageRead",
     "CreateTestSuiteTestCaseRequest",
+    "CreateWorkflowEventRequest",
     "DelimiterChunkerConfig",
     "DelimiterChunkerConfigRequest",
     "DelimiterChunking",
@@ -795,6 +799,7 @@ __all__ = [
     "DeploymentReleaseTagDeploymentHistoryItem",
     "DeploymentReleaseTagRead",
     "DeploymentsListRequestStatus",
+    "DeprecatedPromptRequestInput",
     "DockerServiceToken",
     "DocumentChatMessageContent",
     "DocumentChatMessageContentRequest",
@@ -1344,6 +1349,7 @@ __all__ = [
     "WorkflowExecutionWorkflowResultEvent",
     "WorkflowExpandMetaRequest",
     "WorkflowInitializationError",
+    "WorkflowInput",
     "WorkflowNodeResultData",
     "WorkflowNodeResultEvent",
     "WorkflowNodeResultEventState",

{vellum_ai-1.3.1 → vellum_ai-1.3.2}/src/vellum/client/README.md

@@ -103,7 +103,7 @@ The SDK supports streaming responses, as well, the response will be a generator
 from vellum import (
     JinjaPromptBlock,
     PromptParameters,
-    PromptRequestStringInput,
+    StringInput,
     Vellum,
     VellumVariable,
 )
@@ -115,12 +115,12 @@ client = Vellum(
 response = client.ad_hoc.adhoc_execute_prompt_stream(
     ml_model="x",
     input_values=[
-        PromptRequestStringInput(
-            key="x",
+        StringInput(
+            name="x",
             value="value",
         ),
-        PromptRequestStringInput(
-            key="x",
+        StringInput(
+            name="x",
             value="value",
         ),
     ],

{vellum_ai-1.3.1 → vellum_ai-1.3.2}/src/vellum/client/__init__.py

@@ -479,6 +479,7 @@ class Vellum:
         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,
     ) -> ExecuteWorkflowResponse:
         """
@@ -507,6 +508,9 @@ class Vellum:
         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 initial State loading.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -544,6 +548,7 @@ class Vellum:
             release_tag=release_tag,
             external_id=external_id,
             metadata=metadata,
+            previous_execution_id=previous_execution_id,
             request_options=request_options,
         )
         return _response.data
@@ -559,6 +564,7 @@ class Vellum:
         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,
+        previous_execution_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Iterator[WorkflowStreamEvent]:
         """
@@ -590,6 +596,9 @@ class Vellum:
         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 initial State loading.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -630,6 +639,7 @@ class Vellum:
             external_id=external_id,
             event_types=event_types,
             metadata=metadata,
+            previous_execution_id=previous_execution_id,
             request_options=request_options,
         ) as r:
             yield from r.data
@@ -1376,6 +1386,7 @@ class AsyncVellum:
         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,
     ) -> ExecuteWorkflowResponse:
         """
@@ -1404,6 +1415,9 @@ class AsyncVellum:
         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 initial State loading.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1449,6 +1463,7 @@ class AsyncVellum:
             release_tag=release_tag,
             external_id=external_id,
             metadata=metadata,
+            previous_execution_id=previous_execution_id,
             request_options=request_options,
         )
         return _response.data
@@ -1464,6 +1479,7 @@ class AsyncVellum:
         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,
+        previous_execution_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.AsyncIterator[WorkflowStreamEvent]:
         """
@@ -1495,6 +1511,9 @@ class AsyncVellum:
         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 initial State loading.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1543,6 +1562,7 @@ class AsyncVellum:
             external_id=external_id,
             event_types=event_types,
             metadata=metadata,
+            previous_execution_id=previous_execution_id,
             request_options=request_options,
         ) as r:
             async for _chunk in r.data:

{vellum_ai-1.3.1 → vellum_ai-1.3.2}/src/vellum/client/core/client_wrapper.py

@@ -27,10 +27,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "vellum-ai/1.3.1",
+            "User-Agent": "vellum-ai/1.3.2",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "1.3.1",
+            "X-Fern-SDK-Version": "1.3.2",
             **(self.get_custom_headers() or {}),
         }
         if self._api_version is not None:

{vellum_ai-1.3.1 → vellum_ai-1.3.2}/src/vellum/client/raw_client.py

@@ -515,6 +515,7 @@ class RawVellum:
         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,
     ) -> HttpResponse[ExecuteWorkflowResponse]:
         """
@@ -543,6 +544,9 @@ class RawVellum:
         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 initial State loading.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -567,6 +571,7 @@ class RawVellum:
                 "release_tag": release_tag,
                 "external_id": external_id,
                 "metadata": metadata,
+                "previous_execution_id": previous_execution_id,
             },
             headers={
                 "content-type": "application/json",
@@ -634,6 +639,7 @@ class RawVellum:
         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,
+        previous_execution_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Iterator[HttpResponse[typing.Iterator[WorkflowStreamEvent]]]:
         """
@@ -665,6 +671,9 @@ class RawVellum:
         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 initial State loading.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -690,6 +699,7 @@ class RawVellum:
                 "external_id": external_id,
                 "event_types": event_types,
                 "metadata": metadata,
+                "previous_execution_id": previous_execution_id,
             },
             headers={
                 "content-type": "application/json",
@@ -1728,6 +1738,7 @@ class AsyncRawVellum:
         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,
     ) -> AsyncHttpResponse[ExecuteWorkflowResponse]:
         """
@@ -1756,6 +1767,9 @@ class AsyncRawVellum:
         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 initial State loading.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1780,6 +1794,7 @@ class AsyncRawVellum:
                 "release_tag": release_tag,
                 "external_id": external_id,
                 "metadata": metadata,
+                "previous_execution_id": previous_execution_id,
             },
             headers={
                 "content-type": "application/json",
@@ -1847,6 +1862,7 @@ class AsyncRawVellum:
         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,
+        previous_execution_id: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[WorkflowStreamEvent]]]:
         """
@@ -1878,6 +1894,9 @@ class AsyncRawVellum:
         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 initial State loading.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1903,6 +1922,7 @@ class AsyncRawVellum:
                 "external_id": external_id,
                 "event_types": event_types,
                 "metadata": metadata,
+                "previous_execution_id": previous_execution_id,
             },
             headers={
                 "content-type": "application/json",

{vellum_ai-1.3.1 → vellum_ai-1.3.2}/src/vellum/client/reference.md

@@ -605,6 +605,14 @@ client.execute_workflow(
 <dl>
 <dd>
 
+**previous_execution_id:** `typing.Optional[str]` — The ID of a previous Workflow Execution to reference for initial State loading.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
     
 </dd>
@@ -743,6 +751,14 @@ for chunk in response.data:
 <dl>
 <dd>
 
+**previous_execution_id:** `typing.Optional[str]` — The ID of a previous Workflow Execution to reference for initial State loading.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
     
 </dd>
@@ -1262,7 +1278,7 @@ client.submit_workflow_execution_actuals(
 <dl>
 <dd>
 
-Accept an event and publish it to ClickHouse for analytics processing.
+Accept an event or list of events and publish them to ClickHouse for analytics processing.
 </dd>
 </dl>
 </dd>
@@ -1291,22 +1307,40 @@ client = Vellum(
     api_key="YOUR_API_KEY",
 )
 client.events.create(
-    request=NodeExecutionInitiatedEvent(
-        body=NodeExecutionInitiatedBody(
-            node_definition=VellumCodeResourceDefinition(
-                name="name",
-                module=["module", "module"],
-                id="id",
+    request=[
+        NodeExecutionInitiatedEvent(
+            body=NodeExecutionInitiatedBody(
+                node_definition=VellumCodeResourceDefinition(
+                    name="name",
+                    module=["module", "module"],
+                    id="id",
+                ),
+                inputs={"inputs": {"key": "value"}},
             ),
-            inputs={"inputs": {"key": "value"}},
+            id="id",
+            timestamp=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            trace_id="trace_id",
+            span_id="span_id",
         ),
-        id="id",
-        timestamp=datetime.datetime.fromisoformat(
-            "2024-01-15 09:30:00+00:00",
+        NodeExecutionInitiatedEvent(
+            body=NodeExecutionInitiatedBody(
+                node_definition=VellumCodeResourceDefinition(
+                    name="name",
+                    module=["module", "module"],
+                    id="id",
+                ),
+                inputs={"inputs": {"key": "value"}},
+            ),
+            id="id",
+            timestamp=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            trace_id="trace_id",
+            span_id="span_id",
         ),
-        trace_id="trace_id",
-        span_id="span_id",
-    ),
+    ],
 )
 
 ```
@@ -1323,7 +1357,7 @@ client.events.create(
 <dl>
 <dd>
 
-**request:** `WorkflowEvent` 
+**request:** `CreateWorkflowEventRequest` 
     
 </dd>
 </dl>
@@ -1360,7 +1394,7 @@ client.events.create(
 from vellum import (
     JinjaPromptBlock,
     PromptParameters,
-    PromptRequestStringInput,
+    StringInput,
     Vellum,
     VellumVariable,
 )
@@ -1372,12 +1406,12 @@ client = Vellum(
 client.ad_hoc.adhoc_execute_prompt(
     ml_model="x",
     input_values=[
-        PromptRequestStringInput(
-            key="x",
+        StringInput(
+            name="x",
             value="value",
         ),
-        PromptRequestStringInput(
-            key="x",
+        StringInput(
+            name="x",
             value="value",
         ),
     ],
@@ -1426,7 +1460,7 @@ client.ad_hoc.adhoc_execute_prompt(
 <dl>
 <dd>
 
-**input_values:** `typing.Sequence[PromptRequestInput]` 
+**input_values:** `typing.Sequence[DeprecatedPromptRequestInput]` 
     
 </dd>
 </dl>
@@ -1510,7 +1544,7 @@ client.ad_hoc.adhoc_execute_prompt(
 from vellum import (
     JinjaPromptBlock,
     PromptParameters,
-    PromptRequestStringInput,
+    StringInput,
     Vellum,
     VellumVariable,
 )
@@ -1522,12 +1556,12 @@ client = Vellum(
 response = client.ad_hoc.adhoc_execute_prompt_stream(
     ml_model="x",
     input_values=[
-        PromptRequestStringInput(
-            key="x",
+        StringInput(
+            name="x",
             value="value",
         ),
-        PromptRequestStringInput(
-            key="x",
+        StringInput(
+            name="x",
             value="value",
         ),
     ],
@@ -1578,7 +1612,7 @@ for chunk in response.data:
 <dl>
 <dd>
 
-**input_values:** `typing.Sequence[PromptRequestInput]` 
+**input_values:** `typing.Sequence[DeprecatedPromptRequestInput]` 
     
 </dd>
 </dl>