stract-api 0.1.0__py3-none-any.whl

stract_api/models/document_text.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class DocumentText(BaseModel):
+    """
+    DocumentText
+    """ # noqa: E501
+    text: Optional[StrictStr] = Field(description="Extracted text content of the document")
+    __properties: ClassVar[List[str]] = ["text"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DocumentText from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if text (nullable) is None
+        # and model_fields_set contains the field
+        if self.text is None and "text" in self.model_fields_set:
+            _dict['text'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DocumentText from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text")
+        })
+        return _obj
+
+

stract_api/models/edit_account_request.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class EditAccountRequest(BaseModel):
+    """
+    EditAccountRequest
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of the account", json_schema_extra={"examples": ["Acme Inc"]})
+    __properties: ClassVar[List[str]] = ["name"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EditAccountRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EditAccountRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name")
+        })
+        return _obj
+
+

stract_api/models/edit_field_request.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from stract_api.models.field_type import FieldType
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class EditFieldRequest(BaseModel):
+    """
+    EditFieldRequest
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="Name of the field", json_schema_extra={"examples": ["email"]})
+    description: Optional[StrictStr] = Field(default=None, description="Description of the field", json_schema_extra={"examples": ["Customer's email address"]})
+    type: Optional[FieldType] = None
+    enum_values: Optional[List[StrictStr]] = Field(default=None, description="Allowed values for the field, required if type is enum")
+    __properties: ClassVar[List[str]] = ["name", "description", "type", "enum_values"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EditFieldRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if enum_values (nullable) is None
+        # and model_fields_set contains the field
+        if self.enum_values is None and "enum_values" in self.model_fields_set:
+            _dict['enum_values'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EditFieldRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "type": obj.get("type"),
+            "enum_values": obj.get("enum_values")
+        })
+        return _obj
+
+

stract_api/models/edit_my_user_request.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class EditMyUserRequest(BaseModel):
+    """
+    EditMyUserRequest
+    """ # noqa: E501
+    first_name: Optional[StrictStr] = Field(default=None, description="User's first name")
+    last_name: Optional[StrictStr] = Field(default=None, description="User's last name")
+    __properties: ClassVar[List[str]] = ["first_name", "last_name"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EditMyUserRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EditMyUserRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "first_name": obj.get("first_name"),
+            "last_name": obj.get("last_name")
+        })
+        return _obj
+
+

stract_api/models/field_type.py

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class FieldType(str, Enum):
+    """
+    The data type of the field
+    """
+
+    """
+    allowed enum values
+    """
+    STRING = 'string'
+    BOOLEAN = 'boolean'
+    NUMBER = 'number'
+    DATE = 'date'
+    DATETIME = 'datetime'
+    ENUM = 'enum'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FieldType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

stract_api/models/job.py

@@ -0,0 +1,129 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from uuid import UUID
+from stract_api.models.job_status import JobStatus
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class Job(BaseModel):
+    """
+    Job
+    """ # noqa: E501
+    id: UUID = Field(description="Unique identifier of the job")
+    status: JobStatus
+    struct_id: UUID = Field(description="ID of the struct this job belongs to")
+    struct_name: StrictStr = Field(description="Name of the struct this job belongs to")
+    is_complete: StrictBool = Field(description="Whether the job has completed")
+    dt_created: datetime = Field(description="Timestamp when the job was created")
+    dt_completed: Optional[datetime] = Field(default=None, description="Timestamp when the job completed")
+    catalog_id: Optional[UUID] = Field(default=None, description="ID of the catalog this job was run against, if applicable")
+    catalog_name: Optional[StrictStr] = Field(default=None, description="Name of the catalog this job was run against, if applicable")
+    document_ids: Optional[List[UUID]] = Field(default=None, description="IDs of the documents this job was run against, if applicable")
+    notes: Optional[StrictStr] = Field(default=None, description="Notes about the job, e.g. an error message if the job failed")
+    credits_used: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Number of credits consumed by this job")
+    instructions: Optional[StrictStr] = Field(default=None, description="Additional instructions provided to guide the data extraction")
+    llm_model_id: Optional[StrictStr] = Field(default=None, description="ID of the LLM model used for this job", json_schema_extra={"examples": ["google.gemma-3-27b-it"]})
+    __properties: ClassVar[List[str]] = ["id", "status", "struct_id", "struct_name", "is_complete", "dt_created", "dt_completed", "catalog_id", "catalog_name", "document_ids", "notes", "credits_used", "instructions", "llm_model_id"]
+
+    @_coerce_field_validator('credits_used', mode="before")
+    def credits_used_coerce_numeric_string(cls, value):
+        """The API sends numbers as strings (e.g. '29532'); convert them before strict validation"""
+        if isinstance(value, str):
+            try:
+                return int(value)
+            except ValueError:
+                return float(value)
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Job from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Job from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "status": obj.get("status"),
+            "struct_id": obj.get("struct_id"),
+            "struct_name": obj.get("struct_name"),
+            "is_complete": obj.get("is_complete"),
+            "dt_created": obj.get("dt_created"),
+            "dt_completed": obj.get("dt_completed"),
+            "catalog_id": obj.get("catalog_id"),
+            "catalog_name": obj.get("catalog_name"),
+            "document_ids": obj.get("document_ids"),
+            "notes": obj.get("notes"),
+            "credits_used": obj.get("credits_used"),
+            "instructions": obj.get("instructions"),
+            "llm_model_id": obj.get("llm_model_id")
+        })
+        return _obj
+
+

