rapidata 1.10.1__py3-none-any.whl → 2.1.0__py3-none-any.whl

rapidata/api_client_README.md

@@ -117,9 +117,12 @@ Class | Method | HTTP request | Description
 *OrderApi* | [**order_unlock_post**](rapidata/api_client/docs/OrderApi.md#order_unlock_post) | **POST** /Order/Unlock | Unlocks a newly cloned order.
 *OrderApi* | [**order_update_access_put**](rapidata/api_client/docs/OrderApi.md#order_update_access_put) | **PUT** /Order/UpdateAccess | Updates whether an order is public or not.
 *OrderApi* | [**order_update_order_name_put**](rapidata/api_client/docs/OrderApi.md#order_update_order_name_put) | **PUT** /Order/UpdateOrderName | Updates the name of an order.
-*PipelineApi* | [**pipeline_add_campaign_patch**](rapidata/api_client/docs/PipelineApi.md#pipeline_add_campaign_patch) | **PATCH** /Pipeline/AddCampaign | Adds a campaign to a pipeline.
+*PipelineApi* | [**pipeline_id_campaign_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_campaign_artifact_id_put) | **PUT** /pipeline/{id}/campaign/{artifact-id} | Updates a specific campaign for a pipeline.
+*PipelineApi* | [**pipeline_id_campaign_post**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_campaign_post) | **POST** /pipeline/{id}/campaign | Adds a campaign to a pipeline.
+*PipelineApi* | [**pipeline_id_campaign_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_campaign_put) | **PUT** /pipeline/{id}/campaign | Updates the default campaign for a pipeline.
 *PipelineApi* | [**pipeline_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_get) | **GET** /Pipeline/{id} | Gets a pipeline by its id.
-*PipelineApi* | [**pipeline_update_workflow_config_post**](rapidata/api_client/docs/PipelineApi.md#pipeline_update_workflow_config_post) | **POST** /Pipeline/UpdateWorkflowConfig | Updates the workflow configuration for a pipeline.
+*PipelineApi* | [**pipeline_id_workflow_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_artifact_id_put) | **PUT** /pipeline/{id}/workflow/{artifact-id} | Updates the workflow configuration for a pipeline.
+*PipelineApi* | [**pipeline_id_workflow_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_put) | **PUT** /pipeline/{id}/workflow | Updates the workflow configuration for a pipeline.
 *RapidApi* | [**rapid_add_user_guess_post**](rapidata/api_client/docs/RapidApi.md#rapid_add_user_guess_post) | **POST** /Rapid/AddUserGuess | Submits a user guess for a Rapid.
 *RapidApi* | [**rapid_create_demographic_rapid_post**](rapidata/api_client/docs/RapidApi.md#rapid_create_demographic_rapid_post) | **POST** /Rapid/CreateDemographicRapid | Creates a new Demographic Rapid.
 *RapidApi* | [**rapid_query_validation_rapids_get**](rapidata/api_client/docs/RapidApi.md#rapid_query_validation_rapids_get) | **GET** /Rapid/QueryValidationRapids | Queries the validation rapids for a specific validation set.
@@ -186,10 +189,14 @@ Class | Method | HTTP request | Description
  - [CompareTruth](rapidata/api_client/docs/CompareTruth.md)
  - [CompareWorkflowConfig](rapidata/api_client/docs/CompareWorkflowConfig.md)
  - [CompareWorkflowConfigModel](rapidata/api_client/docs/CompareWorkflowConfigModel.md)
+ - [CompareWorkflowConfigModelPairMakerConfig](rapidata/api_client/docs/CompareWorkflowConfigModelPairMakerConfig.md)
+ - [CompareWorkflowConfigPairMakerConfig](rapidata/api_client/docs/CompareWorkflowConfigPairMakerConfig.md)
  - [CompareWorkflowGetResultOverviewGet200Response](rapidata/api_client/docs/CompareWorkflowGetResultOverviewGet200Response.md)
  - [CompareWorkflowModel](rapidata/api_client/docs/CompareWorkflowModel.md)
  - [CompareWorkflowModel1](rapidata/api_client/docs/CompareWorkflowModel1.md)
+ - [CompareWorkflowModel1PairMakerInformation](rapidata/api_client/docs/CompareWorkflowModel1PairMakerInformation.md)
  - [CompareWorkflowModel1Referee](rapidata/api_client/docs/CompareWorkflowModel1Referee.md)
+ - [CompareWorkflowModelPairMakerConfig](rapidata/api_client/docs/CompareWorkflowModelPairMakerConfig.md)
  - [CompletedRapidModel](rapidata/api_client/docs/CompletedRapidModel.md)
  - [CompletedRapidModelAsset](rapidata/api_client/docs/CompletedRapidModelAsset.md)
  - [ConditionalValidationSelection](rapidata/api_client/docs/ConditionalValidationSelection.md)
@@ -217,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)
@@ -230,7 +238,6 @@ Class | Method | HTTP request | Description
  - [DemographicSelection](rapidata/api_client/docs/DemographicSelection.md)
  - [EarlyStoppingRefereeModel](rapidata/api_client/docs/EarlyStoppingRefereeModel.md)
  - [EmptyValidationTruth](rapidata/api_client/docs/EmptyValidationTruth.md)
- - [ErrorType](rapidata/api_client/docs/ErrorType.md)
  - [EvaluationWorkflowConfig](rapidata/api_client/docs/EvaluationWorkflowConfig.md)
  - [EvaluationWorkflowModel](rapidata/api_client/docs/EvaluationWorkflowModel.md)
  - [FeatureFlag](rapidata/api_client/docs/FeatureFlag.md)
@@ -251,8 +258,8 @@ Class | Method | HTTP request | Description
  - [FreeTextResult](rapidata/api_client/docs/FreeTextResult.md)
  - [Gender](rapidata/api_client/docs/Gender.md)
  - [GenderUserFilterModel](rapidata/api_client/docs/GenderUserFilterModel.md)
- - [GetAttachCategoryWorkflowResultOverviewResult](rapidata/api_client/docs/GetAttachCategoryWorkflowResultOverviewResult.md)
  - [GetAvailableValidationSetsResult](rapidata/api_client/docs/GetAvailableValidationSetsResult.md)
+ - [GetClassifyWorkflowResultOverviewResult](rapidata/api_client/docs/GetClassifyWorkflowResultOverviewResult.md)
  - [GetCompareWorkflowResultOverviewResult](rapidata/api_client/docs/GetCompareWorkflowResultOverviewResult.md)
  - [GetCompareWorkflowResultOverviewSmallResult](rapidata/api_client/docs/GetCompareWorkflowResultOverviewSmallResult.md)
  - [GetDatapointsByDatasetIdResult](rapidata/api_client/docs/GetDatapointsByDatasetIdResult.md)
@@ -269,6 +276,7 @@ Class | Method | HTTP request | Description
  - [GetWorkflowProgressResult](rapidata/api_client/docs/GetWorkflowProgressResult.md)
  - [GetWorkflowResultOverviewResult](rapidata/api_client/docs/GetWorkflowResultOverviewResult.md)
  - [IWorkflowModelPagedResult](rapidata/api_client/docs/IWorkflowModelPagedResult.md)
+ - [IdentityReadBridgeTokenGet202Response](rapidata/api_client/docs/IdentityReadBridgeTokenGet202Response.md)
  - [ImageDimensionMetadata](rapidata/api_client/docs/ImageDimensionMetadata.md)
  - [ImageDimensionMetadataModel](rapidata/api_client/docs/ImageDimensionMetadataModel.md)
  - [ImportFromFileResult](rapidata/api_client/docs/ImportFromFileResult.md)
@@ -306,21 +314,29 @@ Class | Method | HTTP request | Description
  - [NamedEntityTruth](rapidata/api_client/docs/NamedEntityTruth.md)
  - [NeverEndingRefereeConfig](rapidata/api_client/docs/NeverEndingRefereeConfig.md)
  - [NewsletterModel](rapidata/api_client/docs/NewsletterModel.md)
+ - [NotAvailableYetResult](rapidata/api_client/docs/NotAvailableYetResult.md)
  - [NotStartedRapidModel](rapidata/api_client/docs/NotStartedRapidModel.md)
  - [NullAsset](rapidata/api_client/docs/NullAsset.md)
  - [NullAssetModel](rapidata/api_client/docs/NullAssetModel.md)
  - [NullAssetModel1](rapidata/api_client/docs/NullAssetModel1.md)
  - [NullAssetModel2](rapidata/api_client/docs/NullAssetModel2.md)
+ - [OnlinePairMakerConfig](rapidata/api_client/docs/OnlinePairMakerConfig.md)
+ - [OnlinePairMakerConfigModel](rapidata/api_client/docs/OnlinePairMakerConfigModel.md)
+ - [OnlinePairMakerInformation](rapidata/api_client/docs/OnlinePairMakerInformation.md)
  - [OrderModel](rapidata/api_client/docs/OrderModel.md)
  - [OrderModelPagedResult](rapidata/api_client/docs/OrderModelPagedResult.md)
  - [OrderState](rapidata/api_client/docs/OrderState.md)
  - [OriginalFilenameMetadata](rapidata/api_client/docs/OriginalFilenameMetadata.md)
  - [OriginalFilenameMetadataModel](rapidata/api_client/docs/OriginalFilenameMetadataModel.md)
  - [PageInfo](rapidata/api_client/docs/PageInfo.md)
+ - [PipelineIdWorkflowPutRequest](rapidata/api_client/docs/PipelineIdWorkflowPutRequest.md)
  - [PolygonPayload](rapidata/api_client/docs/PolygonPayload.md)
  - [PolygonRapidBlueprint](rapidata/api_client/docs/PolygonRapidBlueprint.md)
  - [PolygonResult](rapidata/api_client/docs/PolygonResult.md)
  - [PolygonTruth](rapidata/api_client/docs/PolygonTruth.md)
+ - [PreArrangedPairMakerConfig](rapidata/api_client/docs/PreArrangedPairMakerConfig.md)
+ - [PreArrangedPairMakerConfigModel](rapidata/api_client/docs/PreArrangedPairMakerConfigModel.md)
+ - [PreArrangedPairMakerInformation](rapidata/api_client/docs/PreArrangedPairMakerInformation.md)
  - [PrivateTextMetadataInput](rapidata/api_client/docs/PrivateTextMetadataInput.md)
  - [ProbabilisticAttachCategoryRefereeConfig](rapidata/api_client/docs/ProbabilisticAttachCategoryRefereeConfig.md)
  - [ProblemDetails](rapidata/api_client/docs/ProblemDetails.md)
@@ -354,7 +370,6 @@ Class | Method | HTTP request | Description
  - [SimpleWorkflowGetResultOverviewGet200Response](rapidata/api_client/docs/SimpleWorkflowGetResultOverviewGet200Response.md)
  - [SimpleWorkflowModel](rapidata/api_client/docs/SimpleWorkflowModel.md)
  - [SimpleWorkflowModel1](rapidata/api_client/docs/SimpleWorkflowModel1.md)
- - [SimpleWorkflowModel1Blueprint](rapidata/api_client/docs/SimpleWorkflowModel1Blueprint.md)
  - [SimpleWorkflowModelBlueprint](rapidata/api_client/docs/SimpleWorkflowModelBlueprint.md)
  - [SkipResult](rapidata/api_client/docs/SkipResult.md)
  - [SortCriterion](rapidata/api_client/docs/SortCriterion.md)
@@ -380,9 +395,8 @@ Class | Method | HTTP request | Description
  - [TranslatedString](rapidata/api_client/docs/TranslatedString.md)
  - [UnlockOrderResult](rapidata/api_client/docs/UnlockOrderResult.md)
  - [UpdateAccessModel](rapidata/api_client/docs/UpdateAccessModel.md)
+ - [UpdateCampaignModel](rapidata/api_client/docs/UpdateCampaignModel.md)
  - [UpdateOrderModel](rapidata/api_client/docs/UpdateOrderModel.md)
- - [UpdateWorkflowConfigRequest](rapidata/api_client/docs/UpdateWorkflowConfigRequest.md)
- - [UpdateWorkflowConfigRequestConfig](rapidata/api_client/docs/UpdateWorkflowConfigRequestConfig.md)
  - [UploadCocoResult](rapidata/api_client/docs/UploadCocoResult.md)
  - [UploadDatapointsResult](rapidata/api_client/docs/UploadDatapointsResult.md)
  - [UploadFilesFromS3BucketModel](rapidata/api_client/docs/UploadFilesFromS3BucketModel.md)

rapidata/rapidata_client/__init__.py

@@ -1,10 +1,4 @@
 from .rapidata_client import RapidataClient
-from .workflow import (
-    ClassifyWorkflow,
-    SelectWordsWorkflow,
-    CompareWorkflow,
-    FreeTextWorkflow,
-)
 from .selection import (
     DemographicSelection,
     LabelingSelection,
@@ -12,23 +6,39 @@ from .selection import (
     ConditionalValidationSelection,
     CappedSelection,
 )
-from .referee import NaiveReferee, EarlyStoppingReferee
 from .metadata import (
     PrivateTextMetadata,
     PublicTextMetadata,
     PromptMetadata,
     SelectWordsMetadata,
 )
-from .settings import Settings, FeatureFlags # remove FeatureFlags next major version
+from .settings import (
+    RapidataSettings, 
+    TranslationBehaviourOptions,
+    AlertOnFastResponse,
+    TranslationBehaviour,
+    FreeTextMinimumCharacters,
+    NoShuffle,
+    PlayVideoUntilTheEnd,
+    CustomSetting,
+    )
 from .country_codes import CountryCodes
-from .assets import MediaAsset, TextAsset, MultiAsset
+from .assets import (
+    MediaAsset, 
+    TextAsset, 
+    MultiAsset, 
+    RapidataDataTypes
+)
 from .filter import (
     CountryFilter,
     LanguageFilter,
     UserScoreFilter,
     CampaignFilter,
     AgeFilter,
-    AgeGroup,
     GenderFilter,
+    CustomFilter,
+    AgeGroup,
     Gender,
 )
+
+from .validation import Box

rapidata/rapidata_client/assets/__init__.py

@@ -2,7 +2,8 @@
 
 This package provides classes for different types of assets, including MediaAsset, TextAsset, and MultiAsset.
 """
-from .base_asset import BaseAsset
-from .media_asset import MediaAsset
-from .text_asset import TextAsset
-from .multi_asset import MultiAsset
+from ._base_asset import BaseAsset
+from ._media_asset import MediaAsset
+from ._text_asset import TextAsset
+from ._multi_asset import MultiAsset
+from .data_type_enum import RapidataDataTypes

rapidata/rapidata_client/assets/{media_asset.py → _media_asset.py}

@@ -5,9 +5,10 @@ Defines the MediaAsset class for handling media file paths within assets.
 
 import os
 from io import BytesIO
-from rapidata.rapidata_client.assets.base_asset import BaseAsset
+from rapidata.rapidata_client.assets._base_asset import BaseAsset
 import requests
 import re
+from PIL import Image
 
 class MediaAsset(BaseAsset):
     """MediaAsset Class
@@ -41,32 +42,52 @@ class MediaAsset(BaseAsset):
         """
         if not isinstance(path, str):
             raise ValueError("Media must be a string, either a local file path or a URL")
-
+        
         if re.match(r'^https?://', path):
-            self.path = self._get_media_bytes(path)
+            self.path = self.__get_media_bytes(path)
             self.name = path.split('/')[-1]
-            if not self.name.endswith(('.jpg', '.jpeg', '.png', '.gif', '.mp3', '.mp4', '.webp')):
-                raise ValueError("Supported file types for custom names: jpg, jpeg, png, gif, mp3, mp4")
+            self.name = self.__check_name_ending(self.name)
             return
         
         if not os.path.exists(path):
             raise FileNotFoundError(f"File not found: {path}")
         
-        
         self.path: str | bytes = path
         self.name = path
-    
+
+    def get_image_dimension(self) -> tuple[int, int] | None:
+        """
+        Get the dimensions (width, height) of an image file.
+        Returns None for non-image files or if dimensions can't be determined.
+        """
+        if not any(self.name.lower().endswith(ext) for ext in ('.jpg', '.jpeg', '.png', '.gif', '.webp')):
+            return None
+            
+        try:
+            if isinstance(self.path, bytes):
+                img = Image.open(BytesIO(self.path))
+            else:
+                img = Image.open(self.path)
+            return img.size
+        except Exception:
+            return None
+
     def set_custom_name(self, name: str) -> 'MediaAsset':
         """Set a custom name for the media asset (only works with URLs)."""
         if isinstance(self.path, bytes):
-            if not name.endswith(('.jpg', '.jpeg', '.png', '.gif', '.mp3', '.mp4', '.webp')):
-                raise ValueError("Supported file types for custom names: jpg, jpeg, png, gif, mp3, mp4")
-            self.name = name
+            self.name = self.__check_name_ending(name)
         else:
             raise ValueError("Custom name can only be set for URLs.")
         return self
+    
+    def __check_name_ending(self, name: str) -> str:
+        """Check if the media path is valid."""
+        if not name.endswith(('.jpg', '.jpeg', '.png', '.gif', '.mp3', '.mp4', '.webp')):
+            print("Warning: Supported file types: jpg, jpeg, png, gif, mp3, mp4. Image might not be displayed correctly.")
+            name = name + '.jpg'
+        return name
 
-    def _get_media_bytes(self, url: str) -> bytes:
+    def __get_media_bytes(self, url: str) -> bytes:
         """
         Downloads media files from URL and validates type and duration.
         

rapidata/rapidata_client/assets/{multi_asset.py → _multi_asset.py}

@@ -3,7 +3,7 @@
 Defines the MultiAsset class for handling multiple BaseAsset instances.
 """
 
-from rapidata.rapidata_client.assets.base_asset import BaseAsset
+from rapidata.rapidata_client.assets._base_asset import BaseAsset
 from rapidata.rapidata_client.assets import MediaAsset, TextAsset
 from typing import Iterator, Sequence
 

rapidata/rapidata_client/assets/{text_asset.py → _text_asset.py}

@@ -3,7 +3,7 @@
 Defines the TextAsset class for handling textual data within assets.
 """
 
-from rapidata.rapidata_client.assets.base_asset import BaseAsset
+from rapidata.rapidata_client.assets._base_asset import BaseAsset
 
 
 class TextAsset(BaseAsset):

rapidata/rapidata_client/assets/data_type_enum.py

@@ -0,0 +1,7 @@
+class RapidataDataTypes:
+    MEDIA = "media" # any form of image, video or audio
+    TEXT = "text"
+
+    @classmethod
+    def _possible_values(cls):
+        return [cls.MEDIA, cls.TEXT]

rapidata/rapidata_client/filter/__init__.py

@@ -1,7 +1,8 @@
-from .base_filter import Filter
+from ._base_filter import RapidataFilter
 from .age_filter import AgeFilter, AgeGroup
 from .campaign_filter import CampaignFilter
 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/rapidata_client/filter/_base_filter.py

@@ -0,0 +1,10 @@
+from abc import abstractmethod
+from typing import Any
+
+
+class RapidataFilter:
+    """The base class for all Rapidata Filters."""
+
+    @abstractmethod
+    def _to_model(self) -> Any:
+        pass

rapidata/rapidata_client/filter/age_filter.py

@@ -1,16 +1,23 @@
 from typing import Any
-from rapidata.rapidata_client.filter.base_filter import Filter
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
 from rapidata.api_client.models.age_user_filter_model import AgeUserFilterModel
-from rapidata.api_client.models.age_group import AgeGroup
+from rapidata.rapidata_client.filter.models.age_group import AgeGroup
 
 
-class AgeFilter(Filter):
+class AgeFilter(RapidataFilter):
+    """AgeFilter Class
+    
+    Can be used to filter who to target based on age groups.
+    
+    
+    Args:
+        age_groups (list[AgeGroup]): List of age groups to filter by."""
 
     def __init__(self, age_groups: list[AgeGroup]):
         self.age_groups = age_groups
 
-    def to_model(self):
+    def _to_model(self):
         return AgeUserFilterModel(
             _t="AgeFilter",
-            ageGroups=self.age_groups,
+            ageGroups=[age_group._to_backend_model() for age_group in self.age_groups],
         )

rapidata/rapidata_client/filter/campaign_filter.py

@@ -1,16 +1,25 @@
 from typing import Any
-from rapidata.rapidata_client.filter.base_filter import Filter
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
 from rapidata.api_client.models.campaign_user_filter_model import (
     CampaignUserFilterModel,
 )
 
 
-class CampaignFilter(Filter):
+class CampaignFilter(RapidataFilter):
+    """CampaignFilter Class
+
+    Can be used to filter who to target based on campaign IDs.
+
+    This filter can only be used when directly in contact with Rapidata.
+    
+    Args:
+        campaign_ids (list[str]): List of campaign IDs to filter by.
+    """
 
     def __init__(self, campaign_ids: list[str]):
         self.campaign_ids = campaign_ids
 
-    def to_model(self):
+    def _to_model(self):
         return CampaignUserFilterModel(
             _t="CampaignFilter",
             campaignIds=self.campaign_ids,

rapidata/rapidata_client/filter/country_filter.py

@@ -1,9 +1,16 @@
 from typing import Any
-from rapidata.rapidata_client.filter.base_filter import Filter
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
 from rapidata.api_client.models.country_user_filter_model import CountryUserFilterModel
 
 
-class CountryFilter(Filter):
+class CountryFilter(RapidataFilter):
+    """CountryFilter Class
+
+    Can be used to filter who to target based on country codes.
+    
+    Args:
+        country_codes (list[str]): List of country codes (capizalized) to filter by.
+    """
 
     def __init__(self, country_codes: list[str]):
         # check that all characters in the country codes are uppercase
@@ -15,5 +22,5 @@ class CountryFilter(Filter):
 
         self.country_codes = country_codes
 
-    def to_model(self):
+    def _to_model(self):
         return CountryUserFilterModel(_t="CountryFilter", countries=self.country_codes)

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/rapidata_client/filter/gender_filter.py

@@ -1,16 +1,23 @@
 from typing import Any
-from rapidata.rapidata_client.filter.base_filter import Filter
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
 from rapidata.api_client.models.gender_user_filter_model import GenderUserFilterModel
-from rapidata.api_client.models.gender import Gender
+from rapidata.rapidata_client.filter.models.gender import Gender
 
 
-class GenderFilter(Filter):
+class GenderFilter(RapidataFilter):
+    """GenderFilter Class
+    
+    Can be used to filter who to target based on their gender.
+    
+    
+    Args:
+        genders (list[Gender]): List of genders to filter by."""
 
     def __init__(self, genders: list[Gender]):
         self.genders = genders
 
-    def to_model(self):
+    def _to_model(self):
         return GenderUserFilterModel(
             _t="GenderFilter",
-            genders=self.genders,
+            genders=[gender._to_backend_model() for gender in self.genders],
         )

rapidata/rapidata_client/filter/language_filter.py

@@ -1,12 +1,19 @@
 from typing import Any
-from rapidata.rapidata_client.filter.base_filter import Filter
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
 from rapidata.api_client.models.language_user_filter_model import (
     LanguageUserFilterModel,
 )
 
 
-class LanguageFilter(Filter):
+class LanguageFilter(RapidataFilter):
+    """LanguageFilter Class
+    
+    Can be used to filter who to target based on language codes.
+    
+    example: LanguageFilter(["en", "de"]) -> will limit the order to be shown to only people who have their phone set to english or german
 
+    Args:
+        language_codes (list[str]): List of language codes to filter by."""
     def __init__(self, language_codes: list[str]):
         if not isinstance(language_codes, list):
             raise ValueError("Language codes must be a list")
@@ -14,8 +21,12 @@ class LanguageFilter(Filter):
         # check that all characters in the language codes are lowercase
         if not all([code.islower() for code in language_codes]):
             raise ValueError("Language codes must be lowercase")
+        
+        for code in language_codes:
+            if not len(code) == 2:
+                raise ValueError("Language codes must be two characters long")
 
         self.languages = language_codes
 
-    def to_model(self):
+    def _to_model(self):
         return LanguageUserFilterModel(_t="LanguageFilter", languages=self.languages)

rapidata/rapidata_client/filter/models/age_group.py

@@ -0,0 +1,26 @@
+from rapidata.api_client.models.age_group import AgeGroup as BackendAgeGroupModel
+from enum import Enum
+
+class AgeGroup(Enum):
+    """AgeGroup Enum
+    
+    Represents the age group of a user. Used to filter who to target based on age groups.
+    
+    Attributes:
+        UNDER_18 (AgeGroup): Represents the age group of users under 18.
+        BETWEEN_18_29 (AgeGroup): Represents the age group of users between 18 and 29.
+        BETWEEN_30_39 (AgeGroup): Represents the age group of users between 30 and 39.
+        BETWEEN_40_49 (AgeGroup): Represents the age group of users between 40 and 49.
+        BETWEEN_50_64 (AgeGroup): Represents the age group of users between 50 and 64.
+        OVER_65 (AgeGroup): Represents the age group of users over 65."""
+    
+    UNDER_18 = BackendAgeGroupModel.ENUM_0_MINUS_17
+    BETWEEN_18_29 = BackendAgeGroupModel.ENUM_18_MINUS_29
+    BETWEEN_30_39 = BackendAgeGroupModel.ENUM_30_MINUS_39
+    BETWEEN_40_49 = BackendAgeGroupModel.ENUM_40_MINUS_49
+    BETWEEN_50_64 = BackendAgeGroupModel.ENUM_50_MINUS_64
+    OVER_65 = BackendAgeGroupModel.ENUM_65_PLUS
+
+    def _to_backend_model(self) -> BackendAgeGroupModel:
+        return BackendAgeGroupModel(self.value)
+

rapidata/rapidata_client/filter/models/gender.py

@@ -0,0 +1,19 @@
+from enum import Enum
+from rapidata.api_client.models.gender import Gender as BackendGenderModel
+
+class Gender(Enum):
+    """Gender Enum
+    
+    Represents the gender of a user. Used to filter who to target based on genders.
+    
+    Attributes:
+        MALE (Gender): Represents the Male gender.
+        FEMALE (Gender): Represents the Female gender.
+        OTHER (Gender): Represents any other gender.
+    """
+    MALE = BackendGenderModel.MALE
+    FEMALE = BackendGenderModel.FEMALE
+    OTHER = BackendGenderModel.OTHER
+
+    def _to_backend_model(self) -> BackendGenderModel:
+        return BackendGenderModel(self.value)

rapidata/rapidata_client/filter/rapidata_filters.py

@@ -0,0 +1,35 @@
+from rapidata.rapidata_client.filter import (
+    AgeFilter, 
+    CampaignFilter, 
+    CountryFilter, 
+    GenderFilter, 
+    LanguageFilter, 
+    UserScoreFilter,
+    CustomFilter)
+
+class RapidataFilters:
+    """RapidataFilters Classes
+
+    These filters can be added to the order to specifically target a certain group of users.
+
+    Note that adding multiple filters to the same order will result in a logical AND operation between the filters.
+
+    Warning: this might significantly slow down the number of responses you receive.
+    
+    Attributes:
+        user_score (UserScoreFilter): The UserScoreFilter instance.
+        age (AgeFilter): The AgeFilter instance.
+        campaign (CampaignFilter): The CampaignFilter instance.
+        country (CountryFilter): The CountryFilter instance.
+        campaign (CampaignFilter): The CampaignFilter instance
+        gender (GenderFilter): The GenderFilter 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/rapidata_client/filter/user_score_filter.py

@@ -1,17 +1,33 @@
 from typing import Any
-from rapidata.rapidata_client.filter.base_filter import Filter
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
 from rapidata.api_client.models.user_score_user_filter_model import (
     UserScoreUserFilterModel,
 )
 
 
-class UserScoreFilter(Filter):
+class UserScoreFilter(RapidataFilter):
+    """UserScoreFilter Class
+    
+    Can be used to filter who to target based on their user score.
+    
+    example: UserScoreFilter(0.5, 0.9) -> will only show the order to users that have a UserScore of >=0.5 and <=0.9
 
-    def __init__(self, lower_bound: int = 0, upper_bound: int = 1):
+    Args:
+        lower_bound (float): The lower bound of the user score.
+        upper_bound (float): The upper bound of the user score.
+    """
+    def __init__(self, lower_bound: float = 0.0, upper_bound: float = 1.0):
+        if lower_bound < 0 or lower_bound > 1:
+            raise ValueError("The lower bound must be between 0 and 1.")
+        if upper_bound < 0 or upper_bound > 1:
+            raise ValueError("The upper bound must be between 0 and 1.")
+        if lower_bound >= upper_bound:
+            raise ValueError("The lower bound must be less than the upper bound.")
+        
         self.upper_bound = upper_bound
         self.lower_bound = lower_bound
 
-    def to_model(self):
+    def _to_model(self):
         return UserScoreUserFilterModel(
             _t="UserScoreFilter",
             upperbound=self.upper_bound,

rapidata/rapidata_client/metadata/__init__.py

@@ -1,5 +1,5 @@
-from .base_metadata import Metadata
-from .private_text_metadata import PrivateTextMetadata
-from .public_text_metadata import PublicTextMetadata
-from .prompt_metadata import PromptMetadata
-from .select_words_metadata import SelectWordsMetadata
+from ._base_metadata import Metadata
+from ._private_text_metadata import PrivateTextMetadata
+from ._public_text_metadata import PublicTextMetadata
+from ._prompt_metadata import PromptMetadata
+from ._select_words_metadata import SelectWordsMetadata

rapidata/rapidata_client/metadata/{base_metadata.py → _base_metadata.py}

@@ -3,10 +3,11 @@ from typing import Any
 
 
 class Metadata:
+    """The base class for all Rapidata Metadata."""
 
     def __init__(self, identifier: str):
         self._identifier = identifier
 
     @abstractmethod
-    def to_model(self) -> Any:
+    def _to_model(self) -> Any:
         pass