vellum-ai 0.7.11__py3-none-any.whl → 0.8.4__py3-none-any.whl

vellum/core/serialization.py

@@ -0,0 +1,170 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import collections
+import typing
+
+import typing_extensions
+
+
+class FieldMetadata:
+    """
+    Metadata class used to annotate fields to provide additional information.
+
+    Example:
+    class MyDict(TypedDict):
+        field: typing.Annotated[str, FieldMetadata(alias="field_name")]
+
+    Will serialize: `{"field": "value"}`
+    To: `{"field_name": "value"}`
+    """
+
+    alias: str
+
+    def __init__(self, *, alias: str) -> None:
+        self.alias = alias
+
+
+def convert_and_respect_annotation_metadata(
+    *,
+    object_: typing.Any,
+    annotation: typing.Any,
+    inner_type: typing.Optional[typing.Any] = None,
+) -> typing.Any:
+    """
+    Respect the metadata annotations on a field, such as aliasing. This function effectively
+    manipulates the dict-form of an object to respect the metadata annotations. This is primarily used for
+    TypedDicts, which cannot support aliasing out of the box, and can be extended for additional
+    utilities, such as defaults.
+
+    Parameters
+    ----------
+    object_ : typing.Any
+
+    annotation : type
+        The type we're looking to apply typing annotations from
+
+    inner_type : typing.Optional[type]
+
+    Returns
+    -------
+    typing.Any
+    """
+
+    if object_ is None:
+        return None
+    if inner_type is None:
+        inner_type = annotation
+
+    clean_type = _remove_annotations(inner_type)
+    if typing_extensions.is_typeddict(clean_type) and isinstance(object_, typing.Mapping):
+        return _convert_typeddict(object_, clean_type)
+
+    if (
+        # If you're iterating on a string, do not bother to coerce it to a sequence.
+        (not isinstance(object_, str))
+        and (
+            (
+                (
+                    typing_extensions.get_origin(clean_type) == typing.List
+                    or typing_extensions.get_origin(clean_type) == list
+                    or clean_type == typing.List
+                )
+                and isinstance(object_, typing.List)
+            )
+            or (
+                (
+                    typing_extensions.get_origin(clean_type) == typing.Set
+                    or typing_extensions.get_origin(clean_type) == set
+                    or clean_type == typing.Set
+                )
+                and isinstance(object_, typing.Set)
+            )
+            or (
+                (
+                    typing_extensions.get_origin(clean_type) == typing.Sequence
+                    or typing_extensions.get_origin(clean_type) == collections.abc.Sequence
+                    or clean_type == typing.Sequence
+                )
+                and isinstance(object_, typing.Sequence)
+            )
+        )
+    ):
+        inner_type = typing_extensions.get_args(clean_type)[0]
+        return [
+            convert_and_respect_annotation_metadata(object_=item, annotation=annotation, inner_type=inner_type)
+            for item in object_
+        ]
+
+    if typing_extensions.get_origin(clean_type) == typing.Union:
+        # We should be able to ~relatively~ safely try to convert keys against all
+        # member types in the union, the edge case here is if one member aliases a field
+        # of the same name to a different name from another member
+        # Or if another member aliases a field of the same name that another member does not.
+        for member in typing_extensions.get_args(clean_type):
+            object_ = convert_and_respect_annotation_metadata(object_=object_, annotation=annotation, inner_type=member)
+        return object_
+
+    annotated_type = _get_annotation(annotation)
+    if annotated_type is None:
+        return object_
+
+    # If the object is not a TypedDict, a Union, or other container (list, set, sequence, etc.)
+    # Then we can safely call it on the recursive conversion.
+    return object_
+
+
+def _convert_typeddict(object_: typing.Mapping[str, object], expected_type: typing.Any) -> typing.Mapping[str, object]:
+    converted_object: typing.Dict[str, object] = {}
+    annotations = typing_extensions.get_type_hints(expected_type, include_extras=True)
+    for key, value in object_.items():
+        type_ = annotations.get(key)
+        if type_ is None:
+            converted_object[key] = value
+        else:
+            converted_object[_alias_key(key, type_)] = convert_and_respect_annotation_metadata(
+                object_=value, annotation=type_
+            )
+    return converted_object
+
+
+def _get_annotation(type_: typing.Any) -> typing.Optional[typing.Any]:
+    maybe_annotated_type = typing_extensions.get_origin(type_)
+    if maybe_annotated_type is None:
+        return None
+
+    if maybe_annotated_type == typing_extensions.NotRequired:
+        type_ = typing_extensions.get_args(type_)[0]
+        maybe_annotated_type = typing_extensions.get_origin(type_)
+
+    if maybe_annotated_type == typing_extensions.Annotated:
+        return type_
+
+    return None
+
+
+def _remove_annotations(type_: typing.Any) -> typing.Any:
+    maybe_annotated_type = typing_extensions.get_origin(type_)
+    if maybe_annotated_type is None:
+        return type_
+
+    if maybe_annotated_type == typing_extensions.NotRequired:
+        return _remove_annotations(typing_extensions.get_args(type_)[0])
+
+    if maybe_annotated_type == typing_extensions.Annotated:
+        return _remove_annotations(typing_extensions.get_args(type_)[0])
+
+    return type_
+
+
+def _alias_key(key: str, type_: typing.Any) -> str:
+    maybe_annotated_type = _get_annotation(type_)
+
+    if maybe_annotated_type is not None:
+        # The actual annotations are 1 onward, the first is the annotated type
+        annotations = typing_extensions.get_args(maybe_annotated_type)[1:]
+
+        for annotation in annotations:
+            if isinstance(annotation, FieldMetadata) and annotation.alias is not None:
+                return annotation.alias
+
+    return key

