rapidata 2.0.0__tar.gz → 2.1.0__tar.gz

{rapidata-2.0.0 → rapidata-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rapidata
-Version: 2.0.0
+Version: 2.1.0
 Summary: Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way.
 License: Apache-2.0
 Author: Rapidata AG

{rapidata-2.0.0 → rapidata-2.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rapidata"
-version = "2.0.0"
+version = "2.1.0"
 description = "Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way."
 authors = ["Rapidata AG <info@rapidata.ai>"]
 license = "Apache-2.0"

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/__init__.py

@@ -20,6 +20,7 @@ from .rapidata_client import (
     LanguageFilter,
     UserScoreFilter,
     CampaignFilter,
+    CustomFilter,
     AgeGroup,
     Gender,
 

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/api_client/__init__.py

@@ -122,6 +122,7 @@ from rapidata.api_client.models.create_simple_pipeline_model import CreateSimple
 from rapidata.api_client.models.create_simple_pipeline_model_artifacts_inner import CreateSimplePipelineModelArtifactsInner
 from rapidata.api_client.models.create_simple_pipeline_model_pipeline_steps_inner import CreateSimplePipelineModelPipelineStepsInner
 from rapidata.api_client.models.create_unsupported_order_model import CreateUnsupportedOrderModel
+from rapidata.api_client.models.custom_user_filter_model import CustomUserFilterModel
 from rapidata.api_client.models.datapoint import Datapoint
 from rapidata.api_client.models.datapoint_asset import DatapointAsset
 from rapidata.api_client.models.datapoint_get_by_id_get200_response import DatapointGetByIdGet200Response

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/api_client/models/__init__.py

@@ -90,6 +90,7 @@ from rapidata.api_client.models.create_simple_pipeline_model import CreateSimple
 from rapidata.api_client.models.create_simple_pipeline_model_artifacts_inner import CreateSimplePipelineModelArtifactsInner
 from rapidata.api_client.models.create_simple_pipeline_model_pipeline_steps_inner import CreateSimplePipelineModelPipelineStepsInner
 from rapidata.api_client.models.create_unsupported_order_model import CreateUnsupportedOrderModel
+from rapidata.api_client.models.custom_user_filter_model import CustomUserFilterModel
 from rapidata.api_client.models.datapoint import Datapoint
 from rapidata.api_client.models.datapoint_asset import DatapointAsset
 from rapidata.api_client.models.datapoint_get_by_id_get200_response import DatapointGetByIdGet200Response

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/api_client/models/add_campaign_model.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+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.create_order_model_user_filters_inner import CreateOrderModelUserFiltersInner
@@ -37,7 +37,8 @@ class AddCampaignModel(BaseModel):
     selections: Optional[List[CappedSelectionSelectionsInner]] = 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.")
-    __properties: ClassVar[List[str]] = ["_t", "artifactId", "campaignName", "userFilters", "validationSetId", "selections", "featureFlags", "priority"]
+    is_sticky: Optional[StrictBool] = Field(default=None, description="Indicates if the campaign is sticky.", alias="isSticky")
+    __properties: ClassVar[List[str]] = ["_t", "artifactId", "campaignName", "userFilters", "validationSetId", "selections", "featureFlags", "priority", "isSticky"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -140,7 +141,8 @@ class AddCampaignModel(BaseModel):
             "validationSetId": obj.get("validationSetId"),
             "selections": [CappedSelectionSelectionsInner.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")
+            "priority": obj.get("priority"),
+            "isSticky": obj.get("isSticky")
         })
         return _obj
 

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/api_client/models/create_order_model.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+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.create_order_model_referee import CreateOrderModelReferee
@@ -38,10 +38,11 @@ class CreateOrderModel(BaseModel):
     aggregator: Optional[StrictStr] = Field(default=None, description="The aggregator is used to determine how the data will be aggregated. The default behavior is enough for most cases")
     feature_flags: Optional[List[FeatureFlagModel]] = Field(default=None, description="The feature flags are used to enable or disable certain features.", alias="featureFlags")
     priority: Optional[StrictInt] = Field(default=None, description="The priority is used to prioritize over other orders.")
+    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.")
-    __properties: ClassVar[List[str]] = ["_t", "orderName", "workflow", "referee", "aggregator", "featureFlags", "priority", "userFilters", "validationSetId", "selections"]
+    __properties: ClassVar[List[str]] = ["_t", "orderName", "workflow", "referee", "aggregator", "featureFlags", "priority", "isSticky", "userFilters", "validationSetId", "selections"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -170,6 +171,7 @@ class CreateOrderModel(BaseModel):
             "aggregator": obj.get("aggregator"),
             "featureFlags": [FeatureFlagModel.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"),
             "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

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/api_client/models/create_order_model_user_filters_inner.py

@@ -20,6 +20,7 @@ from typing import Any, List, Optional
 from rapidata.api_client.models.age_user_filter_model import AgeUserFilterModel
 from rapidata.api_client.models.campaign_user_filter_model import CampaignUserFilterModel
 from rapidata.api_client.models.country_user_filter_model import CountryUserFilterModel
+from rapidata.api_client.models.custom_user_filter_model import CustomUserFilterModel
 from rapidata.api_client.models.gender_user_filter_model import GenderUserFilterModel
 from rapidata.api_client.models.language_user_filter_model import LanguageUserFilterModel
 from rapidata.api_client.models.user_score_user_filter_model import UserScoreUserFilterModel
@@ -27,7 +28,7 @@ from pydantic import StrictStr, Field
 from typing import Union, List, Set, Optional, Dict
 from typing_extensions import Literal, Self
 
-CREATEORDERMODELUSERFILTERSINNER_ONE_OF_SCHEMAS = ["AgeUserFilterModel", "CampaignUserFilterModel", "CountryUserFilterModel", "GenderUserFilterModel", "LanguageUserFilterModel", "UserScoreUserFilterModel"]
+CREATEORDERMODELUSERFILTERSINNER_ONE_OF_SCHEMAS = ["AgeUserFilterModel", "CampaignUserFilterModel", "CountryUserFilterModel", "CustomUserFilterModel", "GenderUserFilterModel", "LanguageUserFilterModel", "UserScoreUserFilterModel"]
 
 class CreateOrderModelUserFiltersInner(BaseModel):
     """
@@ -39,14 +40,16 @@ class CreateOrderModelUserFiltersInner(BaseModel):
     oneof_schema_2_validator: Optional[CampaignUserFilterModel] = None
     # data type: CountryUserFilterModel
     oneof_schema_3_validator: Optional[CountryUserFilterModel] = None
+    # data type: CustomUserFilterModel
+    oneof_schema_4_validator: Optional[CustomUserFilterModel] = None
     # data type: GenderUserFilterModel
-    oneof_schema_4_validator: Optional[GenderUserFilterModel] = None
+    oneof_schema_5_validator: Optional[GenderUserFilterModel] = None
     # data type: LanguageUserFilterModel
-    oneof_schema_5_validator: Optional[LanguageUserFilterModel] = None
+    oneof_schema_6_validator: Optional[LanguageUserFilterModel] = None
     # data type: UserScoreUserFilterModel
-    oneof_schema_6_validator: Optional[UserScoreUserFilterModel] = None
-    actual_instance: Optional[Union[AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel]] = None
-    one_of_schemas: Set[str] = { "AgeUserFilterModel", "CampaignUserFilterModel", "CountryUserFilterModel", "GenderUserFilterModel", "LanguageUserFilterModel", "UserScoreUserFilterModel" }
+    oneof_schema_7_validator: Optional[UserScoreUserFilterModel] = None
+    actual_instance: Optional[Union[AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, CustomUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel]] = None
+    one_of_schemas: Set[str] = { "AgeUserFilterModel", "CampaignUserFilterModel", "CountryUserFilterModel", "CustomUserFilterModel", "GenderUserFilterModel", "LanguageUserFilterModel", "UserScoreUserFilterModel" }
 
     model_config = ConfigDict(
         validate_assignment=True,
@@ -87,6 +90,11 @@ class CreateOrderModelUserFiltersInner(BaseModel):
             error_messages.append(f"Error! Input type `{type(v)}` is not `CountryUserFilterModel`")
         else:
             match += 1
+        # validate data type: CustomUserFilterModel
+        if not isinstance(v, CustomUserFilterModel):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CustomUserFilterModel`")
+        else:
+            match += 1
         # validate data type: GenderUserFilterModel
         if not isinstance(v, GenderUserFilterModel):
             error_messages.append(f"Error! Input type `{type(v)}` is not `GenderUserFilterModel`")
@@ -104,10 +112,10 @@ class CreateOrderModelUserFiltersInner(BaseModel):
             match += 1
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when setting `actual_instance` in CreateOrderModelUserFiltersInner with oneOf schemas: AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when setting `actual_instance` in CreateOrderModelUserFiltersInner with oneOf schemas: AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, CustomUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when setting `actual_instance` in CreateOrderModelUserFiltersInner with oneOf schemas: AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting `actual_instance` in CreateOrderModelUserFiltersInner with oneOf schemas: AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, CustomUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -140,6 +148,12 @@ class CreateOrderModelUserFiltersInner(BaseModel):
             match += 1
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
+        # deserialize data into CustomUserFilterModel
+        try:
+            instance.actual_instance = CustomUserFilterModel.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
         # deserialize data into GenderUserFilterModel
         try:
             instance.actual_instance = GenderUserFilterModel.from_json(json_str)
@@ -161,10 +175,10 @@ class CreateOrderModelUserFiltersInner(BaseModel):
 
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when deserializing the JSON string into CreateOrderModelUserFiltersInner with oneOf schemas: AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when deserializing the JSON string into CreateOrderModelUserFiltersInner with oneOf schemas: AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, CustomUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into CreateOrderModelUserFiltersInner with oneOf schemas: AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into CreateOrderModelUserFiltersInner with oneOf schemas: AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, CustomUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -178,7 +192,7 @@ class CreateOrderModelUserFiltersInner(BaseModel):
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], AgeUserFilterModel, CampaignUserFilterModel, CountryUserFilterModel, CustomUserFilterModel, GenderUserFilterModel, LanguageUserFilterModel, UserScoreUserFilterModel]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None

rapidata-2.1.0/src/rapidata/api_client/models/custom_user_filter_model.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CustomUserFilterModel(BaseModel):
+    """
+    CustomUserFilterModel
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for CustomFilter", alias="_t")
+    identifier: StrictStr
+    values: List[StrictStr]
+    __properties: ClassVar[List[str]] = ["_t", "identifier", "values"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['CustomFilter']):
+            raise ValueError("must be one of enum values ('CustomFilter')")
+        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 CustomUserFilterModel 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 CustomUserFilterModel 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 'CustomFilter',
+            "identifier": obj.get("identifier"),
+            "values": obj.get("values")
+        })
+        return _obj
+
+

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/api_client_README.md

@@ -224,6 +224,7 @@ Class | Method | HTTP request | Description
  - [CreateSimplePipelineModelArtifactsInner](rapidata/api_client/docs/CreateSimplePipelineModelArtifactsInner.md)
  - [CreateSimplePipelineModelPipelineStepsInner](rapidata/api_client/docs/CreateSimplePipelineModelPipelineStepsInner.md)
  - [CreateUnsupportedOrderModel](rapidata/api_client/docs/CreateUnsupportedOrderModel.md)
+ - [CustomUserFilterModel](rapidata/api_client/docs/CustomUserFilterModel.md)
  - [Datapoint](rapidata/api_client/docs/Datapoint.md)
  - [DatapointAsset](rapidata/api_client/docs/DatapointAsset.md)
  - [DatapointGetByIdGet200Response](rapidata/api_client/docs/DatapointGetByIdGet200Response.md)

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/rapidata_client/__init__.py

@@ -35,8 +35,9 @@ from .filter import (
     UserScoreFilter,
     CampaignFilter,
     AgeFilter,
-    AgeGroup,
     GenderFilter,
+    CustomFilter,
+    AgeGroup,
     Gender,
 )
 

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/rapidata_client/filter/__init__.py

@@ -5,3 +5,4 @@ from .country_filter import CountryFilter
 from .gender_filter import GenderFilter, Gender
 from .language_filter import LanguageFilter
 from .user_score_filter import UserScoreFilter
+from .custom_filter import CustomFilter

rapidata-2.1.0/src/rapidata/rapidata_client/filter/custom_filter.py

@@ -0,0 +1,29 @@
+from typing import Any
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
+from rapidata.api_client.models.custom_user_filter_model import CustomUserFilterModel
+
+
+class CustomFilter(RapidataFilter):
+    """CustomFilter Class
+
+    Can be used to filter who to target based on custom filters.
+
+    Ought to be used with contact to Rapidata. 
+    
+    Warning: If identifier does not exist, order will not get any responses.
+    
+    Args:
+        identifier (str): Identifier of the custom filter.
+        values (list[str]): List of values to filter by.
+    """
+
+    def __init__(self, identifier: str, values: list[str]):
+        self.identifier = identifier
+        self.values = values
+
+    def _to_model(self):
+        return CustomUserFilterModel(
+            _t="CustomFilter",
+            identifier=self.identifier,
+            values=self.values,
+        )

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/rapidata_client/filter/rapidata_filters.py

@@ -4,7 +4,8 @@ from rapidata.rapidata_client.filter import (
     CountryFilter, 
     GenderFilter, 
     LanguageFilter, 
-    UserScoreFilter)
+    UserScoreFilter,
+    CustomFilter)
 
 class RapidataFilters:
     """RapidataFilters Classes
@@ -22,10 +23,13 @@ class RapidataFilters:
         country (CountryFilter): The CountryFilter instance.
         campaign (CampaignFilter): The CampaignFilter instance
         gender (GenderFilter): The GenderFilter instance.
-        language (LanguageFilter): The LanguageFilter instance."""
+        language (LanguageFilter): The LanguageFilter instance.
+        custom_filter (CustomFilter): The CustomFilter instance.
+    """
     user_score = UserScoreFilter
     age = AgeFilter 
     campaign = CampaignFilter
     country = CountryFilter
     gender = GenderFilter
     language = LanguageFilter
+    custom_filter = CustomFilter

{rapidata-2.0.0 → rapidata-2.1.0}/src/rapidata/rapidata_client/validation/validation_set_manager.py

@@ -23,6 +23,9 @@ from typing import Sequence
 class ValidationSetManager:
     """
     Responsible for everything related to validation sets. From creation to retrieval.
+
+    Attributes:
+        rapid (RapidsManager): The RapidsManager instance.
     """
     def __init__(self, openapi_service: OpenAPIService) -> None:
         self.__openapi_service = openapi_service