rapidata 0.1.18__py3-none-any.whl → 0.1.20__py3-none-any.whl

rapidata/api_client/api/validation_api.py

@@ -20,6 +20,7 @@ from pydantic import Field, StrictBytes, StrictStr
 from typing import List, Optional, Tuple, Union
 from typing_extensions import Annotated
 from rapidata.api_client.models.add_validation_rapid_model import AddValidationRapidModel
+from rapidata.api_client.models.add_validation_rapid_result import AddValidationRapidResult
 from rapidata.api_client.models.create_empty_validation_set_result import CreateEmptyValidationSetResult
 from rapidata.api_client.models.get_available_validation_sets_result import GetAvailableValidationSetsResult
 from rapidata.api_client.models.import_validation_set_from_file_result import ImportValidationSetFromFileResult
@@ -62,7 +63,7 @@ class ValidationApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> None:
+    ) -> AddValidationRapidResult:
         """Adds a new validation rapid to the specified validation set.
 
 
@@ -102,7 +103,7 @@ class ValidationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "AddValidationRapidResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -132,7 +133,7 @@ class ValidationApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[None]:
+    ) -> ApiResponse[AddValidationRapidResult]:
         """Adds a new validation rapid to the specified validation set.
 
 
@@ -172,7 +173,7 @@ class ValidationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "AddValidationRapidResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -242,7 +243,7 @@ class ValidationApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "AddValidationRapidResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -287,6 +288,15 @@ class ValidationApi:
         # process the body parameter
 
 
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'text/plain', 
+                    'application/json', 
+                    'text/json'
+                ]
+            )
 
         # set the HTTP header `Content-Type`
         if _content_type:

rapidata/api_client/models/__init__.py

@@ -17,16 +17,19 @@
 from rapidata.api_client.models.add_validation_rapid_model import AddValidationRapidModel
 from rapidata.api_client.models.add_validation_rapid_model_payload import AddValidationRapidModelPayload
 from rapidata.api_client.models.add_validation_rapid_model_truth import AddValidationRapidModelTruth
+from rapidata.api_client.models.add_validation_rapid_result import AddValidationRapidResult
 from rapidata.api_client.models.admin_order_model import AdminOrderModel
 from rapidata.api_client.models.admin_order_model_paged_result import AdminOrderModelPagedResult
 from rapidata.api_client.models.age_group import AgeGroup
 from rapidata.api_client.models.age_user_filter_model import AgeUserFilterModel
 from rapidata.api_client.models.aggregator_type import AggregatorType
 from rapidata.api_client.models.attach_category_rapid_blueprint import AttachCategoryRapidBlueprint
+from rapidata.api_client.models.attach_category_result import AttachCategoryResult
 from rapidata.api_client.models.attach_category_truth import AttachCategoryTruth
 from rapidata.api_client.models.base_error import BaseError
 from rapidata.api_client.models.bounding_box_payload import BoundingBoxPayload
 from rapidata.api_client.models.bounding_box_rapid_blueprint import BoundingBoxRapidBlueprint
+from rapidata.api_client.models.bounding_box_result import BoundingBoxResult
 from rapidata.api_client.models.bounding_box_truth import BoundingBoxTruth
 from rapidata.api_client.models.box_shape import BoxShape
 from rapidata.api_client.models.classification_metadata import ClassificationMetadata
@@ -37,12 +40,14 @@ from rapidata.api_client.models.clone_order_model import CloneOrderModel
 from rapidata.api_client.models.clone_order_result import CloneOrderResult
 from rapidata.api_client.models.compare_payload import ComparePayload
 from rapidata.api_client.models.compare_rapid_blueprint import CompareRapidBlueprint
