vellum-ai 0.14.3__py3-none-any.whl → 0.14.5__py3-none-any.whl

vellum/client/core/client_wrapper.py

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

vellum/client/resources/document_indexes/client.py

@@ -54,8 +54,8 @@ class DocumentIndexesClient:
         status : typing.Optional[DocumentIndexesListRequestStatus]
             Filter down to only document indices that have a status matching the status specified
 
-            - `ACTIVE` - Active
-            - `ARCHIVED` - Archived
+            * `ACTIVE` - Active
+            * `ARCHIVED` - Archived
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -589,8 +589,8 @@ class AsyncDocumentIndexesClient:
         status : typing.Optional[DocumentIndexesListRequestStatus]
             Filter down to only document indices that have a status matching the status specified
 
-            - `ACTIVE` - Active
-            - `ARCHIVED` - Archived
+            * `ACTIVE` - Active
+            * `ARCHIVED` - Archived
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

vellum/client/resources/documents/client.py

@@ -278,7 +278,6 @@ class DocumentsClient:
         **Note:** Uses a base url of `https://documents.vellum.ai`.
 
         This is a multipart/form-data request. The `contents` field should be a file upload. It also expects a JSON body with the following fields:
-
         - `add_to_index_names: list[str]` - Optionally include the names of all indexes that you'd like this document to be included in
         - `external_id: str | None` - Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
         - `label: str` - A human-friendly name for this document. Typically the filename.
@@ -675,7 +674,6 @@ class AsyncDocumentsClient:
         **Note:** Uses a base url of `https://documents.vellum.ai`.
 
         This is a multipart/form-data request. The `contents` field should be a file upload. It also expects a JSON body with the following fields:
-
         - `add_to_index_names: list[str]` - Optionally include the names of all indexes that you'd like this document to be included in
         - `external_id: str | None` - Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
         - `label: str` - A human-friendly name for this document. Typically the filename.

vellum/client/resources/folder_entities/client.py

@@ -39,7 +39,6 @@ class FolderEntitiesClient:
 
             To filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide
             a string representing the entity type of the root directory. Supported root directories include:
-
             - PROMPT_SANDBOX
             - WORKFLOW_SANDBOX
             - DOCUMENT_INDEX
@@ -48,8 +47,8 @@ class FolderEntitiesClient:
         entity_status : typing.Optional[FolderEntitiesListRequestEntityStatus]
             Filter down to only those objects whose entities have a status matching the status specified.
 
-            - `ACTIVE` - Active
-            - `ARCHIVED` - Archived
+            * `ACTIVE` - Active
+            * `ARCHIVED` - Archived
 
         limit : typing.Optional[int]
             Number of results to return per page.
@@ -119,7 +118,6 @@ class FolderEntitiesClient:
         folder_id : str
             The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root
             directory. Supported root directories include:
-
             - PROMPT_SANDBOX
             - WORKFLOW_SANDBOX
             - DOCUMENT_INDEX
@@ -190,7 +188,6 @@ class AsyncFolderEntitiesClient:
 
             To filter by an entity's parent folder, provide the ID of the parent folder. To filter by the root directory, provide
             a string representing the entity type of the root directory. Supported root directories include:
-
             - PROMPT_SANDBOX
             - WORKFLOW_SANDBOX
             - DOCUMENT_INDEX
@@ -199,8 +196,8 @@ class AsyncFolderEntitiesClient:
         entity_status : typing.Optional[FolderEntitiesListRequestEntityStatus]
             Filter down to only those objects whose entities have a status matching the status specified.
 
-            - `ACTIVE` - Active
-            - `ARCHIVED` - Archived
+            * `ACTIVE` - Active
+            * `ARCHIVED` - Archived
 
         limit : typing.Optional[int]
             Number of results to return per page.
@@ -278,7 +275,6 @@ class AsyncFolderEntitiesClient:
         folder_id : str
             The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root
             directory. Supported root directories include:
-
             - PROMPT_SANDBOX
             - WORKFLOW_SANDBOX
             - DOCUMENT_INDEX

vellum/client/resources/test_suite_runs/client.py

@@ -163,7 +163,6 @@ class TestSuiteRunsClient:
 
         expand : typing.Optional[typing.Union[str, typing.Sequence[str]]]
             The response fields to expand for more information.
-
             - 'results.metric_results.metric_label' expands the metric label for each metric result.
             - 'results.metric_results.metric_definition' expands the metric definition for each metric result.
             - 'results.metric_results.metric_definition.name' expands the metric definition name for each metric result.
