vellum-ai 0.8.13__py3-none-any.whl → 0.8.14__py3-none-any.whl

vellum/client.py

@@ -19,6 +19,7 @@ from .types.prompt_deployment_expand_meta_request import PromptDeploymentExpandM
 from .types.raw_prompt_execution_overrides_request import RawPromptExecutionOverridesRequest
 from .core.request_options import RequestOptions
 from .types.execute_prompt_response import ExecutePromptResponse
+from .core.serialization import convert_and_respect_annotation_metadata
 from .core.pydantic_utilities import parse_obj_as
 from .errors.bad_request_error import BadRequestError
 from .errors.forbidden_error import ForbiddenError
@@ -197,13 +198,19 @@ class Vellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "inputs": inputs,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[PromptDeploymentInputRequest], direction="write"
+                ),
                 "prompt_deployment_id": prompt_deployment_id,
                 "prompt_deployment_name": prompt_deployment_name,
                 "release_tag": release_tag,
                 "external_id": external_id,
-                "expand_meta": expand_meta,
-                "raw_overrides": raw_overrides,
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=PromptDeploymentExpandMetaRequest, direction="write"
+                ),
+                "raw_overrides": convert_and_respect_annotation_metadata(
+                    object_=raw_overrides, annotation=RawPromptExecutionOverridesRequest, direction="write"
+                ),
                 "expand_raw": expand_raw,
                 "metadata": metadata,
             },
@@ -366,13 +373,19 @@ class Vellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "inputs": inputs,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[PromptDeploymentInputRequest], direction="write"
+                ),
                 "prompt_deployment_id": prompt_deployment_id,
                 "prompt_deployment_name": prompt_deployment_name,
                 "release_tag": release_tag,
                 "external_id": external_id,
-                "expand_meta": expand_meta,
-                "raw_overrides": raw_overrides,
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=PromptDeploymentExpandMetaRequest, direction="write"
+                ),
+                "raw_overrides": convert_and_respect_annotation_metadata(
+                    object_=raw_overrides, annotation=RawPromptExecutionOverridesRequest, direction="write"
+                ),
                 "expand_raw": expand_raw,
                 "metadata": metadata,
             },
@@ -508,8 +521,12 @@ class Vellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "inputs": inputs,
-                "expand_meta": expand_meta,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[WorkflowRequestInputRequest], direction="write"
+                ),
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=WorkflowExpandMetaRequest, direction="write"
+                ),
                 "workflow_deployment_id": workflow_deployment_id,
                 "workflow_deployment_name": workflow_deployment_name,
                 "release_tag": release_tag,
@@ -649,8 +666,12 @@ class Vellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "inputs": inputs,
-                "expand_meta": expand_meta,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[WorkflowRequestInputRequest], direction="write"
+                ),
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=WorkflowExpandMetaRequest, direction="write"
+                ),
                 "workflow_deployment_id": workflow_deployment_id,
                 "workflow_deployment_name": workflow_deployment_name,
                 "release_tag": release_tag,
