vellum-ai 0.3.20__py3-none-any.whl → 0.3.22__py3-none-any.whl

vellum/terraform/provider/__init__.py

@@ -0,0 +1,237 @@
+'''
+# `provider`
+
+Refer to the Terraform Registry for docs: [`vellum`](https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs).
+'''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
+import abc
+import builtins
+import datetime
+import enum
+import typing
+
+import jsii
+import publication
+import typing_extensions
+
+from typeguard import check_type
+
+from .._jsii import *
+
+import cdktf as _cdktf_9a9027ec
+import constructs as _constructs_77d1e7e8
+
+
+class VellumProvider(
+    _cdktf_9a9027ec.TerraformProvider,
+    metaclass=jsii.JSIIMeta,
+    jsii_type="vellum-ai_vellum.provider.VellumProvider",
+):
+    '''Represents a {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs vellum}.'''
+
+    def __init__(
+        self,
+        scope: _constructs_77d1e7e8.Construct,
+        id: builtins.str,
+        *,
+        alias: typing.Optional[builtins.str] = None,
+        api_key: typing.Optional[builtins.str] = None,
+    ) -> None:
+        '''Create a new {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs vellum} Resource.
+
+        :param scope: The scope in which to define this construct.
+        :param id: The scoped construct ID. Must be unique amongst siblings in the same scope
+        :param alias: Alias name. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs#alias VellumProvider#alias}
+        :param api_key: API Key to authenticate with the Vellum API. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs#api_key VellumProvider#api_key}
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__8f332a1b6664893e57a3554abbbfd334296d68a0c02222521351772fec263177)
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
+            check_type(argname="argument id", value=id, expected_type=type_hints["id"])
+        config = VellumProviderConfig(alias=alias, api_key=api_key)
+
+        jsii.create(self.__class__, self, [scope, id, config])
+
+    @jsii.member(jsii_name="generateConfigForImport")
+    @builtins.classmethod
+    def generate_config_for_import(
+        cls,
+        scope: _constructs_77d1e7e8.Construct,
+        import_to_id: builtins.str,
+        import_from_id: builtins.str,
+        provider: typing.Optional[_cdktf_9a9027ec.TerraformProvider] = None,
+    ) -> _cdktf_9a9027ec.ImportableResource:
+        '''Generates CDKTF code for importing a VellumProvider resource upon running "cdktf plan ".
+
+        :param scope: The scope in which to define this construct.
+        :param import_to_id: The construct id used in the generated config for the VellumProvider to import.
+        :param import_from_id: The id of the existing VellumProvider that should be imported. Refer to the {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs#import import section} in the documentation of this resource for the id to use
+        :param provider: ? Optional instance of the provider where the VellumProvider to import is found.
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__43f598a9f664a05d63c3b7644f2981a0397df03284b98ca077e6d7265f6aebcb)
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
+            check_type(argname="argument import_to_id", value=import_to_id, expected_type=type_hints["import_to_id"])
+            check_type(argname="argument import_from_id", value=import_from_id, expected_type=type_hints["import_from_id"])
+            check_type(argname="argument provider", value=provider, expected_type=type_hints["provider"])
+        return typing.cast(_cdktf_9a9027ec.ImportableResource, jsii.sinvoke(cls, "generateConfigForImport", [scope, import_to_id, import_from_id, provider]))
+
+    @jsii.member(jsii_name="resetAlias")
+    def reset_alias(self) -> None:
+        return typing.cast(None, jsii.invoke(self, "resetAlias", []))
+
+    @jsii.member(jsii_name="resetApiKey")
+    def reset_api_key(self) -> None:
+        return typing.cast(None, jsii.invoke(self, "resetApiKey", []))
+
+    @jsii.member(jsii_name="synthesizeAttributes")
+    def _synthesize_attributes(self) -> typing.Mapping[builtins.str, typing.Any]:
+        return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.invoke(self, "synthesizeAttributes", []))
+
+    @jsii.member(jsii_name="synthesizeHclAttributes")
+    def _synthesize_hcl_attributes(self) -> typing.Mapping[builtins.str, typing.Any]:
+        return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.invoke(self, "synthesizeHclAttributes", []))
+
+    @jsii.python.classproperty
+    @jsii.member(jsii_name="tfResourceType")
+    def TF_RESOURCE_TYPE(cls) -> builtins.str:
+        return typing.cast(builtins.str, jsii.sget(cls, "tfResourceType"))
+
+    @builtins.property
+    @jsii.member(jsii_name="aliasInput")
+    def alias_input(self) -> typing.Optional[builtins.str]:
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "aliasInput"))
+
+    @builtins.property
+    @jsii.member(jsii_name="apiKeyInput")
+    def api_key_input(self) -> typing.Optional[builtins.str]:
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "apiKeyInput"))
+
+    @builtins.property
+    @jsii.member(jsii_name="alias")
+    def alias(self) -> typing.Optional[builtins.str]:
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "alias"))
+
+    @alias.setter
+    def alias(self, value: typing.Optional[builtins.str]) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__15a78e7b117167a258d082de10d77ec8038e1f5fcc5ff5ef0caadbce4dec2c02)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "alias", value)
+
+    @builtins.property
+    @jsii.member(jsii_name="apiKey")
+    def api_key(self) -> typing.Optional[builtins.str]:
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "apiKey"))
+
+    @api_key.setter
+    def api_key(self, value: typing.Optional[builtins.str]) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__402b9018cf60ba05eb9ab72153d7f52235bd10a5f5615a074a53880068a8779b)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "apiKey", value)
+
+
+@jsii.data_type(
+    jsii_type="vellum-ai_vellum.provider.VellumProviderConfig",
+    jsii_struct_bases=[],
+    name_mapping={"alias": "alias", "api_key": "apiKey"},
+)
+class VellumProviderConfig:
+    def __init__(
+        self,
+        *,
+        alias: typing.Optional[builtins.str] = None,
+        api_key: typing.Optional[builtins.str] = None,
+    ) -> None:
+        '''
+        :param alias: Alias name. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs#alias VellumProvider#alias}
+        :param api_key: API Key to authenticate with the Vellum API. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs#api_key VellumProvider#api_key}
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__bb8c32f1d43f1344224f7a690abc6e2489c4dff67cb93921483ed2cc4b5410e1)
+            check_type(argname="argument alias", value=alias, expected_type=type_hints["alias"])
+            check_type(argname="argument api_key", value=api_key, expected_type=type_hints["api_key"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {}
+        if alias is not None:
+            self._values["alias"] = alias
+        if api_key is not None:
+            self._values["api_key"] = api_key
+
+    @builtins.property
+    def alias(self) -> typing.Optional[builtins.str]:
+        '''Alias name.
+
+        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs#alias VellumProvider#alias}
+        '''
+        result = self._values.get("alias")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    @builtins.property
+    def api_key(self) -> typing.Optional[builtins.str]:
+        '''API Key to authenticate with the Vellum API.
+
+        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/vellum-ai/vellum/0.0.2/docs#api_key VellumProvider#api_key}
+        '''
+        result = self._values.get("api_key")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "VellumProviderConfig(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
+__all__ = [
+    "VellumProvider",
+    "VellumProviderConfig",
+]
+
+publication.publish()
+
+def _typecheckingstub__8f332a1b6664893e57a3554abbbfd334296d68a0c02222521351772fec263177(
+    scope: _constructs_77d1e7e8.Construct,
+    id: builtins.str,
+    *,
+    alias: typing.Optional[builtins.str] = None,
+    api_key: typing.Optional[builtins.str] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__43f598a9f664a05d63c3b7644f2981a0397df03284b98ca077e6d7265f6aebcb(
+    scope: _constructs_77d1e7e8.Construct,
+    import_to_id: builtins.str,
+    import_from_id: builtins.str,
+    provider: typing.Optional[_cdktf_9a9027ec.TerraformProvider] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__15a78e7b117167a258d082de10d77ec8038e1f5fcc5ff5ef0caadbce4dec2c02(
+    value: typing.Optional[builtins.str],
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__402b9018cf60ba05eb9ab72153d7f52235bd10a5f5615a074a53880068a8779b(
+    value: typing.Optional[builtins.str],
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__bb8c32f1d43f1344224f7a690abc6e2489c4dff67cb93921483ed2cc4b5410e1(
+    *,
+    alias: typing.Optional[builtins.str] = None,
+    api_key: typing.Optional[builtins.str] = None,
+) -> None:
+    """Type checking stubs"""
+    pass

vellum/terraform/py.typed

@@ -0,0 +1 @@
+

vellum/terraform/versions.json

@@ -0,0 +1,3 @@
+{
+  "registry.terraform.io/vellum-ai/vellum": "0.0.2"
+}

vellum/types/__init__.py

@@ -165,6 +165,7 @@ from .logprobs_enum import LogprobsEnum
 from .metadata_filter_config_request import MetadataFilterConfigRequest
 from .metadata_filter_rule_combinator import MetadataFilterRuleCombinator
 from .metadata_filter_rule_request import MetadataFilterRuleRequest
+from .ml_model_usage import MlModelUsage
 from .model_version_build_config import ModelVersionBuildConfig
 from .model_version_exec_config import ModelVersionExecConfig
 from .model_version_exec_config_parameters import ModelVersionExecConfigParameters
@@ -259,6 +260,7 @@ from .prompt_template_block_data_request import PromptTemplateBlockDataRequest
 from .prompt_template_block_properties import PromptTemplateBlockProperties
 from .prompt_template_block_properties_request import PromptTemplateBlockPropertiesRequest
 from .prompt_template_block_request import PromptTemplateBlockRequest
+from .prompt_template_block_state import PromptTemplateBlockState
 from .provider_enum import ProviderEnum
 from .raw_prompt_execution_overrides_request import RawPromptExecutionOverridesRequest
 from .register_prompt_error_response import RegisterPromptErrorResponse
@@ -398,6 +400,7 @@ from .test_suite_run_execution import TestSuiteRunExecution
 from .test_suite_run_execution_chat_history_output import TestSuiteRunExecutionChatHistoryOutput
 from .test_suite_run_execution_error_output import TestSuiteRunExecutionErrorOutput
 from .test_suite_run_execution_json_output import TestSuiteRunExecutionJsonOutput
+from .test_suite_run_execution_metric_definition import TestSuiteRunExecutionMetricDefinition
 from .test_suite_run_execution_metric_result import TestSuiteRunExecutionMetricResult
 from .test_suite_run_execution_number_output import TestSuiteRunExecutionNumberOutput
 from .test_suite_run_execution_output import (
@@ -673,6 +676,7 @@ __all__ = [
     "MetadataFilterConfigRequest",
     "MetadataFilterRuleCombinator",
     "MetadataFilterRuleRequest",
+    "MlModelUsage",
     "ModelVersionBuildConfig",
     "ModelVersionExecConfig",
     "ModelVersionExecConfigParameters",
@@ -757,6 +761,7 @@ __all__ = [
     "PromptTemplateBlockProperties",
     "PromptTemplateBlockPropertiesRequest",
     "PromptTemplateBlockRequest",
+    "PromptTemplateBlockState",
     "ProviderEnum",
     "RawPromptExecutionOverridesRequest",
     "RegisterPromptErrorResponse",
@@ -880,6 +885,7 @@ __all__ = [
     "TestSuiteRunExecutionChatHistoryOutput",
     "TestSuiteRunExecutionErrorOutput",
     "TestSuiteRunExecutionJsonOutput",
+    "TestSuiteRunExecutionMetricDefinition",
     "TestSuiteRunExecutionMetricResult",
     "TestSuiteRunExecutionNumberOutput",
     "TestSuiteRunExecutionOutput",

vellum/types/fulfilled_prompt_execution_meta.py

@@ -5,6 +5,7 @@ import typing
 
 from ..core.datetime_utils import serialize_datetime
 from .finish_reason_enum import FinishReasonEnum
+from .ml_model_usage import MlModelUsage
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -19,6 +20,7 @@ class FulfilledPromptExecutionMeta(pydantic.BaseModel):
 
     latency: typing.Optional[int] = None
     finish_reason: typing.Optional[FinishReasonEnum] = None
+    usage: typing.Optional[MlModelUsage] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/fulfilled_workflow_node_result_event.py

@@ -24,7 +24,7 @@ class FulfilledWorkflowNodeResultEvent(pydantic.BaseModel):
     ts: typing.Optional[dt.datetime] = None
     data: typing.Optional[WorkflowNodeResultData] = None
     source_execution_id: typing.Optional[str] = None
-    output_values: typing.Optional[typing.List[NodeOutputCompiledValue]] = None
+    output_values: typing.List[NodeOutputCompiledValue]
     mocked: typing.Optional[bool] = None
 
     def json(self, **kwargs: typing.Any) -> str:

vellum/types/ml_model_usage.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class MlModelUsage(pydantic.BaseModel):
+    output_token_count: typing.Optional[int] = None
+    input_token_count: typing.Optional[int] = None
+    input_char_count: typing.Optional[int] = None
+    output_char_count: typing.Optional[int] = None
+    compute_nanos: typing.Optional[int] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/named_test_case_chat_history_variable_value_request.py

@@ -13,8 +13,12 @@ except ImportError:
 
 
 class NamedTestCaseChatHistoryVariableValueRequest(pydantic.BaseModel):
-    name: str
+    """
+    Named Test Case value that is of type CHAT_HISTORY
+    """
+
     value: typing.Optional[typing.List[ChatMessageRequest]] = None
+    name: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/named_test_case_error_variable_value_request.py

@@ -13,8 +13,12 @@ except ImportError:
 
 
 class NamedTestCaseErrorVariableValueRequest(pydantic.BaseModel):
-    name: str
+    """
+    Named Test Case value that is of type ERROR
+    """
+
     value: typing.Optional[VellumErrorRequest] = None
+    name: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/named_test_case_json_variable_value_request.py

@@ -12,8 +12,12 @@ except ImportError:
 
 
 class NamedTestCaseJsonVariableValueRequest(pydantic.BaseModel):
-    name: str
+    """
+    Named Test Case value that is of type JSON
+    """
+
     value: typing.Optional[typing.Dict[str, typing.Any]] = None
+    name: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/named_test_case_number_variable_value_request.py

@@ -12,8 +12,12 @@ except ImportError:
 
 
 class NamedTestCaseNumberVariableValueRequest(pydantic.BaseModel):
-    name: str
+    """
+    Named Test Case value that is of type NUMBER
+    """
+
     value: typing.Optional[float] = None
+    name: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/named_test_case_search_results_variable_value_request.py

@@ -13,8 +13,12 @@ except ImportError:
 
 
 class NamedTestCaseSearchResultsVariableValueRequest(pydantic.BaseModel):
-    name: str
+    """
+    Named Test Case value that is of type SEARCH_RESULTS
+    """
+
     value: typing.Optional[typing.List[SearchResultRequest]] = None
+    name: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/named_test_case_string_variable_value_request.py

@@ -12,8 +12,12 @@ except ImportError:
 
 
 class NamedTestCaseStringVariableValueRequest(pydantic.BaseModel):
-    name: str
+    """
+    Named Test Case value that is of type STRING
+    """
+
     value: typing.Optional[str] = None
+    name: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/prompt_deployment_expand_meta_request_request.py

@@ -37,6 +37,11 @@ class PromptDeploymentExpandMetaRequestRequest(pydantic.BaseModel):
     If enabled, the response will include the reason provided by the model for why the execution finished.
     """
 
+    usage: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If enabled, the response will include model host usage tracking. This may increase latency for some model hosts.
+    """
+
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
         return super().json(**kwargs_with_defaults)

vellum/types/prompt_execution_meta.py

@@ -5,6 +5,7 @@ import typing
 
 from ..core.datetime_utils import serialize_datetime
 from .finish_reason_enum import FinishReasonEnum
+from .ml_model_usage import MlModelUsage
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -17,6 +18,7 @@ class PromptExecutionMeta(pydantic.BaseModel):
     The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
     """
 
+    usage: typing.Optional[MlModelUsage] = None
     model_name: typing.Optional[str] = None
     latency: typing.Optional[int] = None
     deployment_release_tag: typing.Optional[str] = None

vellum/types/prompt_template_block.py

@@ -7,6 +7,7 @@ import typing
 
 from ..core.datetime_utils import serialize_datetime
 from .block_type_enum import BlockTypeEnum
+from .prompt_template_block_state import PromptTemplateBlockState
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -18,6 +19,7 @@ class PromptTemplateBlock(pydantic.BaseModel):
     id: str
     block_type: BlockTypeEnum
     properties: PromptTemplateBlockProperties
+    state: typing.Optional[PromptTemplateBlockState] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/prompt_template_block_request.py

@@ -7,6 +7,7 @@ import typing
 
 from ..core.datetime_utils import serialize_datetime
 from .block_type_enum import BlockTypeEnum
+from .prompt_template_block_state import PromptTemplateBlockState
 
 try:
     import pydantic.v1 as pydantic  # type: ignore
@@ -18,6 +19,7 @@ class PromptTemplateBlockRequest(pydantic.BaseModel):
     id: str
     block_type: BlockTypeEnum
     properties: PromptTemplateBlockPropertiesRequest
+    state: typing.Optional[PromptTemplateBlockState] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/prompt_template_block_state.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class PromptTemplateBlockState(str, enum.Enum):
+    """
+    - `ENABLED` - ENABLED
+    - `DISABLED` - DISABLED
+    """
+
+    ENABLED = "ENABLED"
+    DISABLED = "DISABLED"
+
+    def visit(self, enabled: typing.Callable[[], T_Result], disabled: typing.Callable[[], T_Result]) -> T_Result:
+        if self is PromptTemplateBlockState.ENABLED:
+            return enabled()
+        if self is PromptTemplateBlockState.DISABLED:
+            return disabled()

vellum/types/test_suite_run_execution_chat_history_output.py

@@ -13,8 +13,13 @@ except ImportError:
 
 
 class TestSuiteRunExecutionChatHistoryOutput(pydantic.BaseModel):
-    output_variable_id: str
+    """
+    Execution output of an entity evaluated during a Test Suite Run that is of type CHAT_HISTORY
+    """
+
+    name: str
     value: typing.Optional[typing.List[ChatMessage]] = None
+    output_variable_id: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/test_suite_run_execution_error_output.py

@@ -13,8 +13,13 @@ except ImportError:
 
 
 class TestSuiteRunExecutionErrorOutput(pydantic.BaseModel):
-    output_variable_id: str
+    """
+    Execution output of an entity evaluated during a Test Suite Run that is of type ERROR
+    """
+
+    name: str
     value: typing.Optional[VellumError] = None
+    output_variable_id: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/test_suite_run_execution_json_output.py

@@ -12,8 +12,13 @@ except ImportError:
 
 
 class TestSuiteRunExecutionJsonOutput(pydantic.BaseModel):
-    output_variable_id: str
+    """
+    Execution output of an entity evaluated during a Test Suite Run that is of type JSON
+    """
+
+    name: str
     value: typing.Optional[typing.Dict[str, typing.Any]] = None
+    output_variable_id: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/test_suite_run_execution_metric_definition.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+
+try:
+    import pydantic.v1 as pydantic  # type: ignore
+except ImportError:
+    import pydantic  # type: ignore
+
+
+class TestSuiteRunExecutionMetricDefinition(pydantic.BaseModel):
+    id: typing.Optional[str] = None
+    label: typing.Optional[str] = None
+    name: typing.Optional[str] = None
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().dict(**kwargs_with_defaults)
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/test_suite_run_execution_metric_result.py

@@ -4,6 +4,7 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from .test_suite_run_execution_metric_definition import TestSuiteRunExecutionMetricDefinition
 from .test_suite_run_metric_output import TestSuiteRunMetricOutput
 
 try:
@@ -15,6 +16,8 @@ except ImportError:
 class TestSuiteRunExecutionMetricResult(pydantic.BaseModel):
     metric_id: str
     outputs: typing.List[TestSuiteRunMetricOutput]
+    metric_label: typing.Optional[str] = None
+    metric_definition: typing.Optional[TestSuiteRunExecutionMetricDefinition] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/test_suite_run_execution_number_output.py

@@ -12,8 +12,13 @@ except ImportError:
 
 
 class TestSuiteRunExecutionNumberOutput(pydantic.BaseModel):
-    output_variable_id: str
+    """
+    Execution output of an entity evaluated during a Test Suite Run that is of type NUMBER
+    """
+
+    name: str
     value: typing.Optional[float] = None
+    output_variable_id: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}

vellum/types/test_suite_run_execution_search_results_output.py

@@ -13,8 +13,13 @@ except ImportError:
 
 
 class TestSuiteRunExecutionSearchResultsOutput(pydantic.BaseModel):
-    output_variable_id: str
+    """
+    Execution output of an entity evaluated during a Test Suite Run that is of type SEARCH_RESULTS
+    """
+
+    name: str
     value: typing.Optional[typing.List[SearchResult]] = None
+    output_variable_id: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}