@@ -381,7 +380,6 @@ class AsyncTestSuiteRunsClient:
 
         expand : typing.Optional[typing.Union[str, typing.Sequence[str]]]
             The response fields to expand for more information.
-
             - 'results.metric_results.metric_label' expands the metric label for each metric result.
             - 'results.metric_results.metric_definition' expands the metric definition for each metric result.
             - 'results.metric_results.metric_definition.name' expands the metric definition name for each metric result.

vellum/client/types/deployment_read.py

@@ -30,17 +30,17 @@ class DeploymentRead(UniversalBaseModel):
     """
     The current status of the deployment
     
-    - `ACTIVE` - Active
-    - `ARCHIVED` - Archived
+    * `ACTIVE` - Active
+    * `ARCHIVED` - Archived
     """
 
     environment: typing.Optional[EnvironmentEnum] = pydantic.Field(default=None)
     """
     The environment this deployment is used in
     
-    - `DEVELOPMENT` - Development
-    - `STAGING` - Staging
-    - `PRODUCTION` - Production
+    * `DEVELOPMENT` - Development
+    * `STAGING` - Staging
+    * `PRODUCTION` - Production
     """
 
     last_deployed_on: dt.datetime

vellum/client/types/deployment_release_tag_read.py

@@ -18,8 +18,8 @@ class DeploymentReleaseTagRead(UniversalBaseModel):
     """
     The source of how the Release Tag was originally created
     
-    - `SYSTEM` - System
-    - `USER` - User
+    * `SYSTEM` - System
+    * `USER` - User
     """
 
     history_item: DeploymentReleaseTagDeploymentHistoryItem = pydantic.Field()

vellum/client/types/document_document_to_document_index.py

@@ -26,11 +26,11 @@ class DocumentDocumentToDocumentIndex(UniversalBaseModel):
     """
     An enum value representing where this document is along its indexing lifecycle for this index.
     
-    - `AWAITING_PROCESSING` - Awaiting Processing
-    - `QUEUED` - Queued
-    - `INDEXING` - Indexing
-    - `INDEXED` - Indexed
-    - `FAILED` - Failed
+    * `AWAITING_PROCESSING` - Awaiting Processing
+    * `QUEUED` - Queued
+    * `INDEXING` - Indexing
+    * `INDEXED` - Indexed
+    * `FAILED` - Failed
     """
 
     extracted_text_file_url: typing.Optional[str] = None

vellum/client/types/document_index_read.py

@@ -27,17 +27,17 @@ class DocumentIndexRead(UniversalBaseModel):
     """
     The current status of the document index
     
-    - `ACTIVE` - Active
-    - `ARCHIVED` - Archived
+    * `ACTIVE` - Active
+    * `ARCHIVED` - Archived
     """
 
     environment: typing.Optional[EnvironmentEnum] = pydantic.Field(default=None)
     """
     The environment this document index is used in
     
-    - `DEVELOPMENT` - Development
-    - `STAGING` - Staging
-    - `PRODUCTION` - Production
+    * `DEVELOPMENT` - Development
+    * `STAGING` - Staging
+    * `PRODUCTION` - Production
     """
 
     indexing_config: DocumentIndexIndexingConfig

vellum/client/types/document_read.py

@@ -28,7 +28,7 @@ class DocumentRead(UniversalBaseModel):
     """
     The current status of the document
     
-    - `ACTIVE` - Active
+    * `ACTIVE` - Active
     """
 
     original_file_url: typing.Optional[str] = None

vellum/client/types/enriched_normalized_completion.py

@@ -29,9 +29,9 @@ class EnrichedNormalizedCompletion(UniversalBaseModel):
     """
     The reason the generation finished.
     
-    - `LENGTH` - LENGTH
-    - `STOP` - STOP
-    - `UNKNOWN` - UNKNOWN
+    * `LENGTH` - LENGTH
+    * `STOP` - STOP
+    * `UNKNOWN` - UNKNOWN
     """
 
     logprobs: typing.Optional[NormalizedLogProbs] = pydantic.Field(default=None)

vellum/client/types/generate_options_request.py

@@ -12,8 +12,8 @@ class GenerateOptionsRequest(UniversalBaseModel):
     """
     Which logprobs to include, if any. Defaults to NONE.
     
-    - `ALL` - ALL
-    - `NONE` - NONE
+    * `ALL` - ALL
+    * `NONE` - NONE
     """
 
     if IS_PYDANTIC_V2:

vellum/client/types/slim_deployment_read.py

