rapidata 2.5.0__py3-none-any.whl → 2.6.0__py3-none-any.whl

rapidata/api_client/models/ab_test_selection_a_inner.py

@@ -0,0 +1,212 @@
+# 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.conditional_validation_selection import ConditionalValidationSelection
+from rapidata.api_client.models.demographic_selection import DemographicSelection
+from rapidata.api_client.models.labeling_selection import LabelingSelection
+from rapidata.api_client.models.static_selection import StaticSelection
+from rapidata.api_client.models.validation_selection import ValidationSelection
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+ABTESTSELECTIONAINNER_ONE_OF_SCHEMAS = ["AbTestSelection", "CappedSelection", "ConditionalValidationSelection", "DemographicSelection", "LabelingSelection", "StaticSelection", "ValidationSelection"]
+
+class AbTestSelectionAInner(BaseModel):
+    """
+    AbTestSelectionAInner
+    """
+    # data type: AbTestSelection
+    oneof_schema_1_validator: Optional[AbTestSelection] = None
+    # data type: CappedSelection
+    oneof_schema_2_validator: Optional[CappedSelection] = None
+    # data type: ConditionalValidationSelection
+    oneof_schema_3_validator: Optional[ConditionalValidationSelection] = None
+    # data type: DemographicSelection
+    oneof_schema_4_validator: Optional[DemographicSelection] = None
+    # data type: LabelingSelection
+    oneof_schema_5_validator: Optional[LabelingSelection] = None
+    # data type: StaticSelection
+    oneof_schema_6_validator: Optional[StaticSelection] = None
+    # data type: ValidationSelection
+    oneof_schema_7_validator: Optional[ValidationSelection] = None
+    actual_instance: Optional[Union[AbTestSelection, CappedSelection, ConditionalValidationSelection, DemographicSelection, LabelingSelection, StaticSelection, ValidationSelection]] = None
+    one_of_schemas: Set[str] = { "AbTestSelection", "CappedSelection", "ConditionalValidationSelection", "DemographicSelection", "LabelingSelection", "StaticSelection", "ValidationSelection" }
+
+    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 = AbTestSelectionAInner.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: AbTestSelection
+        if not isinstance(v, AbTestSelection):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `AbTestSelection`")
+        else:
+            match += 1
+        # validate data type: CappedSelection
+        if not isinstance(v, CappedSelection):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CappedSelection`")
+        else:
+            match += 1
+        # validate data type: ConditionalValidationSelection
+        if not isinstance(v, ConditionalValidationSelection):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ConditionalValidationSelection`")
+        else:
+            match += 1
+        # validate data type: DemographicSelection
+        if not isinstance(v, DemographicSelection):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `DemographicSelection`")
+        else:
+            match += 1
+        # validate data type: LabelingSelection
+        if not isinstance(v, LabelingSelection):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `LabelingSelection`")
+        else:
+            match += 1
+        # validate data type: StaticSelection
+        if not isinstance(v, StaticSelection):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `StaticSelection`")
+        else:
+            match += 1
+        # validate data type: ValidationSelection
+        if not isinstance(v, ValidationSelection):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ValidationSelection`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in AbTestSelectionAInner with oneOf schemas: AbTestSelection, CappedSelection, ConditionalValidationSelection, DemographicSelection, LabelingSelection, StaticSelection, ValidationSelection. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in AbTestSelectionAInner with oneOf schemas: AbTestSelection, CappedSelection, ConditionalValidationSelection, DemographicSelection, LabelingSelection, StaticSelection, ValidationSelection. 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 AbTestSelection
+        try:
+            instance.actual_instance = AbTestSelection.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CappedSelection
+        try:
+            instance.actual_instance = CappedSelection.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ConditionalValidationSelection
+        try:
+            instance.actual_instance = ConditionalValidationSelection.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into DemographicSelection
+        try:
+            instance.actual_instance = DemographicSelection.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into LabelingSelection
+        try:
+            instance.actual_instance = LabelingSelection.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into StaticSelection
+        try:
+            instance.actual_instance = StaticSelection.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ValidationSelection
+        try:
+            instance.actual_instance = ValidationSelection.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 AbTestSelectionAInner with oneOf schemas: AbTestSelection, CappedSelection, ConditionalValidationSelection, DemographicSelection, LabelingSelection, StaticSelection, ValidationSelection. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into AbTestSelectionAInner with oneOf schemas: AbTestSelection, CappedSelection, ConditionalValidationSelection, DemographicSelection, LabelingSelection, StaticSelection, ValidationSelection. 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], AbTestSelection, CappedSelection, ConditionalValidationSelection, DemographicSelection, LabelingSelection, StaticSelection, ValidationSelection]]:
+        """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())
+
+from rapidata.api_client.models.ab_test_selection import AbTestSelection
+from rapidata.api_client.models.capped_selection import CappedSelection
+# TODO: Rewrite to not use raise_errors
+AbTestSelectionAInner.model_rebuild(raise_errors=False)
+

rapidata/api_client/models/add_campaign_model.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from rapidata.api_client.models.capped_selection_selections_inner import CappedSelectionSelectionsInner
+from rapidata.api_client.models.ab_test_selection_a_inner import AbTestSelectionAInner
 from rapidata.api_client.models.create_order_model_user_filters_inner import CreateOrderModelUserFiltersInner
 from rapidata.api_client.models.feature_flag import FeatureFlag
 from typing import Optional, Set
@@ -34,7 +34,7 @@ class AddCampaignModel(BaseModel):
     campaign_name: StrictStr = Field(description="The name of the campaign.", alias="campaignName")
     user_filters: List[CreateOrderModelUserFiltersInner] = Field(description="The user filters to apply to the campaign.", alias="userFilters")
     validation_set_id: Optional[StrictStr] = Field(default=None, description="A validation set that should be used.", alias="validationSetId")
-    selections: Optional[List[CappedSelectionSelectionsInner]] = Field(description="The selections that the campaign should have.")
+    selections: Optional[List[AbTestSelectionAInner]] = Field(description="The selections that the campaign should have.")
     feature_flags: List[FeatureFlag] = Field(description="The feature flags that should be applied to the campaign.", alias="featureFlags")
     priority: StrictInt = Field(description="The priority of the campaign.")
     is_sticky: Optional[StrictBool] = Field(default=None, description="Indicates if the campaign is sticky.", alias="isSticky")
@@ -139,7 +139,7 @@ class AddCampaignModel(BaseModel):
             "campaignName": obj.get("campaignName"),
             "userFilters": [CreateOrderModelUserFiltersInner.from_dict(_item) for _item in obj["userFilters"]] if obj.get("userFilters") is not None else None,
             "validationSetId": obj.get("validationSetId"),
-            "selections": [CappedSelectionSelectionsInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None,
+            "selections": [AbTestSelectionAInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None,
             "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None,
             "priority": obj.get("priority"),
             "isSticky": obj.get("isSticky")

rapidata/api_client/models/capped_selection.py

@@ -27,7 +27,7 @@ class CappedSelection(BaseModel):
     CappedSelection
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for CappedSelection", alias="_t")
-    selections: List[CappedSelectionSelectionsInner]
+    selections: List[AbTestSelectionAInner]
     max_rapids: StrictInt = Field(alias="maxRapids")
     __properties: ClassVar[List[str]] = ["_t", "selections", "maxRapids"]
 
@@ -97,12 +97,12 @@ class CappedSelection(BaseModel):
 
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'CappedSelection',
-            "selections": [CappedSelectionSelectionsInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None,
+            "selections": [AbTestSelectionAInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None,
             "maxRapids": obj.get("maxRapids")
         })
         return _obj
 
-from rapidata.api_client.models.capped_selection_selections_inner import CappedSelectionSelectionsInner
+from rapidata.api_client.models.ab_test_selection_a_inner import AbTestSelectionAInner
 # TODO: Rewrite to not use raise_errors
 CappedSelection.model_rebuild(raise_errors=False)
 

rapidata/api_client/models/compare_match_status.py

@@ -0,0 +1,39 @@
+# 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 CompareMatchStatus(str, Enum):
+    """
+    CompareMatchStatus
+    """
+
+    """
+    allowed enum values
+    """
+    IDLE = 'Idle'
+    QUEUED = 'Queued'
+    PROCESSING = 'Processing'
+    COMPLETED = 'Completed'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CompareMatchStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/create_order_model.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from rapidata.api_client.models.capped_selection_selections_inner import CappedSelectionSelectionsInner
+from rapidata.api_client.models.ab_test_selection_a_inner import AbTestSelectionAInner
 from rapidata.api_client.models.create_order_model_referee import CreateOrderModelReferee
 from rapidata.api_client.models.create_order_model_user_filters_inner import CreateOrderModelUserFiltersInner
 from rapidata.api_client.models.create_order_model_workflow import CreateOrderModelWorkflow
@@ -41,7 +41,7 @@ class CreateOrderModel(BaseModel):
     is_sticky: Optional[StrictBool] = Field(default=None, description="Indicates if the underlying campaign should be sticky.", alias="isSticky")
     user_filters: List[CreateOrderModelUserFiltersInner] = Field(description="The user filters are used to restrict the order to only collect votes from a specific demographic.", alias="userFilters")
     validation_set_id: Optional[StrictStr] = Field(default=None, description="The validation set id can be changed to point to a specific validation set. if not provided a sane default will be  used.", alias="validationSetId")
-    selections: Optional[List[CappedSelectionSelectionsInner]] = Field(default=None, description="The selections are used to determine which tasks are shown to a user.")
+    selections: Optional[List[AbTestSelectionAInner]] = Field(default=None, description="The selections are used to determine which tasks are shown to a user.")
     __properties: ClassVar[List[str]] = ["_t", "orderName", "workflow", "referee", "aggregator", "featureFlags", "priority", "isSticky", "userFilters", "validationSetId", "selections"]
 
     @field_validator('t')
@@ -174,7 +174,7 @@ class CreateOrderModel(BaseModel):
             "isSticky": obj.get("isSticky"),
             "userFilters": [CreateOrderModelUserFiltersInner.from_dict(_item) for _item in obj["userFilters"]] if obj.get("userFilters") is not None else None,
             "validationSetId": obj.get("validationSetId"),
-            "selections": [CappedSelectionSelectionsInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None
+            "selections": [AbTestSelectionAInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None
         })
         return _obj
 

rapidata/api_client/models/get_compare_workflow_results_model.py

@@ -0,0 +1,114 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.compare_match_status import CompareMatchStatus
+from rapidata.api_client.models.page_info import PageInfo
+from rapidata.api_client.models.sort_criterion import SortCriterion
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetCompareWorkflowResultsModel(BaseModel):
+    """
+    Model for getting the overview of a compare workflow result.
+    """ # noqa: E501
+    page: Optional[PageInfo] = None
+    states: Optional[List[CompareMatchStatus]] = Field(default=None, description="An optional list of states to filter the results by.")
+    sort_criteria: Optional[List[SortCriterion]] = Field(default=None, description="A list of criteria to sort the results by.", alias="sortCriteria")
+    __properties: ClassVar[List[str]] = ["page", "states", "sortCriteria"]
+
+    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 GetCompareWorkflowResultsModel 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 page
+        if self.page:
+            _dict['page'] = self.page.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in sort_criteria (list)
+        _items = []
+        if self.sort_criteria:
+            for _item_sort_criteria in self.sort_criteria:
+                if _item_sort_criteria:
+                    _items.append(_item_sort_criteria.to_dict())
+            _dict['sortCriteria'] = _items
+        # set to None if states (nullable) is None
+        # and model_fields_set contains the field
+        if self.states is None and "states" in self.model_fields_set:
+            _dict['states'] = None
+
+        # set to None if sort_criteria (nullable) is None
+        # and model_fields_set contains the field
+        if self.sort_criteria is None and "sort_criteria" in self.model_fields_set:
+            _dict['sortCriteria'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetCompareWorkflowResultsModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "page": PageInfo.from_dict(obj["page"]) if obj.get("page") is not None else None,
+            "states": obj.get("states"),
+            "sortCriteria": [SortCriterion.from_dict(_item) for _item in obj["sortCriteria"]] if obj.get("sortCriteria") is not None else None
+        })
+        return _obj
+
+

rapidata/api_client/models/get_compare_workflow_results_result.py

@@ -0,0 +1,104 @@
+# 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
+from rapidata.api_client.models.get_compare_workflow_results_result_asset import GetCompareWorkflowResultsResultAsset
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetCompareWorkflowResultsResult(BaseModel):
+    """
+    GetCompareWorkflowResultsResult
+    """ # noqa: E501
+    workflow_datapoint_id: StrictStr = Field(alias="workflowDatapointId")
+    asset: GetCompareWorkflowResultsResultAsset
+    elo: StrictInt
+    state: StrictStr
+    __properties: ClassVar[List[str]] = ["workflowDatapointId", "asset", "elo", "state"]
+
+    @field_validator('state')
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['Idle', 'Queued', 'Processing', 'Completed']):
+            raise ValueError("must be one of enum values ('Idle', 'Queued', 'Processing', 'Completed')")
+        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 GetCompareWorkflowResultsResult 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 asset
+        if self.asset:
+            _dict['asset'] = self.asset.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetCompareWorkflowResultsResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "workflowDatapointId": obj.get("workflowDatapointId"),
+            "asset": GetCompareWorkflowResultsResultAsset.from_dict(obj["asset"]) if obj.get("asset") is not None else None,
+            "elo": obj.get("elo"),
+            "state": obj.get("state")
+        })
+        return _obj
+
+