rapidata 2.38.0__py3-none-any.whl → 2.39.0__py3-none-any.whl

rapidata/rapidata_client/datapoints/assets/_base_asset.py

@@ -3,9 +3,11 @@
 Defines the BaseAsset class, which serves as the abstract base class for all asset types.
 """
 
+
 class BaseAsset:
     """BaseAsset Class
 
     An abstract base class for different types of assets. This class is intended to be subclassed by specific asset types.
     """
+
     pass

rapidata/rapidata_client/datapoints/assets/_text_asset.py

@@ -24,11 +24,11 @@ class TextAsset(BaseAsset):
         """
         if not isinstance(text, str):
             raise ValueError(f"Text must be a string, got {type(text)}")
-        
+
         self.text = text
 
     def __str__(self) -> str:
         return f"TextAsset(text={self.text})"
-    
+
     def __repr__(self) -> str:
         return f"TextAsset(text={self.text})"

rapidata/rapidata_client/datapoints/assets/data_type_enum.py

@@ -1,6 +1,6 @@
 class RapidataDataTypes:
     # deprecated use Literal["media", "text"] instead
-    MEDIA = "media" # any form of image, video or audio
+    MEDIA = "media"  # any form of image, video or audio
     TEXT = "text"
 
     @classmethod

rapidata/rapidata_client/datapoints/metadata/_media_asset_metadata.py

@@ -1,7 +1,11 @@
-from rapidata.api_client.models.prompt_asset_metadata_input import PromptAssetMetadataInput
+from rapidata.api_client.models.prompt_asset_metadata_input import (
+    PromptAssetMetadataInput,
+)
 from rapidata.api_client.models.url_asset_input import UrlAssetInput
 from rapidata.rapidata_client.datapoints.metadata._base_metadata import Metadata
-from rapidata.api_client.models.prompt_asset_metadata_input_asset import PromptAssetMetadataInputAsset
+from rapidata.api_client.models.prompt_asset_metadata_input_asset import (
+    PromptAssetMetadataInputAsset,
+)
 
 
 class MediaAssetMetadata(Metadata):
@@ -12,11 +16,8 @@ class MediaAssetMetadata(Metadata):
 
     def to_model(self):
         return PromptAssetMetadataInput(
-            _t="PromptAssetMetadataInput", 
+            _t="PromptAssetMetadataInput",
             asset=PromptAssetMetadataInputAsset(
-                actual_instance=UrlAssetInput(
-                    _t="UrlAssetInput", 
-                    url=self._url
-                )
-            )
+                actual_instance=UrlAssetInput(_t="UrlAssetInput", url=self._url)
+            ),
         )

rapidata/rapidata_client/datapoints/metadata/_prompt_metadata.py

@@ -10,9 +10,8 @@ class PromptMetadata(Metadata):
 
         if not isinstance(prompt, str):
             raise ValueError("Prompt must be a string")
-        
+
         self._prompt = prompt
-    
 
     def to_model(self):
         return PromptMetadataInput(_t="PromptMetadataInput", prompt=self._prompt)

rapidata/rapidata_client/filter/models/age_group.py

@@ -1,11 +1,12 @@
 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.
@@ -13,7 +14,7 @@ class AgeGroup(Enum):
         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
@@ -23,4 +24,3 @@ class AgeGroup(Enum):
 
     def _to_backend_model(self) -> BackendAgeGroupModel:
         return BackendAgeGroupModel(self.value)
-

rapidata/rapidata_client/filter/models/gender.py

@@ -1,16 +1,18 @@
 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

rapidata/rapidata_client/filter/rapidata_filters.py

@@ -1,12 +1,14 @@
 from rapidata.rapidata_client.filter import (
-    AgeFilter, 
-    CountryFilter, 
-    GenderFilter, 
-    LanguageFilter, 
+    AgeFilter,
+    CountryFilter,
+    GenderFilter,
+    LanguageFilter,
     UserScoreFilter,
     NotFilter,
     OrFilter,
-    AndFilter)
+    AndFilter,
+)
+
 
 class RapidataFilters:
     """RapidataFilters Classes
@@ -15,9 +17,9 @@ class RapidataFilters:
 
     Note that adding multiple filters to the same order will result in a logical AND operation between the filters.
 
-    Warning: 
+    Warning:
         This might significantly slow down the number of responses you receive.
-    
+
     Attributes:
         user_score (UserScoreFilter): Filters for users with a specific user score.
         age (AgeFilter): Filters for users with a specific age.
@@ -36,7 +38,7 @@ class RapidataFilters:
 
         This ensures the order is only shown to users in the US and Germany whose phones are set to English.
 
-    Info:        
+    Info:
         The OR, AND and NOT filter support the |, & and ~ operators respectively.
         The AND is additionally given by the elements in the list.
 
@@ -47,8 +49,9 @@ class RapidataFilters:
 
         This would return users who are not under 18 years old and are from the US or who are from Canada and whose phones are set to English.
     """
