rapidata 2.27.2__py3-none-any.whl → 2.44.3__py3-none-any.whl

rapidata/api_client/models/user_score_filter.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserScoreFilter(BaseModel):
+    """
+    UserScoreFilter
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for UserScoreFilter", alias="_t")
+    lowerbound: Union[StrictFloat, StrictInt]
+    upperbound: Union[StrictFloat, StrictInt]
+    dimension: StrictStr
+    execution_order: Optional[StrictInt] = Field(default=None, alias="executionOrder")
+    __properties: ClassVar[List[str]] = ["_t", "lowerbound", "upperbound", "dimension", "executionOrder"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['UserScoreFilter']):
+            raise ValueError("must be one of enum values ('UserScoreFilter')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UserScoreFilter 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 UserScoreFilter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "_t": obj.get("_t") if obj.get("_t") is not None else 'UserScoreFilter',
+            "lowerbound": obj.get("lowerbound"),
+            "upperbound": obj.get("upperbound"),
+            "dimension": obj.get("dimension"),
+            "executionOrder": obj.get("executionOrder")
+        })
+        return _obj
+
+

rapidata/api_client/models/user_state.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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 UserState(str, Enum):
+    """
+    UserState
+    """
+
+    """
+    allowed enum values
+    """
+    TRAINING = 'Training'
+    BLACKLIST = 'Blacklist'
+    ACTIVE = 'Active'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of UserState from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/user_state_filter.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.user_state import UserState
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserStateFilter(BaseModel):
+    """
+    UserStateFilter
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for UserStateFilter", alias="_t")
+    states: List[UserState]
+    execution_order: Optional[StrictInt] = Field(default=None, alias="executionOrder")
+    __properties: ClassVar[List[str]] = ["_t", "states", "executionOrder"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['UserStateFilter']):
+            raise ValueError("must be one of enum values ('UserStateFilter')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UserStateFilter 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "execution_order",
+        ])
+
+        _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 UserStateFilter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "_t": obj.get("_t") if obj.get("_t") is not None else 'UserStateFilter',
+            "states": obj.get("states"),
+            "executionOrder": obj.get("executionOrder")
+        })
+        return _obj
+
+

rapidata/api_client/models/validation_chance.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
-from typing import Any, ClassVar, Dict, List, Union
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -29,7 +29,8 @@ class ValidationChance(BaseModel):
     user_score_threshold: Union[StrictFloat, StrictInt] = Field(alias="userScoreThreshold")
     chance: Union[StrictFloat, StrictInt]
     rapid_count: StrictInt = Field(alias="rapidCount")