vellum/errors/bad_request_error.py

@@ -1,10 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing
-
 from ..core.api_error import ApiError
+import typing
 
 
 class BadRequestError(ApiError):
-    def __init__(self, body: typing.Any):
+    def __init__(self, body: typing.Optional[typing.Any]):
         super().__init__(status_code=400, body=body)

vellum/errors/forbidden_error.py

@@ -1,10 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing
-
 from ..core.api_error import ApiError
+import typing
 
 
 class ForbiddenError(ApiError):
-    def __init__(self, body: typing.Any):
+    def __init__(self, body: typing.Optional[typing.Any]):
         super().__init__(status_code=403, body=body)

vellum/errors/internal_server_error.py

@@ -1,10 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing
-
 from ..core.api_error import ApiError
+import typing
 
 
 class InternalServerError(ApiError):
-    def __init__(self, body: typing.Any):
+    def __init__(self, body: typing.Optional[typing.Any]):
         super().__init__(status_code=500, body=body)

vellum/errors/not_found_error.py

@@ -1,10 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing
-
 from ..core.api_error import ApiError
+import typing
 
 
 class NotFoundError(ApiError):
-    def __init__(self, body: typing.Any):
+    def __init__(self, body: typing.Optional[typing.Any]):
         super().__init__(status_code=404, body=body)

vellum/lib/test_suites/resources.py

@@ -5,7 +5,7 @@ import time
 from functools import cached_property
 from typing import Callable, Generator, List, cast, Iterable
 
