rapidata 2.27.0__py3-none-any.whl → 2.44.4__py3-none-any.whl

rapidata/api_client/models/i_validation_truth_transcription_truth.py

@@ -0,0 +1,115 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    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, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from rapidata.api_client.models.transcription_word import TranscriptionWord
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IValidationTruthTranscriptionTruth(BaseModel):
+    """
+    IValidationTruthTranscriptionTruth
+    """ # noqa: E501
+    t: StrictStr = Field(alias="_t")
+    correct_words: List[TranscriptionWord] = Field(alias="correctWords")
+    strict_grading: Optional[StrictBool] = Field(default=None, alias="strictGrading")
+    required_precision: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="requiredPrecision")
+    required_completeness: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="requiredCompleteness")
+    __properties: ClassVar[List[str]] = ["_t", "correctWords", "strictGrading", "requiredPrecision", "requiredCompleteness"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['TranscriptionTruth']):
+            raise ValueError("must be one of enum values ('TranscriptionTruth')")
+        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 IValidationTruthTranscriptionTruth 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 correct_words (list)
+        _items = []
+        if self.correct_words:
+            for _item_correct_words in self.correct_words:
+                if _item_correct_words:
+                    _items.append(_item_correct_words.to_dict())
+            _dict['correctWords'] = _items
+        # set to None if strict_grading (nullable) is None
+        # and model_fields_set contains the field
+        if self.strict_grading is None and "strict_grading" in self.model_fields_set:
+            _dict['strictGrading'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IValidationTruthTranscriptionTruth 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"),
+            "correctWords": [TranscriptionWord.from_dict(_item) for _item in obj["correctWords"]] if obj.get("correctWords") is not None else None,
+            "strictGrading": obj.get("strictGrading"),
+            "requiredPrecision": obj.get("requiredPrecision"),
+            "requiredCompleteness": obj.get("requiredCompleteness")
+        })
+        return _obj
+
+

rapidata/api_client/models/i_workflow_config.py