+from rapidata.api_client.models.compare_result import CompareResult
 from rapidata.api_client.models.compare_truth import CompareTruth
 from rapidata.api_client.models.compare_workflow_config import CompareWorkflowConfig
 from rapidata.api_client.models.compare_workflow_config_rapid_selection_configs_inner import CompareWorkflowConfigRapidSelectionConfigsInner
 from rapidata.api_client.models.compare_workflow_config_referee import CompareWorkflowConfigReferee
 from rapidata.api_client.models.compare_workflow_model import CompareWorkflowModel
 from rapidata.api_client.models.conditional_validation_rapid_selection_config import ConditionalValidationRapidSelectionConfig
+from rapidata.api_client.models.coordinate import Coordinate
 from rapidata.api_client.models.correlated_rapid_selection_config import CorrelatedRapidSelectionConfig
 from rapidata.api_client.models.count_classification_metadata_filter_config import CountClassificationMetadataFilterConfig
 from rapidata.api_client.models.count_metadata import CountMetadata
@@ -55,6 +60,7 @@ from rapidata.api_client.models.create_dataset_artifact_model import CreateDatas
 from rapidata.api_client.models.create_dataset_artifact_model_dataset import CreateDatasetArtifactModelDataset
 from rapidata.api_client.models.create_default_order_model import CreateDefaultOrderModel
 from rapidata.api_client.models.create_default_order_model_workflow_config import CreateDefaultOrderModelWorkflowConfig
+from rapidata.api_client.models.create_demographic_rapid_model import CreateDemographicRapidModel
 from rapidata.api_client.models.create_empty_validation_set_result import CreateEmptyValidationSetResult
 from rapidata.api_client.models.create_legacy_order_result import CreateLegacyOrderResult
 from rapidata.api_client.models.create_order_model import CreateOrderModel
@@ -79,6 +85,7 @@ from rapidata.api_client.models.datapoint_model_asset import DatapointModelAsset
 from rapidata.api_client.models.dataset_evaluation_step_model import DatasetEvaluationStepModel
 from rapidata.api_client.models.demographic_rapid_selection_config import DemographicRapidSelectionConfig
 from rapidata.api_client.models.demographic_selection import DemographicSelection
+from rapidata.api_client.models.early_stopping_referee_model import EarlyStoppingRefereeModel
 from rapidata.api_client.models.empty_validation_truth import EmptyValidationTruth
 from rapidata.api_client.models.error_type import ErrorType
 from rapidata.api_client.models.feature_flag import FeatureFlag
@@ -91,6 +98,7 @@ from rapidata.api_client.models.filter import Filter
 from rapidata.api_client.models.filter_operator import FilterOperator
 from rapidata.api_client.models.free_text_payload import FreeTextPayload
 from rapidata.api_client.models.free_text_rapid_blueprint import FreeTextRapidBlueprint
+from rapidata.api_client.models.free_text_result import FreeTextResult
 from rapidata.api_client.models.gender import Gender
 from rapidata.api_client.models.gender_user_filter_model import GenderUserFilterModel
 from rapidata.api_client.models.get_available_validation_sets_result import GetAvailableValidationSetsResult
@@ -107,12 +115,17 @@ from rapidata.api_client.models.import_validation_set_from_file_result import Im
 from rapidata.api_client.models.issue_auth_token_result import IssueAuthTokenResult
 from rapidata.api_client.models.issue_client_auth_token_result import IssueClientAuthTokenResult
 from rapidata.api_client.models.labeling_selection import LabelingSelection
+from rapidata.api_client.models.line import Line
 from rapidata.api_client.models.line_payload import LinePayload
+from rapidata.api_client.models.line_point import LinePoint
 from rapidata.api_client.models.line_rapid_blueprint import LineRapidBlueprint
+from rapidata.api_client.models.line_result import LineResult
 from rapidata.api_client.models.line_truth import LineTruth
 from rapidata.api_client.models.locate_box_truth import LocateBoxTruth
+from rapidata.api_client.models.locate_coordinate import LocateCoordinate
 from rapidata.api_client.models.locate_payload import LocatePayload
 from rapidata.api_client.models.locate_rapid_blueprint import LocateRapidBlueprint