stract_api/models/job_document.py

@@ -0,0 +1,123 @@
+# coding: utf-8
+
+"""
+    Stract API
+
+    Get structured output from unstructured inputs  ## Machine authentication  Programmatic access to the API is authenticated with an API key. Include the API key in every request as a bearer token in the `authorization` header:  ``` authorization: bearer [apiKey] ```  ## SDKs  Official SDKs are available for the following languages:  - **Node (JavaScript / TypeScript)**: [`stract-api` on npm](https://www.npmjs.com/package/stract-api) - **Java (17+)**: [`com.stract-api:stract-api` on Maven Central](https://central.sonatype.com/artifact/com.stract-api/stract-api) 
+
+    The version of the OpenAPI document: 0.9.4
+    Contact: matt@stract-api.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from uuid import UUID
+from stract_api.models.job_status import JobStatus
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+from pydantic import field_validator as _coerce_field_validator
+
+class JobDocument(BaseModel):
+    """
+    JobDocument
+    """ # noqa: E501
+    id: UUID = Field(description="Unique identifier of the job document")
+    job_id: UUID = Field(description="ID of the job this record belongs to")
+    document_id: UUID = Field(description="ID of the document this record belongs to")
+    document_name: StrictStr = Field(description="Name of the document this record belongs to")
+    notes: Optional[StrictStr] = Field(default=None, description="Notes about the job document, e.g. an error message if processing failed")
+    status: JobStatus
+    is_complete: StrictBool = Field(description="Whether processing of this document has completed")
+    error_description: Optional[StrictStr] = Field(default=None, description="Description of the error, if processing this document failed")
+    credits_used: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Number of credits consumed processing this document")
+    dt_started: Optional[datetime] = Field(default=None, description="Timestamp when processing of this document started")
+    dt_completed: Optional[datetime] = Field(default=None, description="Timestamp when processing of this document completed")
+    __properties: ClassVar[List[str]] = ["id", "job_id", "document_id", "document_name", "notes", "status", "is_complete", "error_description", "credits_used", "dt_started", "dt_completed"]
+
+    @_coerce_field_validator('credits_used', mode="before")
+    def credits_used_coerce_numeric_string(cls, value):
+        """The API sends numbers as strings (e.g. '29532'); convert them before strict validation"""
+        if isinstance(value, str):
+            try:
+                return int(value)
+            except ValueError:
+                return float(value)
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of JobDocument from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of JobDocument from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "job_id": obj.get("job_id"),
+            "document_id": obj.get("document_id"),
+            "document_name": obj.get("document_name"),
+            "notes": obj.get("notes"),
+            "status": obj.get("status"),
+            "is_complete": obj.get("is_complete"),
+            "error_description": obj.get("error_description"),
+            "credits_used": obj.get("credits_used"),
+            "dt_started": obj.get("dt_started"),
+            "dt_completed": obj.get("dt_completed")
+        })
+        return _obj
+
+