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

rapidata/api_client/models/benchmark_query_result_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.benchmark_query_result import BenchmarkQueryResult
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BenchmarkQueryResultPagedResult(BaseModel):
+    """
+    BenchmarkQueryResultPagedResult
+    """ # noqa: E501
+    total: StrictInt
+    page: StrictInt
+    page_size: StrictInt = Field(alias="pageSize")
+    items: List[BenchmarkQueryResult]
+    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 BenchmarkQueryResultPagedResult 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 BenchmarkQueryResultPagedResult 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": [BenchmarkQueryResult.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/boost_leaderboard_model.py

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

rapidata/api_client/models/boost_mode.py

@@ -0,0 +1,37 @@
+# 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 BoostMode(str, Enum):
+    """
+    BoostMode
+    """
+
+    """
+    allowed enum values
+    """
+    AUTOMATIC = 'Automatic'
+    MANUAL = 'Manual'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BoostMode from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/boost_query_result.py

@@ -17,8 +17,10 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List
+from rapidata.api_client.models.boost_query_result_boost_mode import BoostQueryResultBoostMode
+from rapidata.api_client.models.boost_query_result_boost_status import BoostQueryResultBoostStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -26,18 +28,12 @@ class BoostQueryResult(BaseModel):
     """
     BoostQueryResult
     """ # noqa: E501
-    status: StrictStr
+    status: BoostQueryResultBoostStatus
+    mode: BoostQueryResultBoostMode
     active_campaigns: List[StrictStr] = Field(alias="activeCampaigns")
     inactive_campaigns: List[StrictStr] = Field(alias="inactiveCampaigns")
     unknown_campaigns: List[StrictInt] = Field(alias="unknownCampaigns")
-    __properties: ClassVar[List[str]] = ["status", "activeCampaigns", "inactiveCampaigns", "unknownCampaigns"]
-
-    @field_validator('status')
-    def status_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['Active', 'Inactive', 'Partial', 'Unknown']):
-            raise ValueError("must be one of enum values ('Active', 'Inactive', 'Partial', 'Unknown')")
-        return value
+    __properties: ClassVar[List[str]] = ["status", "mode", "activeCampaigns", "inactiveCampaigns", "unknownCampaigns"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -91,6 +87,7 @@ class BoostQueryResult(BaseModel):
 
         _obj = cls.model_validate({
             "status": obj.get("status"),
+            "mode": obj.get("mode"),
             "activeCampaigns": obj.get("activeCampaigns"),
             "inactiveCampaigns": obj.get("inactiveCampaigns"),
             "unknownCampaigns": obj.get("unknownCampaigns")

rapidata/api_client/models/boost_query_result_boost_mode.py

@@ -0,0 +1,37 @@
+# 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 BoostQueryResultBoostMode(str, Enum):
+    """
+    BoostQueryResultBoostMode
+    """
+
+    """
+    allowed enum values
+    """
+    AUTOMATIC = 'Automatic'
+    MANUAL = 'Manual'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BoostQueryResultBoostMode from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/boost_query_result_boost_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 BoostQueryResultBoostStatus(str, Enum):
+    """
+    BoostQueryResultBoostStatus
+    """
+
+    """
+    allowed enum values
+    """
+    ACTIVE = 'Active'
+    INACTIVE = 'Inactive'
+    PARTIAL = 'Partial'
+    UNKNOWN = 'Unknown'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BoostQueryResultBoostStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/boosting_profile.py

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

rapidata/api_client/models/box_shape.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
@@ -26,19 +26,11 @@ class BoxShape(BaseModel):
     """
     BoxShape
     """ # noqa: E501
-    t: StrictStr = Field(description="Discriminator value for BoxShape", alias="_t")
     x_min: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="xMin")
     y_min: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="yMin")
     x_max: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="xMax")
     y_max: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="yMax")
