vellum-ai 0.0.1__py3-none-any.whl

vellum/types/model_version_exec_config_parameters.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+
+
+class ModelVersionExecConfigParameters(pydantic.BaseModel):
+    temperature: float
+    max_tokens: int
+    stop: typing.List[str]
+    top_p: float
+    top_k: typing.Optional[float]
+    frequency_penalty: float
+    presence_penalty: float
+    logit_bias: typing.Optional[typing.Dict[str, typing.Optional[float]]]
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/model_version_exec_config_read.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .model_version_exec_config_parameters import ModelVersionExecConfigParameters
+from .prompt_template_block_data import PromptTemplateBlockData
+
+
+class ModelVersionExecConfigRead(pydantic.BaseModel):
+    parameters: ModelVersionExecConfigParameters = pydantic.Field(
+        description=("The generation parameters that are passed to the LLM provider at runtime.\n")
+    )
+    input_variables: typing.List[str] = pydantic.Field(
+        description=("Names of the template variables specified in the prompt template.\n")
+    )
+    prompt_template: str = pydantic.Field(
+        description=("The template used to generate prompts for this model version.\n")
+    )
+    prompt_block_data: typing.Optional[PromptTemplateBlockData]
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/model_version_read.py

@@ -0,0 +1,43 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .model_type_enum import ModelTypeEnum
+from .model_version_build_config import ModelVersionBuildConfig
+from .model_version_exec_config_read import ModelVersionExecConfigRead
+from .model_version_read_status_enum import ModelVersionReadStatusEnum
+from .provider_enum import ProviderEnum
+
+
+class ModelVersionRead(pydantic.BaseModel):
+    id: str = pydantic.Field(description=("Vellum-generated ID that uniquely identifies this model version.\n"))
+    created: str = pydantic.Field(description=("Timestamp of when this model version was created.\n"))
+    label: str = pydantic.Field(description=("Human-friendly name for this model version.\n"))
+    model_type: ModelTypeEnum = pydantic.Field(description=("The type of task this model is used for.\n"))
+    provider: ProviderEnum = pydantic.Field(description=("Which LLM provider this model version is associated with.\n"))
+    external_id: str = pydantic.Field(
+        description=("The unique id of this model version as it exists in the above provider's system.\n")
+    )
+    build_config: ModelVersionBuildConfig = pydantic.Field(
+        description=("Configuration used to build this model version.\n")
+    )
+    exec_config: ModelVersionExecConfigRead = pydantic.Field(
+        description=("Configuration used to execute this model version.\n")
+    )
+    status: typing.Optional[ModelVersionReadStatusEnum]
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/model_version_read_status_enum.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ModelVersionReadStatusEnum(str, enum.Enum):
+    CREATING = "CREATING"
+    READY = "READY"
+    CREATION_FAILED = "CREATION_FAILED"
+    DISABLED = "DISABLED"
+
+    def visit(
+        self,
+        creating: typing.Callable[[], T_Result],
+        ready: typing.Callable[[], T_Result],
+        creation_failed: typing.Callable[[], T_Result],
+        disabled: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is ModelVersionReadStatusEnum.CREATING:
+            return creating()
+        if self is ModelVersionReadStatusEnum.READY:
+            return ready()
+        if self is ModelVersionReadStatusEnum.CREATION_FAILED:
+            return creation_failed()
+        if self is ModelVersionReadStatusEnum.DISABLED:
+            return disabled()

vellum/types/model_version_sandbox_snapshot.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+
+
+class ModelVersionSandboxSnapshot(pydantic.BaseModel):
+    id: str = pydantic.Field(description=("The ID of the sandbox snapshot.\n"))
+    prompt_index: int = pydantic.Field(description=("The index of the prompt in the sandbox snapshot.\n"))
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/normalized_log_probs.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .normalized_token_log_probs import NormalizedTokenLogProbs
+
+
+class NormalizedLogProbs(pydantic.BaseModel):
+    tokens: typing.List[NormalizedTokenLogProbs]
+    likelihood: float
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/normalized_token_log_probs.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+
+
+class NormalizedTokenLogProbs(pydantic.BaseModel):
+    token: str
+    logprob: float
+    top_logprobs: typing.Dict[str, float]
+    text_offset: int
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/paginated_slim_document_list.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .slim_document import SlimDocument
+
+
+class PaginatedSlimDocumentList(pydantic.BaseModel):
+    count: typing.Optional[int]
+    next: typing.Optional[str]
+    previous: typing.Optional[str]
+    results: typing.Optional[typing.List[SlimDocument]]
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/processing_state_enum.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ProcessingStateEnum(str, enum.Enum):
+    QUEUED = "QUEUED"
+    PROCESSING = "PROCESSING"
+    PROCESSED = "PROCESSED"
+    FAILED = "FAILED"
+
+    def visit(
+        self,
+        queued: typing.Callable[[], T_Result],
+        processing: typing.Callable[[], T_Result],
+        processed: typing.Callable[[], T_Result],
+        failed: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is ProcessingStateEnum.QUEUED:
+            return queued()
+        if self is ProcessingStateEnum.PROCESSING:
+            return processing()
+        if self is ProcessingStateEnum.PROCESSED:
+            return processed()
+        if self is ProcessingStateEnum.FAILED:
+            return failed()

vellum/types/prompt_template_block.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .block_type_enum import BlockTypeEnum
+from .prompt_template_block_properties import PromptTemplateBlockProperties
+
+
+class PromptTemplateBlock(pydantic.BaseModel):
+    block_type: BlockTypeEnum
+    properties: PromptTemplateBlockProperties
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/prompt_template_block_data.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .prompt_template_block import PromptTemplateBlock
+
+
+class PromptTemplateBlockData(pydantic.BaseModel):
+    version: int
+    blocks: typing.List[PromptTemplateBlock]
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/prompt_template_block_properties.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .chat_role_enum import ChatRoleEnum
+
+
+class PromptTemplateBlockProperties(pydantic.BaseModel):
+    chat_role: typing.Optional[ChatRoleEnum]
+    text: typing.Optional[str]
+    variable_name: typing.Optional[str]
+    blocks: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/provider_enum.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class ProviderEnum(str, enum.Enum):
+    ANTHROPIC = "ANTHROPIC"
+    COHERE = "COHERE"
+    GOOGLE = "GOOGLE"
+    HOSTED = "HOSTED"
+    OPENAI = "OPENAI"
+    PYQ = "PYQ"
+
+    def visit(
+        self,
+        anthropic: typing.Callable[[], T_Result],
+        cohere: typing.Callable[[], T_Result],
+        google: typing.Callable[[], T_Result],
+        hosted: typing.Callable[[], T_Result],
+        openai: typing.Callable[[], T_Result],
+        pyq: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is ProviderEnum.ANTHROPIC:
+            return anthropic()
+        if self is ProviderEnum.COHERE:
+            return cohere()
+        if self is ProviderEnum.GOOGLE:
+            return google()
+        if self is ProviderEnum.HOSTED:
+            return hosted()
+        if self is ProviderEnum.OPENAI:
+            return openai()
+        if self is ProviderEnum.PYQ:
+            return pyq()

vellum/types/search_error_response.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+
+
+class SearchErrorResponse(pydantic.BaseModel):
+    detail: str = pydantic.Field(description=("Details about why the request failed.\n"))
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_filters_request.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+
+
+class SearchFiltersRequest(pydantic.BaseModel):
+    external_ids: typing.Optional[typing.List[str]] = pydantic.Field(
+        description=("The document external IDs to filter by\n")
+    )
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_request_options_request.py

@@ -0,0 +1,36 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .search_filters_request import SearchFiltersRequest
+from .search_result_merging_request import SearchResultMergingRequest
+from .search_weights_request import SearchWeightsRequest
+
+
+class SearchRequestOptionsRequest(pydantic.BaseModel):
+    limit: typing.Optional[int] = pydantic.Field(description=("The maximum number of results to return.\n"))
+    weights: typing.Optional[SearchWeightsRequest] = pydantic.Field(
+        description=("The weights to use for the search. Must add up to 1.0.\n")
+    )
+    result_merging: typing.Optional[SearchResultMergingRequest] = pydantic.Field(
+        description=("The configuration for merging results.\n")
+    )
+    filters: typing.Optional[SearchFiltersRequest] = pydantic.Field(
+        description=("The filters to apply to the search.\n")
+    )
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .search_result import SearchResult
+
+
+class SearchResponse(pydantic.BaseModel):
+    results: typing.List[SearchResult] = pydantic.Field(
+        description=("The results of the search. Each result represents a chunk that matches the search query.\n")
+    )
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .document import Document
+
+
+class SearchResult(pydantic.BaseModel):
+    document: Document = pydantic.Field(
+        description=("The document that contains the chunk that matched the search query.\n")
+    )
+    text: str = pydantic.Field(description=("The text of the chunk that matched the search query.\n"))
+    keywords: typing.List[str]
+    score: float = pydantic.Field(description=("A score representing how well the chunk matches the search query.\n"))
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_result_merging_request.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+
+
+class SearchResultMergingRequest(pydantic.BaseModel):
+    enabled: bool = pydantic.Field(description=("Whether to enable merging results\n"))
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/search_weights_request.py

@@ -0,0 +1,25 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+
+
+class SearchWeightsRequest(pydantic.BaseModel):
+    semantic_similarity: float = pydantic.Field(description=("The relative weight to give to semantic similarity\n"))
+    keywords: float = pydantic.Field(description=("The relative weight to give to keyword matches\n"))
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/slim_document.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+
+from ..core.datetime_utils import serialize_datetime
+from .document_document_to_document_index import DocumentDocumentToDocumentIndex
+from .processing_state_enum import ProcessingStateEnum
+from .slim_document_status_enum import SlimDocumentStatusEnum
+
+
+class SlimDocument(pydantic.BaseModel):
+    id: str = pydantic.Field(description=("Vellum-generated ID that uniquely identifies this document.\n"))
+    external_id: typing.Optional[str] = pydantic.Field(
+        description=("The external ID that was originally provided when uploading the document.\n")
+    )
+    last_uploaded_at: str = pydantic.Field(
+        description=("A timestamp representing when this document was most recently uploaded.\n")
+    )
+    label: str = pydantic.Field(description=("Human-friendly name for this document.\n"))
+    processing_state: typing.Optional[ProcessingStateEnum] = pydantic.Field(
+        description=("The current processing state of the document\n")
+    )
+    status: typing.Optional[SlimDocumentStatusEnum] = pydantic.Field(description=("The document's current status.\n"))
+    keywords: typing.Optional[typing.List[str]] = pydantic.Field(
+        description=(
+            "A list of keywords associated with this document. Originally provided when uploading the document.\n"
+        )
+    )
+    document_to_document_indexes: typing.List[DocumentDocumentToDocumentIndex]
+
+    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
+        json_encoders = {dt.datetime: serialize_datetime}

vellum/types/slim_document_status_enum.py

@@ -0,0 +1,14 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class SlimDocumentStatusEnum(str, enum.Enum):
+    ACTIVE = "ACTIVE"
+
+    def visit(self, active: typing.Callable[[], T_Result]) -> T_Result:
+        if self is SlimDocumentStatusEnum.ACTIVE:
+            return active()