@@ -30,17 +30,17 @@ class SlimDeploymentRead(UniversalBaseModel):
     """
     The current status of the deployment
     
-    - `ACTIVE` - Active
-    - `ARCHIVED` - Archived
+    * `ACTIVE` - Active
+    * `ARCHIVED` - Archived
     """
 
     environment: typing.Optional[EnvironmentEnum] = pydantic.Field(default=None)
     """
     The environment this deployment is used in
     
-    - `DEVELOPMENT` - Development
-    - `STAGING` - Staging
-    - `PRODUCTION` - Production
+    * `DEVELOPMENT` - Development
+    * `STAGING` - Staging
+    * `PRODUCTION` - Production
     """
 
     last_deployed_on: dt.datetime

vellum/client/types/slim_document.py

@@ -37,15 +37,15 @@ class SlimDocument(UniversalBaseModel):
     """
     An enum value representing why the document could not be processed. Is null unless processing_state is FAILED.
     
-    - `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
-    - `INVALID_FILE` - Invalid File
+    * `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
+    * `INVALID_FILE` - Invalid File
     """
 
     status: typing.Optional[DocumentStatus] = pydantic.Field(default=None)
     """
     The document's current status.
     
-    - `ACTIVE` - Active
+    * `ACTIVE` - Active
     """
 
     keywords: typing.Optional[typing.List[str]] = pydantic.Field(default=None)

vellum/client/types/slim_document_document_to_document_index.py

@@ -26,11 +26,11 @@ class SlimDocumentDocumentToDocumentIndex(UniversalBaseModel):
     """
     An enum value representing where this document is along its indexing lifecycle for this index.
     
-    - `AWAITING_PROCESSING` - Awaiting Processing
-    - `QUEUED` - Queued
-    - `INDEXING` - Indexing
-    - `INDEXED` - Indexed
-    - `FAILED` - Failed
+    * `AWAITING_PROCESSING` - Awaiting Processing
+    * `QUEUED` - Queued
+    * `INDEXING` - Indexing
+    * `INDEXED` - Indexed
+    * `FAILED` - Failed
     """
 
     if IS_PYDANTIC_V2:

vellum/client/types/slim_workflow_deployment.py

@@ -29,17 +29,17 @@ class SlimWorkflowDeployment(UniversalBaseModel):
     """
     The current status of the workflow deployment
     
-    - `ACTIVE` - Active
-    - `ARCHIVED` - Archived
+    * `ACTIVE` - Active
+    * `ARCHIVED` - Archived
     """
 
     environment: typing.Optional[EnvironmentEnum] = pydantic.Field(default=None)
     """
     The environment this workflow deployment is used in
     
-    - `DEVELOPMENT` - Development
-    - `STAGING` - Staging
-    - `PRODUCTION` - Production
+    * `DEVELOPMENT` - Development
+    * `STAGING` - Staging
+    * `PRODUCTION` - Production
     """
 
     created: dt.datetime

vellum/client/types/test_suite_run_read.py

@@ -21,11 +21,11 @@ class TestSuiteRunRead(UniversalBaseModel):
     """
     The current state of this run
     
-    - `QUEUED` - Queued
-    - `RUNNING` - Running
-    - `COMPLETE` - Complete
-    - `FAILED` - Failed
-    - `CANCELLED` - Cancelled
+    * `QUEUED` - Queued
+    * `RUNNING` - Running
+    * `COMPLETE` - Complete
+    * `FAILED` - Failed
+    * `CANCELLED` - Cancelled
     """
 
     exec_config: typing.Optional[TestSuiteRunExecConfig] = pydantic.Field(default=None)

vellum/client/types/workflow_deployment_read.py

@@ -29,17 +29,17 @@ class WorkflowDeploymentRead(UniversalBaseModel):
     """
     The current status of the workflow deployment
     
-    - `ACTIVE` - Active
-    - `ARCHIVED` - Archived
+    * `ACTIVE` - Active
+    * `ARCHIVED` - Archived
     """
 
     environment: typing.Optional[EnvironmentEnum] = pydantic.Field(default=None)
     """
     The environment this workflow deployment is used in
     
-    - `DEVELOPMENT` - Development
-    - `STAGING` - Staging
-    - `PRODUCTION` - Production
+    * `DEVELOPMENT` - Development
+    * `STAGING` - Staging
+    * `PRODUCTION` - Production
     """
 
     created: dt.datetime

vellum/client/types/workflow_release_tag_read.py

@@ -18,8 +18,8 @@ class WorkflowReleaseTagRead(UniversalBaseModel):
     """
     The source of how the Release Tag was originally created
     
-    - `SYSTEM` - System
-    - `USER` - User
+    * `SYSTEM` - System
+    * `USER` - User
     """
 
     history_item: WorkflowReleaseTagWorkflowDeploymentHistoryItem = pydantic.Field()