-    __properties: ClassVar[List[str]] = ["_t", "xMin", "yMin", "xMax", "yMax"]
-
-    @field_validator('t')
-    def t_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['BoxShape']):
-            raise ValueError("must be one of enum values ('BoxShape')")
-        return value
+    __properties: ClassVar[List[str]] = ["xMin", "yMin", "xMax", "yMax"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -79,26 +71,6 @@ class BoxShape(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # set to None if x_min (nullable) is None
-        # and model_fields_set contains the field
-        if self.x_min is None and "x_min" in self.model_fields_set:
-            _dict['xMin'] = None
-
-        # set to None if y_min (nullable) is None
-        # and model_fields_set contains the field
-        if self.y_min is None and "y_min" in self.model_fields_set:
-            _dict['yMin'] = None
-
-        # set to None if x_max (nullable) is None
-        # and model_fields_set contains the field
-        if self.x_max is None and "x_max" in self.model_fields_set:
-            _dict['xMax'] = None
-
-        # set to None if y_max (nullable) is None
-        # and model_fields_set contains the field
-        if self.y_max is None and "y_max" in self.model_fields_set:
-            _dict['yMax'] = None
-
         return _dict
 
     @classmethod
@@ -111,7 +83,6 @@ class BoxShape(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "_t": obj.get("_t") if obj.get("_t") is not None else 'BoxShape',
             "xMin": obj.get("xMin"),
             "yMin": obj.get("yMin"),
             "xMax": obj.get("xMax"),

rapidata/api_client/models/campaign_filter.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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CampaignFilter(BaseModel):
+    """
+    CampaignFilter
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for CampaignFilter", alias="_t")
+    campaign_ids: List[StrictStr] = Field(alias="campaignIds")
+    execution_order: Optional[StrictInt] = Field(default=None, alias="executionOrder")
+    __properties: ClassVar[List[str]] = ["_t", "campaignIds", "executionOrder"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['CampaignFilter']):
+            raise ValueError("must be one of enum values ('CampaignFilter')")
+        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 CampaignFilter 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 CampaignFilter 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 'CampaignFilter',
+            "campaignIds": obj.get("campaignIds"),
+            "executionOrder": obj.get("executionOrder")
+        })
+        return _obj
+
+

rapidata/api_client/models/campaign_query_result.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -18,8 +18,10 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.boosting_profile import BoostingProfile
+from rapidata.api_client.models.campaign_status import CampaignStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,17 +32,12 @@ class CampaignQueryResult(BaseModel):
     id: StrictStr
     owner_mail: StrictStr = Field(alias="ownerMail")
     name: StrictStr
-    status: StrictStr
+    status: CampaignStatus
     priority: StrictInt
+    boosting_profile: BoostingProfile = Field(alias="boostingProfile")
+    requires_booster: Optional[StrictBool] = Field(default=None, alias="requiresBooster")
     created_at: datetime = Field(alias="createdAt")
-    __properties: ClassVar[List[str]] = ["id", "ownerMail", "name", "status", "priority", "createdAt"]
-
-    @field_validator('status')
-    def status_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['Created', 'Preview', 'Active', 'Analysis', 'Paused', 'Completed']):
-            raise ValueError("must be one of enum values ('Created', 'Preview', 'Active', 'Analysis', 'Paused', 'Completed')")
-        return value
+    __properties: ClassVar[List[str]] = ["id", "ownerMail", "name", "status", "priority", "boostingProfile", "requiresBooster", "createdAt"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -81,6 +78,9 @@ class CampaignQueryResult(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of boosting_profile
+        if self.boosting_profile:
+            _dict['boostingProfile'] = self.boosting_profile.to_dict()
         return _dict
 
     @classmethod
@@ -98,6 +98,8 @@ class CampaignQueryResult(BaseModel):
             "name": obj.get("name"),
             "status": obj.get("status"),
             "priority": obj.get("priority"),
+            "boostingProfile": BoostingProfile.from_dict(obj["boostingProfile"]) if obj.get("boostingProfile") is not None else None,
+            "requiresBooster": obj.get("requiresBooster"),
             "createdAt": obj.get("createdAt")
         })
         return _obj