vellum-ai 0.14.40__py3-none-any.whl → 0.14.42__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,
@@ -518,7 +518,6 @@ from .types import (
     WorkflowDeploymentReleaseWorkflowDeployment,
     WorkflowDeploymentReleaseWorkflowVersion,
     WorkflowError,
-    WorkflowEventDisplayContext,
     WorkflowEventError,
     WorkflowEventExecutionRead,
     WorkflowExecutionActual,
@@ -728,6 +727,7 @@ __all__ = [
     "ExecuteApiRequestBody",
     "ExecuteApiRequestHeadersValue",
     "ExecuteApiResponse",
+    "ExecuteApiResponseJson",
     "ExecutePromptEvent",
     "ExecutePromptResponse",
     "ExecuteWorkflowResponse",
@@ -858,7 +858,6 @@ __all__ = [
     "NamedTestCaseVariableValue",
     "NamedTestCaseVariableValueRequest",
     "NewMemberJoinBehaviorEnum",
-    "NodeEventDisplayContext",
     "NodeExecutionFulfilledBody",
     "NodeExecutionFulfilledEvent",
     "NodeExecutionInitiatedBody",
@@ -1151,7 +1150,6 @@ __all__ = [
     "WorkflowDeploymentReleaseWorkflowVersion",
     "WorkflowDeploymentsListRequestStatus",
     "WorkflowError",
-    "WorkflowEventDisplayContext",
     "WorkflowEventError",
     "WorkflowEventExecutionRead",
     "WorkflowExecutionActual",

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.40",
+            "X-Fern-SDK-Version": "0.14.42",
         }
         headers["X_API_KEY"] = self.api_key
         return headers

vellum/client/reference.md

@@ -1206,6 +1206,143 @@ client.submit_workflow_execution_actuals(
 </details>
 
 ## AdHoc
+<details><summary><code>client.ad_hoc.<a href="src/vellum/resources/ad_hoc/client.py">adhoc_execute_prompt</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from vellum import (
+    JinjaPromptBlock,
+    PromptParameters,
+    PromptRequestStringInput,
+    Vellum,
+    VellumVariable,
+)
+
+client = Vellum(
+    api_key="YOUR_API_KEY",
+)
+client.ad_hoc.adhoc_execute_prompt(
+    ml_model="ml_model",
+    input_values=[
+        PromptRequestStringInput(
+            key="key",
+            value="value",
+        )
+    ],
+    input_variables=[
+        VellumVariable(
+            id="id",
+            key="key",
+            type="STRING",
+        )
+    ],
+    parameters=PromptParameters(),
+    blocks=[
+        JinjaPromptBlock(
+            template="template",
+        )
+    ],
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**ml_model:** `str` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**input_values:** `typing.Sequence[PromptRequestInput]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**input_variables:** `typing.Sequence[VellumVariable]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**parameters:** `PromptParameters` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**blocks:** `typing.Sequence[PromptBlock]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**settings:** `typing.Optional[PromptSettings]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**functions:** `typing.Optional[typing.Sequence[FunctionDefinition]]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**expand_meta:** `typing.Optional[AdHocExpandMeta]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.ad_hoc.<a href="src/vellum/resources/ad_hoc/client.py">adhoc_execute_prompt_stream</a>(...)</code></summary>
 <dl>
 <dd>
@@ -2110,7 +2247,7 @@ client.deployments.update_deployment_release_tag(
 <dl>
 <dd>
 
-**history_item_id:** `typing.Optional[str]` — The ID of the Deployment History Item to tag
+**history_item_id:** `typing.Optional[str]` — The ID of the Release to tag
     
 </dd>
 </dl>
@@ -3271,7 +3408,7 @@ client.documents.retrieve(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this document.
+**id:** `str` 
     
 </dd>
 </dl>
@@ -3341,7 +3478,7 @@ client.documents.destroy(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this document.
+**id:** `str` 
     
 </dd>
 </dl>
@@ -3411,7 +3548,7 @@ client.documents.partial_update(
 <dl>
 <dd>
 
-**id:** `str` — A UUID string identifying this document.
+**id:** `str` 
     
 </dd>
 </dl>

vellum/client/resources/ad_hoc/client.py

@@ -13,12 +13,12 @@ from ...core.request_options import RequestOptions
 from ...types.ad_hoc_execute_prompt_event import AdHocExecutePromptEvent
 from ...core.serialization import convert_and_respect_annotation_metadata
 from ...core.pydantic_utilities import parse_obj_as
-import json
 from ...errors.bad_request_error import BadRequestError
 from ...errors.forbidden_error import ForbiddenError
 from ...errors.internal_server_error import InternalServerError
 from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
+import json
 from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -29,6 +29,157 @@ class AdHocClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
+    def adhoc_execute_prompt(
+        self,
+        *,
+        ml_model: str,
+        input_values: typing.Sequence[PromptRequestInput],
+        input_variables: typing.Sequence[VellumVariable],
+        parameters: PromptParameters,
+        blocks: typing.Sequence[PromptBlock],
+        settings: typing.Optional[PromptSettings] = OMIT,
+        functions: typing.Optional[typing.Sequence[FunctionDefinition]] = OMIT,
+        expand_meta: typing.Optional[AdHocExpandMeta] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AdHocExecutePromptEvent:
+        """
+        Parameters
+        ----------
+        ml_model : str
+
+        input_values : typing.Sequence[PromptRequestInput]
+
+        input_variables : typing.Sequence[VellumVariable]
+
+        parameters : PromptParameters
+
+        blocks : typing.Sequence[PromptBlock]
+
+        settings : typing.Optional[PromptSettings]
+
+        functions : typing.Optional[typing.Sequence[FunctionDefinition]]
+
+        expand_meta : typing.Optional[AdHocExpandMeta]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AdHocExecutePromptEvent
+
+
+        Examples
+        --------
+        from vellum import (
+            JinjaPromptBlock,
+            PromptParameters,
+            PromptRequestStringInput,
+            Vellum,
+            VellumVariable,
+        )
+
+        client = Vellum(
+            api_key="YOUR_API_KEY",
+        )
+        client.ad_hoc.adhoc_execute_prompt(
+            ml_model="ml_model",
+            input_values=[
+                PromptRequestStringInput(
+                    key="key",
+                    value="value",
+                )
+            ],
+            input_variables=[
+                VellumVariable(
+                    id="id",
+                    key="key",
+                    type="STRING",
+                )
+            ],
+            parameters=PromptParameters(),
+            blocks=[
+                JinjaPromptBlock(
+                    template="template",
+                )
+            ],
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/ad-hoc/execute-prompt",
+            base_url=self._client_wrapper.get_environment().default,
+            method="POST",
+            json={
+                "ml_model": ml_model,
+                "input_values": convert_and_respect_annotation_metadata(
+                    object_=input_values, annotation=typing.Sequence[PromptRequestInput], direction="write"
+                ),
+                "input_variables": convert_and_respect_annotation_metadata(
+                    object_=input_variables, annotation=typing.Sequence[VellumVariable], direction="write"
+                ),
+                "parameters": convert_and_respect_annotation_metadata(
+                    object_=parameters, annotation=PromptParameters, direction="write"
+                ),
+                "settings": convert_and_respect_annotation_metadata(
+                    object_=settings, annotation=PromptSettings, direction="write"
+                ),
+                "blocks": convert_and_respect_annotation_metadata(
+                    object_=blocks, annotation=typing.Sequence[PromptBlock], direction="write"
+                ),
+                "functions": convert_and_respect_annotation_metadata(
+                    object_=functions, annotation=typing.Sequence[FunctionDefinition], direction="write"
+                ),
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=AdHocExpandMeta, direction="write"
+                ),
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    AdHocExecutePromptEvent,
+                    parse_obj_as(
+                        type_=AdHocExecutePromptEvent,  # 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 == 403:
+                raise ForbiddenError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    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 adhoc_execute_prompt_stream(
         self,
         *,
@@ -195,6 +346,165 @@ class AsyncAdHocClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
+    async def adhoc_execute_prompt(
+        self,
+        *,
+        ml_model: str,
+        input_values: typing.Sequence[PromptRequestInput],
+        input_variables: typing.Sequence[VellumVariable],
+        parameters: PromptParameters,
+        blocks: typing.Sequence[PromptBlock],
+        settings: typing.Optional[PromptSettings] = OMIT,
+        functions: typing.Optional[typing.Sequence[FunctionDefinition]] = OMIT,
+        expand_meta: typing.Optional[AdHocExpandMeta] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AdHocExecutePromptEvent:
+        """
+        Parameters
+        ----------
+        ml_model : str
+
+        input_values : typing.Sequence[PromptRequestInput]
+
+        input_variables : typing.Sequence[VellumVariable]
+
+        parameters : PromptParameters
+
+        blocks : typing.Sequence[PromptBlock]
+
+        settings : typing.Optional[PromptSettings]
+
+        functions : typing.Optional[typing.Sequence[FunctionDefinition]]
+
+        expand_meta : typing.Optional[AdHocExpandMeta]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AdHocExecutePromptEvent
+
+
+        Examples
+        --------
+        import asyncio
+
+        from vellum import (
+            AsyncVellum,
+            JinjaPromptBlock,
+            PromptParameters,
+            PromptRequestStringInput,
+            VellumVariable,
+        )
+
+        client = AsyncVellum(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.ad_hoc.adhoc_execute_prompt(
+                ml_model="ml_model",
+                input_values=[
+                    PromptRequestStringInput(
+                        key="key",
+                        value="value",
+                    )
+                ],
+                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/ad-hoc/execute-prompt",
+            base_url=self._client_wrapper.get_environment().default,
+            method="POST",
+            json={
+                "ml_model": ml_model,
+                "input_values": convert_and_respect_annotation_metadata(
+                    object_=input_values, annotation=typing.Sequence[PromptRequestInput], direction="write"
+                ),
+                "input_variables": convert_and_respect_annotation_metadata(
+                    object_=input_variables, annotation=typing.Sequence[VellumVariable], direction="write"
+                ),
+                "parameters": convert_and_respect_annotation_metadata(
+                    object_=parameters, annotation=PromptParameters, direction="write"
+                ),
+                "settings": convert_and_respect_annotation_metadata(
+                    object_=settings, annotation=PromptSettings, direction="write"
+                ),
+                "blocks": convert_and_respect_annotation_metadata(
+                    object_=blocks, annotation=typing.Sequence[PromptBlock], direction="write"
+                ),
+                "functions": convert_and_respect_annotation_metadata(
+                    object_=functions, annotation=typing.Sequence[FunctionDefinition], direction="write"
+                ),
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=AdHocExpandMeta, direction="write"
+                ),
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    AdHocExecutePromptEvent,
+                    parse_obj_as(
+                        type_=AdHocExecutePromptEvent,  # 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 == 403:
+                raise ForbiddenError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    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 adhoc_execute_prompt_stream(
         self,
         *,

vellum/client/resources/deployments/client.py

@@ -351,7 +351,7 @@ class DeploymentsClient:
             The name of the Release Tag associated with this Deployment that you'd like to update.
 
         history_item_id : typing.Optional[str]
-            The ID of the Deployment History Item to tag
+            The ID of the Release to tag
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -895,7 +895,7 @@ class AsyncDeploymentsClient:
             The name of the Release Tag associated with this Deployment that you'd like to update.
 
         history_item_id : typing.Optional[str]
-            The ID of the Deployment History Item to tag
+            The ID of the Release to tag
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

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/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
@@ -542,7 +542,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 +714,7 @@ __all__ = [
     "ExecuteApiRequestBody",
     "ExecuteApiRequestHeadersValue",
     "ExecuteApiResponse",
+    "ExecuteApiResponseJson",
     "ExecutePromptEvent",
     "ExecutePromptResponse",
     "ExecuteWorkflowResponse",
@@ -839,7 +839,6 @@ __all__ = [
     "NamedTestCaseVariableValue",
     "NamedTestCaseVariableValueRequest",
     "NewMemberJoinBehaviorEnum",
-    "NodeEventDisplayContext",
     "NodeExecutionFulfilledBody",
     "NodeExecutionFulfilledEvent",
     "NodeExecutionInitiatedBody",
@@ -1128,7 +1127,6 @@ __all__ = [
     "WorkflowDeploymentReleaseWorkflowDeployment",
     "WorkflowDeploymentReleaseWorkflowVersion",
     "WorkflowError",
-    "WorkflowEventDisplayContext",
     "WorkflowEventError",
     "WorkflowEventExecutionRead",
     "WorkflowExecutionActual",