vellum/workflows/constants.py

@@ -3,6 +3,15 @@ from typing import Any, cast
 
 
 class _UndefMeta(type):
+    def __new__(cls, name: str, bases: tuple[type, ...], attrs: dict[str, Any]) -> type:
+        cls.__name__ = "undefined"
+        cls.__qualname__ = "undefined"
+
+        undefined_class = super().__new__(cls, name, bases, attrs)
+        undefined_class.__name__ = "undefined"
+        undefined_class.__qualname__ = "undefined"
+        return undefined_class
+
     def __repr__(cls) -> str:
         return "undefined"
 

vellum/workflows/context.py

@@ -1,5 +1,6 @@
 from contextlib import contextmanager
 import threading
+from uuid import UUID
 from typing import Iterator, Optional, cast
 
 from vellum.client.core import UniversalBaseModel
@@ -8,6 +9,7 @@ from vellum.workflows.events.types import ParentContext
 
 class ExecutionContext(UniversalBaseModel):
     parent_context: Optional[ParentContext] = None
+    trace_id: Optional[UUID] = None
 
 
 _CONTEXT_KEY = "_execution_context"
@@ -30,11 +32,14 @@ def get_parent_context() -> ParentContext:
 
 
 @contextmanager
-def execution_context(parent_context: Optional[ParentContext] = None) -> Iterator[None]:
+def execution_context(
+    parent_context: Optional[ParentContext] = None, trace_id: Optional[UUID] = None
+) -> Iterator[None]:
     """Context manager for handling execution context."""
     prev_context = get_execution_context()
-    set_context = ExecutionContext(parent_context=parent_context) if parent_context else prev_context
-
+    set_trace_id = prev_context.trace_id or trace_id
+    set_parent_context = parent_context or prev_context.parent_context
+    set_context = ExecutionContext(parent_context=set_parent_context, trace_id=set_trace_id)
     try:
         set_execution_context(set_context)
         yield

vellum/workflows/nodes/core/map_node/node.py

@@ -42,8 +42,8 @@ class MapNode(BaseAdornmentNode[StateType], Generic[StateType, MapNodeItemType])
     Used to map over a list of items and execute a Subworkflow on each iteration.
 
     items: List[MapNodeItemType] - The items to map over
-    subworkflow: Type["BaseWorkflow[SubworkflowInputs, BaseState]"] - The Subworkflow to execute on each iteration
     max_concurrency: Optional[int] = None - The maximum number of concurrent subworkflow executions
+    subworkflow: Type["BaseWorkflow"] - The Subworkflow to execute
     """
 
     items: List[MapNodeItemType]

vellum/workflows/nodes/core/retry_node/node.py

@@ -18,9 +18,10 @@ class RetryNode(BaseAdornmentNode[StateType], Generic[StateType]):
     Used to retry a Subworkflow a specified number of times.
 
     max_attempts: int - The maximum number of attempts to retry the Subworkflow
-    delay: float - The number of seconds to wait between retries
-    retry_on_error_code: Optional[VellumErrorCode] = None - The error code to retry on
-    subworkflow: Type["BaseWorkflow[SubworkflowInputs, BaseState]"] - The Subworkflow to execute
+    delay: float = None - The number of seconds to wait between retries
+    retry_on_error_code: Optional[WorkflowErrorCode] = None - The error code to retry on
+    retry_on_condition: Optional[BaseDescriptor] = None - The condition to retry on
+    subworkflow: Type["BaseWorkflow"] - The Subworkflow to execute
     """
 
     max_attempts: int

vellum/workflows/nodes/core/try_node/node.py

@@ -17,7 +17,7 @@ class TryNode(BaseAdornmentNode[StateType], Generic[StateType]):
     """
     Used to execute a Subworkflow and handle errors.
 
-    on_error_code: Optional[VellumErrorCode] = None - The error code to handle
+    on_error_code: Optional[WorkflowErrorCode] = None - The error code to handle
     subworkflow: Type["BaseWorkflow"] - The Subworkflow to execute
     """
 

vellum/workflows/nodes/displayable/bases/inline_prompt_node/node.py

@@ -17,6 +17,7 @@ from vellum import (
 )
 from vellum.client import RequestOptions
 from vellum.client.types.chat_message_request import ChatMessageRequest
+from vellum.client.types.prompt_settings import PromptSettings
 from vellum.workflows.constants import OMIT
 from vellum.workflows.context import get_parent_context
 from vellum.workflows.errors import WorkflowErrorCode