@@ -0,0 +1,168 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    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.i_workflow_config_compare_workflow_config import IWorkflowConfigCompareWorkflowConfig
+from rapidata.api_client.models.i_workflow_config_evaluation_workflow_config import IWorkflowConfigEvaluationWorkflowConfig
+from rapidata.api_client.models.i_workflow_config_grouped_ranking_workflow_config import IWorkflowConfigGroupedRankingWorkflowConfig
+from rapidata.api_client.models.i_workflow_config_simple_workflow_config import IWorkflowConfigSimpleWorkflowConfig
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+IWORKFLOWCONFIG_ONE_OF_SCHEMAS = ["IWorkflowConfigCompareWorkflowConfig", "IWorkflowConfigEvaluationWorkflowConfig", "IWorkflowConfigGroupedRankingWorkflowConfig", "IWorkflowConfigSimpleWorkflowConfig"]
+
+class IWorkflowConfig(BaseModel):
+    """
+    IWorkflowConfig
+    """
+    # data type: IWorkflowConfigCompareWorkflowConfig
+    oneof_schema_1_validator: Optional[IWorkflowConfigCompareWorkflowConfig] = None
+    # data type: IWorkflowConfigEvaluationWorkflowConfig
+    oneof_schema_2_validator: Optional[IWorkflowConfigEvaluationWorkflowConfig] = None
+    # data type: IWorkflowConfigGroupedRankingWorkflowConfig
+    oneof_schema_3_validator: Optional[IWorkflowConfigGroupedRankingWorkflowConfig] = None
+    # data type: IWorkflowConfigSimpleWorkflowConfig
+    oneof_schema_4_validator: Optional[IWorkflowConfigSimpleWorkflowConfig] = None
+    actual_instance: Optional[Union[IWorkflowConfigCompareWorkflowConfig, IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig]] = None
+    one_of_schemas: Set[str] = { "IWorkflowConfigCompareWorkflowConfig", "IWorkflowConfigEvaluationWorkflowConfig", "IWorkflowConfigGroupedRankingWorkflowConfig", "IWorkflowConfigSimpleWorkflowConfig" }
+
+    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 = IWorkflowConfig.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: IWorkflowConfigCompareWorkflowConfig
+        if not isinstance(v, IWorkflowConfigCompareWorkflowConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowConfigCompareWorkflowConfig`")
+        else:
+            match += 1
+        # validate data type: IWorkflowConfigEvaluationWorkflowConfig
+        if not isinstance(v, IWorkflowConfigEvaluationWorkflowConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowConfigEvaluationWorkflowConfig`")
+        else:
+            match += 1
+        # validate data type: IWorkflowConfigGroupedRankingWorkflowConfig
+        if not isinstance(v, IWorkflowConfigGroupedRankingWorkflowConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowConfigGroupedRankingWorkflowConfig`")
+        else:
+            match += 1
+        # validate data type: IWorkflowConfigSimpleWorkflowConfig
+        if not isinstance(v, IWorkflowConfigSimpleWorkflowConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `IWorkflowConfigSimpleWorkflowConfig`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in IWorkflowConfig with oneOf schemas: IWorkflowConfigCompareWorkflowConfig, IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in IWorkflowConfig with oneOf schemas: IWorkflowConfigCompareWorkflowConfig, IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig. 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 IWorkflowConfigCompareWorkflowConfig
+        try:
+            instance.actual_instance = IWorkflowConfigCompareWorkflowConfig.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into IWorkflowConfigEvaluationWorkflowConfig
+        try:
+            instance.actual_instance = IWorkflowConfigEvaluationWorkflowConfig.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into IWorkflowConfigGroupedRankingWorkflowConfig
+        try:
+            instance.actual_instance = IWorkflowConfigGroupedRankingWorkflowConfig.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into IWorkflowConfigSimpleWorkflowConfig
+        try:
+            instance.actual_instance = IWorkflowConfigSimpleWorkflowConfig.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 IWorkflowConfig with oneOf schemas: IWorkflowConfigCompareWorkflowConfig, IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into IWorkflowConfig with oneOf schemas: IWorkflowConfigCompareWorkflowConfig, IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig. 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], IWorkflowConfigCompareWorkflowConfig, IWorkflowConfigEvaluationWorkflowConfig, IWorkflowConfigGroupedRankingWorkflowConfig, IWorkflowConfigSimpleWorkflowConfig]]:
+        """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())
+
+

rapidata/api_client/models/i_workflow_config_compare_workflow_config.py

@@ -0,0 +1,142 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    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, Optional
+from rapidata.api_client.models.elo_config import EloConfig
+from rapidata.api_client.models.feature_flag import FeatureFlag
+from rapidata.api_client.models.i_asset import IAsset
+from rapidata.api_client.models.i_pair_maker_config import IPairMakerConfig
+from rapidata.api_client.models.i_referee_config import IRefereeConfig
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IWorkflowConfigCompareWorkflowConfig(BaseModel):
+    """
+    IWorkflowConfigCompareWorkflowConfig
+    """ # noqa: E501
+    t: StrictStr = Field(alias="_t")
+    criteria: StrictStr
+    referee: IRefereeConfig
+    context: Optional[StrictStr] = None
+    context_asset: Optional[IAsset] = Field(default=None, alias="contextAsset")
+    elo_config: Optional[EloConfig] = Field(default=None, alias="eloConfig")
+    pair_maker_config: Optional[IPairMakerConfig] = Field(default=None, alias="pairMakerConfig")
+    feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags")
+    __properties: ClassVar[List[str]] = ["_t", "criteria", "referee", "context", "contextAsset", "eloConfig", "pairMakerConfig", "featureFlags"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['CompareWorkflowConfig']):
+            raise ValueError("must be one of enum values ('CompareWorkflowConfig')")
+        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 IWorkflowConfigCompareWorkflowConfig 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 referee
+        if self.referee:
+            _dict['referee'] = self.referee.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of context_asset
+        if self.context_asset:
+            _dict['contextAsset'] = self.context_asset.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of elo_config
+        if self.elo_config:
+            _dict['eloConfig'] = self.elo_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of pair_maker_config
+        if self.pair_maker_config:
+            _dict['pairMakerConfig'] = self.pair_maker_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list)
+        _items = []
+        if self.feature_flags:
+            for _item_feature_flags in self.feature_flags:
+                if _item_feature_flags:
+                    _items.append(_item_feature_flags.to_dict())
+            _dict['featureFlags'] = _items
+        # set to None if context (nullable) is None
+        # and model_fields_set contains the field
+        if self.context is None and "context" in self.model_fields_set:
+            _dict['context'] = None
+
+        # set to None if context_asset (nullable) is None
+        # and model_fields_set contains the field
+        if self.context_asset is None and "context_asset" in self.model_fields_set:
+            _dict['contextAsset'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IWorkflowConfigCompareWorkflowConfig 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"),
+            "criteria": obj.get("criteria"),
+            "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None,
+            "context": obj.get("context"),
+            "contextAsset": IAsset.from_dict(obj["contextAsset"]) if obj.get("contextAsset") is not None else None,
+            "eloConfig": EloConfig.from_dict(obj["eloConfig"]) if obj.get("eloConfig") is not None else None,
+            "pairMakerConfig": IPairMakerConfig.from_dict(obj["pairMakerConfig"]) if obj.get("pairMakerConfig") is not None else None,
+            "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None
+        })
+        return _obj
+
+

rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    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, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.feature_flag import FeatureFlag
+from rapidata.api_client.models.i_referee_config import IRefereeConfig
+from typing import Optional, Set
+from typing_extensions import Self
+
+class IWorkflowConfigEvaluationWorkflowConfig(BaseModel):
+    """
+    IWorkflowConfigEvaluationWorkflowConfig
+    """ # noqa: E501
+    t: StrictStr = Field(alias="_t")
+    validation_set_id: StrictStr = Field(alias="validationSetId")
+    referee: IRefereeConfig
+    should_accept_incorrect: StrictBool = Field(alias="shouldAcceptIncorrect")
+    feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags")
+    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "referee", "shouldAcceptIncorrect", "featureFlags"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['EvaluationWorkflowConfig']):
+            raise ValueError("must be one of enum values ('EvaluationWorkflowConfig')")
+        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 IWorkflowConfigEvaluationWorkflowConfig 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 referee
+        if self.referee:
+            _dict['referee'] = self.referee.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list)
+        _items = []
+        if self.feature_flags:
+            for _item_feature_flags in self.feature_flags:
+                if _item_feature_flags:
+                    _items.append(_item_feature_flags.to_dict())
+            _dict['featureFlags'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of IWorkflowConfigEvaluationWorkflowConfig 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"),
+            "validationSetId": obj.get("validationSetId"),
+            "referee": IRefereeConfig.from_dict(obj["referee"]) if obj.get("referee") is not None else None,
+            "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect"),
+            "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None
+        })
+        return _obj
+
+