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

rapidata/api_client/models/rapid_issue.py

@@ -0,0 +1,45 @@
+# 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
+from enum import Enum
+from typing_extensions import Self
+
+
+class RapidIssue(str, Enum):
+    """
+    RapidIssue
+    """
+
+    """
+    allowed enum values
+    """
+    OTHER = 'Other'
+    CANNOTSUBMIT = 'CannotSubmit'
+    NOASSET = 'NoAsset'
+    INAPPROPRIATE = 'Inappropriate'
+    NOCORRECTOPTION = 'NoCorrectOption'
+    WRONGLANGUAGE = 'WrongLanguage'
+    DONOTUNDERSTAND = 'DoNotUnderstand'
+    DONOTCARE = 'DoNotCare'
+    NOTSEEOPTIONSORMEDIADIDNTLOAD = 'NotSeeOptionsOrMediaDidntLoad'
+    MYANSWERISCORRECT = 'MyAnswerIsCorrect'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RapidIssue from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/rapid_modality.py

@@ -0,0 +1,46 @@
+# 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 RapidModality(str, Enum):
+    """
+    RapidModality
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'None'
+    BOUNDINGBOX = 'BoundingBox'
+    CLASSIFY = 'Classify'
+    COMPARE = 'Compare'
+    FREETEXT = 'FreeText'
+    LINE = 'Line'
+    LOCATE = 'Locate'
+    NAMEDENTITY = 'NamedEntity'
+    POLYGON = 'Polygon'
+    SCRUB = 'Scrub'
+    TRANSCRIPTION = 'Transcription'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RapidModality from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/rapid_model.py

@@ -0,0 +1,157 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from rapidata.api_client.models.feature_flag import FeatureFlag
+from rapidata.api_client.models.i_asset_model import IAssetModel
+from rapidata.api_client.models.i_rapid_payload import IRapidPayload
+from rapidata.api_client.models.i_referee_info import IRefereeInfo
+from rapidata.api_client.models.i_validation_truth import IValidationTruth
+from rapidata.api_client.models.rapid_state import RapidState
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RapidModel(BaseModel):
+    """
+    RapidModel
+    """ # noqa: E501
+    id: StrictStr
+    payload: IRapidPayload
+    referee: IRefereeInfo
+    asset: IAssetModel
+    state: RapidState
+    has_responses: StrictBool = Field(alias="hasResponses")
+    should_accept_incorrect: StrictBool = Field(alias="shouldAcceptIncorrect")
+    truth: Optional[IValidationTruth]
+    explanation: Optional[StrictStr]
+    random_correct_probability: Union[StrictFloat, StrictInt] = Field(alias="randomCorrectProbability")
+    key: Optional[StrictStr]
+    completed_at: Optional[datetime] = Field(alias="completedAt")
+    feature_flags: List[FeatureFlag] = Field(alias="featureFlags")
+    __properties: ClassVar[List[str]] = ["id", "payload", "referee", "asset", "state", "hasResponses", "shouldAcceptIncorrect", "truth", "explanation", "randomCorrectProbability", "key", "completedAt", "featureFlags"]
+
+    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 RapidModel 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 payload
+        if self.payload:
+            _dict['payload'] = self.payload.to_dict()
+        # 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 asset
+        if self.asset:
+            _dict['asset'] = self.asset.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of truth
+        if self.truth:
+            _dict['truth'] = self.truth.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 truth (nullable) is None
+        # and model_fields_set contains the field
+        if self.truth is None and "truth" in self.model_fields_set:
+            _dict['truth'] = None
+
+        # set to None if explanation (nullable) is None
+        # and model_fields_set contains the field
+        if self.explanation is None and "explanation" in self.model_fields_set:
+            _dict['explanation'] = None
+
+        # set to None if key (nullable) is None
+        # and model_fields_set contains the field
+        if self.key is None and "key" in self.model_fields_set:
+            _dict['key'] = None
+
+        # set to None if completed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.completed_at is None and "completed_at" in self.model_fields_set:
+            _dict['completedAt'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RapidModel 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"),
+            "payload": IRapidPayload.from_dict(obj["payload"]) if obj.get("payload") is not None else None,
+            "referee": IRefereeInfo.from_dict(obj["referee"]) if obj.get("referee") is not None else None,
+            "asset": IAssetModel.from_dict(obj["asset"]) if obj.get("asset") is not None else None,
+            "state": obj.get("state"),
+            "hasResponses": obj.get("hasResponses"),
+            "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect"),
+            "truth": IValidationTruth.from_dict(obj["truth"]) if obj.get("truth") is not None else None,
+            "explanation": obj.get("explanation"),
+            "randomCorrectProbability": obj.get("randomCorrectProbability"),
+            "key": obj.get("key"),
+            "completedAt": obj.get("completedAt"),
+            "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/rapid_model_paged_result.py

@@ -0,0 +1,105 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.rapid_model import RapidModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RapidModelPagedResult(BaseModel):
+    """
+    RapidModelPagedResult
+    """ # noqa: E501
+    total: StrictInt
+    page: StrictInt
+    page_size: StrictInt = Field(alias="pageSize")
+    items: List[RapidModel]
+    total_pages: Optional[StrictInt] = Field(default=None, alias="totalPages")
+    __properties: ClassVar[List[str]] = ["total", "page", "pageSize", "items", "totalPages"]
+
+    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 RapidModelPagedResult 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([
+            "total_pages",
+        ])
+
+        _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 items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RapidModelPagedResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total": obj.get("total"),
+            "page": obj.get("page"),
+            "pageSize": obj.get("pageSize"),
+            "items": [RapidModel.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
+            "totalPages": obj.get("totalPages")
+        })
+        return _obj
+
+

rapidata/api_client/models/rapid_model_referee.py

@@ -0,0 +1,154 @@
+# 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.naive_referee_info import NaiveRefereeInfo
+from rapidata.api_client.models.never_ending_referee_info import NeverEndingRefereeInfo
+from rapidata.api_client.models.probabilistic_attach_category_referee_info import ProbabilisticAttachCategoryRefereeInfo
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+RAPIDMODELREFEREE_ONE_OF_SCHEMAS = ["NaiveRefereeInfo", "NeverEndingRefereeInfo", "ProbabilisticAttachCategoryRefereeInfo"]
+
+class RapidModelReferee(BaseModel):
+    """
+    RapidModelReferee
+    """
+    # data type: ProbabilisticAttachCategoryRefereeInfo
+    oneof_schema_1_validator: Optional[ProbabilisticAttachCategoryRefereeInfo] = None
+    # data type: NeverEndingRefereeInfo
+    oneof_schema_2_validator: Optional[NeverEndingRefereeInfo] = None
+    # data type: NaiveRefereeInfo
+    oneof_schema_3_validator: Optional[NaiveRefereeInfo] = None
+    actual_instance: Optional[Union[NaiveRefereeInfo, NeverEndingRefereeInfo, ProbabilisticAttachCategoryRefereeInfo]] = None
+    one_of_schemas: Set[str] = { "NaiveRefereeInfo", "NeverEndingRefereeInfo", "ProbabilisticAttachCategoryRefereeInfo" }
+
+    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 = RapidModelReferee.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: ProbabilisticAttachCategoryRefereeInfo
+        if not isinstance(v, ProbabilisticAttachCategoryRefereeInfo):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ProbabilisticAttachCategoryRefereeInfo`")
+        else:
+            match += 1
+        # validate data type: NeverEndingRefereeInfo
+        if not isinstance(v, NeverEndingRefereeInfo):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NeverEndingRefereeInfo`")
+        else:
+            match += 1
+        # validate data type: NaiveRefereeInfo
+        if not isinstance(v, NaiveRefereeInfo):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NaiveRefereeInfo`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in RapidModelReferee with oneOf schemas: NaiveRefereeInfo, NeverEndingRefereeInfo, ProbabilisticAttachCategoryRefereeInfo. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in RapidModelReferee with oneOf schemas: NaiveRefereeInfo, NeverEndingRefereeInfo, ProbabilisticAttachCategoryRefereeInfo. 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 ProbabilisticAttachCategoryRefereeInfo
+        try:
+            instance.actual_instance = ProbabilisticAttachCategoryRefereeInfo.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into NeverEndingRefereeInfo
+        try:
+            instance.actual_instance = NeverEndingRefereeInfo.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into NaiveRefereeInfo
+        try:
+            instance.actual_instance = NaiveRefereeInfo.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 RapidModelReferee with oneOf schemas: NaiveRefereeInfo, NeverEndingRefereeInfo, ProbabilisticAttachCategoryRefereeInfo. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into RapidModelReferee with oneOf schemas: NaiveRefereeInfo, NeverEndingRefereeInfo, ProbabilisticAttachCategoryRefereeInfo. 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], NaiveRefereeInfo, NeverEndingRefereeInfo, ProbabilisticAttachCategoryRefereeInfo]]:
+        """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/rapid_response.py

@@ -0,0 +1,103 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Union
+from rapidata.api_client.models.rapid_response_result import RapidResponseResult
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RapidResponse(BaseModel):
+    """
+    RapidResponse
+    """ # noqa: E501
+    id: StrictStr
+    user_id: StrictStr = Field(alias="userId")
+    country: StrictStr
+    result: RapidResponseResult
+    user_score: Union[StrictFloat, StrictInt] = Field(alias="userScore")
+    user_scores: Dict[str, Union[StrictFloat, StrictInt]] = Field(alias="userScores")
+    demographic_information: Dict[str, StrictStr] = Field(alias="demographicInformation")
+    __properties: ClassVar[List[str]] = ["id", "userId", "country", "result", "userScore", "userScores", "demographicInformation"]
+
+    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 RapidResponse 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 result
+        if self.result:
+            _dict['result'] = self.result.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RapidResponse 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"),
+            "userId": obj.get("userId"),
+            "country": obj.get("country"),
+            "result": RapidResponseResult.from_dict(obj["result"]) if obj.get("result") is not None else None,
+            "userScore": obj.get("userScore"),
+            "userScores": obj.get("userScores"),
+            "demographicInformation": obj.get("demographicInformation")
+        })
+        return _obj
+
+