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

vellum/types/sandbox_scenario.py

@@ -4,22 +4,22 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .scenario_input import ScenarioInput
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
+class SandboxScenario(pydantic_v1.BaseModel):
+    """
+    Sandbox Scenario
+    """
 
-class SandboxScenario(pydantic.BaseModel):
     label: typing.Optional[str] = None
-    inputs: typing.List[ScenarioInput] = pydantic.Field()
+    inputs: typing.List[ScenarioInput] = pydantic_v1.Field()
     """
     The inputs for the scenario
     """
 
-    id: str = pydantic.Field()
+    id: str = pydantic_v1.Field()
     """
     The id of the scenario
     """
@@ -35,5 +35,5 @@ class SandboxScenario(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/scenario_input.py

@@ -1,34 +1,31 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
+from __future__ import annotations
+
 import typing
 
-from ..core.datetime_utils import serialize_datetime
-from .chat_message import ChatMessage
-from .scenario_input_type_enum import ScenarioInputTypeEnum
+from .scenario_input_chat_history_variable_value import ScenarioInputChatHistoryVariableValue
+from .scenario_input_string_variable_value import ScenarioInputStringVariableValue
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
+class ScenarioInput_String(ScenarioInputStringVariableValue):
+    type: typing.Literal["STRING"] = "STRING"
 
-class ScenarioInput(pydantic.BaseModel):
-    key: str
-    type: typing.Optional[ScenarioInputTypeEnum] = None
-    value: typing.Optional[str] = None
-    chat_history: typing.Optional[typing.List[ChatMessage]] = None
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
 
-    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 ScenarioInput_ChatHistory(ScenarioInputChatHistoryVariableValue):
+    type: typing.Literal["CHAT_HISTORY"] = "CHAT_HISTORY"
 
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
-        json_encoders = {dt.datetime: serialize_datetime}
+        allow_population_by_field_name = True
+        populate_by_name = True
+
+
+ScenarioInput = typing.Union[ScenarioInput_String, ScenarioInput_ChatHistory]

vellum/types/{registered_prompt_sandbox.py → scenario_input_chat_history_variable_value.py}

@@ -4,23 +4,17 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+from .chat_message import ChatMessage
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class RegisteredPromptSandbox(pydantic.BaseModel):
-    id: str = pydantic.Field()
+class ScenarioInputChatHistoryVariableValue(pydantic_v1.BaseModel):
     """
-    The ID of the generated sandbox.
+    Prompt Sandbox Scenario input value that is of type CHAT_HISTORY
     """
 
-    label: str = pydantic.Field()
-    """
-    A human-friendly label for the generated sandbox.
-    """
+    value: typing.Optional[typing.List[ChatMessage]] = None
+    input_variable_id: str
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -33,5 +27,5 @@ class RegisteredPromptSandbox(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/scenario_input_string_variable_value.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
+
+
+class ScenarioInputStringVariableValue(pydantic_v1.BaseModel):
+    """
+    Prompt Sandbox Scenario input value that is of type STRING
+    """
+
+    value: typing.Optional[str] = None
+    input_variable_id: str
+
+    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_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_error_response.py

@@ -4,15 +4,11 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchErrorResponse(pydantic.BaseModel):
-    detail: str = pydantic.Field()
+class SearchErrorResponse(pydantic_v1.BaseModel):
+    detail: str = pydantic_v1.Field()
     """
     Details about why the request failed.
     """
@@ -28,5 +24,5 @@ class SearchErrorResponse(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_filters_request.py

@@ -4,21 +4,17 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .metadata_filter_config_request import MetadataFilterConfigRequest
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchFiltersRequest(pydantic.BaseModel):
-    external_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+class SearchFiltersRequest(pydantic_v1.BaseModel):
+    external_ids: typing.Optional[typing.List[str]] = pydantic_v1.Field(default=None)
     """
     The document external IDs to filter by
     """
 
-    metadata: typing.Optional[MetadataFilterConfigRequest] = pydantic.Field(default=None)
+    metadata: typing.Optional[MetadataFilterConfigRequest] = pydantic_v1.Field(default=None)
     """
     The metadata filters to apply to the search
     """
@@ -34,5 +30,5 @@ class SearchFiltersRequest(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_node_result.py

@@ -4,15 +4,11 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .search_node_result_data import SearchNodeResultData
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchNodeResult(pydantic.BaseModel):
+class SearchNodeResult(pydantic_v1.BaseModel):
     """
     A Node Result Event emitted from a Search Node.
     """
@@ -30,5 +26,5 @@ class SearchNodeResult(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_node_result_data.py

@@ -4,17 +4,13 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .search_result import SearchResult
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchNodeResultData(pydantic.BaseModel):
+class SearchNodeResultData(pydantic_v1.BaseModel):
     results_output_id: str
-    results: typing.List[SearchResult] = pydantic.Field()
+    results: typing.List[SearchResult] = pydantic_v1.Field()
     """
     The results of the search. Each result represents a chunk that matches the search query.
     """
@@ -33,5 +29,5 @@ class SearchNodeResultData(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_request_options_request.py

@@ -4,33 +4,29 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .search_filters_request import SearchFiltersRequest
 from .search_result_merging_request import SearchResultMergingRequest
 from .search_weights_request import SearchWeightsRequest
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchRequestOptionsRequest(pydantic.BaseModel):
-    limit: typing.Optional[int] = pydantic.Field(default=None)
+class SearchRequestOptionsRequest(pydantic_v1.BaseModel):
+    limit: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
     The maximum number of results to return.
     """
 
-    weights: typing.Optional[SearchWeightsRequest] = pydantic.Field(default=None)
+    weights: typing.Optional[SearchWeightsRequest] = pydantic_v1.Field(default=None)
     """
     The weights to use for the search. Must add up to 1.0.
     """
 
-    result_merging: typing.Optional[SearchResultMergingRequest] = pydantic.Field(default=None)
+    result_merging: typing.Optional[SearchResultMergingRequest] = pydantic_v1.Field(default=None)
     """
     The configuration for merging results.
     """
 
-    filters: typing.Optional[SearchFiltersRequest] = pydantic.Field(default=None)
+    filters: typing.Optional[SearchFiltersRequest] = pydantic_v1.Field(default=None)
     """
     The filters to apply to the search.
     """
@@ -46,5 +42,5 @@ class SearchRequestOptionsRequest(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_response.py

@@ -4,16 +4,12 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .search_result import SearchResult
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchResponse(pydantic.BaseModel):
-    results: typing.List[SearchResult] = pydantic.Field()
+class SearchResponse(pydantic_v1.BaseModel):
+    results: typing.List[SearchResult] = pydantic_v1.Field()
     """
     The results of the search. Each result represents a chunk that matches the search query.
     """
@@ -29,5 +25,5 @@ class SearchResponse(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result.py

@@ -4,27 +4,23 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .search_result_document import SearchResultDocument
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchResult(pydantic.BaseModel):
-    text: str = pydantic.Field()
+class SearchResult(pydantic_v1.BaseModel):
+    text: str = pydantic_v1.Field()
     """
     The text of the chunk that matched the search query.
     """
 
-    score: float = pydantic.Field()
+    score: float = pydantic_v1.Field()
     """
     A score representing how well the chunk matches the search query.
     """
 
     keywords: typing.List[str]
-    document: SearchResultDocument = pydantic.Field()
+    document: SearchResultDocument = pydantic_v1.Field()
     """
     The document that contains the chunk that matched the search query.
     """
@@ -40,5 +36,5 @@ class SearchResult(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result_document.py

@@ -4,30 +4,26 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchResultDocument(pydantic.BaseModel):
-    id: str = pydantic.Field()
+class SearchResultDocument(pydantic_v1.BaseModel):
+    id: str = pydantic_v1.Field()
     """
     The ID of the document.
     """
 
-    label: str = pydantic.Field()
+    label: str = pydantic_v1.Field()
     """
     The human-readable name for the document.
     """
 
-    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    external_id: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
     The unique ID of the document as represented in an external system and specified when it was originally uploaded.
     """
 
-    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
     """
     A previously supplied JSON object containing metadata that can be filtered on when searching.
     """
@@ -43,5 +39,5 @@ class SearchResultDocument(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result_document_request.py

@@ -4,25 +4,21 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchResultDocumentRequest(pydantic.BaseModel):
-    label: str = pydantic.Field()
+class SearchResultDocumentRequest(pydantic_v1.BaseModel):
+    label: str = pydantic_v1.Field()
     """
     The human-readable name for the document.
     """
 
-    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    external_id: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
     The unique ID of the document as represented in an external system and specified when it was originally uploaded.
     """
 
-    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
     """
     A previously supplied JSON object containing metadata that can be filtered on when searching.
     """
@@ -38,5 +34,5 @@ class SearchResultDocumentRequest(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result_merging_request.py

@@ -4,15 +4,11 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchResultMergingRequest(pydantic.BaseModel):
-    enabled: typing.Optional[bool] = pydantic.Field(default=None)
+class SearchResultMergingRequest(pydantic_v1.BaseModel):
+    enabled: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
     Whether to enable merging results
     """
@@ -28,5 +24,5 @@ class SearchResultMergingRequest(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result_request.py

@@ -4,27 +4,23 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .search_result_document_request import SearchResultDocumentRequest
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchResultRequest(pydantic.BaseModel):
-    text: str = pydantic.Field()
+class SearchResultRequest(pydantic_v1.BaseModel):
+    text: str = pydantic_v1.Field()
     """
     The text of the chunk that matched the search query.
     """
 
-    score: float = pydantic.Field()
+    score: float = pydantic_v1.Field()
     """
     A score representing how well the chunk matches the search query.
     """
 
     keywords: typing.List[str]
-    document: SearchResultDocumentRequest = pydantic.Field()
+    document: SearchResultDocumentRequest = pydantic_v1.Field()
     """
     The document that contains the chunk that matched the search query.
     """
@@ -40,5 +36,5 @@ class SearchResultRequest(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_results_variable_value.py

@@ -4,15 +4,11 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .search_result import SearchResult
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchResultsVariableValue(pydantic.BaseModel):
+class SearchResultsVariableValue(pydantic_v1.BaseModel):
     value: typing.Optional[typing.List[SearchResult]] = None
 
     def json(self, **kwargs: typing.Any) -> str:
@@ -26,5 +22,5 @@ class SearchResultsVariableValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_weights_request.py

@@ -4,20 +4,16 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SearchWeightsRequest(pydantic.BaseModel):
-    semantic_similarity: typing.Optional[float] = pydantic.Field(default=None)
+class SearchWeightsRequest(pydantic_v1.BaseModel):
+    semantic_similarity: typing.Optional[float] = pydantic_v1.Field(default=None)
     """
     The relative weight to give to semantic similarity
     """
 
-    keywords: typing.Optional[float] = pydantic.Field(default=None)
+    keywords: typing.Optional[float] = pydantic_v1.Field(default=None)
     """
     The relative weight to give to keywords
     """
@@ -33,5 +29,5 @@ class SearchWeightsRequest(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/slim_deployment_read.py

@@ -4,30 +4,26 @@ import datetime as dt
 import typing
 
 from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import pydantic_v1
 from .entity_status import EntityStatus
 from .environment_enum import EnvironmentEnum
 from .vellum_variable import VellumVariable
 
-try:
-    import pydantic.v1 as pydantic  # type: ignore
-except ImportError:
-    import pydantic  # type: ignore
 
-
-class SlimDeploymentRead(pydantic.BaseModel):
+class SlimDeploymentRead(pydantic_v1.BaseModel):
     id: str
     created: dt.datetime
-    label: str = pydantic.Field()
+    label: str = pydantic_v1.Field()
     """
     A human-readable label for the deployment
     """
 
-    name: str = pydantic.Field()
+    name: str = pydantic_v1.Field()
     """
     A name that uniquely identifies this deployment within its workspace
     """
 
-    status: typing.Optional[EntityStatus] = pydantic.Field(default=None)
+    status: typing.Optional[EntityStatus] = pydantic_v1.Field(default=None)
     """
     The current status of the deployment
     
@@ -35,7 +31,7 @@ class SlimDeploymentRead(pydantic.BaseModel):
     - `ARCHIVED` - Archived
     """
 
-    environment: typing.Optional[EnvironmentEnum] = pydantic.Field(default=None)
+    environment: typing.Optional[EnvironmentEnum] = pydantic_v1.Field(default=None)
     """
     The environment this deployment is used in
     
@@ -58,5 +54,5 @@ class SlimDeploymentRead(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
-        extra = pydantic.Extra.allow
+        extra = pydantic_v1.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}