@@ -772,8 +793,12 @@ class Vellum:
             json={
                 "deployment_id": deployment_id,
                 "deployment_name": deployment_name,
-                "requests": requests,
-                "options": options,
+                "requests": convert_and_respect_annotation_metadata(
+                    object_=requests, annotation=typing.Sequence[GenerateRequest], direction="write"
+                ),
+                "options": convert_and_respect_annotation_metadata(
+                    object_=options, annotation=GenerateOptionsRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -915,8 +940,12 @@ class Vellum:
             json={
                 "deployment_id": deployment_id,
                 "deployment_name": deployment_name,
-                "requests": requests,
-                "options": options,
+                "requests": convert_and_respect_annotation_metadata(
+                    object_=requests, annotation=typing.Sequence[GenerateRequest], direction="write"
+                ),
+                "options": convert_and_respect_annotation_metadata(
+                    object_=options, annotation=GenerateOptionsRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -1036,7 +1065,9 @@ class Vellum:
                 "index_id": index_id,
                 "index_name": index_name,
                 "query": query,
-                "options": options,
+                "options": convert_and_respect_annotation_metadata(
+                    object_=options, annotation=SearchRequestOptionsRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -1132,7 +1163,9 @@ class Vellum:
             json={
                 "deployment_id": deployment_id,
                 "deployment_name": deployment_name,
-                "actuals": actuals,
+                "actuals": convert_and_respect_annotation_metadata(
+                    object_=actuals, annotation=typing.Sequence[SubmitCompletionActualRequest], direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -1222,7 +1255,9 @@ class Vellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "actuals": actuals,
+                "actuals": convert_and_respect_annotation_metadata(
+                    object_=actuals, annotation=typing.Sequence[SubmitWorkflowExecutionActualRequest], direction="write"
+                ),
                 "execution_id": execution_id,
                 "external_id": external_id,
             },
@@ -1386,13 +1421,19 @@ class AsyncVellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "inputs": inputs,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[PromptDeploymentInputRequest], direction="write"
+                ),
                 "prompt_deployment_id": prompt_deployment_id,
                 "prompt_deployment_name": prompt_deployment_name,
                 "release_tag": release_tag,
                 "external_id": external_id,
-                "expand_meta": expand_meta,
-                "raw_overrides": raw_overrides,
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=PromptDeploymentExpandMetaRequest, direction="write"
+                ),
+                "raw_overrides": convert_and_respect_annotation_metadata(
+                    object_=raw_overrides, annotation=RawPromptExecutionOverridesRequest, direction="write"
+                ),
                 "expand_raw": expand_raw,
                 "metadata": metadata,
             },
@@ -1563,13 +1604,19 @@ class AsyncVellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "inputs": inputs,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[PromptDeploymentInputRequest], direction="write"
+                ),
                 "prompt_deployment_id": prompt_deployment_id,
                 "prompt_deployment_name": prompt_deployment_name,
                 "release_tag": release_tag,
                 "external_id": external_id,
-                "expand_meta": expand_meta,
-                "raw_overrides": raw_overrides,
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=PromptDeploymentExpandMetaRequest, direction="write"
+                ),
+                "raw_overrides": convert_and_respect_annotation_metadata(
+                    object_=raw_overrides, annotation=RawPromptExecutionOverridesRequest, direction="write"
+                ),
                 "expand_raw": expand_raw,
                 "metadata": metadata,
             },
@@ -1713,8 +1760,12 @@ class AsyncVellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "inputs": inputs,
-                "expand_meta": expand_meta,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[WorkflowRequestInputRequest], direction="write"
+                ),
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=WorkflowExpandMetaRequest, direction="write"
+                ),
                 "workflow_deployment_id": workflow_deployment_id,
                 "workflow_deployment_name": workflow_deployment_name,
                 "release_tag": release_tag,
@@ -1862,8 +1913,12 @@ class AsyncVellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "inputs": inputs,
-                "expand_meta": expand_meta,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[WorkflowRequestInputRequest], direction="write"
+                ),
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=WorkflowExpandMetaRequest, direction="write"
+                ),
                 "workflow_deployment_id": workflow_deployment_id,
                 "workflow_deployment_name": workflow_deployment_name,
                 "release_tag": release_tag,