+
     user_score = UserScoreFilter
-    age = AgeFilter 
+    age = AgeFilter
     country = CountryFilter
     gender = GenderFilter
     language = LanguageFilter

rapidata/rapidata_client/referee/__init__.py

@@ -1,3 +1,3 @@
 from ._base_referee import Referee
-from ._naive_referee import NaiveReferee #as MaxVoteReferee
+from ._naive_referee import NaiveReferee  # as MaxVoteReferee
 from ._early_stopping_referee import EarlyStoppingReferee

rapidata/rapidata_client/referee/_base_referee.py

@@ -1,10 +1,12 @@
 from abc import ABC, abstractmethod
 from typing import Any, Mapping
 
+
 class Referee(ABC):
     """
-    The referee defines when a rapid is considered complete. 
+    The referee defines when a rapid is considered complete.
     """
+
     @abstractmethod
     def _to_dict(self) -> Mapping[str, str | int | float]:
         """

rapidata/rapidata_client/referee/_early_stopping_referee.py

@@ -15,7 +15,7 @@ class EarlyStoppingReferee(Referee):
     The threshold behaves logarithmically, meaning small increments (e.g., from 0.99
     to 0.999) can significantly impact the stopping criteria.
 
-    This referee is supported for the classification and compare tasks (in compare, 
+    This referee is supported for the classification and compare tasks (in compare,
     the two options are treated as the categories).
 
     Args:
@@ -34,7 +34,7 @@ class EarlyStoppingReferee(Referee):
             raise ValueError("The threshold must be between 0 and 1.")
         if max_vote_count < 1:
             raise ValueError("The number of responses must be greater than 0.")
-        
+
         self.threshold = threshold
         self.max_vote_count = max_vote_count
 

rapidata/rapidata_client/selection/ab_test_selection.py

@@ -10,17 +10,21 @@ from typing import Sequence
 
 class AbTestSelection(RapidataSelection):
     """AbTestSelection Class
-    
+
     Splits the userbase into two segments and serves them a different collection of rapids.
 
     Useful for A/B Test.
-    
+
     Args:
         a_selections (Sequence[RapidataSelection]): List of selections for group A.
         b_selections (Sequence[RapidataSelection]): List of selections for group B.
     """
 
-    def __init__(self, a_selections: Sequence[RapidataSelection], b_selections: Sequence[RapidataSelection]):
+    def __init__(
+        self,
+        a_selections: Sequence[RapidataSelection],
+        b_selections: Sequence[RapidataSelection],
+    ):
         self.a_selections = a_selections
         self.b_selections = b_selections
 

rapidata/rapidata_client/selection/capped_selection.py

@@ -12,9 +12,9 @@ class CappedSelection(RapidataSelection):
     """CappedSelection Class
 
     Takes in different selections and caps the amount of rapids that can be shown.
-    
+
     Useful for demographic and conditional validation selections.
-    
+
     Args:
         selections (Sequence[RapidataSelection]): List of selections to cap.
         max_rapids (int): The maximum amount of rapids that can be shown for this selection.

rapidata/rapidata_client/selection/conditional_validation_selection.py

@@ -1,3 +1,4 @@
+from rapidata.rapidata_client.config.logger import logger
 from rapidata.rapidata_client.selection._base_selection import RapidataSelection
 from rapidata.api_client.models.conditional_validation_rapid_selection_config import (
     ValidationChance,
@@ -12,13 +13,13 @@ class ConditionalValidationSelection(RapidataSelection):
     """Conditional validation selection class.
 
     Probabilistically decides how many validation rapids you want to show per session based on the user score.
-    
+
     Args:
         validation_set_id (str): The id of the validation set to be used.
         thresholds (list[float]): The thresholds to use for the user score.
         chances (list[float]): The chances of showing a validation rapid for each threshold.
         rapid_counts (list[int]): The amount of validation rapids that will be shown per session of this validation set for each threshold if selected by probability. (all or nothing)
-        dimension (Optional[str], optional): The dimension of the userScore that will be used in the thresholds. Defaults to None.
+        dimensions (Optional[list[str]], optional): The dimensions of the userScore that will be used in the thresholds. Defaults to None.
 
     Example:
         ```python
@@ -29,7 +30,7 @@ class ConditionalValidationSelection(RapidataSelection):
             rapid_counts=[1, 1]
         )
         ```
-        This means that there's a 100% chance of showing a validation rapid if the user score is between 0 and 0.7, 
+        This means that there's a 100% chance of showing a validation rapid if the user score is between 0 and 0.7,
         and a 20% chance of showing a validation rapid if the user score is between 0.7 and 1.
     """
 
@@ -40,17 +41,22 @@ class ConditionalValidationSelection(RapidataSelection):
         chances: list[float],
         rapid_counts: list[int],
         dimension: Optional[str] = None,
+        dimensions: Optional[list[str]] = None,
     ):
         if len(thresholds) != len(chances) or len(thresholds) != len(rapid_counts):
             raise ValueError(
                 "The lengths of thresholds, chances and rapid_counts must be equal."
             )
