vellum-ai 0.14.41__py3-none-any.whl → 0.14.43__py3-none-any.whl

vellum/__init__.py

@@ -105,6 +105,7 @@ from .types import (
     ExecuteApiRequestBody,
     ExecuteApiRequestHeadersValue,
     ExecuteApiResponse,
+    ExecuteApiResponseJson,
     ExecutePromptEvent,
     ExecutePromptResponse,
     ExecuteWorkflowResponse,
@@ -229,7 +230,6 @@ from .types import (
     NamedTestCaseVariableValue,
     NamedTestCaseVariableValueRequest,
     NewMemberJoinBehaviorEnum,
-    NodeEventDisplayContext,
     NodeExecutionFulfilledBody,
     NodeExecutionFulfilledEvent,
     NodeExecutionInitiatedBody,
@@ -310,6 +310,7 @@ from .types import (
     PromptNodeResultData,
     PromptOutput,
     PromptParameters,
+    PromptPushResponse,
     PromptRequestChatHistoryInput,
     PromptRequestInput,
     PromptRequestJsonInput,
@@ -518,7 +519,6 @@ from .types import (
     WorkflowDeploymentReleaseWorkflowDeployment,
     WorkflowDeploymentReleaseWorkflowVersion,
     WorkflowError,
-    WorkflowEventDisplayContext,
     WorkflowEventError,
     WorkflowEventExecutionRead,
     WorkflowExecutionActual,
@@ -728,6 +728,7 @@ __all__ = [
     "ExecuteApiRequestBody",
     "ExecuteApiRequestHeadersValue",
     "ExecuteApiResponse",
+    "ExecuteApiResponseJson",
     "ExecutePromptEvent",
     "ExecutePromptResponse",
     "ExecuteWorkflowResponse",
@@ -858,7 +859,6 @@ __all__ = [
     "NamedTestCaseVariableValue",
     "NamedTestCaseVariableValueRequest",
     "NewMemberJoinBehaviorEnum",
-    "NodeEventDisplayContext",
     "NodeExecutionFulfilledBody",
     "NodeExecutionFulfilledEvent",
     "NodeExecutionInitiatedBody",
@@ -940,6 +940,7 @@ __all__ = [
     "PromptNodeResultData",
     "PromptOutput",
     "PromptParameters",
+    "PromptPushResponse",
     "PromptRequestChatHistoryInput",
     "PromptRequestInput",
     "PromptRequestJsonInput",
@@ -1151,7 +1152,6 @@ __all__ = [
     "WorkflowDeploymentReleaseWorkflowVersion",
     "WorkflowDeploymentsListRequestStatus",
     "WorkflowError",
-    "WorkflowEventDisplayContext",
     "WorkflowEventError",
     "WorkflowEventExecutionRead",
     "WorkflowExecutionActual",

vellum/client/core/client_wrapper.py

@@ -18,9 +18,9 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "vellum-ai",
-            "X-Fern-SDK-Version": "0.14.41",
+            "X-Fern-SDK-Version": "0.14.43",
         }
-        headers["X_API_KEY"] = self.api_key
+        headers["X-API-KEY"] = self.api_key
         return headers
 
     def get_environment(self) -> VellumEnvironment:

vellum/client/reference.md

@@ -3408,7 +3408,7 @@ client.documents.retrieve(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this document.
+**id:** `str` 
     
 </dd>
 </dl>
@@ -3478,7 +3478,7 @@ client.documents.destroy(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this document.
+**id:** `str` 
     
 </dd>
 </dl>
@@ -3548,7 +3548,7 @@ client.documents.partial_update(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this document.
+**id:** `str` 
     
 </dd>
 </dl>
@@ -4266,6 +4266,113 @@ client.prompts.pull(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.prompts.<a href="src/vellum/resources/prompts/client.py">push</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Used to push updates to a Prompt in Vellum.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import (
+    JinjaPromptBlock,
+    PromptExecConfig,
+    PromptParameters,
+    Vellum,
+    VellumVariable,
+)
+
+client = Vellum(
+    api_key="YOUR_API_KEY",
+)
+client.prompts.push(
+    exec_config=PromptExecConfig(
+        ml_model="ml_model",
+        input_variables=[
+            VellumVariable(
+                id="id",
+                key="key",
+                type="STRING",
+            )
+        ],
+        parameters=PromptParameters(),
+        blocks=[
+            JinjaPromptBlock(
+                template="template",
+            )
+        ],
+    ),
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**exec_config:** `PromptExecConfig` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**prompt_variant_id:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**prompt_sandbox_id:** `typing.Optional[str]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

vellum/client/resources/documents/client.py

@@ -106,7 +106,6 @@ class DocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -154,7 +153,6 @@ class DocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -203,7 +201,6 @@ class DocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         label : typing.Optional[str]
             A human-readable label for the document. Defaults to the originally uploaded file's file name.
@@ -471,7 +468,6 @@ class AsyncDocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -527,7 +523,6 @@ class AsyncDocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -584,7 +579,6 @@ class AsyncDocumentsClient:
         Parameters
         ----------
         id : str
-            A UUID string identifying this document.
 
         label : typing.Optional[str]
             A human-readable label for the document. Defaults to the originally uploaded file's file name.

vellum/client/resources/prompts/client.py

@@ -1,7 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.client_wrapper import SyncClientWrapper
 import typing
+from ...core.client_wrapper import SyncClientWrapper
 from ...core.request_options import RequestOptions
 from ...types.prompt_exec_config import PromptExecConfig
 from ...core.jsonable_encoder import jsonable_encoder
@@ -10,8 +10,13 @@ from ...errors.bad_request_error import BadRequestError
 from ...errors.not_found_error import NotFoundError
 from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
+from ...types.prompt_push_response import PromptPushResponse
+from ...core.serialization import convert_and_respect_annotation_metadata
 from ...core.client_wrapper import AsyncClientWrapper
 
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
 
 class PromptsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
@@ -100,6 +105,113 @@ class PromptsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def push(
+        self,
+        *,
+        exec_config: PromptExecConfig,
+        prompt_variant_id: typing.Optional[str] = OMIT,
+        prompt_sandbox_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PromptPushResponse:
+        """
+        Used to push updates to a Prompt in Vellum.
+
+        Parameters
+        ----------
+        exec_config : PromptExecConfig
+
+        prompt_variant_id : typing.Optional[str]
+
+        prompt_sandbox_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PromptPushResponse
+
+
+        Examples
+        --------
+        from vellum import (
+            JinjaPromptBlock,
+            PromptExecConfig,
+            PromptParameters,
+            Vellum,
+            VellumVariable,
+        )
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.push(
+            exec_config=PromptExecConfig(
+                ml_model="ml_model",
+                input_variables=[
+                    VellumVariable(
+                        id="id",
+                        key="key",
+                        type="STRING",
+                    )
+                ],
+                parameters=PromptParameters(),
+                blocks=[
+                    JinjaPromptBlock(
+                        template="template",
+                    )
+                ],
+            ),
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/prompts/push",
+            base_url=self._client_wrapper.get_environment().default,
+            method="POST",
+            json={
+                "exec_config": convert_and_respect_annotation_metadata(
+                    object_=exec_config, annotation=PromptExecConfig, direction="write"
+                ),
+                "prompt_variant_id": prompt_variant_id,
+                "prompt_sandbox_id": prompt_sandbox_id,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PromptPushResponse,
+                    parse_obj_as(
+                        type_=PromptPushResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    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, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
 
 class AsyncPromptsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -195,3 +307,118 @@ class AsyncPromptsClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def push(
+        self,
+        *,
+        exec_config: PromptExecConfig,
+        prompt_variant_id: typing.Optional[str] = OMIT,
+        prompt_sandbox_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PromptPushResponse:
+        """
+        Used to push updates to a Prompt in Vellum.
+
+        Parameters
+        ----------
+        exec_config : PromptExecConfig
+
+        prompt_variant_id : typing.Optional[str]
+
+        prompt_sandbox_id : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PromptPushResponse
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import (
+            AsyncVellum,
+            JinjaPromptBlock,
+            PromptExecConfig,
+            PromptParameters,
+            VellumVariable,
+        )
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.prompts.push(
+                exec_config=PromptExecConfig(
+                    ml_model="ml_model",
+                    input_variables=[
+                        VellumVariable(
+                            id="id",
+                            key="key",
+                            type="STRING",
+                        )
+                    ],
+                    parameters=PromptParameters(),
+                    blocks=[
+                        JinjaPromptBlock(
+                            template="template",
+                        )
+                    ],
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/prompts/push",
+            base_url=self._client_wrapper.get_environment().default,
+            method="POST",
+            json={
+                "exec_config": convert_and_respect_annotation_metadata(
+                    object_=exec_config, annotation=PromptExecConfig, direction="write"
+                ),
+                "prompt_variant_id": prompt_variant_id,
+                "prompt_sandbox_id": prompt_sandbox_id,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PromptPushResponse,
+                    parse_obj_as(
+                        type_=PromptPushResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    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, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

vellum/client/types/__init__.py

@@ -109,6 +109,7 @@ from .execute_api_request_bearer_token import ExecuteApiRequestBearerToken
 from .execute_api_request_body import ExecuteApiRequestBody
 from .execute_api_request_headers_value import ExecuteApiRequestHeadersValue
 from .execute_api_response import ExecuteApiResponse
+from .execute_api_response_json import ExecuteApiResponseJson
 from .execute_prompt_event import ExecutePromptEvent
 from .execute_prompt_response import ExecutePromptResponse
 from .execute_workflow_response import ExecuteWorkflowResponse
@@ -237,7 +238,6 @@ from .named_test_case_string_variable_value_request import NamedTestCaseStringVa
 from .named_test_case_variable_value import NamedTestCaseVariableValue
 from .named_test_case_variable_value_request import NamedTestCaseVariableValueRequest
 from .new_member_join_behavior_enum import NewMemberJoinBehaviorEnum
-from .node_event_display_context import NodeEventDisplayContext
 from .node_execution_fulfilled_body import NodeExecutionFulfilledBody
 from .node_execution_fulfilled_event import NodeExecutionFulfilledEvent
 from .node_execution_initiated_body import NodeExecutionInitiatedBody
@@ -318,6 +318,7 @@ from .prompt_node_result import PromptNodeResult
 from .prompt_node_result_data import PromptNodeResultData
 from .prompt_output import PromptOutput
 from .prompt_parameters import PromptParameters
+from .prompt_push_response import PromptPushResponse
 from .prompt_request_chat_history_input import PromptRequestChatHistoryInput
 from .prompt_request_input import PromptRequestInput
 from .prompt_request_json_input import PromptRequestJsonInput
@@ -542,7 +543,6 @@ from .workflow_deployment_release import WorkflowDeploymentRelease
 from .workflow_deployment_release_workflow_deployment import WorkflowDeploymentReleaseWorkflowDeployment
 from .workflow_deployment_release_workflow_version import WorkflowDeploymentReleaseWorkflowVersion
 from .workflow_error import WorkflowError
-from .workflow_event_display_context import WorkflowEventDisplayContext
 from .workflow_event_error import WorkflowEventError
 from .workflow_event_execution_read import WorkflowEventExecutionRead
 from .workflow_execution_actual import WorkflowExecutionActual
@@ -715,6 +715,7 @@ __all__ = [
     "ExecuteApiRequestBody",
     "ExecuteApiRequestHeadersValue",
     "ExecuteApiResponse",
+    "ExecuteApiResponseJson",
     "ExecutePromptEvent",
     "ExecutePromptResponse",
     "ExecuteWorkflowResponse",
@@ -839,7 +840,6 @@ __all__ = [
     "NamedTestCaseVariableValue",
     "NamedTestCaseVariableValueRequest",
     "NewMemberJoinBehaviorEnum",
-    "NodeEventDisplayContext",
     "NodeExecutionFulfilledBody",
     "NodeExecutionFulfilledEvent",
     "NodeExecutionInitiatedBody",
@@ -920,6 +920,7 @@ __all__ = [
     "PromptNodeResultData",
     "PromptOutput",
     "PromptParameters",
+    "PromptPushResponse",
     "PromptRequestChatHistoryInput",
     "PromptRequestInput",
     "PromptRequestJsonInput",
@@ -1128,7 +1129,6 @@ __all__ = [
     "WorkflowDeploymentReleaseWorkflowDeployment",
     "WorkflowDeploymentReleaseWorkflowVersion",
     "WorkflowError",
-    "WorkflowEventDisplayContext",
     "WorkflowEventError",
     "WorkflowEventExecutionRead",
     "WorkflowExecutionActual",

vellum/client/types/deployment_read.py

@@ -50,9 +50,9 @@ class DeploymentRead(UniversalBaseModel):
     A human-readable description of the deployment
     """
 
-    active_model_version_ids: typing.List[str] = pydantic.Field()
+    active_model_version_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
     """
-    Deprecated. The Prompt execution endpoints return a `prompt_version_id` that could be used instead.
+    Deprecated. This now always returns a null value.
     """
 
     last_deployed_history_item_id: str = pydantic.Field()

vellum/client/types/execute_api_response.py

@@ -2,8 +2,9 @@
 
 from ..core.pydantic_utilities import UniversalBaseModel
 import typing_extensions
-import typing
+from .execute_api_response_json import ExecuteApiResponseJson
 from ..core.serialization import FieldMetadata
+import typing
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import pydantic
 
@@ -11,9 +12,7 @@ import pydantic
 class ExecuteApiResponse(UniversalBaseModel):
     status_code: int
     text: str
-    json_: typing_extensions.Annotated[
-        typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="json")
-    ] = None
+    json_: typing_extensions.Annotated[ExecuteApiResponseJson, FieldMetadata(alias="json")]
     headers: typing.Dict[str, str]
 
     if IS_PYDANTIC_V2:

vellum/client/types/execute_api_response_json.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ExecuteApiResponseJson = typing.Union[
+    typing.Dict[str, typing.Optional[typing.Any]], typing.List[typing.Optional[typing.Any]]
+]

vellum/client/types/{workflow_event_display_context.py → prompt_push_response.py}

@@ -1,17 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from __future__ import annotations
 from ..core.pydantic_utilities import UniversalBaseModel
-import typing
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
 import pydantic
-from ..core.pydantic_utilities import update_forward_refs
 
 
-class WorkflowEventDisplayContext(UniversalBaseModel):
-    node_displays: typing.Dict[str, "NodeEventDisplayContext"]
-    workflow_inputs: typing.Dict[str, str]
-    workflow_outputs: typing.Dict[str, str]
+class PromptPushResponse(UniversalBaseModel):
+    prompt_variant_id: str
+    prompt_sandbox_id: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
@@ -21,8 +18,3 @@ class WorkflowEventDisplayContext(UniversalBaseModel):
             frozen = True
             smart_union = True
             extra = pydantic.Extra.allow
-
-
-from .node_event_display_context import NodeEventDisplayContext  # noqa: E402
-
-update_forward_refs(WorkflowEventDisplayContext)

vellum/client/types/prompt_settings.py

@@ -8,6 +8,7 @@ import pydantic
 
 class PromptSettings(UniversalBaseModel):
     timeout: typing.Optional[float] = None
+    stream_enabled: typing.Optional[bool] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

vellum/client/types/workflow_event_execution_read.py

@@ -10,8 +10,6 @@ from .workflow_deployment_parent_context import WorkflowDeploymentParentContext
 from .workflow_parent_context import WorkflowParentContext
 from .workflow_sandbox_parent_context import WorkflowSandboxParentContext
 from .array_vellum_value import ArrayVellumValue
-from .node_event_display_context import NodeEventDisplayContext
-from .workflow_event_display_context import WorkflowEventDisplayContext
 import typing
 import datetime as dt
 from .execution_vellum_value import ExecutionVellumValue
@@ -56,5 +54,3 @@ update_forward_refs(WorkflowDeploymentParentContext, WorkflowEventExecutionRead=
 update_forward_refs(WorkflowParentContext, WorkflowEventExecutionRead=WorkflowEventExecutionRead)
 update_forward_refs(WorkflowSandboxParentContext, WorkflowEventExecutionRead=WorkflowEventExecutionRead)
 update_forward_refs(ArrayVellumValue, WorkflowEventExecutionRead=WorkflowEventExecutionRead)
-update_forward_refs(NodeEventDisplayContext, WorkflowEventExecutionRead=WorkflowEventExecutionRead)
-update_forward_refs(WorkflowEventDisplayContext, WorkflowEventExecutionRead=WorkflowEventExecutionRead)