-    __properties: ClassVar[List[str]] = ["userScoreThreshold", "chance", "rapidCount"]
+    selections: Optional[List[AbTestSelectionAInner]] = None
+    __properties: ClassVar[List[str]] = ["userScoreThreshold", "chance", "rapidCount", "selections"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -70,6 +71,18 @@ class ValidationChance(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of each item in selections (list)
+        _items = []
+        if self.selections:
+            for _item_selections in self.selections:
+                if _item_selections:
+                    _items.append(_item_selections.to_dict())
+            _dict['selections'] = _items
+        # set to None if selections (nullable) is None
+        # and model_fields_set contains the field
+        if self.selections is None and "selections" in self.model_fields_set:
+            _dict['selections'] = None
+
         return _dict
 
     @classmethod
@@ -84,8 +97,12 @@ class ValidationChance(BaseModel):
         _obj = cls.model_validate({
             "userScoreThreshold": obj.get("userScoreThreshold"),
             "chance": obj.get("chance"),
-            "rapidCount": obj.get("rapidCount")
+            "rapidCount": obj.get("rapidCount"),
+            "selections": [AbTestSelectionAInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None
         })
         return _obj
 
+from rapidata.api_client.models.ab_test_selection_a_inner import AbTestSelectionAInner
+# TODO: Rewrite to not use raise_errors
+ValidationChance.model_rebuild(raise_errors=False)
 

rapidata/api_client/models/validation_set_model.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -18,8 +18,8 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -29,10 +29,39 @@ class ValidationSetModel(BaseModel):
     """ # noqa: E501
     id: StrictStr
     name: StrictStr
+    asset_type: List[StrictStr] = Field(alias="assetType")
+    modality: List[StrictStr]
+    prompt_type: List[StrictStr] = Field(alias="promptType")
+    dimensions: Optional[List[StrictStr]] = None
+    is_public: StrictBool = Field(alias="isPublic")
     owner_id: StrictStr = Field(alias="ownerId")
     owner_mail: StrictStr = Field(alias="ownerMail")
     created_at: datetime = Field(alias="createdAt")
-    __properties: ClassVar[List[str]] = ["id", "name", "ownerId", "ownerMail", "createdAt"]
+    __properties: ClassVar[List[str]] = ["id", "name", "assetType", "modality", "promptType", "dimensions", "isPublic", "ownerId", "ownerMail", "createdAt"]
+
+    @field_validator('asset_type')
+    def asset_type_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(['None', 'Image', 'Video', 'Audio', 'Text']):
+                raise ValueError("each list item must be one of ('None', 'Image', 'Video', 'Audio', 'Text')")
+        return value
+
+    @field_validator('modality')
+    def modality_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(['None', 'BoundingBox', 'Classify', 'Compare', 'FreeText', 'Line', 'Locate', 'NamedEntity', 'Polygon', 'Scrub', 'Transcription']):
+                raise ValueError("each list item must be one of ('None', 'BoundingBox', 'Classify', 'Compare', 'FreeText', 'Line', 'Locate', 'NamedEntity', 'Polygon', 'Scrub', 'Transcription')")
+        return value
+
+    @field_validator('prompt_type')
+    def prompt_type_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(['None', 'Text', 'Asset']):
+                raise ValueError("each list item must be one of ('None', 'Text', 'Asset')")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -87,6 +116,11 @@ class ValidationSetModel(BaseModel):
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
+            "assetType": obj.get("assetType"),
+            "modality": obj.get("modality"),
+            "promptType": obj.get("promptType"),
+            "dimensions": obj.get("dimensions"),
+            "isPublic": obj.get("isPublic"),
             "ownerId": obj.get("ownerId"),
             "ownerMail": obj.get("ownerMail"),
             "createdAt": obj.get("createdAt")

rapidata/api_client/models/validation_set_overview_model.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)

rapidata/api_client/models/validation_set_validation_set_id_rapid_post_payload_parameter.py

@@ -0,0 +1,252 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from rapidata.api_client.models.bounding_box_payload import BoundingBoxPayload
+from rapidata.api_client.models.classify_payload import ClassifyPayload
+from rapidata.api_client.models.compare_payload import ComparePayload
+from rapidata.api_client.models.free_text_payload import FreeTextPayload
+from rapidata.api_client.models.line_payload import LinePayload
+from rapidata.api_client.models.locate_payload import LocatePayload
+from rapidata.api_client.models.named_entity_payload import NamedEntityPayload
+from rapidata.api_client.models.polygon_payload import PolygonPayload
+from rapidata.api_client.models.scrub_payload import ScrubPayload
+from rapidata.api_client.models.transcription_payload import TranscriptionPayload
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+VALIDATIONSETVALIDATIONSETIDRAPIDPOSTPAYLOADPARAMETER_ONE_OF_SCHEMAS = ["BoundingBoxPayload", "ClassifyPayload", "ComparePayload", "FreeTextPayload", "LinePayload", "LocatePayload", "NamedEntityPayload", "PolygonPayload", "ScrubPayload", "TranscriptionPayload"]
+
+class ValidationSetValidationSetIdRapidPostPayloadParameter(BaseModel):
+    """
+    ValidationSetValidationSetIdRapidPostPayloadParameter
+    """
+    # data type: TranscriptionPayload
+    oneof_schema_1_validator: Optional[TranscriptionPayload] = None
+    # data type: ScrubPayload
+    oneof_schema_2_validator: Optional[ScrubPayload] = None
+    # data type: PolygonPayload
+    oneof_schema_3_validator: Optional[PolygonPayload] = None
+    # data type: NamedEntityPayload
+    oneof_schema_4_validator: Optional[NamedEntityPayload] = None
+    # data type: LocatePayload
+    oneof_schema_5_validator: Optional[LocatePayload] = None
+    # data type: LinePayload
+    oneof_schema_6_validator: Optional[LinePayload] = None
+    # data type: FreeTextPayload
+    oneof_schema_7_validator: Optional[FreeTextPayload] = None
+    # data type: ComparePayload
+    oneof_schema_8_validator: Optional[ComparePayload] = None
+    # data type: ClassifyPayload
+    oneof_schema_9_validator: Optional[ClassifyPayload] = None
+    # data type: BoundingBoxPayload
+    oneof_schema_10_validator: Optional[BoundingBoxPayload] = None
+    actual_instance: Optional[Union[BoundingBoxPayload, ClassifyPayload, ComparePayload, FreeTextPayload, LinePayload, LocatePayload, NamedEntityPayload, PolygonPayload, ScrubPayload, TranscriptionPayload]] = None
+    one_of_schemas: Set[str] = { "BoundingBoxPayload", "ClassifyPayload", "ComparePayload", "FreeTextPayload", "LinePayload", "LocatePayload", "NamedEntityPayload", "PolygonPayload", "ScrubPayload", "TranscriptionPayload" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    discriminator_value_class_map: Dict[str, str] = {
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = ValidationSetValidationSetIdRapidPostPayloadParameter.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: TranscriptionPayload
+        if not isinstance(v, TranscriptionPayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TranscriptionPayload`")
+        else:
+            match += 1
+        # validate data type: ScrubPayload
+        if not isinstance(v, ScrubPayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScrubPayload`")
+        else:
+            match += 1
+        # validate data type: PolygonPayload
+        if not isinstance(v, PolygonPayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PolygonPayload`")
+        else:
+            match += 1
+        # validate data type: NamedEntityPayload
+        if not isinstance(v, NamedEntityPayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NamedEntityPayload`")
+        else:
+            match += 1
+        # validate data type: LocatePayload
+        if not isinstance(v, LocatePayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `LocatePayload`")
+        else:
+            match += 1
+        # validate data type: LinePayload
+        if not isinstance(v, LinePayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `LinePayload`")
+        else:
+            match += 1
+        # validate data type: FreeTextPayload
+        if not isinstance(v, FreeTextPayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `FreeTextPayload`")
+        else:
+            match += 1
+        # validate data type: ComparePayload
+        if not isinstance(v, ComparePayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ComparePayload`")
+        else:
+            match += 1
+        # validate data type: ClassifyPayload
+        if not isinstance(v, ClassifyPayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ClassifyPayload`")
+        else:
+            match += 1
+        # validate data type: BoundingBoxPayload
+        if not isinstance(v, BoundingBoxPayload):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `BoundingBoxPayload`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in ValidationSetValidationSetIdRapidPostPayloadParameter with oneOf schemas: BoundingBoxPayload, ClassifyPayload, ComparePayload, FreeTextPayload, LinePayload, LocatePayload, NamedEntityPayload, PolygonPayload, ScrubPayload, TranscriptionPayload. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in ValidationSetValidationSetIdRapidPostPayloadParameter with oneOf schemas: BoundingBoxPayload, ClassifyPayload, ComparePayload, FreeTextPayload, LinePayload, LocatePayload, NamedEntityPayload, PolygonPayload, ScrubPayload, TranscriptionPayload. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into TranscriptionPayload
+        try:
+            instance.actual_instance = TranscriptionPayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ScrubPayload
+        try:
+            instance.actual_instance = ScrubPayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into PolygonPayload
+        try:
+            instance.actual_instance = PolygonPayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into NamedEntityPayload
+        try:
+            instance.actual_instance = NamedEntityPayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into LocatePayload
+        try:
+            instance.actual_instance = LocatePayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into LinePayload
+        try:
+            instance.actual_instance = LinePayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into FreeTextPayload
+        try:
+            instance.actual_instance = FreeTextPayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ComparePayload
+        try:
+            instance.actual_instance = ComparePayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ClassifyPayload
+        try:
+            instance.actual_instance = ClassifyPayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into BoundingBoxPayload
+        try:
+            instance.actual_instance = BoundingBoxPayload.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into ValidationSetValidationSetIdRapidPostPayloadParameter with oneOf schemas: BoundingBoxPayload, ClassifyPayload, ComparePayload, FreeTextPayload, LinePayload, LocatePayload, NamedEntityPayload, PolygonPayload, ScrubPayload, TranscriptionPayload. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into ValidationSetValidationSetIdRapidPostPayloadParameter with oneOf schemas: BoundingBoxPayload, ClassifyPayload, ComparePayload, FreeTextPayload, LinePayload, LocatePayload, NamedEntityPayload, PolygonPayload, ScrubPayload, TranscriptionPayload. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], BoundingBoxPayload, ClassifyPayload, ComparePayload, FreeTextPayload, LinePayload, LocatePayload, NamedEntityPayload, PolygonPayload, ScrubPayload, TranscriptionPayload]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+