@@ -53,6 +54,8 @@ class BaseInlinePromptNode(BasePromptNode[StateType], Generic[StateType]):
     parameters: PromptParameters = DEFAULT_PROMPT_PARAMETERS
     expand_meta: Optional[AdHocExpandMeta] = OMIT
 
+    settings: Optional[PromptSettings] = None
+
     class Trigger(BasePromptNode.Trigger):
         merge_behavior = MergeBehavior.AWAIT_ANY
 
@@ -60,6 +63,7 @@ class BaseInlinePromptNode(BasePromptNode[StateType], Generic[StateType]):
         input_variables, input_values = self._compile_prompt_inputs()
         parent_context = get_parent_context()
         request_options = self.request_options or RequestOptions()
+
         request_options["additional_body_parameters"] = {
             "execution_context": {"parent_context": parent_context},
             **request_options.get("additional_body_parameters", {}),
@@ -79,6 +83,7 @@ class BaseInlinePromptNode(BasePromptNode[StateType], Generic[StateType]):
             input_variables=input_variables,
             parameters=self.parameters,
             blocks=self.blocks,
+            settings=self.settings,
             functions=normalized_functions,
             expand_meta=self.expand_meta,
             request_options=request_options,

vellum/workflows/nodes/displayable/code_execution_node/tests/test_code_execution_node.py

@@ -1,12 +1,16 @@
 import pytest
 import os
-from typing import Any, Union
+from typing import Any, List, Union
+
+from pydantic import BaseModel
 
 from vellum import CodeExecutorResponse, NumberVellumValue, StringInput, StringVellumValue
+from vellum.client.types.chat_message import ChatMessage
 from vellum.client.types.code_execution_package import CodeExecutionPackage
 from vellum.client.types.code_executor_secret_input import CodeExecutorSecretInput
 from vellum.client.types.function_call import FunctionCall
 from vellum.client.types.number_input import NumberInput
+from vellum.client.types.string_chat_message_content import StringChatMessageContent
 from vellum.workflows.errors import WorkflowErrorCode
 from vellum.workflows.exceptions import NodeException
 from vellum.workflows.inputs.base import BaseInputs
@@ -610,3 +614,79 @@ def main(arg1: list[bool]) -> int:
 
     # AND the error should contain the execution error details
     assert outputs == {"result": 3, "log": ""}
+
+
+def test_run_node__union_output_type__pydantic_children():
+    # GIVEN a node that is a union type with a pydantic child
+    class OptionOne(BaseModel):
+        foo: str
+
+    class OptionTwo(BaseModel):
+        bar: int
+
+    class ExampleCodeExecutionNode(CodeExecutionNode[BaseState, Union[OptionOne, OptionTwo]]):
+        code = """\
+def main():
+    return { "foo": "hello" }
+"""
+        runtime = "PYTHON_3_11_6"
+        code_inputs = {}
+
+    # WHEN we run the node
+    node = ExampleCodeExecutionNode()
+
+    # THEN it should run successfully
+    outputs = node.run()
+
+    # AND the result should be the correct type
+    assert outputs == {"result": OptionOne(foo="hello"), "log": ""}
+
+
+def test_run_node__union_output_type__miss():
+    # GIVEN a node that is a union type
+    class ExampleCodeExecutionNode(CodeExecutionNode[BaseState, Union[int, float]]):
+        code = """\
+def main():
+    return "hello"
+"""
+        runtime = "PYTHON_3_11_6"
+        code_inputs = {}
+
+    # WHEN we run the node
+    node = ExampleCodeExecutionNode()
+
+    # THEN it should raise a NodeException with the execution error
+    with pytest.raises(NodeException) as exc_info:
+        node.run()
+
+    # AND the error should contain the execution error details
+    assert exc_info.value.message == "Expected an output of type 'int | float', but received 'str'"
+
+
+def test_run_node__chat_history_output_type():
+    # GIVEN a node that that has a chat history return type
+    class ExampleCodeExecutionNode(CodeExecutionNode[BaseState, List[ChatMessage]]):
+        code = """\
+def main():
+    return [
+        {
+            "role": "USER",
+            "content": {
+                "type": "STRING",
+                "value": "Hello, world!",
+            }
+        }
+    ]
+"""
+        code_inputs = {}
+        runtime = "PYTHON_3_11_6"
+
+    # WHEN we run the node
+    node = ExampleCodeExecutionNode()
+    outputs = node.run()
+
+    # AND the error should contain the execution error details
+    assert outputs == {
+        "result": [ChatMessage(role="USER", content=StringChatMessageContent(value="Hello, world!"))],
+        "log": "",
+    }