+from rapidata.api_client.models.locate_result import LocateResult
 from rapidata.api_client.models.location_metadata import LocationMetadata
 from rapidata.api_client.models.location_metadata_exists_filter_config import LocationMetadataExistsFilterConfig
 from rapidata.api_client.models.logic_operator import LogicOperator
@@ -125,6 +138,7 @@ from rapidata.api_client.models.naive_referee_model import NaiveRefereeModel
 from rapidata.api_client.models.named_classification import NamedClassification
 from rapidata.api_client.models.named_entity_payload import NamedEntityPayload
 from rapidata.api_client.models.named_entity_rapid_blueprint import NamedEntityRapidBlueprint
+from rapidata.api_client.models.named_entity_result import NamedEntityResult
 from rapidata.api_client.models.named_entity_truth import NamedEntityTruth
 from rapidata.api_client.models.never_ending_referee_config import NeverEndingRefereeConfig
 from rapidata.api_client.models.newsletter_model import NewsletterModel
@@ -138,23 +152,33 @@ from rapidata.api_client.models.original_filename_metadata import OriginalFilena
 from rapidata.api_client.models.page_info import PageInfo
 from rapidata.api_client.models.polygon_payload import PolygonPayload
 from rapidata.api_client.models.polygon_rapid_blueprint import PolygonRapidBlueprint
+from rapidata.api_client.models.polygon_result import PolygonResult
 from rapidata.api_client.models.polygon_truth import PolygonTruth
 from rapidata.api_client.models.private_text_metadata_input import PrivateTextMetadataInput
 from rapidata.api_client.models.probabilistic_attach_category_referee_config import ProbabilisticAttachCategoryRefereeConfig
 from rapidata.api_client.models.prompt_metadata import PromptMetadata
 from rapidata.api_client.models.prompt_metadata_input import PromptMetadataInput
 from rapidata.api_client.models.public_text_metadata_input import PublicTextMetadataInput
+from rapidata.api_client.models.query_model import QueryModel
 from rapidata.api_client.models.query_orders_model import QueryOrdersModel
+from rapidata.api_client.models.query_validation_rapids_result import QueryValidationRapidsResult
+from rapidata.api_client.models.query_validation_rapids_result_asset import QueryValidationRapidsResultAsset
+from rapidata.api_client.models.query_validation_rapids_result_paged_result import QueryValidationRapidsResultPagedResult
 from rapidata.api_client.models.query_validation_set_model import QueryValidationSetModel
+from rapidata.api_client.models.rapid_result_model import RapidResultModel
+from rapidata.api_client.models.rapid_result_model_result import RapidResultModelResult
+from rapidata.api_client.models.rapid_skipped_model import RapidSkippedModel
 from rapidata.api_client.models.request_password_reset_command import RequestPasswordResetCommand
 from rapidata.api_client.models.root_filter import RootFilter
 from rapidata.api_client.models.send_completion_mail_step_model import SendCompletionMailStepModel
+from rapidata.api_client.models.shape import Shape
 from rapidata.api_client.models.signup_customer_model import SignupCustomerModel
 from rapidata.api_client.models.signup_shadow_customer_model import SignupShadowCustomerModel
 from rapidata.api_client.models.simple_workflow_config import SimpleWorkflowConfig
 from rapidata.api_client.models.simple_workflow_config_blueprint import SimpleWorkflowConfigBlueprint
 from rapidata.api_client.models.simple_workflow_model import SimpleWorkflowModel
 from rapidata.api_client.models.simple_workflow_model_blueprint import SimpleWorkflowModelBlueprint
+from rapidata.api_client.models.skip_result import SkipResult
 from rapidata.api_client.models.sort_criterion import SortCriterion
 from rapidata.api_client.models.sort_direction import SortDirection
 from rapidata.api_client.models.static_rapid_selection_config import StaticRapidSelectionConfig
@@ -168,6 +192,7 @@ from rapidata.api_client.models.transcription_metadata import TranscriptionMetad
 from rapidata.api_client.models.transcription_metadata_input import TranscriptionMetadataInput
 from rapidata.api_client.models.transcription_payload import TranscriptionPayload
 from rapidata.api_client.models.transcription_rapid_blueprint import TranscriptionRapidBlueprint