-        
+
+        if dimension:
+            logger.warning("dimension is deprecated, use dimensions instead")
+            dimensions = (dimensions or []) + [dimension]
+
         self.validation_set_id = validation_set_id
         self.thresholds = thresholds
         self.chances = chances
         self.rapid_counts = rapid_counts
-        self.dimension = dimension
+        self.dimensions = dimensions
 
     def _to_model(self):
         return ConditionalValidationSelectionModel(
@@ -64,5 +70,5 @@ class ConditionalValidationSelection(RapidataSelection):
                     self.thresholds, self.chances, self.rapid_counts
                 )
             ],
-            dimension=self.dimension,
+            dimensions=self.dimensions,
         )

rapidata/rapidata_client/selection/demographic_selection.py

@@ -1,11 +1,13 @@
 from rapidata.rapidata_client.selection._base_selection import RapidataSelection
-from rapidata.api_client.models.demographic_selection import DemographicSelection as DemographicSelectionModel
+from rapidata.api_client.models.demographic_selection import (
+    DemographicSelection as DemographicSelectionModel,
+)
 
 
 class DemographicSelection(RapidataSelection):
     """Demographic selection class.
-    
-    This is used to ask demographic questions in an order.    
+
+    This is used to ask demographic questions in an order.
 
     The keys will select the rapids based on the confidence we already saved for each user.
 
@@ -15,7 +17,7 @@ class DemographicSelection(RapidataSelection):
         keys (list[str]): List of keys for the demographic rapids to be shown. As an example: "age"
         max_rapids (int): The maximum number of rapids to run.\n
             Allows to provide more keys, in case some of the earlier ones are not selected because of high confidence.
-                 
+
     Example:
         ```python
         DemographicSelection(["age", "gender"], 1)
@@ -23,11 +25,12 @@ class DemographicSelection(RapidataSelection):
         This will try to ask the user about their age, if that is not selected due to an already high confidence, it will try asking about their gender.
         The gender question may also be skipped if the confidence is high enough.
     """
-    
 
     def __init__(self, keys: list[str], max_rapids: int):
         self.keys = keys
         self.max_rapids = max_rapids
 
     def _to_model(self):
-        return DemographicSelectionModel(_t="DemographicSelection", keys=self.keys, maxRapids=self.max_rapids)
+        return DemographicSelectionModel(
+            _t="DemographicSelection", keys=self.keys, maxRapids=self.max_rapids
+        )

rapidata/rapidata_client/selection/rapidata_selections.py

@@ -1,15 +1,17 @@
 from rapidata.rapidata_client.selection import (
-    DemographicSelection, 
-    LabelingSelection, 
-    ValidationSelection, 
-    ConditionalValidationSelection, 
+    DemographicSelection,
+    LabelingSelection,
+    ValidationSelection,
+    ConditionalValidationSelection,
     CappedSelection,
-    ShufflingSelection)
+    ShufflingSelection,
+)
+
 
 class RapidataSelections:
     """RapidataSelections Classes
 
-    Selections are used to define what type of tasks and in what order they are shown to the user. 
+    Selections are used to define what type of tasks and in what order they are shown to the user.
     All selections combined are called a "Session". A session can contain multiple tasks of different types of tasks.
     As an example, a session might be 1 validation task, 2 labeling tasks.
 
@@ -20,16 +22,17 @@ class RapidataSelections:
         demographic (DemographicSelection): Decides if and how many demographic questions you want to show per session.
         capped (CappedSelection): Takes in different selections and caps the amount of rapids that can be shown.
         shuffling (ShufflingSelection): Shuffles the selections provided in the list.
-    
+
     Example:
         ```python
         from rapidata import LabelingSelection, ValidationSelection
-        selections=[ValidationSelection("your-validation-set-id", 1), 
+        selections=[ValidationSelection("your-validation-set-id", 1),
                     LabelingSelection(2)]
         ```
 
         This will require annotators to complete one validation task followed by two labeling tasks.
     """
