rapidata 1.5.0__tar.gz → 1.6.1__tar.gz

{rapidata-1.5.0 → rapidata-1.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rapidata
-Version: 1.5.0
+Version: 1.6.1
 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
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: deprecated (>=1.2.14,<2.0.0)
 Requires-Dist: pillow (>=10.4.0,<11.0.0)
 Requires-Dist: pydantic (>=2.8.2,<3.0.0)
 Requires-Dist: pyjwt (>=2.9.0,<3.0.0)

{rapidata-1.5.0 → rapidata-1.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rapidata"
-version = "1.5.0"
+version = "1.6.1"
 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"
@@ -15,6 +15,7 @@ pillow = "^10.4.0"
 pydantic = "^2.8.2"
 python-dateutil = "^2.9.0.post0"
 tqdm = "^4.66.5"
+deprecated = "^1.2.14"
 
 
 [tool.poetry.group.dev.dependencies]

{rapidata-1.5.0 → rapidata-1.6.1}/src/rapidata/__init__.py

@@ -15,7 +15,8 @@ from .rapidata_client import (
     PublicTextMetadata,
     PromptMetadata,
     TranscriptionMetadata,
-    FeatureFlags,
+    Settings,
+    FeatureFlags, # remove next major version
     CountryCodes,
     MediaAsset,
     TextAsset,

{rapidata-1.5.0 → rapidata-1.6.1}/src/rapidata/rapidata_client/__init__.py

@@ -19,7 +19,7 @@ from .metadata import (
     PromptMetadata,
     TranscriptionMetadata,
 )
-from .feature_flags import FeatureFlags
+from .settings import Settings, FeatureFlags # remove FeatureFlags next major version
 from .country_codes import CountryCodes
 from .assets import MediaAsset, TextAsset, MultiAsset
 from .filter import (

{rapidata-1.5.0 → rapidata-1.6.1}/src/rapidata/rapidata_client/order/rapidata_order.py

@@ -3,7 +3,7 @@ from rapidata.rapidata_client.dataset.rapidata_dataset import RapidataDataset
 from rapidata.service.openapi_service import OpenAPIService
 import json
 from rapidata.api_client.exceptions import ApiException
-from typing import Optional, cast
+from typing import Optional, cast, Any
 from rapidata.api_client.models.workflow_artifact_model import WorkflowArtifactModel
 from tqdm import tqdm
 
@@ -11,12 +11,11 @@ class RapidataOrder:
     """
     Represents a Rapidata order.
 
-    :param name: The name of the order.
-    :type name: str
-    :param workflow: The workflow associated with the order.
-    :type workflow: Workflow
-    :param rapidata_service: The Rapidata service used to create and manage the order.
-    :type rapidata_service: RapidataService
+    Args:
+        The ID of the order.
+        The optional Dataset associated with the order.
+        The OpenAPIService instance used to interact with the Rapidata API.
+        The name of the order.
     """
 
     def __init__(
@@ -36,30 +35,23 @@ class RapidataOrder:
         """
         Submits the order for processing.
         """
-
         self.openapi_service.order_api.order_submit_post(self.order_id)
 
-    def approve(self):
-        """
-        Approves the order for execution.
-        """
-        self.openapi_service.order_api.order_approve_post(self.order_id)
-
-    def get_status(self):
+    def get_status(self) -> str:
         """
         Gets the status of the order.
-
-        :return: The status of the order.
-        :rtype: str
+        
+        Returns: 
+            The status of the order.
         """
-        return self.openapi_service.order_api.order_get_by_id_get(self.order_id)
+        return self.openapi_service.order_api.order_get_by_id_get(self.order_id).state
 
     def display_progress_bar(self, refresh_rate=5):
         """
         Displays a progress bar for the order processing using tqdm.
         
-        :param refresh_rate: How often to refresh the progress bar, in seconds.
-        :type refresh_rate: float
+        Prameter: 
+            How often to refresh the progress bar, in seconds.
         """
         total_rapids = self._get_workflow_progress().total
         with tqdm(total=total_rapids, desc="Processing order", unit="rapids") as pbar:
@@ -107,15 +99,15 @@ class RapidataOrder:
         return progress
 
         
-    def get_results(self):
+    def get_results(self) -> dict[str, Any]:
         """
         Gets the results of the order. 
         If the order is still processing, this method will block until the order is completed and then return the results.
 
-        :return: The results of the order.
-        :rtype: dict
+        Returns: 
+            The results of the order.
         """
-        while self.get_status().state == "Processing":
+        while self.get_status() == "Processing":
             sleep(5)
 
         try:
@@ -131,10 +123,10 @@ class RapidataOrder:
             raise Exception(f"Failed to parse order results: {str(e)}") from e
 
     @property
-    def dataset(self):
+    def dataset(self) -> RapidataDataset | None:
         """
         The dataset associated with the order.
-        :return: The RapidataDataset instance.
-        :rtype: RapidataDataset
+        Returns: 
+            The RapidataDataset instance.
         """
         return self._dataset

{rapidata-1.5.0 → rapidata-1.6.1}/src/rapidata/rapidata_client/order/rapidata_order_builder.py

@@ -14,11 +14,7 @@ from rapidata.api_client.models.create_order_model_user_filters_inner import (
 from rapidata.api_client.models.create_order_model_workflow import (
     CreateOrderModelWorkflow,
 )
-from rapidata.api_client.models.country_user_filter_model import CountryUserFilterModel
-from rapidata.api_client.models.language_user_filter_model import (
-    LanguageUserFilterModel,
-)
-from rapidata.rapidata_client.feature_flags import FeatureFlags
+from rapidata.rapidata_client.settings import FeatureFlags, Settings
 from rapidata.rapidata_client.metadata.base_metadata import Metadata
 from rapidata.rapidata_client.dataset.rapidata_dataset import RapidataDataset
 from rapidata.rapidata_client.referee.naive_referee import NaiveReferee
@@ -35,6 +31,8 @@ from rapidata.rapidata_client.assets import MediaAsset, TextAsset, MultiAsset
 
 from typing import Optional, cast, Sequence
 
+from deprecated import deprecated
+
 
 class RapidataOrderBuilder:
     """Builder object for creating Rapidata orders.
@@ -66,7 +64,7 @@ class RapidataOrderBuilder:
         self._metadata: list[Metadata] | None = None
         self._aggregator: AggregatorType | None = None
         self._validation_set_id: str | None = None
-        self._feature_flags: FeatureFlags | None = None
+        self._settings: Settings | FeatureFlags | None = None # remove featureflag next big release
         self._user_filters: list[Filter] = []
         self._selections: list[Selection] = []
         self._rapids_per_bag: int = 2
@@ -101,8 +99,8 @@ class RapidataOrderBuilder:
             referee=CreateOrderModelReferee(self._referee.to_model()),
             validationSetId=self._validation_set_id,
             featureFlags=(
-                self._feature_flags.to_list()
-                if self._feature_flags is not None
+                self._settings.to_list()
+                if self._settings is not None
                 else None
             ),
             selections=[
@@ -269,6 +267,26 @@ class RapidataOrderBuilder:
         self._metadata = metadata  # type: ignore
         return self
 
+    def settings(self, settings: Settings) -> "RapidataOrderBuilder":
+        """
+        Set the settings for the order.
+
+        Args:
+            settings (Settings): The settings to be set.
+
+        Returns:
+            RapidataOrderBuilder: The updated RapidataOrderBuilder instance.
+        """
+        if not isinstance(settings, Settings):
+            raise TypeError("Settings must be of type Settings.")
+
+        self._settings = settings
+        return self
+
+    @deprecated(
+        version="1.6.0",
+        reason="The feature_flags method is deprecated, use settings instead.",
+    )
     def feature_flags(self, feature_flags: FeatureFlags) -> "RapidataOrderBuilder":
         """
         Set the feature flags for the order.
@@ -282,7 +300,7 @@ class RapidataOrderBuilder:
         if not isinstance(feature_flags, FeatureFlags):
             raise TypeError("Feature flags must be of type FeatureFlags.")
 
-        self._feature_flags = feature_flags
+        self._settings = feature_flags
         return self
 
     def filters(self, filters: Sequence[Filter]) -> "RapidataOrderBuilder":

{rapidata-1.5.0 → rapidata-1.6.1}/src/rapidata/rapidata_client/rapidata_client.py

@@ -3,7 +3,6 @@ from rapidata.rapidata_client.dataset.rapidata_validation_set import (
 )
 from rapidata.rapidata_client.dataset.validation_set_builder import ValidationSetBuilder
 from rapidata.rapidata_client.order.rapidata_order_builder import RapidataOrderBuilder
-from rapidata.rapidata_client.utils.utils import Utils
 from rapidata.service.openapi_service import OpenAPIService
 from rapidata.rapidata_client.order.rapidata_order import RapidataOrder
 from rapidata.rapidata_client.dataset.rapidata_dataset import RapidataDataset
@@ -178,12 +177,3 @@ class RapidataClient:
             CompareQuestionBuilder: A CompareQuestionBuilder instance.
         """
         return CompareCriteriaBuilder(name=name, openapi_service=self.openapi_service)
-
-    @property
-    def utils(self) -> Utils:
-        """Get the Utils instance.
-
-        Returns:
-            Utils: The Utils instance associated with this client.
-        """
-        return Utils(openapi_service=self.openapi_service)

{rapidata-1.5.0/src/rapidata/rapidata_client/feature_flags → rapidata-1.6.1/src/rapidata/rapidata_client/settings}/__init__.py

@@ -1 +1,2 @@
 from .feature_flags import FeatureFlags
+from .settings import Settings

{rapidata-1.5.0/src/rapidata/rapidata_client/feature_flags → rapidata-1.6.1/src/rapidata/rapidata_client/settings}/feature_flags.py

@@ -1,12 +1,13 @@
 from rapidata.api_client.models.feature_flag_model import FeatureFlagModel
 from enum import Enum
+from deprecated import deprecated
 
 class TranslationBehaviour(Enum):
     BOTH = "both"
     ONLY_ORIGINAL = "only original"
     ONLY_TRANSLATED = "only translated"
 
-
+@deprecated(version="1.6.0", reason="Use the Settings class instead.")
 class FeatureFlags:
     """A class to manage feature flags.
 
@@ -17,6 +18,7 @@ class FeatureFlags:
         _flags (dict[str, str]): A dictionary to store feature flags.
     """
 
+    @deprecated(version="1.6.0", reason="Use the Settings class instead.")
     def __init__(self):
         """Initialize the FeatureFlags object with an empty flags dictionary."""
         self._flags: dict[str, str] = {}

rapidata-1.6.1/src/rapidata/rapidata_client/settings/settings.py

@@ -0,0 +1,123 @@
+from rapidata.api_client.models.feature_flag_model import FeatureFlagModel
+from enum import Enum
+
+class TranslationBehaviour(Enum):
+    BOTH = "both"
+    ONLY_ORIGINAL = "only original"
+    ONLY_TRANSLATED = "only translated"
+
+
+class Settings:
+    """A class to manage settings.
+
+    This class provides methods to set and manage various settings
+    used in the application.
+
+    Attributes:
+        _settings (dict[str, str]): A dictionary to store settings.
+    """
+
+    def __init__(self):
+        """Initialize the Settings object with an empty flags dictionary."""
+        self._settings: dict[str, str] = {}
+
+    def to_list(self) -> list[FeatureFlagModel]:
+        """Convert the settings to a list of FeatureFlagModel objects.
+
+        Returns:
+            list[FeatureFlagModel]: A list of FeatureFlagModel objects
+                representing the current settings.
+        """
+        return [
+            FeatureFlagModel(key=name, value=value)
+            for name, value in self._settings.items()
+        ]
+
+    def alert_on_fast_response(self, milliseconds: int):
+        """Gives an alert as a pop up on the UI when the response time is less than the threshold.
+
+        Args:
+            milliseconds (int): if the user responds in less than this time, an alert will be shown.
+
+        Returns:
+            Settings: The current Settings instance for method chaining.
+        """
+        if milliseconds < 10:
+            print(
+                f"Warning: Are you sure you want to set the threshold so low ({milliseconds} milliseconds)?"
+            )
+
+        if milliseconds > 30000:
+            print(
+                f"Warning: Are you sure you want to set the threshold so high ({milliseconds/1000} seconds)?"
+            )
+
+        self._settings["alert_on_fast_response"] = str(milliseconds)
+        return self
+
+
+    def translation_behaviour(self, behaviour: TranslationBehaviour = TranslationBehaviour.BOTH):
+        """Defines what's the behaviour of the translation in the UI.
+
+        The behaviour can be set to:
+            - TranslationBehaviour.BOTH: Show both the original and the translated text.
+            - TranslationBehaviour.ONLY_ORIGINAL: Show only the original text.
+            - TranslationBehaviour.ONLY_TRANSLATED: Show only the translated text.
+
+        Args:
+            behaviour (TranslationBehaviour): The translation behaviour. Defaults to TranslationBehaviour.BOTH.
+
+        Returns:
+            Settings: The current Settings instance for method chaining.
+        """
+        self._settings["translation_behaviour"] = behaviour.value
+        return self
+
+    def free_text_minimum_characters(self, value: int):
+        """Set the minimum number of characters a user has to type before the task can be successfully submitted.
+
+        Args:
+            value (int): The minimum number of characters for free text.
+
+        Returns:
+            Settings: The current Settings instance for method chaining.
+        """
+        self._settings["free_text_minimum_characters"] = str(value)
+        return self
+
+    def no_shuffle(self, value: bool = True):
+        """Only for classify tasks. If true, the order of the categories will be the same as the one in the workflow.
+
+        Args:
+            value (bool, optional): Whether to disable shuffling. Defaults to True.
+
+        Returns:
+            Settings: The current Settings instance for method chaining.
+        """
+        self._settings["no_shuffle"] = str(value)
+        return self
+
+    def compare_with_prompt_design(self, value: bool = True):
+        """A special design to compare two texts/images based on a criteria and a given prompt.
+
+        Args:
+            value (bool, optional): Whether to enable compare with prompt design. Defaults to True.
+
+        Returns:
+            Settings: The current Settings instance for method chaining.
+        """
+        self._settings["claire"] = str(value)
+        return self
+
+    def key_value(self, key: str, value: str):
+        """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.
+
+        Returns:
+            Settings: The current Settings instance for method chaining.
+        """
+        self._settings[key] = value
+        return self

{rapidata-1.5.0 → rapidata-1.6.1}/src/rapidata/rapidata_client/workflow/base_workflow.py

@@ -4,7 +4,7 @@ from typing import Any
 from rapidata.api_client.models.simple_workflow_model import SimpleWorkflowModel
 from rapidata.api_client.models.evaluation_workflow_model import EvaluationWorkflowModel
 from rapidata.api_client.models.compare_workflow_model import CompareWorkflowModel
-from rapidata.rapidata_client.feature_flags import FeatureFlags
+from rapidata.rapidata_client.settings import Settings
 from rapidata.rapidata_client.referee.base_referee import Referee
 
 
@@ -13,7 +13,7 @@ class Workflow(ABC):
     def __init__(self, type: str):
         self._type = type
         self._target_country_codes: list[str] = []
-        self._feature_flags: FeatureFlags = FeatureFlags()
+        self._feature_flags: Settings = Settings()
 
     def to_dict(self) -> dict[str, Any]:
         return {
@@ -37,6 +37,6 @@ class Workflow(ABC):
         self._target_country_codes = target_country_codes
         return self
 
-    def feature_flags(self, feature_flags: FeatureFlags):
+    def feature_flags(self, feature_flags: Settings):
         self._feature_flags = feature_flags
         return self

rapidata-1.5.0/src/rapidata/rapidata_client/utils/utils.py

@@ -1,22 +0,0 @@
-from rapidata.api_client.models.classify_payload import ClassifyPayload
-from rapidata.api_client.models.create_demographic_rapid_model import (
-    CreateDemographicRapidModel,
-)
-from rapidata.service.openapi_service import OpenAPIService
-
-
-class Utils:
-    def __init__(self, openapi_service: OpenAPIService):
-        self.openapi_service = openapi_service
-
-    def new_demographic_rapid(
-        self, question: str, options: list[str], identifier: str, media_path: str
-    ):
-        payload = ClassifyPayload(
-            _t="ClassifyPayload", title=question, possibleCategories=options
-        )
-        model = CreateDemographicRapidModel(identifier=identifier, payload=payload)
-
-        self.openapi_service.rapid_api.rapid_create_demographic_rapid_post(
-            model=model, file=[media_path]
-        )

rapidata-1.5.0/src/rapidata/utils/image_utils.py

@@ -1,13 +0,0 @@
-from io import BytesIO
-import PIL.Image as Image
-
-class ImageUtils:
-
-    @staticmethod
-    def convert_PIL_image_to_bytes(image: Image.Image):
-        """
-        Convert a PIL image to bytes with meta data encoded. We can't just use image.tobytes() because this only returns the pixel data.
-        """
-        buffer = BytesIO()
-        image.save(buffer, image.format)
-        return buffer.getvalue()