vellum-ai 0.14.42__tar.gz → 0.14.43__tar.gz

{vellum_ai-0.14.42 → vellum_ai-0.14.43}/PKG-INFO

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

{vellum_ai-0.14.42 → vellum_ai-0.14.43}/ee/vellum_cli/pull.py

@@ -179,6 +179,13 @@ def pull_command(
     except ApiError as e:
         if e.status_code == 401 or e.status_code == 403:
             raise Exception("Please make sure your `VELLUM_API_KEY` environment variable is set correctly.")
+
+        if e.status_code == 500:
+            raise Exception(
+                "The Pull API failed with an unexpected error. Please try again later and contact support if the problem persists."  # noqa: E501
+            )
+
+        # TODO: We should return an Origin header in to validate this case
         raise Exception(
             "The API we tried to pull is invalid. Please make sure your `VELLUM_API_URL` environment variable is set correctly."  # noqa: E501
         )

{vellum_ai-0.14.42 → vellum_ai-0.14.43}/ee/vellum_cli/tests/test_pull.py

@@ -950,6 +950,29 @@ def test_pull__unauthorized_error_path(vellum_client):
     assert str(result.exception) == "Please make sure your `VELLUM_API_KEY` environment variable is set correctly."
 
 
+def test_pull__unexpected_error_path(vellum_client):
+    workflow_deployment = "test-workflow-deployment-id"
+
+    # GIVEN an unauthorized error with the error message from the API
+    def mock_error_generator():
+        yield b""
+        raise ApiError(status_code=500, body={"detail": "Internal server error"})
+
+    vellum_client.workflows.pull.return_value = mock_error_generator()
+
+    # WHEN the user runs the pull command
+    runner = CliRunner()
+    result = runner.invoke(cli_main, ["workflows", "pull", "--workflow-deployment", workflow_deployment])
+
+    # THEN the command returns an error
+    assert result.exit_code == 1
+    assert (
+        str(result.exception)
+        == """The Pull API failed with an unexpected error. \
+Please try again later and contact support if the problem persists."""
+    )
+
+
 @pytest.mark.parametrize(
     "workflow_deployment",
     [

{vellum_ai-0.14.42 → vellum_ai-0.14.43}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vellum-ai"
-version = "0.14.42"
+version = "0.14.43"
 description = ""
 readme = "README.md"
 authors = []

{vellum_ai-0.14.42 → vellum_ai-0.14.43}/src/vellum/__init__.py

@@ -310,6 +310,7 @@ from .types import (
     PromptNodeResultData,
     PromptOutput,
     PromptParameters,
+    PromptPushResponse,
     PromptRequestChatHistoryInput,
     PromptRequestInput,
     PromptRequestJsonInput,
@@ -939,6 +940,7 @@ __all__ = [
     "PromptNodeResultData",
     "PromptOutput",
     "PromptParameters",
+    "PromptPushResponse",
     "PromptRequestChatHistoryInput",
     "PromptRequestInput",
     "PromptRequestJsonInput",

{vellum_ai-0.14.42 → vellum_ai-0.14.43}/src/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.42",
+            "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_ai-0.14.42 → vellum_ai-0.14.43}/src/vellum/client/reference.md

@@ -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_ai-0.14.43/src/vellum/client/resources/prompts/client.py

@@ -0,0 +1,424 @@
+# This file was auto-generated by Fern from our API Definition.
+
+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
+from ...core.pydantic_utilities import parse_obj_as
+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):
+        self._client_wrapper = client_wrapper
+
+    def pull(
+        self,
+        id: str,
+        *,
+        prompt_variant_id: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PromptExecConfig:
+        """
+        Used to pull the definition of a Prompt from Vellum.
+
+        Parameters
+        ----------
+        id : str
+            The ID of the Prompt to pull from. Prompt Sandbox IDs are currently supported.
+
+        prompt_variant_id : typing.Optional[str]
+            The ID of the Prompt Variant within a Prompt Sandbox to pull. Must be included if providing the ID of a Prompt Sandbox.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PromptExecConfig
+
+
+        Examples
+        --------
+        from vellum import Vellum
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.prompts.pull(
+            id="id",
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/prompts/{jsonable_encoder(id)}/pull",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            params={
+                "prompt_variant_id": prompt_variant_id,
+            },
+            headers={
+                "Accept": "application/json",
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PromptExecConfig,
+                    parse_obj_as(
+                        type_=PromptExecConfig,  # 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)
+
+    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):
+        self._client_wrapper = client_wrapper
+
+    async def pull(
+        self,
+        id: str,
+        *,
+        prompt_variant_id: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PromptExecConfig:
+        """
+        Used to pull the definition of a Prompt from Vellum.
+
+        Parameters
+        ----------
+        id : str
+            The ID of the Prompt to pull from. Prompt Sandbox IDs are currently supported.
+
+        prompt_variant_id : typing.Optional[str]
+            The ID of the Prompt Variant within a Prompt Sandbox to pull. Must be included if providing the ID of a Prompt Sandbox.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PromptExecConfig
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import AsyncVellum
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.prompts.pull(
+                id="id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/prompts/{jsonable_encoder(id)}/pull",
+            base_url=self._client_wrapper.get_environment().default,
+            method="GET",
+            params={
+                "prompt_variant_id": prompt_variant_id,
+            },
+            headers={
+                "Accept": "application/json",
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PromptExecConfig,
+                    parse_obj_as(
+                        type_=PromptExecConfig,  # 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)
+
+    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_ai-0.14.42 → vellum_ai-0.14.43}/src/vellum/client/types/__init__.py

@@ -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
@@ -919,6 +920,7 @@ __all__ = [
     "PromptNodeResultData",
     "PromptOutput",
     "PromptParameters",
+    "PromptPushResponse",
     "PromptRequestChatHistoryInput",
     "PromptRequestInput",
     "PromptRequestJsonInput",

{vellum_ai-0.14.42 → vellum_ai-0.14.43}/src/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_ai-0.14.43/src/vellum/client/types/prompt_push_response.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+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
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

vellum_ai-0.14.43/src/vellum/types/prompt_push_response.py

@@ -0,0 +1,3 @@
+# WARNING: This file will be removed in a future release. Please import from "vellum.client" instead.
+
+from vellum.client.types.prompt_push_response import *

{vellum_ai-0.14.42 → vellum_ai-0.14.43}/src/vellum/workflows/nodes/bases/base.py

@@ -41,9 +41,6 @@ def is_nested_class(nested: Any, parent: Type) -> bool:
 
 class BaseNodeMeta(type):
     def __new__(mcs, name: str, bases: Tuple[Type, ...], dct: Dict[str, Any]) -> Any:
-        # TODO: Inherit the inner Output classes from every base class.
-        #   https://app.shortcut.com/vellum/story/4007/support-auto-inheriting-parent-node-outputs
-
         if "Outputs" in dct:
             outputs_class = dct["Outputs"]
             if not any(issubclass(base, BaseOutputs) for base in outputs_class.__bases__):