-from vellum import TestSuiteRunRead, TestSuiteRunMetricOutput_Number
+from vellum import TestSuiteRunRead, TestSuiteRunMetricNumberOutput
 from vellum.client import Vellum
 from vellum.lib.test_suites.constants import (
     DEFAULT_MAX_POLLING_DURATION_MS,
@@ -18,7 +18,7 @@ from vellum.types import (
     ExternalTestCaseExecutionRequest,
     NamedTestCaseVariableValueRequest,
     TestCaseVariableValue,
-    TestSuiteRunExecConfigRequest_External,
+    TestSuiteRunExternalExecConfigRequest,
     TestSuiteRunExecution,
     TestSuiteRunExternalExecConfigDataRequest,
     TestSuiteRunMetricOutput,
@@ -177,7 +177,7 @@ class VellumTestSuiteRunResults:
     ) -> List[float | None]:
         """Returns the values of a numeric metric output that match the given criteria."""
 
-        metric_outputs: list[TestSuiteRunMetricOutput_Number] = []
+        metric_outputs: list[TestSuiteRunMetricNumberOutput] = []
 
         for output in self.get_metric_outputs(
             metric_identifier=metric_identifier, output_identifier=output_identifier
@@ -321,7 +321,7 @@ class VellumTestSuite:
 
         test_suite_run = self.client.test_suite_runs.create(
             test_suite_id=self._test_suite_id,
-            exec_config=TestSuiteRunExecConfigRequest_External(
+            exec_config=TestSuiteRunExternalExecConfigRequest(
                 type="EXTERNAL",
                 data=TestSuiteRunExternalExecConfigDataRequest(
                     executions=executions,

vellum/resources/deployments/client.py

@@ -1,24 +1,24 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+from ...core.client_wrapper import SyncClientWrapper
+from .types.deployments_list_request_status import DeploymentsListRequestStatus
+from ...core.request_options import RequestOptions
+from ...types.paginated_slim_deployment_read_list import PaginatedSlimDeploymentReadList
+from ...core.pydantic_utilities import parse_obj_as
 from json.decoder import JSONDecodeError
-
 from ...core.api_error import ApiError
-from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ...types.deployment_read import DeploymentRead
 from ...core.jsonable_encoder import jsonable_encoder
-from ...core.pydantic_utilities import pydantic_v1
-from ...core.request_options import RequestOptions
+from ...types.deployment_release_tag_read import DeploymentReleaseTagRead
+from ...types.prompt_deployment_input_request import PromptDeploymentInputRequest
+from ...types.compile_prompt_deployment_expand_meta_request import CompilePromptDeploymentExpandMetaRequest
+from ...types.deployment_provider_payload_response import DeploymentProviderPayloadResponse
 from ...errors.bad_request_error import BadRequestError
 from ...errors.forbidden_error import ForbiddenError
-from ...errors.internal_server_error import InternalServerError
 from ...errors.not_found_error import NotFoundError
-from ...types.compile_prompt_deployment_expand_meta_request import CompilePromptDeploymentExpandMetaRequest
-from ...types.deployment_provider_payload_response import DeploymentProviderPayloadResponse
-from ...types.deployment_read import DeploymentRead
-from ...types.deployment_release_tag_read import DeploymentReleaseTagRead
-from ...types.paginated_slim_deployment_read_list import PaginatedSlimDeploymentReadList
-from ...types.prompt_deployment_input_request import PromptDeploymentInputRequest
-from .types.deployments_list_request_status import DeploymentsListRequestStatus
+from ...errors.internal_server_error import InternalServerError
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -64,7 +64,7 @@ class DeploymentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -75,12 +75,23 @@ class DeploymentsClient:
             "v1/deployments",
             base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            params={"limit": limit, "offset": offset, "ordering": ordering, "status": status},
+            params={
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+                "status": status,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PaginatedSlimDeploymentReadList, _response.json())  # type: ignore
+                return typing.cast(
+                    PaginatedSlimDeploymentReadList,
+                    parse_obj_as(
+                        type_=PaginatedSlimDeploymentReadList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -105,7 +116,7 @@ class DeploymentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -122,7 +133,13 @@ class DeploymentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DeploymentRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DeploymentRead,
+                    parse_obj_as(
+                        type_=DeploymentRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -152,7 +169,7 @@ class DeploymentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -170,7 +187,13 @@ class DeploymentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DeploymentReleaseTagRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DeploymentReleaseTagRead,
+                    parse_obj_as(
+                        type_=DeploymentReleaseTagRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -208,7 +231,7 @@ class DeploymentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
@@ -222,13 +245,21 @@ class DeploymentsClient:
             f"v1/deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
             base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            json={"history_item_id": history_item_id},
+            json={
+                "history_item_id": history_item_id,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DeploymentReleaseTagRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DeploymentReleaseTagRead,
+                    parse_obj_as(
+                        type_=DeploymentReleaseTagRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -282,13 +313,18 @@ class DeploymentsClient:
 
         Examples
         --------
-        from vellum.client import Vellum
+        from vellum import StringInputRequest, Vellum
 
         client = Vellum(
             api_key="YOUR_API_KEY",
         )
         client.deployments.retrieve_provider_payload(
-            inputs=[],
+            inputs=[
+                StringInputRequest(
+                    name="name",
+                    value="value",
+                )
+            ],
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -307,15 +343,53 @@ class DeploymentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DeploymentProviderPayloadResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    DeploymentProviderPayloadResponse,
+                    parse_obj_as(
+                        type_=DeploymentProviderPayloadResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             if _response.status_code == 400:
-                raise BadRequestError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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 == 404:
-                raise NotFoundError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                raise NotFoundError(
+                    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(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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)
@@ -364,7 +438,7 @@ class AsyncDeploymentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -381,12 +455,23 @@ class AsyncDeploymentsClient:
             "v1/deployments",
             base_url=self._client_wrapper.get_environment().default,
             method="GET",
-            params={"limit": limit, "offset": offset, "ordering": ordering, "status": status},
+            params={
+                "limit": limit,
+                "offset": offset,
+                "ordering": ordering,
+                "status": status,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(PaginatedSlimDeploymentReadList, _response.json())  # type: ignore
+                return typing.cast(
+                    PaginatedSlimDeploymentReadList,
+                    parse_obj_as(
+                        type_=PaginatedSlimDeploymentReadList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -413,7 +498,7 @@ class AsyncDeploymentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -436,7 +521,13 @@ class AsyncDeploymentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DeploymentRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DeploymentRead,
+                    parse_obj_as(
+                        type_=DeploymentRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -468,7 +559,7 @@ class AsyncDeploymentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -492,7 +583,13 @@ class AsyncDeploymentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DeploymentReleaseTagRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DeploymentReleaseTagRead,
+                    parse_obj_as(
+                        type_=DeploymentReleaseTagRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -532,7 +629,7 @@ class AsyncDeploymentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -552,13 +649,21 @@ class AsyncDeploymentsClient:
             f"v1/deployments/{jsonable_encoder(id)}/release-tags/{jsonable_encoder(name)}",
             base_url=self._client_wrapper.get_environment().default,
             method="PATCH",
-            json={"history_item_id": history_item_id},
+            json={
+                "history_item_id": history_item_id,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DeploymentReleaseTagRead, _response.json())  # type: ignore
+                return typing.cast(
+                    DeploymentReleaseTagRead,
+                    parse_obj_as(
+                        type_=DeploymentReleaseTagRead,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -614,7 +719,7 @@ class AsyncDeploymentsClient:
         --------
         import asyncio
 
-        from vellum.client import AsyncVellum
+        from vellum import AsyncVellum, StringInputRequest
 
         client = AsyncVellum(
             api_key="YOUR_API_KEY",
@@ -623,7 +728,12 @@ class AsyncDeploymentsClient:
 
         async def main() -> None:
             await client.deployments.retrieve_provider_payload(
-                inputs=[],
+                inputs=[
+                    StringInputRequest(
+                        name="name",
+                        value="value",
+                    )
+                ],
             )
 
 
@@ -645,15 +755,53 @@ class AsyncDeploymentsClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(DeploymentProviderPayloadResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    DeploymentProviderPayloadResponse,
+                    parse_obj_as(
+                        type_=DeploymentProviderPayloadResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             if _response.status_code == 400:
-                raise BadRequestError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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 == 404:
-                raise NotFoundError(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                raise NotFoundError(
+                    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(pydantic_v1.parse_obj_as(typing.Any, _response.json()))  # type: ignore
+                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)