+
     labeling = LabelingSelection
     validation = ValidationSelection
     conditional_validation = ConditionalValidationSelection

rapidata/rapidata_client/selection/shuffling_selection.py

@@ -1,6 +1,7 @@
-
 from rapidata.api_client.models.ab_test_selection_a_inner import AbTestSelectionAInner
-from rapidata.api_client.models.shuffling_selection import ShufflingSelection as ShufflingSelectionModel
+from rapidata.api_client.models.shuffling_selection import (
+    ShufflingSelection as ShufflingSelectionModel,
+)
 from rapidata.rapidata_client.selection._base_selection import RapidataSelection
 
 from typing import Sequence
@@ -10,7 +11,7 @@ class ShufflingSelection(RapidataSelection):
     """ShufflingSelection Class
 
     Shuffles the selections provided in the list.
-    
+
     Args:
         selections (Sequence[RapidataSelection]): List of selections to shuffle.
 
@@ -31,6 +32,5 @@ class ShufflingSelection(RapidataSelection):
             selections=[
                 AbTestSelectionAInner(selection._to_model())
                 for selection in self.selections
-            ]
+            ],
         )
-    

rapidata/rapidata_client/selection/validation_selection.py

@@ -1,5 +1,6 @@
-
-from rapidata.api_client.models.validation_selection import ValidationSelection as ValidationSelectionModel
+from rapidata.api_client.models.validation_selection import (
+    ValidationSelection as ValidationSelectionModel,
+)
 from rapidata.rapidata_client.selection._base_selection import RapidataSelection
 
 
@@ -7,7 +8,7 @@ class ValidationSelection(RapidataSelection):
     """Validation selection class.
 
     Decides how many validation rapids you want to show per session.
-    
+
     Args:
         validation_set_id (str): The id of the validation set to be used.
         amount (int): The amount of validation rapids that will be shown per session of this validation set.
@@ -18,5 +19,8 @@ class ValidationSelection(RapidataSelection):
         self.amount = amount
 
     def _to_model(self):
-        return ValidationSelectionModel(_t="ValidationSelection", validationSetId=self.validation_set_id, amount=self.amount)
-    
+        return ValidationSelectionModel(
+            _t="ValidationSelection",
+            validationSetId=self.validation_set_id,
+            amount=self.amount,
+        )

rapidata/rapidata_client/settings/allow_neither_both.py

@@ -1,5 +1,6 @@
 from rapidata.rapidata_client.settings._rapidata_setting import RapidataSetting
 
+
 class AllowNeitherBoth(RapidataSetting):
     """
     Set whether to allow neither or both options.

rapidata/rapidata_client/settings/custom_setting.py

@@ -1,9 +1,10 @@
 from rapidata.rapidata_client.settings._rapidata_setting import RapidataSetting
 
+
 class CustomSetting(RapidataSetting):
     """
     Set a custom setting with the given key and value. Use this to enable features that do not have a dedicated method (yet)
-    
+
     Args:
         key (str): The key for the custom setting.
         value (str): The value for the custom setting.
@@ -12,5 +13,5 @@ class CustomSetting(RapidataSetting):
     def __init__(self, key: str, value: str):
         if not isinstance(key, str):
             raise ValueError("The key must be a string.")
-        
+
         super().__init__(key=key, value=value)

rapidata/rapidata_client/settings/models/translation_behaviour_options.py

@@ -1,14 +1,15 @@
 from enum import Enum
 
+
 class TranslationBehaviourOptions(Enum):
     """The options for the translation behaviour setting.
-    
+
     Attributes:
         BOTH: Show both the original and the translated text.
             May clutter the screen if the options are too long.
         ONLY_ORIGINAL: Show only the original text.
         ONLY_TRANSLATED: Show only the translated text."""
-    
+
     BOTH = "both"
     ONLY_ORIGINAL = "only original"
     ONLY_TRANSLATED = "only translated"

rapidata/rapidata_client/settings/no_shuffle.py

@@ -1,16 +1,18 @@
 from rapidata.rapidata_client.settings._rapidata_setting import RapidataSetting
 
+
 class NoShuffle(RapidataSetting):
     """
     Only for classification and compare tasks. If true, the order of the categories / images will not be shuffled and presented in the same order as specified.
 
     If this is not added to the order, the shuffling will be active.
-    
+
     Args:
         value (bool, optional): Whether to disable shuffling. Defaults to True for function call.
     """
+
     def __init__(self, value: bool = True):
         if not isinstance(value, bool):
             raise ValueError("The value must be a boolean.")