@@ -1993,8 +2048,12 @@ class AsyncVellum:
             json={
                 "deployment_id": deployment_id,
                 "deployment_name": deployment_name,
-                "requests": requests,
-                "options": options,
+                "requests": convert_and_respect_annotation_metadata(
+                    object_=requests, annotation=typing.Sequence[GenerateRequest], direction="write"
+                ),
+                "options": convert_and_respect_annotation_metadata(
+                    object_=options, annotation=GenerateOptionsRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -2144,8 +2203,12 @@ class AsyncVellum:
             json={
                 "deployment_id": deployment_id,
                 "deployment_name": deployment_name,
-                "requests": requests,
-                "options": options,
+                "requests": convert_and_respect_annotation_metadata(
+                    object_=requests, annotation=typing.Sequence[GenerateRequest], direction="write"
+                ),
+                "options": convert_and_respect_annotation_metadata(
+                    object_=options, annotation=GenerateOptionsRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -2273,7 +2336,9 @@ class AsyncVellum:
                 "index_id": index_id,
                 "index_name": index_name,
                 "query": query,
-                "options": options,
+                "options": convert_and_respect_annotation_metadata(
+                    object_=options, annotation=SearchRequestOptionsRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -2377,7 +2442,9 @@ class AsyncVellum:
             json={
                 "deployment_id": deployment_id,
                 "deployment_name": deployment_name,
-                "actuals": actuals,
+                "actuals": convert_and_respect_annotation_metadata(
+                    object_=actuals, annotation=typing.Sequence[SubmitCompletionActualRequest], direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -2475,7 +2542,9 @@ class AsyncVellum:
             base_url=self._client_wrapper.get_environment().predict,
             method="POST",
             json={
-                "actuals": actuals,
+                "actuals": convert_and_respect_annotation_metadata(
+                    object_=actuals, annotation=typing.Sequence[SubmitWorkflowExecutionActualRequest], direction="write"
+                ),
                 "execution_id": execution_id,
                 "external_id": external_id,
             },

vellum/core/client_wrapper.py

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

vellum/core/http_client.py

@@ -224,7 +224,9 @@ class HttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=convert_file_dict_to_httpx_tuples(remove_none_from_dict(files)) if files is not None else None,
+            files=convert_file_dict_to_httpx_tuples(remove_none_from_dict(files))
+            if (files is not None and files is not omit)
+            else None,
             timeout=timeout,
         )
 
@@ -306,7 +308,9 @@ class HttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=convert_file_dict_to_httpx_tuples(remove_none_from_dict(files)) if files is not None else None,
+            files=convert_file_dict_to_httpx_tuples(remove_none_from_dict(files))
+            if (files is not None and files is not omit)
+            else None,
             timeout=timeout,
         ) as stream:
             yield stream

vellum/core/pydantic_utilities.py

@@ -10,6 +10,7 @@ import typing_extensions
 import pydantic
 
 from .datetime_utils import serialize_datetime
+from .serialization import convert_and_respect_annotation_metadata
 
 IS_PYDANTIC_V2 = pydantic.VERSION.startswith("2.")
 
@@ -56,11 +57,12 @@ Model = typing.TypeVar("Model", bound=pydantic.BaseModel)
 
 
 def parse_obj_as(type_: typing.Type[T], object_: typing.Any) -> T:
+    dealiased_object = convert_and_respect_annotation_metadata(object_=object_, annotation=type_, direction="read")
     if IS_PYDANTIC_V2:
         adapter = pydantic.TypeAdapter(type_)  # type: ignore # Pydantic v2
-        return adapter.validate_python(object_)
+        return adapter.validate_python(dealiased_object)
     else:
-        return pydantic.parse_obj_as(type_, object_)
+        return pydantic.parse_obj_as(type_, dealiased_object)
 
 
 def to_jsonable_with_fallback(
@@ -75,13 +77,40 @@ def to_jsonable_with_fallback(
 
 
 class UniversalBaseModel(pydantic.BaseModel):
-    class Config:
-        populate_by_name = True
-        smart_union = True
-        allow_population_by_field_name = True
-        json_encoders = {dt.datetime: serialize_datetime}
-        # Allow fields begining with `model_` to be used in the model
-        protected_namespaces = ()
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+            # Allow fields begining with `model_` to be used in the model
+            protected_namespaces=(),
+        )  # type: ignore # Pydantic v2
+
+        @pydantic.model_serializer(mode="wrap", when_used="json")  # type: ignore # Pydantic v2
+        def serialize_model(self, handler: pydantic.SerializerFunctionWrapHandler) -> typing.Any:  # type: ignore # Pydantic v2
+            serialized = handler(self)
+            data = {k: serialize_datetime(v) if isinstance(v, dt.datetime) else v for k, v in serialized.items()}
+            return data
+
+    else:
+
+        class Config:
+            smart_union = True
+            json_encoders = {dt.datetime: serialize_datetime}
+
+    @classmethod
+    def model_construct(
+        cls: typing.Type["Model"], _fields_set: typing.Optional[typing.Set[str]] = None, **values: typing.Any
+    ) -> "Model":
+        dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read")
+        return cls.construct(_fields_set, **dealiased_object)
+
+    @classmethod
+    def construct(
+        cls: typing.Type["Model"], _fields_set: typing.Optional[typing.Set[str]] = None, **values: typing.Any
+    ) -> "Model":
+        dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read")
+        if IS_PYDANTIC_V2:
+            return super().model_construct(_fields_set, **dealiased_object)  # type: ignore # Pydantic v2
+        else:
+            return super().construct(_fields_set, **dealiased_object)
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {
@@ -117,7 +146,7 @@ class UniversalBaseModel(pydantic.BaseModel):
                 "exclude_none": True,
                 "exclude_unset": False,
             }
-            return deep_union_pydantic_dicts(
+            dict_dump = deep_union_pydantic_dicts(
                 super().model_dump(**kwargs_with_defaults_exclude_unset),  # type: ignore # Pydantic v2
                 super().model_dump(**kwargs_with_defaults_exclude_none),  # type: ignore # Pydantic v2
             )
@@ -143,7 +172,9 @@ class UniversalBaseModel(pydantic.BaseModel):
                 **kwargs,
             }
 
-            return super().dict(**kwargs_with_defaults_exclude_unset_include_fields)
+            dict_dump = super().dict(**kwargs_with_defaults_exclude_unset_include_fields)
+
+        return convert_and_respect_annotation_metadata(object_=dict_dump, annotation=self.__class__, direction="write")
 
 
 def deep_union_pydantic_dicts(

vellum/core/serialization.py

@@ -71,6 +71,24 @@ def convert_and_respect_annotation_metadata(
     if typing_extensions.is_typeddict(clean_type) and isinstance(object_, typing.Mapping):
         return _convert_mapping(object_, clean_type, direction)
 
+    if (
+        typing_extensions.get_origin(clean_type) == typing.Dict
+        or typing_extensions.get_origin(clean_type) == dict
+        or clean_type == typing.Dict
+    ) and isinstance(object_, typing.Dict):
+        key_type = typing_extensions.get_args(clean_type)[0]
+        value_type = typing_extensions.get_args(clean_type)[1]
+
+        return {
+            key: convert_and_respect_annotation_metadata(
+                object_=value,
+                annotation=annotation,
+                inner_type=value_type,
+                direction=direction,
+            )
+            for key, value in object_.items()
+        }
+
     # If you're iterating on a string, do not bother to coerce it to a sequence.
     if not isinstance(object_, str):
         if (

vellum/resources/ad_hoc/client.py

@@ -9,6 +9,7 @@ from ...types.prompt_block_request import PromptBlockRequest
 from ...types.ad_hoc_expand_meta_request import AdHocExpandMetaRequest
 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
@@ -133,11 +134,21 @@ class AdHocClient:
             method="POST",
             json={
                 "ml_model": ml_model,
-                "input_values": input_values,
-                "input_variables": input_variables,
-                "parameters": parameters,
-                "blocks": blocks,
-                "expand_meta": expand_meta,
+                "input_values": convert_and_respect_annotation_metadata(
+                    object_=input_values, annotation=typing.Sequence[PromptRequestInputRequest], direction="write"
+                ),
+                "input_variables": convert_and_respect_annotation_metadata(
+                    object_=input_variables, annotation=typing.Sequence[VellumVariableRequest], direction="write"
+                ),
+                "parameters": convert_and_respect_annotation_metadata(
+                    object_=parameters, annotation=PromptParametersRequest, direction="write"
+                ),
+                "blocks": convert_and_respect_annotation_metadata(
+                    object_=blocks, annotation=typing.Sequence[PromptBlockRequest], direction="write"
+                ),
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=AdHocExpandMetaRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -314,11 +325,21 @@ class AsyncAdHocClient:
             method="POST",
             json={
                 "ml_model": ml_model,
-                "input_values": input_values,
-                "input_variables": input_variables,
-                "parameters": parameters,
-                "blocks": blocks,
-                "expand_meta": expand_meta,
+                "input_values": convert_and_respect_annotation_metadata(
+                    object_=input_values, annotation=typing.Sequence[PromptRequestInputRequest], direction="write"
+                ),
+                "input_variables": convert_and_respect_annotation_metadata(
+                    object_=input_variables, annotation=typing.Sequence[VellumVariableRequest], direction="write"
+                ),
+                "parameters": convert_and_respect_annotation_metadata(
+                    object_=parameters, annotation=PromptParametersRequest, direction="write"
+                ),
+                "blocks": convert_and_respect_annotation_metadata(
+                    object_=blocks, annotation=typing.Sequence[PromptBlockRequest], direction="write"
+                ),
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=AdHocExpandMetaRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,

vellum/resources/deployments/client.py

@@ -14,6 +14,7 @@ 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 ...core.serialization import convert_and_respect_annotation_metadata
 from ...errors.bad_request_error import BadRequestError
 from ...errors.forbidden_error import ForbiddenError
 from ...errors.not_found_error import NotFoundError
@@ -334,9 +335,13 @@ class DeploymentsClient:
             json={
                 "deployment_id": deployment_id,
                 "deployment_name": deployment_name,
-                "inputs": inputs,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[PromptDeploymentInputRequest], direction="write"
+                ),
                 "release_tag": release_tag,
-                "expand_meta": expand_meta,
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=CompilePromptDeploymentExpandMetaRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -746,9 +751,13 @@ class AsyncDeploymentsClient:
             json={
                 "deployment_id": deployment_id,
                 "deployment_name": deployment_name,
-                "inputs": inputs,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[PromptDeploymentInputRequest], direction="write"
+                ),
                 "release_tag": release_tag,
-                "expand_meta": expand_meta,
+                "expand_meta": convert_and_respect_annotation_metadata(
+                    object_=expand_meta, annotation=CompilePromptDeploymentExpandMetaRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,

vellum/resources/document_indexes/client.py

@@ -12,6 +12,7 @@ from ...types.document_index_indexing_config_request import DocumentIndexIndexin
 from ...types.entity_status import EntityStatus
 from ...types.environment_enum import EnvironmentEnum
 from ...types.document_index_read import DocumentIndexRead
+from ...core.serialization import convert_and_respect_annotation_metadata
 from ...core.jsonable_encoder import jsonable_encoder
 from ...core.client_wrapper import AsyncClientWrapper
 
@@ -191,7 +192,9 @@ class DocumentIndexesClient:
                 "name": name,
                 "status": status,
                 "environment": environment,
-                "indexing_config": indexing_config,
+                "indexing_config": convert_and_respect_annotation_metadata(
+                    object_=indexing_config, annotation=DocumentIndexIndexingConfigRequest, direction="write"
+                ),
                 "copy_documents_from_index_id": copy_documents_from_index_id,
             },
             request_options=request_options,
@@ -740,7 +743,9 @@ class AsyncDocumentIndexesClient:
                 "name": name,
                 "status": status,
                 "environment": environment,
-                "indexing_config": indexing_config,
+                "indexing_config": convert_and_respect_annotation_metadata(
+                    object_=indexing_config, annotation=DocumentIndexIndexingConfigRequest, direction="write"
+                ),
                 "copy_documents_from_index_id": copy_documents_from_index_id,
             },
             request_options=request_options,

vellum/resources/documents/client.py

@@ -261,10 +261,10 @@ class DocumentsClient:
         *,
         label: str,
         contents: core.File,
-        add_to_index_names: typing.Optional[typing.List[str]] = None,
-        external_id: typing.Optional[str] = None,
-        keywords: typing.Optional[typing.List[str]] = None,
-        metadata: typing.Optional[str] = None,
+        add_to_index_names: typing.Optional[typing.List[str]] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        keywords: typing.Optional[typing.List[str]] = OMIT,
+        metadata: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> UploadDocumentResponse:
         """
@@ -653,10 +653,10 @@ class AsyncDocumentsClient:
         *,
         label: str,
         contents: core.File,
-        add_to_index_names: typing.Optional[typing.List[str]] = None,
-        external_id: typing.Optional[str] = None,
-        keywords: typing.Optional[typing.List[str]] = None,
-        metadata: typing.Optional[str] = None,
+        add_to_index_names: typing.Optional[typing.List[str]] = OMIT,
+        external_id: typing.Optional[str] = OMIT,
+        keywords: typing.Optional[typing.List[str]] = OMIT,
+        metadata: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> UploadDocumentResponse:
         """

vellum/resources/sandboxes/client.py

@@ -10,6 +10,7 @@ from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
 from ...types.named_scenario_input_request import NamedScenarioInputRequest
 from ...types.sandbox_scenario import SandboxScenario
+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
@@ -166,7 +167,9 @@ class SandboxesClient:
             method="POST",
             json={
                 "label": label,
-                "inputs": inputs,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[NamedScenarioInputRequest], direction="write"
+                ),
                 "scenario_id": scenario_id,
             },
             request_options=request_options,
@@ -400,7 +403,9 @@ class AsyncSandboxesClient:
             method="POST",
             json={
                 "label": label,
-                "inputs": inputs,
+                "inputs": convert_and_respect_annotation_metadata(
+                    object_=inputs, annotation=typing.Sequence[NamedScenarioInputRequest], direction="write"
+                ),
                 "scenario_id": scenario_id,
             },
             request_options=request_options,

vellum/resources/test_suite_runs/client.py

@@ -5,6 +5,7 @@ from ...core.client_wrapper import SyncClientWrapper
 from ...types.test_suite_run_exec_config_request import TestSuiteRunExecConfigRequest
 from ...core.request_options import RequestOptions
 from ...types.test_suite_run_read import TestSuiteRunRead
+from ...core.serialization import convert_and_respect_annotation_metadata
 from ...core.pydantic_utilities import parse_obj_as
 from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
@@ -72,7 +73,9 @@ class TestSuiteRunsClient:
             method="POST",
             json={
                 "test_suite_id": test_suite_id,
-                "exec_config": exec_config,
+                "exec_config": convert_and_respect_annotation_metadata(
+                    object_=exec_config, annotation=TestSuiteRunExecConfigRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -276,7 +279,9 @@ class AsyncTestSuiteRunsClient:
             method="POST",
             json={
                 "test_suite_id": test_suite_id,
-                "exec_config": exec_config,
+                "exec_config": convert_and_respect_annotation_metadata(
+                    object_=exec_config, annotation=TestSuiteRunExecConfigRequest, direction="write"
+                ),
             },
             request_options=request_options,
             omit=OMIT,

vellum/resources/test_suites/client.py

@@ -10,6 +10,7 @@ from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
 from ...types.named_test_case_variable_value_request import NamedTestCaseVariableValueRequest
 from ...types.test_suite_test_case import TestSuiteTestCase
+from ...core.serialization import convert_and_respect_annotation_metadata
 from ...types.test_suite_test_case_bulk_operation_request import TestSuiteTestCaseBulkOperationRequest
 from ...types.test_suite_test_case_bulk_result import TestSuiteTestCaseBulkResult
 import json
@@ -165,8 +166,16 @@ class TestSuitesClient:
                 "id": id,
                 "external_id": external_id,
                 "label": label,
-                "input_values": input_values,
-                "evaluation_values": evaluation_values,
+                "input_values": convert_and_respect_annotation_metadata(
+                    object_=input_values,
+                    annotation=typing.Sequence[NamedTestCaseVariableValueRequest],
+                    direction="write",
+                ),
+                "evaluation_values": convert_and_respect_annotation_metadata(
+                    object_=evaluation_values,
+                    annotation=typing.Sequence[NamedTestCaseVariableValueRequest],
+                    direction="write",
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -253,7 +262,9 @@ class TestSuitesClient:
             f"v1/test-suites/{jsonable_encoder(id)}/test-cases-bulk",
             base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            json=request,
+            json=convert_and_respect_annotation_metadata(
+                object_=request, annotation=typing.Sequence[TestSuiteTestCaseBulkOperationRequest], direction="write"
+            ),
             request_options=request_options,
             omit=OMIT,
         ) as _response:
@@ -489,8 +500,16 @@ class AsyncTestSuitesClient:
                 "id": id,
                 "external_id": external_id,
                 "label": label,
-                "input_values": input_values,
-                "evaluation_values": evaluation_values,
+                "input_values": convert_and_respect_annotation_metadata(
+                    object_=input_values,
+                    annotation=typing.Sequence[NamedTestCaseVariableValueRequest],
+                    direction="write",
+                ),
+                "evaluation_values": convert_and_respect_annotation_metadata(
+                    object_=evaluation_values,
+                    annotation=typing.Sequence[NamedTestCaseVariableValueRequest],
+                    direction="write",
+                ),
             },
             request_options=request_options,
             omit=OMIT,
@@ -585,7 +604,9 @@ class AsyncTestSuitesClient:
             f"v1/test-suites/{jsonable_encoder(id)}/test-cases-bulk",
             base_url=self._client_wrapper.get_environment().default,
             method="POST",
-            json=request,
+            json=convert_and_respect_annotation_metadata(
+                object_=request, annotation=typing.Sequence[TestSuiteTestCaseBulkOperationRequest], direction="write"
+            ),
             request_options=request_options,
             omit=OMIT,
         ) as _response:

vellum/types/api_node_result_data.py

@@ -2,15 +2,19 @@
 
 from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-import pydantic
+import typing_extensions
+from ..core.serialization import FieldMetadata
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
 
 
 class ApiNodeResultData(UniversalBaseModel):
     text_output_id: str
     text: typing.Optional[str] = None
     json_output_id: str
-    json_: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(alias="json", default=None)
+    json_: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="json")
+    ] = None
     status_code_output_id: str
     status_code: int
 

{vellum_ai-0.8.13.dist-info → vellum_ai-0.8.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vellum-ai
-Version: 0.8.13
+Version: 0.8.14
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0

{vellum_ai-0.8.13.dist-info → vellum_ai-0.8.14.dist-info}/RECORD

@@ -1,17 +1,17 @@
 vellum/__init__.py,sha256=ZjILSZ1gKX9YUZjjOzr0wngRMV7aYaCvuCXgoxt7n2o,30148
-vellum/client.py,sha256=tsLLtZbwPASP8Cdh1RF19pOuNmZbBKFkUiplU9X190Q,101256
+vellum/client.py,sha256=n9AlNDHYObmRUM5hX_iiFj6eYDzjIca3cdKVGuRjUSA,106566
 vellum/core/__init__.py,sha256=SQ85PF84B9MuKnBwHNHWemSGuy-g_515gFYNFhvEE0I,1438
 vellum/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
-vellum/core/client_wrapper.py,sha256=rsTOZjk7z3mQIFC1nDTnTmM5L8SZWvNAx974kSd7ktQ,1898
+vellum/core/client_wrapper.py,sha256=WJP8_-tl96sFBvhJ-8U9ur1H5s7hdz5N1KWJEYSiY9s,1898
 vellum/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 vellum/core/file.py,sha256=X9IbmkZmB2bB_DpmZAO3crWdXagOakAyn6UCOCImCPg,2322
-vellum/core/http_client.py,sha256=rZSidd9LazCjduvdBhZ7GDs4iGfn-OAfRGsDXB1z8f4,18882
+vellum/core/http_client.py,sha256=7scAV2vhOSQ3MqAoGBfEGZ5lZ5GOU65KdWdP0u9VR4A,18978
 vellum/core/jsonable_encoder.py,sha256=qaF1gtgH-kQZb4kJskETwcCsOPUof-NnYVdszHkb-dM,3656
-vellum/core/pydantic_utilities.py,sha256=mrrWV91fMWAertBxn2shhHQDm_i2WrbQrqXskVEVKHg,9170
+vellum/core/pydantic_utilities.py,sha256=l7MVQHx5ytOhzpGiMaZC8tmFsZTBSrWMiiIk-rkBLsk,10851
 vellum/core/query_encoder.py,sha256=ekulqNd0j8TgD7ox-Qbz7liqX8-KP9blvT9DsRCenYM,2144
 vellum/core/remove_none_from_dict.py,sha256=EU9SGgYidWq7SexuJbNs4-PZ-5Bl3Vppd864mS6vQZw,342
 vellum/core/request_options.py,sha256=5cCGt5AEGgtP5xifDl4oVQUmSjlIA8FmRItAlJawM18,1417
-vellum/core/serialization.py,sha256=5evS9ZBT8F0_GUAfzb6FQvdgw4JKuHFBlEoqZ8Y8-DU,8970
+vellum/core/serialization.py,sha256=D9h_t-RQON3-CHWs1C4ESY9B-Yd5d-l5lnTLb_X896g,9601
 vellum/environment.py,sha256=vkEIsMFufsklAMQJxa_E9R60LQsbeqKbWqtyXjffZp8,498
 vellum/errors/__init__.py,sha256=HZB8vVqzDNx0M2uFJ05S5RcGTH95iVDl4v3rQ4xRqSw,343
 vellum/errors/bad_request_error.py,sha256=_EbO8mWqN9kFZPvIap8qa1lL_EWkRcsZe1HKV9GDWJY,264
@@ -30,25 +30,25 @@ vellum/lib/utils/paginator.py,sha256=yDvgehocYBDclLt5SewZH4hCIyq0yLHdBzkyPCoYPjs
 vellum/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vellum/resources/__init__.py,sha256=iaTrngunVag3wUnyP3TlA8lG55RUCYw4qgdlZXzhi2Q,806
 vellum/resources/ad_hoc/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
-vellum/resources/ad_hoc/client.py,sha256=7WwFing-VwbfZJbwBRJCkJ3ypXJ7jMSt4kaCVSTW3gk,14006
+vellum/resources/ad_hoc/client.py,sha256=JVEf85pJJ1u_Vie-kEIvqv1Qx0BPA73DFEpBu7iyKK8,15590
 vellum/resources/deployments/__init__.py,sha256=AE0TcFwLrLBljM0ZDX-pPw4Kqt-1f5JDpIok2HS80QI,157
-vellum/resources/deployments/client.py,sha256=A_x9lFFFNiiwggPcrMfP88vv5F0FuLo39Ek36WEfJpE,28516
+vellum/resources/deployments/client.py,sha256=tF3llT_g6rfzDHpLhlEoz9gJDy8vIdNGKfICMJp3iEw,29236
 vellum/resources/deployments/types/__init__.py,sha256=IhwnmoXJ0r_QEhh1b2tBcaAm_x3fWMVuIhYmAapp_ZA,183
 vellum/resources/deployments/types/deployments_list_request_status.py,sha256=CxlQD16KZXme7x31YYCe_3aAgEueutDTeJo5A4Au-aU,174
 vellum/resources/document_indexes/__init__.py,sha256=YpOl_9IV7xOlH4OmusQxtAJB11kxQfCSMDyT1_UD0oM,165
-vellum/resources/document_indexes/client.py,sha256=MoqaMRDP0eLSh1f8YE9P2Wxj4xlObtd3aMJHxTNqQlQ,37140
+vellum/resources/document_indexes/client.py,sha256=1kp5I8DC4UPvjlWsocuaNhgpIQppDfHFkZIMBKBFj9s,37520
 vellum/resources/document_indexes/types/__init__.py,sha256=IoFqKHN_VBdEhC7VL8_6Jbatrn0e0zuYEJAJUahcUR0,196
 vellum/resources/document_indexes/types/document_indexes_list_request_status.py,sha256=sfUEB0cvOSmlE2iITqnMVyHv05Zy2fWP4QjCIYqMg0M,178
 vellum/resources/documents/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
-vellum/resources/documents/client.py,sha256=C5hDZw1y_iNlPdSuePK-0hEwve4JIbKcx72kMNAo-Rg,27574
+vellum/resources/documents/client.py,sha256=TRptBN1FG4wyTYOq0TpmkXlQL63Owbvsa539E1VXs6s,27574
 vellum/resources/folder_entities/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
 vellum/resources/folder_entities/client.py,sha256=yxkHRAx8frCk-WvgcRD-WzMhA2kxvY_j42S436-j4EQ,4440
 vellum/resources/sandboxes/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
-vellum/resources/sandboxes/client.py,sha256=RDFDge2gkI6Kpo3VhlRISKS8wHDp7MYh83XVN-Eybys,16762
+vellum/resources/sandboxes/client.py,sha256=i-6DHap5k6gFcYS-kWI8ayJFVZxb-GENRft6BJwVam4,17158
 vellum/resources/test_suite_runs/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
-vellum/resources/test_suite_runs/client.py,sha256=laE40piDiurzmO1mwStY0ebsxQpTuETgiCAewtSrNk8,14192
+vellum/resources/test_suite_runs/client.py,sha256=AwSx890RssSN3mSpeFxWdVv-GR30Av5oMEVshh9Sauw,14562
 vellum/resources/test_suites/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
-vellum/resources/test_suites/client.py,sha256=Sy_mXyAwObTwRSPH9gOO8gNZRfx4MlQVV3TxaAdnVx0,23795
+vellum/resources/test_suites/client.py,sha256=waf3-2XIuXnFAumcus0Z1jfat_YMQANBxvDHHbL0sVM,25039
 vellum/resources/workflow_deployments/__init__.py,sha256=-5BCA0kSmW6WUh4gqLuQtHv4zFdt9lccuDwMU5YvEu4,173
 vellum/resources/workflow_deployments/client.py,sha256=ezSg3EDA5UszvrT15jx7-RoSO8pXRwAIDlqMCJXkNOY,17393
 vellum/resources/workflow_deployments/types/__init__.py,sha256=rmS_4dtbgLHGNQJ_pOloygrjl4sNbKZjTEKBxbMyz6E,208
@@ -75,7 +75,7 @@ vellum/types/ad_hoc_rejected_prompt_execution_meta.py,sha256=Yo3TNjemHUfxU9R3EMz
 vellum/types/ad_hoc_streaming_prompt_execution_meta.py,sha256=OVSyUL81lpkbXdxnQmPD6qPIxrErEDAgDofQ9lGWLXk,741
 vellum/types/add_openai_api_key_enum.py,sha256=GB7sLK_Ou7-Xn73sKJHUo6Gx3TjyhU7uJvWZAg4UeaI,92
 vellum/types/api_node_result.py,sha256=3zAbNGNYY6EgJDzqmcIvLqq8wU-WoMEwGT1W1fjto6U,729
-vellum/types/api_node_result_data.py,sha256=skjoVCR7LRr4mwdqOUGcgutqY4qWB6t6_xkzVJDXZHQ,803
+vellum/types/api_node_result_data.py,sha256=GqizJBzReiAQSKW4M1LQYA1ndXlsQ57Dr_apO0AMTVE,909
 vellum/types/array_chat_message_content.py,sha256=353TDzStNXA2dQETvnJrazCr33nlFx7hgvvPV526ECg,780
 vellum/types/array_chat_message_content_item.py,sha256=XyWDIqVeWoqLzUIvZO_qj_-iwCr6SBcvQJoVxKAjmDs,421
 vellum/types/array_chat_message_content_item_request.py,sha256=AUFfh6CQfrD4MdwpS3KhGpalaYpEj_hAlF_lePDDdbU,494
@@ -484,7 +484,7 @@ vellum/types/workflow_result_event_output_data_search_results.py,sha256=U34IK7Zv
 vellum/types/workflow_result_event_output_data_string.py,sha256=tM3kgh6tEhD0dFEb_7UU0-UspeN4pUdINCcCrD64W74,1228
 vellum/types/workflow_stream_event.py,sha256=Wn3Yzuy9MqWAeo8tEaXDTKDEbJoA8DdYdMVq8EKuhu8,361
 vellum/version.py,sha256=jq-1PlAYxN9AXuaZqbYk9ak27SgE2lw9Ia5gx1b1gVI,76
-vellum_ai-0.8.13.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
-vellum_ai-0.8.13.dist-info/METADATA,sha256=rqpR6maCbemvdA9jmQ2YPnoTEVKONY7EIwozIZ_yMfg,4395
-vellum_ai-0.8.13.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-vellum_ai-0.8.13.dist-info/RECORD,,
+vellum_ai-0.8.14.dist-info/LICENSE,sha256=CcaljEIoOBaU-wItPH4PmM_mDCGpyuUY0Er1BGu5Ti8,1073
+vellum_ai-0.8.14.dist-info/METADATA,sha256=9DFXbn9jQ9rpVPuqKvNEt6yf5AmGEpO1q8DgosmUc1M,4395
+vellum_ai-0.8.14.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+vellum_ai-0.8.14.dist-info/RECORD,,