vellum-ai 0.3.13__py3-none-any.whl → 0.3.15__py3-none-any.whl

vellum/types/document_read.py

@@ -16,32 +16,41 @@ except ImportError:
 
 class DocumentRead(pydantic.BaseModel):
     id: str
-    external_id: typing.Optional[str] = pydantic.Field(
-        description="The unique id of this document as it exists in the user's system."
-    )
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The unique id of this document as it exists in the user's system.
+    """
+
     last_uploaded_at: dt.datetime
-    label: str = pydantic.Field(
-        description="A human-readable label for the document. Defaults to the originally uploaded file's file name."
-    )
-    processing_state: typing.Optional[ProcessingStateEnum] = pydantic.Field(
-        description=(
-            "The current processing state of the document\n"
-            "\n"
-            "- `QUEUED` - Queued\n"
-            "- `PROCESSING` - Processing\n"
-            "- `PROCESSED` - Processed\n"
-            "- `FAILED` - Failed\n"
-        )
-    )
-    status: typing.Optional[DocumentStatus] = pydantic.Field(
-        description=("The current status of the document\n" "\n" "- `ACTIVE` - Active\n")
-    )
-    original_file_url: typing.Optional[str]
-    processed_file_url: typing.Optional[str]
+    label: str = pydantic.Field()
+    """
+    A human-readable label for the document. Defaults to the originally uploaded file's file name.
+    """
+
+    processing_state: typing.Optional[ProcessingStateEnum] = pydantic.Field(default=None)
+    """
+    The current processing state of the document
+    
+    - `QUEUED` - Queued
+    - `PROCESSING` - Processing
+    - `PROCESSED` - Processed
+    - `FAILED` - Failed
+    """
+
+    status: typing.Optional[DocumentStatus] = pydantic.Field(default=None)
+    """
+    The current status of the document
+    
+    - `ACTIVE` - Active
+    """
+
+    original_file_url: typing.Optional[str] = None
+    processed_file_url: typing.Optional[str] = None
     document_to_document_indexes: typing.List[DocumentDocumentToDocumentIndex]
-    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(
-        description="A previously supplied JSON object containing metadata that can be filtered on when searching."
-    )
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    A previously supplied JSON object containing metadata that can be filtered on when searching.
+    """
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -54,4 +63,5 @@ class DocumentRead(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/document_status.py

@@ -1,5 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing_extensions
+import typing
 
-DocumentStatus = typing_extensions.Literal["ACTIVE"]
+DocumentStatus = typing.Literal["ACTIVE"]

vellum/types/enriched_normalized_completion.py

@@ -15,26 +15,42 @@ except ImportError:
 
 
 class EnrichedNormalizedCompletion(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The Vellum-generated ID of the completion.")
-    external_id: typing.Optional[str] = pydantic.Field(
-        description="The external ID that was originally provided along with the generation request, which uniquely identifies this generation in an external system."
-    )
-    text: str = pydantic.Field(description="The text generated by the LLM.")
-    finish_reason: typing.Optional[FinishReasonEnum] = pydantic.Field(
-        description=(
-            "The reason the generation finished.\n"
-            "\n"
-            "- `LENGTH` - LENGTH\n"
-            "- `STOP` - STOP\n"
-            "- `UNKNOWN` - UNKNOWN\n"
-        )
-    )
-    logprobs: typing.Optional[NormalizedLogProbs] = pydantic.Field(
-        description="The logprobs of the completion. Only present if specified in the original request options."
-    )
-    model_version_id: str = pydantic.Field(description="The ID of the model version used to generate this completion.")
+    id: str = pydantic.Field()
+    """
+    The Vellum-generated ID of the completion.
+    """
+
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The external ID that was originally provided along with the generation request, which uniquely identifies this generation in an external system.
+    """
+
+    text: str = pydantic.Field()
+    """
+    The text generated by the LLM.
+    """
+
+    finish_reason: typing.Optional[FinishReasonEnum] = pydantic.Field(default=None)
+    """
+    The reason the generation finished.
+    
+    - `LENGTH` - LENGTH
+    - `STOP` - STOP
+    - `UNKNOWN` - UNKNOWN
+    """
+
+    logprobs: typing.Optional[NormalizedLogProbs] = pydantic.Field(default=None)
+    """
+    The logprobs of the completion. Only present if specified in the original request options.
+    """
+
+    model_version_id: str = pydantic.Field()
+    """
+    The ID of the model version used to generate this completion.
+    """
+
     prompt_version_id: str
-    type: typing.Optional[VellumVariableType]
+    type: typing.Optional[VellumVariableType] = None
     deployment_release_tag: str
     model_name: str
 
@@ -49,4 +65,5 @@ class EnrichedNormalizedCompletion(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/error_enum.py

@@ -1,5 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing_extensions
+import typing
 
-ErrorEnum = typing_extensions.Literal["ERROR"]
+ErrorEnum = typing.Literal["ERROR"]

vellum/types/error_variable_value.py

@@ -13,7 +13,7 @@ except ImportError:
 
 
 class ErrorVariableValue(pydantic.BaseModel):
-    value: typing.Optional[VellumError]
+    value: typing.Optional[VellumError] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -26,4 +26,5 @@ class ErrorVariableValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execute_prompt_api_error_response.py

@@ -12,7 +12,10 @@ except ImportError:
 
 
 class ExecutePromptApiErrorResponse(pydantic.BaseModel):
-    detail: str = pydantic.Field(description="Details about why the request failed.")
+    detail: str = pydantic.Field()
+    """
+    Details about why the request failed.
+    """
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -25,4 +28,5 @@ class ExecutePromptApiErrorResponse(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execute_prompt_event.py

@@ -4,8 +4,6 @@ from __future__ import annotations
 
 import typing
 
-import typing_extensions
-
 from .fulfilled_execute_prompt_event import FulfilledExecutePromptEvent
 from .initiated_execute_prompt_event import InitiatedExecutePromptEvent
 from .rejected_execute_prompt_event import RejectedExecutePromptEvent
@@ -13,39 +11,43 @@ from .streaming_execute_prompt_event import StreamingExecutePromptEvent
 
 
 class ExecutePromptEvent_Initiated(InitiatedExecutePromptEvent):
-    state: typing_extensions.Literal["INITIATED"]
+    state: typing.Literal["INITIATED"] = "INITIATED"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutePromptEvent_Streaming(StreamingExecutePromptEvent):
-    state: typing_extensions.Literal["STREAMING"]
+    state: typing.Literal["STREAMING"] = "STREAMING"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutePromptEvent_Fulfilled(FulfilledExecutePromptEvent):
-    state: typing_extensions.Literal["FULFILLED"]
+    state: typing.Literal["FULFILLED"] = "FULFILLED"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutePromptEvent_Rejected(RejectedExecutePromptEvent):
-    state: typing_extensions.Literal["REJECTED"]
+    state: typing.Literal["REJECTED"] = "REJECTED"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 ExecutePromptEvent = typing.Union[

vellum/types/execute_prompt_response.py

@@ -4,28 +4,28 @@ from __future__ import annotations
 
 import typing
 
-import typing_extensions
-
 from .fulfilled_execute_prompt_response import FulfilledExecutePromptResponse
 from .rejected_execute_prompt_response import RejectedExecutePromptResponse
 
 
 class ExecutePromptResponse_Fulfilled(FulfilledExecutePromptResponse):
-    state: typing_extensions.Literal["FULFILLED"]
+    state: typing.Literal["FULFILLED"] = "FULFILLED"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutePromptResponse_Rejected(RejectedExecutePromptResponse):
-    state: typing_extensions.Literal["REJECTED"]
+    state: typing.Literal["REJECTED"] = "REJECTED"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 ExecutePromptResponse = typing.Union[ExecutePromptResponse_Fulfilled, ExecutePromptResponse_Rejected]

vellum/types/execute_workflow_error_response.py

@@ -12,7 +12,10 @@ except ImportError:
 
 
 class ExecuteWorkflowErrorResponse(pydantic.BaseModel):
-    detail: str = pydantic.Field(description="Details about why the request failed.")
+    detail: str = pydantic.Field()
+    """
+    Details about why the request failed.
+    """
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -25,4 +28,5 @@ class ExecuteWorkflowErrorResponse(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execute_workflow_response.py

@@ -14,8 +14,8 @@ except ImportError:
 
 class ExecuteWorkflowResponse(pydantic.BaseModel):
     execution_id: str
-    run_id: typing.Optional[str]
-    external_id: typing.Optional[str]
+    run_id: typing.Optional[str] = None
+    external_id: typing.Optional[str] = None
     data: ExecuteWorkflowWorkflowResultEvent
 
     def json(self, **kwargs: typing.Any) -> str:
@@ -29,4 +29,5 @@ class ExecuteWorkflowResponse(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execute_workflow_stream_error_response.py

@@ -12,7 +12,10 @@ except ImportError:
 
 
 class ExecuteWorkflowStreamErrorResponse(pydantic.BaseModel):
-    detail: str = pydantic.Field(description="Details about why the request failed.")
+    detail: str = pydantic.Field()
+    """
+    Details about why the request failed.
+    """
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -25,4 +28,5 @@ class ExecuteWorkflowStreamErrorResponse(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execute_workflow_workflow_result_event.py

@@ -4,28 +4,28 @@ from __future__ import annotations
 
 import typing
 
-import typing_extensions
-
 from .fulfilled_execute_workflow_workflow_result_event import FulfilledExecuteWorkflowWorkflowResultEvent
 from .rejected_execute_workflow_workflow_result_event import RejectedExecuteWorkflowWorkflowResultEvent
 
 
 class ExecuteWorkflowWorkflowResultEvent_Fulfilled(FulfilledExecuteWorkflowWorkflowResultEvent):
-    state: typing_extensions.Literal["FULFILLED"]
+    state: typing.Literal["FULFILLED"] = "FULFILLED"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecuteWorkflowWorkflowResultEvent_Rejected(RejectedExecuteWorkflowWorkflowResultEvent):
-    state: typing_extensions.Literal["REJECTED"]
+    state: typing.Literal["REJECTED"] = "REJECTED"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 ExecuteWorkflowWorkflowResultEvent = typing.Union[

vellum/types/execution_array_vellum_value.py

@@ -13,9 +13,13 @@ except ImportError:
 
 
 class ExecutionArrayVellumValue(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    id: str = pydantic.Field()
+    """
+    The variable's uniquely identifying internal id.
+    """
+
     name: str
-    value: typing.Optional[typing.List[ArrayVariableValueItem]]
+    value: typing.Optional[typing.List[ArrayVariableValueItem]] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -28,4 +32,5 @@ class ExecutionArrayVellumValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execution_chat_history_vellum_value.py

@@ -13,9 +13,13 @@ except ImportError:
 
 
 class ExecutionChatHistoryVellumValue(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    id: str = pydantic.Field()
+    """
+    The variable's uniquely identifying internal id.
+    """
+
     name: str
-    value: typing.Optional[typing.List[ChatMessage]]
+    value: typing.Optional[typing.List[ChatMessage]] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -28,4 +32,5 @@ class ExecutionChatHistoryVellumValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execution_error_vellum_value.py

@@ -13,9 +13,13 @@ except ImportError:
 
 
 class ExecutionErrorVellumValue(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    id: str = pydantic.Field()
+    """
+    The variable's uniquely identifying internal id.
+    """
+
     name: str
-    value: typing.Optional[VellumError]
+    value: typing.Optional[VellumError] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -28,4 +32,5 @@ class ExecutionErrorVellumValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execution_function_call_vellum_value.py

@@ -13,9 +13,13 @@ except ImportError:
 
 
 class ExecutionFunctionCallVellumValue(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    id: str = pydantic.Field()
+    """
+    The variable's uniquely identifying internal id.
+    """
+
     name: str
-    value: typing.Optional[FunctionCall]
+    value: typing.Optional[FunctionCall] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -28,4 +32,5 @@ class ExecutionFunctionCallVellumValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execution_json_vellum_value.py

@@ -12,9 +12,13 @@ except ImportError:
 
 
 class ExecutionJsonVellumValue(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    id: str = pydantic.Field()
+    """
+    The variable's uniquely identifying internal id.
+    """
+
     name: str
-    value: typing.Optional[typing.Dict[str, typing.Any]]
+    value: typing.Optional[typing.Dict[str, typing.Any]] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -27,4 +31,5 @@ class ExecutionJsonVellumValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execution_number_vellum_value.py

@@ -12,9 +12,13 @@ except ImportError:
 
 
 class ExecutionNumberVellumValue(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    id: str = pydantic.Field()
+    """
+    The variable's uniquely identifying internal id.
+    """
+
     name: str
-    value: typing.Optional[float]
+    value: typing.Optional[float] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -27,4 +31,5 @@ class ExecutionNumberVellumValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execution_search_results_vellum_value.py

@@ -13,9 +13,13 @@ except ImportError:
 
 
 class ExecutionSearchResultsVellumValue(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    id: str = pydantic.Field()
+    """
+    The variable's uniquely identifying internal id.
+    """
+
     name: str
-    value: typing.Optional[typing.List[SearchResult]]
+    value: typing.Optional[typing.List[SearchResult]] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -28,4 +32,5 @@ class ExecutionSearchResultsVellumValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execution_string_vellum_value.py

@@ -12,9 +12,13 @@ except ImportError:
 
 
 class ExecutionStringVellumValue(pydantic.BaseModel):
-    id: str = pydantic.Field(description="The variable's uniquely identifying internal id.")
+    id: str = pydantic.Field()
+    """
+    The variable's uniquely identifying internal id.
+    """
+
     name: str
-    value: typing.Optional[str]
+    value: typing.Optional[str] = None
 
     def json(self, **kwargs: typing.Any) -> str:
         kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
@@ -27,4 +31,5 @@ class ExecutionStringVellumValue(pydantic.BaseModel):
     class Config:
         frozen = True
         smart_union = True
+        extra = pydantic.Extra.allow
         json_encoders = {dt.datetime: serialize_datetime}

vellum/types/execution_vellum_value.py

@@ -4,8 +4,6 @@ from __future__ import annotations
 
 import typing
 
-import typing_extensions
-
 from .execution_array_vellum_value import ExecutionArrayVellumValue
 from .execution_chat_history_vellum_value import ExecutionChatHistoryVellumValue
 from .execution_error_vellum_value import ExecutionErrorVellumValue
@@ -17,75 +15,83 @@ from .execution_string_vellum_value import ExecutionStringVellumValue
 
 
 class ExecutionVellumValue_String(ExecutionStringVellumValue):
-    type: typing_extensions.Literal["STRING"]
+    type: typing.Literal["STRING"] = "STRING"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutionVellumValue_Number(ExecutionNumberVellumValue):
-    type: typing_extensions.Literal["NUMBER"]
+    type: typing.Literal["NUMBER"] = "NUMBER"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutionVellumValue_Json(ExecutionJsonVellumValue):
-    type: typing_extensions.Literal["JSON"]
+    type: typing.Literal["JSON"] = "JSON"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutionVellumValue_ChatHistory(ExecutionChatHistoryVellumValue):
-    type: typing_extensions.Literal["CHAT_HISTORY"]
+    type: typing.Literal["CHAT_HISTORY"] = "CHAT_HISTORY"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutionVellumValue_SearchResults(ExecutionSearchResultsVellumValue):
-    type: typing_extensions.Literal["SEARCH_RESULTS"]
+    type: typing.Literal["SEARCH_RESULTS"] = "SEARCH_RESULTS"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutionVellumValue_Error(ExecutionErrorVellumValue):
-    type: typing_extensions.Literal["ERROR"]
+    type: typing.Literal["ERROR"] = "ERROR"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutionVellumValue_Array(ExecutionArrayVellumValue):
-    type: typing_extensions.Literal["ARRAY"]
+    type: typing.Literal["ARRAY"] = "ARRAY"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 class ExecutionVellumValue_FunctionCall(ExecutionFunctionCallVellumValue):
-    type: typing_extensions.Literal["FUNCTION_CALL"]
+    type: typing.Literal["FUNCTION_CALL"] = "FUNCTION_CALL"
 
     class Config:
         frozen = True
         smart_union = True
         allow_population_by_field_name = True
+        populate_by_name = True
 
 
 ExecutionVellumValue = typing.Union[

vellum/types/fulfilled_enum.py

@@ -1,5 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import typing_extensions
+import typing
 
-FulfilledEnum = typing_extensions.Literal["FULFILLED"]
+FulfilledEnum = typing.Literal["FULFILLED"]