-        
+
         super().__init__(key="no_shuffle", value=value)

rapidata/rapidata_client/settings/play_video_until_the_end.py

@@ -1,16 +1,19 @@
 from rapidata.rapidata_client.settings._rapidata_setting import RapidataSetting
 
+
 class PlayVideoUntilTheEnd(RapidataSetting):
     """
     Allows users to only answer once the video has finished playing.
     The additional time gets added on top of the video duration. Can be negative to allow answers before the video ends.
-    
+
     Args:
         additional_time (int, optional): Additional time in milliseconds. Defaults to 0.
     """
-    
+
     def __init__(self, additional_time: int = 0):
         if additional_time < -25000 or additional_time > 25000:
             raise ValueError("The additional time must be between -25000 and 25000.")
-        
-        super().__init__(key="alert_on_fast_response_add_media_duration", value=additional_time)
+
+        super().__init__(
+            key="alert_on_fast_response_add_media_duration", value=additional_time
+        )

rapidata/rapidata_client/settings/rapidata_settings.py

@@ -5,14 +5,15 @@ from rapidata.rapidata_client.settings import (
     NoShuffle,
     PlayVideoUntilTheEnd,
     AllowNeitherBoth,
-    )
+)
+
 
 class RapidataSettings:
     """
     Container class for all setting factory functions
 
     Settings can be added to an order to determine the behaviour of the task.
-    
+
     Attributes:
         alert_on_fast_response (AlertOnFastResponse): Gives an alert as a pop up on the UI when the response time is less than the milliseconds.
         translation_behaviour (TranslationBehaviour): Defines what's the behaviour of the translation in the UI.
@@ -27,7 +28,7 @@ class RapidataSettings:
         settings=[FreeTextMinimumCharacters(10)]
         ```
 
-        This can be used in a free text order to set the minimum number of characters required to submit the task. 
+        This can be used in a free text order to set the minimum number of characters required to submit the task.
     """
 
     alert_on_fast_response = AlertOnFastResponse

rapidata/rapidata_client/settings/translation_behaviour.py

@@ -1,18 +1,20 @@
-from rapidata.rapidata_client.settings.models.translation_behaviour_options import TranslationBehaviourOptions
+from rapidata.rapidata_client.settings.models.translation_behaviour_options import (
+    TranslationBehaviourOptions,
+)
 from rapidata.rapidata_client.settings._rapidata_setting import RapidataSetting
 
+
 class TranslationBehaviour(RapidataSetting):
     """
     Defines what's the behaviour of the translation in the UI.
     Will not translate text datapoints or sentences.
-    
+
     Args:
         value (TranslationBehaviourOptions): The translation behaviour.
     """
-    
+
     def __init__(self, value: TranslationBehaviourOptions):
         if not isinstance(value, TranslationBehaviourOptions):
             raise ValueError("The value must be a TranslationBehaviourOptions.")
-        
-        super().__init__(key="translation_behaviour", value=value)
 
+        super().__init__(key="translation_behaviour", value=value)

rapidata/rapidata_client/validation/rapidata_validation_set.py

@@ -4,7 +4,9 @@ from colorama import Fore
 from rapidata.rapidata_client.validation.rapids.rapids import Rapid
 from rapidata.service.openapi_service import OpenAPIService
 from rapidata.rapidata_client.config import logger, managed_print, tracer
-from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsModel
+from rapidata.api_client.models.update_validation_set_model import (
+    UpdateValidationSetModel,
+)
 from rapidata.api_client.models.update_should_alert_model import UpdateShouldAlertModel
 
 
@@ -49,8 +51,8 @@ class RapidataValidationSet:
             logger.debug(
                 "Updating dimensions for validation set %s to %s", self.id, dimensions
             )
-            self.__openapi_service.validation_api.validation_set_validation_set_id_dimensions_put(
-                self.id, UpdateDimensionsModel(dimensions=dimensions)
+            self.__openapi_service.validation_api.validation_set_validation_set_id_patch(
+                self.id, UpdateValidationSetModel(dimensions=dimensions)
             )
             return self
 
@@ -67,8 +69,8 @@ class RapidataValidationSet:
             logger.debug(
                 "Setting shouldAlert for validation set %s to %s", self.id, should_alert
             )
-            self.__openapi_service.validation_api.validation_set_validation_set_id_shouldalert_patch(
-                self.id, UpdateShouldAlertModel(shouldAlert=should_alert)
+            self.__openapi_service.validation_api.validation_set_validation_set_id_patch(
+                self.id, UpdateValidationSetModel(shouldAlert=should_alert)
             )
             return self