rapidata 1.9.0__tar.gz → 1.10.1__tar.gz

{rapidata-1.9.0 → rapidata-1.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rapidata
-Version: 1.9.0
+Version: 1.10.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

{rapidata-1.9.0 → rapidata-1.10.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rapidata"
-version = "1.9.0"
+version = "1.10.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"

{rapidata-1.9.0 → rapidata-1.10.1}/src/rapidata/api_client/models/rapid_answer.py

@@ -28,11 +28,12 @@ class RapidAnswer(BaseModel):
     RapidAnswer
     """ # noqa: E501
     id: StrictStr
+    user_id: StrictStr = Field(alias="userId")
     country: StrictStr
     result: RapidAnswerResult
     user_score: Union[StrictFloat, StrictInt] = Field(alias="userScore")
     demographic_information: Dict[str, StrictStr] = Field(alias="demographicInformation")
-    __properties: ClassVar[List[str]] = ["id", "country", "result", "userScore", "demographicInformation"]
+    __properties: ClassVar[List[str]] = ["id", "userId", "country", "result", "userScore", "demographicInformation"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -89,6 +90,7 @@ class RapidAnswer(BaseModel):
 
         _obj = cls.model_validate({
             "id": obj.get("id"),
+            "userId": obj.get("userId"),
             "country": obj.get("country"),
             "result": RapidAnswerResult.from_dict(obj["result"]) if obj.get("result") is not None else None,
             "userScore": obj.get("userScore"),

{rapidata-1.9.0 → rapidata-1.10.1}/src/rapidata/rapidata_client/dataset/validation_set_builder.py

@@ -44,7 +44,7 @@ class ValidationSetBuilder:
         self.validation_set_id: str | None = None
         self._rapid_parts: list[ValidatioRapidParts] = []
 
-    def create(self) -> RapidataValidationSet:
+    def submit(self) -> RapidataValidationSet:
         """Create the validation set by executing all HTTP requests. This should be the last method called on the builder.
 
         Returns:
@@ -79,6 +79,18 @@ class ValidationSetBuilder:
             )
 
         return validation_set
+
+    @deprecated("Use submit instead")
+    def create(self) -> RapidataValidationSet:
+        """Create the validation set by executing all HTTP requests. This should be the last method called on the builder.
+
+        Returns:
+            RapidataValidationSet: A RapidataValidationSet instance.
+
+        Raises:
+            ValueError: If the validation set creation fails.
+        """
+        return self.submit()
     
     def add_rapid(self, rapid: Rapid):
         """Add a rapid to the validation set.

rapidata-1.10.1/src/rapidata/rapidata_client/order/order_builder.py

@@ -0,0 +1,25 @@
+from rapidata.service.openapi_service import OpenAPIService
+from rapidata.rapidata_client.simple_builders.simple_classification_builders import ClassificationQuestionBuilder
+from rapidata.rapidata_client.simple_builders.simple_compare_builders import CompareCriteriaBuilder
+from rapidata.rapidata_client.simple_builders.simple_free_text_builders import FreeTextQuestionBuilder
+from rapidata.rapidata_client.simple_builders.simple_select_words_builders import SelectWordsInstructionBuilder
+from rapidata.rapidata_client.order.rapidata_order_builder import RapidataOrderBuilder
+
+class BaseOrderBuilder():
+    def __init__(self, openapi_service: OpenAPIService):
+        self.openapi_service = openapi_service
+    
+    def classify_order(self, name: str):
+        return ClassificationQuestionBuilder(name, self.openapi_service)
+    
+    def compare_order(self, name: str):
+        return CompareCriteriaBuilder(name, self.openapi_service)
+
+    def free_text_order(self, name: str):
+        return FreeTextQuestionBuilder(name, self.openapi_service)
+    
+    def select_words_order(self, name: str):
+        return SelectWordsInstructionBuilder(name, self.openapi_service)
+
+    def advanced_order(self, name: str):
+        return RapidataOrderBuilder(name, self.openapi_service)

{rapidata-1.9.0 → rapidata-1.10.1}/src/rapidata/rapidata_client/rapidata_client.py

@@ -5,6 +5,8 @@ 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
 
+from rapidata.rapidata_client.order.order_builder import BaseOrderBuilder
+
 from rapidata.rapidata_client.simple_builders.simple_classification_builders import ClassificationQuestionBuilder
 from rapidata.rapidata_client.simple_builders.simple_compare_builders import CompareCriteriaBuilder
 from rapidata.rapidata_client.simple_builders.simple_free_text_builders import FreeTextQuestionBuilder
@@ -28,8 +30,6 @@ from deprecated import deprecated
 
 class RapidataClient:
     """The Rapidata client is the main entry point for interacting with the Rapidata API. It allows you to create orders and validation sets."""
-
-    rapid_builder = BaseRapidBuilder()
     
     def __init__(
         self,
@@ -53,8 +53,12 @@ class RapidataClient:
             oauth_scope=oauth_scope,
             cert_path=cert_path
         )
+        
+        self.rapid_builder = BaseRapidBuilder()
+
+        self.order_builder = BaseOrderBuilder(openapi_service=self.openapi_service)
     
-    @deprecated("Use the specific builder methods instead.")
+    @deprecated("Use the order_builder instead.")
     def new_order(self, name: str) -> RapidataOrderBuilder:
         """Create a new order using a RapidataOrderBuilder instance.
 
@@ -64,7 +68,22 @@ class RapidataClient:
         Returns:
             RapidataOrderBuilder: A RapidataOrderBuilder instance.
         """
-        return RapidataOrderBuilder(openapi_service=self.openapi_service, name=name)
+        return self.new_advanced_order(name)
+    
+    @deprecated("Use the order_builder instead.")
+    def new_advanced_order(self, name: str) -> RapidataOrderBuilder:
+        """Create a new order using a RapidataOrderBuilder instance.
+        This method is intended for creating orders with complex requirements that can not be fulfilled with the specific builders.
+        For any other order, it is recommended to use the specific builder methods.
+        example: create_classify_order, create_compare_order, create_free_text_order, create_select_words_order
+
+        Args:
+            name (str): The name of the order.
+
+        Returns:
+            RapidataOrderBuilder: A RapidataOrderBuilder instance.
+        """
+        return RapidataOrderBuilder(name=name, openapi_service=self.openapi_service)
 
     def new_validation_set(self, name: str) -> ValidationSetBuilder:
         """Create a new validation set using a ValidationDatasetBuilder instance.
@@ -161,6 +180,7 @@ class RapidataClient:
         orders = [self.get_validation_set(validation_set.id) for validation_set in validation_page_result.items] # type: ignore # will be fixed with the next backend deployment
         return orders
 
+    @deprecated("Use the order_builder instead.")
     def create_classify_order(self, name: str) -> ClassificationQuestionBuilder:
         """Create a new classification order where people are asked to classify an image.
 
@@ -172,6 +192,7 @@ class RapidataClient:
         """
         return ClassificationQuestionBuilder(name=name, openapi_service=self.openapi_service)
 
+    @deprecated("Use the order_builder instead.")
     def create_compare_order(self, name: str) -> CompareCriteriaBuilder:
         """Create a new comparison order where people are asked to compare two images.
 
@@ -183,6 +204,7 @@ class RapidataClient:
         """
         return CompareCriteriaBuilder(name=name, openapi_service=self.openapi_service)
     
+    @deprecated("Use the order_builder instead.")
     def create_free_text_order(self, name: str) -> FreeTextQuestionBuilder:
         """Create a new free text order where people are asked to provide a free text answer.
 
@@ -194,6 +216,7 @@ class RapidataClient:
         """
         return FreeTextQuestionBuilder(name=name, openapi_service=self.openapi_service)
     
+    @deprecated("Use the order_builder instead.")
     def create_select_words_order(self, name: str) -> SelectWordsInstructionBuilder:
         """Create a new select words order where people are asked to transcribe an audio file.
 

{rapidata-1.9.0 → rapidata-1.10.1}/src/rapidata/rapidata_client/selection/capped_selection.py

@@ -21,5 +21,5 @@ class CappedSelection(Selection):
                 CappedSelectionSelectionsInner(selection.to_model())
                 for selection in self.selections
             ],
-            max_rapids=self.max_rapids,
+            maxRapids=self.max_rapids,
         )

{rapidata-1.9.0 → rapidata-1.10.1}/src/rapidata/rapidata_client/simple_builders/simple_classification_builders.py

@@ -28,7 +28,7 @@ class ClassificationOrderBuilder:
         self._options = options
         self._media_assets = media_assets
         self._responses_required = 10
-        self._probability_threshold = None
+        self._confidence_threshold = None
         self._metadata = None
         self._validation_set_id = None
         self._filters: list[Filter] = []
@@ -54,12 +54,16 @@ class ClassificationOrderBuilder:
 
     def responses(self, responses_required: int) -> 'ClassificationOrderBuilder':
         """Set the number of responses required per datapoint for the classification order. Will default to 10."""
+        if responses_required < 1:
+            raise ValueError("Responses required must be at least 1")
+        
         self._responses_required = responses_required
         return self
 
-    def probability_threshold(self, probability_threshold: float) -> 'ClassificationOrderBuilder':
-        """Set the probability threshold for early stopping."""
-        self._probability_threshold = probability_threshold
+    def confidence_threshold(self, confidence_threshold: float) -> 'ClassificationOrderBuilder':
+        """Set the confidence threshold for early stopping.
+        That means that the order will either stop at the number of responses or when the confidence threshold is reached, whatever comes first."""
+        self._confidence_threshold = confidence_threshold
         return self
 
     def validation_set(self, validation_set_id: str) -> 'ClassificationOrderBuilder':
@@ -104,14 +108,27 @@ class ClassificationOrderBuilder:
 
         return self
 
-    @deprecated("Use .run instead.")
+    @deprecated("Use .submit instead.")
     def create(self, submit: bool = True, max_upload_workers: int = 10) -> 'RapidataOrder':
         """Create the classification order."""
-        return self.run(submit=submit, disable_link=False)
-
+        return self.submit(submit=submit, disable_link=False)
+    
+    @deprecated("Use .submit instead.")
     def run(self, submit: bool = True, disable_link: bool = False) -> 'RapidataOrder':
         """Run the classification order.
         
+        Args:
+            submit (bool): Whether to submit the order. Defaults to True. \
+                Set this to False if you first want to see the order on your dashboard before running it.
+            disable_link (bool): Whether to disable the printing of the link to the order. Defaults to False.
+            
+        Returns:
+            RapidataOrder: The created classification order."""
+        return self.submit(submit=submit, disable_link=disable_link)
+
+    def submit(self, submit: bool = True, disable_link: bool = False) -> 'RapidataOrder':
+        """Submit the classification order to be labeled.
+        
         Args:
             submit (bool): Whether to submit the order. Defaults to True. \
                 Set this to False if you first want to see the order on your dashboard before running it.
@@ -120,10 +137,10 @@ class ClassificationOrderBuilder:
         Returns:
             RapidataOrder: The created classification order."""
                 
-        if self._probability_threshold and self._responses_required:
+        if self._confidence_threshold:
             referee = EarlyStoppingReferee(
                 max_vote_count=self._responses_required,
-                threshold=self._probability_threshold
+                threshold=self._confidence_threshold
             )
 
         else:

{rapidata-1.9.0 → rapidata-1.10.1}/src/rapidata/rapidata_client/simple_builders/simple_compare_builders.py

@@ -23,13 +23,16 @@ class CompareOrderBuilder:
         self._responses_required = 10
         self._metadata = None
         self._validation_set_id = None
-        self._probability_threshold = None
+        self._confidence_threshold = None
         self._filters: list[Filter] = []
         self._settings = Settings()
         self._time_effort = time_effort
 
     def responses(self, responses_required: int) -> 'CompareOrderBuilder':
         """Set the number of resoonses required per matchup/pairing for the comparison order. Will default to 10 if not set."""
+        if responses_required < 1:
+            raise ValueError("Responses required must be at least 1.")
+        
         self._responses_required = responses_required
         return self
     
@@ -61,9 +64,10 @@ class CompareOrderBuilder:
         self._validation_set_id = validation_set_id
         return self
     
-    def probability_threshold(self, probability_threshold: float) -> 'CompareOrderBuilder':
-        """Set the probability threshold for early stopping."""
-        self._probability_threshold = probability_threshold
+    def confidence_threshold(self, confidence_threshold: float) -> 'CompareOrderBuilder':
+        """Set the confidence threshold for early stopping.
+        That means that the order will either stop at the number of responses or when the confidence threshold is reached, whatever comes first."""
+        self._confidence_threshold = confidence_threshold
         return self
     
     def countries(self, country_codes: list[str]) -> 'CompareOrderBuilder':
@@ -103,14 +107,27 @@ class CompareOrderBuilder:
 
         return self
     
-    @deprecated("Use .run instead.")
+    @deprecated("Use .submit instead.")
     def create(self, submit: bool = True, max_upload_workers: int = 10) -> 'RapidataOrder':
         """Create the classification order."""
-        return self.run(submit=submit, disable_link=False)
+        return self.submit(submit=submit, disable_link=False)
     
     def run(self, submit: bool = True, disable_link: bool = False) -> RapidataOrder:
         """Run the compare order.
         
+        Args:
+            submit (bool): Whether to submit the order. Defaults to True. \
+                Set this to False if you first want to see the order on your dashboard before running it.
+            disable_link (bool): Whether to disable the printing of the link to the order. Defaults to False.
+            
+        Returns:
+            RapidataOrder: The created compare order."""
+            
+        return self.submit(submit=submit, disable_link=disable_link)
+    
+    def submit(self, submit: bool = True, disable_link: bool = False) -> RapidataOrder:
+        """Submit the compare order to be labeled.
+        
         Args:
             submit (bool): Whether to submit the order. Defaults to True. \
                 Set this to False if you first want to see the order on your dashboard before running it.
@@ -119,10 +136,10 @@ class CompareOrderBuilder:
         Returns:
             RapidataOrder: The created compare order."""
         
-        if self._probability_threshold and self._responses_required:
+        if self._confidence_threshold:
             referee = EarlyStoppingReferee(
                 max_vote_count=self._responses_required,
-                threshold=self._probability_threshold
+                threshold=self._confidence_threshold
             )
 
         else:

{rapidata-1.9.0 → rapidata-1.10.1}/src/rapidata/rapidata_client/simple_builders/simple_free_text_builders.py

@@ -72,10 +72,22 @@ class FreeTextOrderBuilder:
             self._settings.translation_behaviour(TranslationBehaviour.ONLY_TRANSLATED)
 
         return self
-
+    
     def run(self, submit: bool = True, disable_link: bool = False) -> 'RapidataOrder':
         """Run the free text order.
         
+        Args:
+            submit (bool): Whether to submit the order. Defaults to True. \
+                Set this to False if you first want to see the order on your dashboard before running it.
+            disable_link (bool): Whether to disable the printing of the link to the order. Defaults to False.
+            
+        Returns:
+            RapidataOrder: The created free text order."""
+        return self.submit(submit=submit, disable_link=disable_link)
+
+    def submit(self, submit: bool = True, disable_link: bool = False) -> 'RapidataOrder':
+        """Submit the free text order to be labeled.
+        
         Args:
             submit (bool): Whether to submit the order. Defaults to True. \
                 Set this to False if you first want to see the order on your dashboard before running it.

{rapidata-1.9.0 → rapidata-1.10.1}/src/rapidata/rapidata_client/simple_builders/simple_select_words_builders.py

@@ -82,10 +82,20 @@ class SelectWordsOrderBuilder:
             self._settings.translation_behaviour(TranslationBehaviour.ONLY_TRANSLATED)
 
         return self
-
+    
     def run(self, submit: bool = True, disable_link: bool = False) -> 'RapidataOrder':
         """Run the order.
         
+        Args:
+            submit (bool): Whether to submit the order. Defaults to True. \
+                Set this to False if you first want to see the order on your dashboard before running it.
+            disable_link (bool): Whether to disable the printing of the link to the order. Defaults to False."""
+        
+        return self.submit(submit=submit, disable_link=disable_link)
+
+    def submit(self, submit: bool = True, disable_link: bool = False) -> 'RapidataOrder':
+        """Submit the order to be labeled.
+        
         Args:
             submit (bool): Whether to submit the order. Defaults to True. \
                 Set this to False if you first want to see the order on your dashboard before running it.