+from rapidata.api_client.models.transcription_result import TranscriptionResult
 from rapidata.api_client.models.transcription_truth import TranscriptionTruth
 from rapidata.api_client.models.transcription_word import TranscriptionWord
 from rapidata.api_client.models.unlock_order_result import UnlockOrderResult

rapidata/api_client/models/add_validation_rapid_result.py

@@ -0,0 +1,87 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AddValidationRapidResult(BaseModel):
+    """
+    AddValidationRapidResult
+    """ # noqa: E501
+    rapid_id: StrictStr = Field(alias="rapidId")
+    __properties: ClassVar[List[str]] = ["rapidId"]
+
+    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 AddValidationRapidResult 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 AddValidationRapidResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "rapidId": obj.get("rapidId")
+        })
+        return _obj
+
+

rapidata/api_client/models/attach_category_result.py

@@ -0,0 +1,98 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AttachCategoryResult(BaseModel):
+    """
+    AttachCategoryResult
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for AttachCategoryResult", alias="_t")
+    category: StrictStr
+    rapid_id: StrictStr = Field(alias="rapidId")
+    __properties: ClassVar[List[str]] = ["_t", "category", "rapidId"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['AttachCategoryResult']):
+            raise ValueError("must be one of enum values ('AttachCategoryResult')")
+        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 AttachCategoryResult 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 AttachCategoryResult 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 'AttachCategoryResult',
+            "category": obj.get("category"),
+            "rapidId": obj.get("rapidId")
+        })
+        return _obj
+
+

rapidata/api_client/models/bounding_box_result.py

@@ -0,0 +1,106 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from rapidata.api_client.models.box_shape import BoxShape
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BoundingBoxResult(BaseModel):
+    """
+    BoundingBoxResult
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for BoundingBoxResult", alias="_t")
+    bounding_boxes: List[BoxShape] = Field(alias="boundingBoxes")
+    rapid_id: StrictStr = Field(alias="rapidId")
+    __properties: ClassVar[List[str]] = ["_t", "boundingBoxes", "rapidId"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['BoundingBoxResult']):
+            raise ValueError("must be one of enum values ('BoundingBoxResult')")
+        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 BoundingBoxResult 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in bounding_boxes (list)
+        _items = []
+        if self.bounding_boxes:
+            for _item_bounding_boxes in self.bounding_boxes:
+                if _item_bounding_boxes:
+                    _items.append(_item_bounding_boxes.to_dict())
+            _dict['boundingBoxes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BoundingBoxResult 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 'BoundingBoxResult',
+            "boundingBoxes": [BoxShape.from_dict(_item) for _item in obj["boundingBoxes"]] if obj.get("boundingBoxes") is not None else None,
+            "rapidId": obj.get("rapidId")
+        })
+        return _obj
+
+

rapidata/api_client/models/classification_metadata.py

@@ -39,16 +39,6 @@ class ClassificationMetadata(BaseModel):
             raise ValueError("must be one of enum values ('ClassificationMetadata')")
         return value
 
-    @field_validator('visibilities')
-    def visibilities_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['None', 'Users', 'Customers', 'Admins', 'All']):
-            raise ValueError("must be one of enum values ('None', 'Users', 'Customers', 'Admins', 'All')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/compare_result.py

@@ -0,0 +1,98 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CompareResult(BaseModel):
+    """
+    CompareResult
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for CompareResult", alias="_t")
+    winner_id: StrictStr = Field(alias="winnerId")
+    rapid_id: StrictStr = Field(alias="rapidId")
+    __properties: ClassVar[List[str]] = ["_t", "winnerId", "rapidId"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['CompareResult']):
+            raise ValueError("must be one of enum values ('CompareResult')")
+        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 CompareResult 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 CompareResult 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 'CompareResult',
+            "winnerId": obj.get("winnerId"),
+            "rapidId": obj.get("rapidId")
+        })
+        return _obj
+
+