rapidata 2.42.2__py3-none-any.whl → 2.42.3__py3-none-any.whl

rapidata/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.42.2"
+__version__ = "2.42.3"
 
 from .rapidata_client import (
     RapidataClient,

rapidata/rapidata_client/order/_rapidata_order_builder.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional, Sequence
+from typing import Literal, Optional, Sequence, get_args
 import random
 import urllib.parse
 import webbrowser
@@ -43,6 +43,8 @@ from rapidata.rapidata_client.api.rapidata_api_client import (
     suppress_rapidata_error_logging,
 )
 
+StickyStateLiteral = Literal["Temporary", "Permanent", "Passive"]
+
 
 class RapidataOrderBuilder:
     """Builder object for creating Rapidata orders.
@@ -71,9 +73,7 @@ class RapidataOrderBuilder:
         self.__selections: list[RapidataSelection] = []
         self.__priority: int | None = None
         self.__datapoints: list[Datapoint] = []
-        self.__sticky_state_value: Literal["None", "Temporary", "Permanent"] | None = (
-            None
-        )
+        self.__sticky_state_value: StickyStateLiteral | None = None
         self.__validation_set_manager: ValidationSetManager = ValidationSetManager(
             self.__openapi_service
         )
@@ -147,6 +147,7 @@ class RapidataOrderBuilder:
                         self.__openapi_service.validation_api.validation_set_recommended_get(
                             asset_type=[self.__datapoints[0].get_asset_type()],
                             modality=[self.__workflow.modality],
+                            instruction=self.__workflow._get_instruction(),
                             prompt_type=[
                                 t.value for t in self.__datapoints[0].get_prompt_type()
                             ],
@@ -453,18 +454,16 @@ class RapidataOrderBuilder:
         return self
 
     def _sticky_state(
-        self, sticky_state: Literal["None", "Temporary", "Permanent"] | None = None
+        self, sticky_state: StickyStateLiteral | None = None
     ) -> "RapidataOrderBuilder":
         """
         Set the sticky state for the order.
         """
-        if sticky_state is not None and sticky_state not in [
-            "None",
-            "Temporary",
-            "Permanent",
-        ]:
-            raise TypeError(
-                "Sticky state must be of type Literal['None', 'Temporary', 'Permanent']."
+        sticky_state_valid_values = get_args(StickyStateLiteral)
+
+        if sticky_state is not None and sticky_state not in sticky_state_valid_values:
+            raise ValueError(
+                f"Sticky state must be one of {sticky_state_valid_values} or None"
             )
 
         self.__sticky_state_value = sticky_state

rapidata/rapidata_client/order/rapidata_order_manager.py

@@ -1,4 +1,4 @@
-from typing import Sequence, Optional, Literal
+from typing import Sequence, Optional, Literal, get_args
 from itertools import zip_longest
 
 from rapidata.rapidata_client.config.tracer import tracer
@@ -41,7 +41,7 @@ from rapidata.api_client.models.filter import Filter
 from rapidata.api_client.models.filter_operator import FilterOperator
 from rapidata.api_client.models.sort_criterion import SortCriterion
 from rapidata.api_client.models.sort_direction import SortDirection
-
+from rapidata.rapidata_client.order._rapidata_order_builder import StickyStateLiteral
 
 from tqdm import tqdm
 
@@ -61,7 +61,7 @@ class RapidataOrderManager:
         self.settings = RapidataSettings
         self.selections = RapidataSelections
         self.__priority: int | None = None
-        self.__sticky_state: Literal["None", "Temporary", "Permanent"] | None = None
+        self.__sticky_state: StickyStateLiteral | None = None
         self.__asset_uploader = AssetUploader(openapi_service)
         logger.debug("RapidataOrderManager initialized")
 
@@ -172,21 +172,21 @@ class RapidataOrderManager:
         logger.debug("Order created: %s", order)
         return order
 
-    def _set_priority(self, priority: int):
-        if not isinstance(priority, int):
-            raise TypeError("Priority must be an integer")
+    def _set_priority(self, priority: int | None):
+        if priority is not None and not isinstance(priority, int):
+            raise TypeError("Priority must be an integer or None")
 
-        if priority < 0:
-            raise ValueError("Priority must be greater than 0")
+        if priority is not None and priority < 0:
+            raise ValueError("Priority must be greater than 0 or None")
 
         self.__priority = priority
 
-    def _set_sticky_state(
-        self, sticky_state: Literal["None", "Temporary", "Permanent"]
-    ):
-        if sticky_state not in ["None", "Temporary", "Permanent"]:
+    def _set_sticky_state(self, sticky_state: StickyStateLiteral | None):
+        sticky_state_valid_values = get_args(StickyStateLiteral)
+
+        if sticky_state is not None and sticky_state not in sticky_state_valid_values:
             raise ValueError(
-                "Sticky state must be one of 'None', 'Temporary', 'Permanent'"
+                f"Sticky state must be one of {sticky_state_valid_values} or None"
             )
 
         self.__sticky_state = sticky_state

rapidata/rapidata_client/workflow/_base_workflow.py

@@ -44,6 +44,10 @@ class Workflow(ABC):
     ):
         pass
 
+    @abstractmethod
+    def _get_instruction(self) -> str:
+        pass
+
     @abstractmethod
     def _to_model(
         self,

rapidata/rapidata_client/workflow/_classify_workflow.py

@@ -35,6 +35,9 @@ class ClassifyWorkflow(Workflow):
         self._instruction = instruction
         self._answer_options = answer_options
 
+    def _get_instruction(self) -> str:
+        return self._instruction
+
     def _to_dict(self) -> dict[str, Any]:
         return {
             **super()._to_dict(),

rapidata/rapidata_client/workflow/_compare_workflow.py

@@ -31,6 +31,9 @@ class CompareWorkflow(Workflow):
         self._instruction = instruction
         self._a_b_names = a_b_names
 
+    def _get_instruction(self) -> str:
+        return self._instruction
+
     def _to_dict(self) -> dict[str, Any]:
         return {
             **super()._to_dict(),

rapidata/rapidata_client/workflow/_draw_workflow.py

@@ -16,6 +16,9 @@ class DrawWorkflow(Workflow):
         super().__init__(type="SimpleWorkflowConfig")
         self._target = target
 
+    def _get_instruction(self) -> str:
+        return self._target
+
     def _to_model(self) -> SimpleWorkflowModel:
         blueprint = LineRapidBlueprint(_t="LineBlueprint", target=self._target)
 

rapidata/rapidata_client/workflow/_evaluation_workflow.py

@@ -22,6 +22,9 @@ class EvaluationWorkflow(Workflow):
         self.validation_set_id = validation_set_id
         self.should_accept_incorrect = should_accept_incorrect
 
+    def _get_instruction(self) -> str:
+        return ""
+
     def _to_model(self):
         return EvaluationWorkflowModel(
             _t="EvaluationWorkflow",

rapidata/rapidata_client/workflow/_free_text_workflow.py

@@ -33,6 +33,9 @@ class FreeTextWorkflow(Workflow):
         self._instruction = instruction
         self._validation_system_prompt = validation_system_prompt
 
+    def _get_instruction(self) -> str:
+        return self._instruction
+
     def _to_dict(self) -> dict[str, Any]:
         return {
             **super()._to_dict(),

rapidata/rapidata_client/workflow/_locate_workflow.py

@@ -16,6 +16,9 @@ class LocateWorkflow(Workflow):
         super().__init__(type="SimpleWorkflowConfig")
         self._target = target
 
+    def _get_instruction(self) -> str:
+        return self._target
+
     def _to_model(self) -> SimpleWorkflowModel:
         blueprint = LocateRapidBlueprint(_t="LocateBlueprint", target=self._target)
 

rapidata/rapidata_client/workflow/_ranking_workflow.py

@@ -73,6 +73,9 @@ class RankingWorkflow(Workflow):
             scalingFactor=elo_scaling_factor,
         )
 
+    def _get_instruction(self) -> str:
+        return self.criteria
+
     def _to_model(self) -> CompareWorkflowModel:
 
         return CompareWorkflowModel(

rapidata/rapidata_client/workflow/_select_words_workflow.py

@@ -31,6 +31,9 @@ class SelectWordsWorkflow(Workflow):
         super().__init__(type="SimpleWorkflowConfig")
         self._instruction = instruction
 
+    def _get_instruction(self) -> str:
+        return self._instruction
+
     def _to_model(self) -> SimpleWorkflowModel:
         blueprint = TranscriptionRapidBlueprint(
             _t="TranscriptionBlueprint", title=self._instruction

rapidata/rapidata_client/workflow/_timestamp_workflow.py

@@ -29,6 +29,9 @@ class TimestampWorkflow(Workflow):
         super().__init__(type="SimpleWorkflowConfig")
         self._instruction = instruction
 
+    def _get_instruction(self) -> str:
+        return self._instruction
+
     def _to_model(self) -> SimpleWorkflowModel:
         blueprint = ScrubRapidBlueprint(_t="ScrubBlueprint", target=self._instruction)
 

{rapidata-2.42.2.dist-info → rapidata-2.42.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rapidata
-Version: 2.42.2
+Version: 2.42.3
 Summary: Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way.
 License: Apache-2.0
 License-File: LICENSE

{rapidata-2.42.2.dist-info → rapidata-2.42.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-rapidata/__init__.py,sha256=JE3wmzFPMDBFCoTTrU5UkvBELIuoQtdUwG6wPOUZbD0,875
+rapidata/__init__.py,sha256=w5Fcsu571VQBJn_5rIIIsm3F4_8HuBOjNCPV3jabwzo,875
 rapidata/api_client/__init__.py,sha256=Rh2aAoa6nDv09Z7cpTNdrPotXixBcNN_2VevCDD1goc,37144
 rapidata/api_client/api/__init__.py,sha256=CaZJ54mxbAEzAFd0Cjy0mfiUabD-d_7tqVOgjU4RxZI,1749
 rapidata/api_client/api/asset_api.py,sha256=buYMBGvg5_SLkJ7aG07c7_1rT6TXTCqoLfoV8O2nJhM,34442
@@ -657,10 +657,10 @@ rapidata/rapidata_client/filter/rapidata_filters.py,sha256=B8ptQsaAn1e14Grv8xBYQ
 rapidata/rapidata_client/filter/response_count_filter.py,sha256=i2u2YQD3_RLQRZyqAceAGLQS3es97Q2n8KTlgfDYMko,2332
 rapidata/rapidata_client/filter/user_score_filter.py,sha256=4B3Zzp7aosDFmte3nLPTlXMN4zatT6Wcq5QLIoXqhgI,1910
 rapidata/rapidata_client/order/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rapidata/rapidata_client/order/_rapidata_order_builder.py,sha256=RZwRyPzxR_D3aVZU-K98-FqIbOpzXNmmkJzzmYwYJnU,16828
+rapidata/rapidata_client/order/_rapidata_order_builder.py,sha256=FTJJRCW9KehIlqELOXmKeLhuGcLj9m9ImEU1agOIRa4,16915
 rapidata/rapidata_client/order/dataset/_rapidata_dataset.py,sha256=8EhoRVBxWMbp1mtS56Uogg2dwFC2vySw5hNqTPDTHzM,6345
 rapidata/rapidata_client/order/rapidata_order.py,sha256=w41HUWE6q9L2Stx0ScZdKb7qLjWFIUPMMDOe2fElLvM,14481
-rapidata/rapidata_client/order/rapidata_order_manager.py,sha256=_IS2ONiINmq4ga_2oWsbSluwC-SEv03yo_aKWluOGQk,40823
+rapidata/rapidata_client/order/rapidata_order_manager.py,sha256=Ya8s40hzigIIpo9WphL67sguuqY_3q-Z4AL8IHmX-ZI,41028
 rapidata/rapidata_client/order/rapidata_results.py,sha256=weL4S14fzug3ZOJbQk9Oj-4tv2jx5aZAMp7VJ-a6Qq4,8437
 rapidata/rapidata_client/rapidata_client.py,sha256=5BJMstjJFmBwkflC_YnzlhoOF3SKP3u2wQ56G_hvB3Q,5862
 rapidata/rapidata_client/referee/__init__.py,sha256=J8oZJNUduPr-Tmn8iJwR-qBiSv7owhUFcEzXTRETecw,155
@@ -702,22 +702,22 @@ rapidata/rapidata_client/validation/rapids/rapids.py,sha256=E4O4p2br0g9lgB3tOdfE
 rapidata/rapidata_client/validation/rapids/rapids_manager.py,sha256=YqGxnqJ2vYfAywXJDujQEBrYnlf0URdLxQ7hTR1JeOI,16225
 rapidata/rapidata_client/validation/validation_set_manager.py,sha256=uBKdf-13LKeetvVz425292L6jSYBNrsM08S-n9xEXAw,35099
 rapidata/rapidata_client/workflow/__init__.py,sha256=6kfMN7TQVpiQNGjNHg3X7KdnCyYe3K2TIq7ZVEatQcU,476
-rapidata/rapidata_client/workflow/_base_workflow.py,sha256=UoB9mh0azAf8_IgH6ujGsRQS9PxSiVCSDsAfLjV7wgM,1570
-rapidata/rapidata_client/workflow/_classify_workflow.py,sha256=gJ-Us3bCzbgiTyIKWLFjCJQS6ClqAnObLtZgCJGUASI,2546
-rapidata/rapidata_client/workflow/_compare_workflow.py,sha256=AwLlV6246Nd2PvsTUw4loZekK44HANv_pNOZWkPWZiE,2177
-rapidata/rapidata_client/workflow/_draw_workflow.py,sha256=CKbNGp1NdlvipO_Rc-We_JkocRsE2NY32iXg-pPBvtM,1347
-rapidata/rapidata_client/workflow/_evaluation_workflow.py,sha256=3b71NpxAdmYfRTZCZHq-UoQFqY7CDlMup6VwE7412kc,1732
-rapidata/rapidata_client/workflow/_free_text_workflow.py,sha256=d5vZDZ_ZdzP4Crecm-cm-vBhkJkx5EPtAFAuSVH2EwI,2664
-rapidata/rapidata_client/workflow/_locate_workflow.py,sha256=zqE5XZALqdcyEW_e_gVF61pLOmt85O7sDRU28qLuAa4,1371
-rapidata/rapidata_client/workflow/_ranking_workflow.py,sha256=Rtc-Yj99gpM3JY4hH7QqGeL0o5LSClv2xxNCl-9leVA,4436
-rapidata/rapidata_client/workflow/_select_words_workflow.py,sha256=huxVRP4G9nhHr3i37A9r91SHSUq5YXTvC0qe92W9RGM,2210
-rapidata/rapidata_client/workflow/_timestamp_workflow.py,sha256=k1MZ1_nYysibDYWJ5aogiIOjRYFiFTTEnxsK2kCXAtw,1774
+rapidata/rapidata_client/workflow/_base_workflow.py,sha256=ctbCiQ1VKR9mTKl3MRubtSChrPcbjjZ-xP61f1PBBwc,1643
+rapidata/rapidata_client/workflow/_classify_workflow.py,sha256=KDdASQL9u-PSosHrtvKAYc5P_Hy94RcB16gK2RtbacE,2619
+rapidata/rapidata_client/workflow/_compare_workflow.py,sha256=Yf8NLxrK8MHbmXLvghy3-xvQosVW3CpYy9uRO1y2xpg,2250
+rapidata/rapidata_client/workflow/_draw_workflow.py,sha256=O7r_bltnGfxQV_TOzyC_5Z2-VeAPH-yMSA5WDEu4NzE,1415
+rapidata/rapidata_client/workflow/_evaluation_workflow.py,sha256=F4-K-bDYh9qjq8S_L8VL5E9pzAO1iTRec47srFVTL3U,1790
+rapidata/rapidata_client/workflow/_free_text_workflow.py,sha256=pf2z2lanj7v6Zo-nYc0x8XVghK4JfX7bfsHk-TVOV1c,2737
+rapidata/rapidata_client/workflow/_locate_workflow.py,sha256=7UXapQBmuUsFMpvG6TPk0D9g9PrCa9y92Y4nb1ecjcw,1439
+rapidata/rapidata_client/workflow/_ranking_workflow.py,sha256=Ma7MpzhkTtg9jdugowAT0bTi_7WbR6z99gENdTn0H7k,4505
+rapidata/rapidata_client/workflow/_select_words_workflow.py,sha256=b3APwuDuMphtOVefOaaOVebcaRcnnVQ6NltZkEPXnCo,2283
+rapidata/rapidata_client/workflow/_timestamp_workflow.py,sha256=totcKhAItkPS7HMrjbr6_CGgKMKzohzpdCxMu0X-vCw,1847
 rapidata/service/__init__.py,sha256=ULBu1tCwgp055OifUXZKtExkzqXeTa_LRROzjMWAd90,69
 rapidata/service/credential_manager.py,sha256=T3yL4tXVnibRytxjQkOC-ex3kFGQR5KcKUUAtao4PFw,8698
 rapidata/service/local_file_service.py,sha256=0Q4LdoEtPFKzgXK2oZ1cQ-X7FipakscjGnnBH8dRFRQ,855
 rapidata/service/openapi_service.py,sha256=E2zVagI_ri15PK06ITO_VNKYDJ0VZQG1YQ1T6bEIVsY,5566
 rapidata/types/__init__.py,sha256=gSGrmWV5gEA6pPfAR5vwSy_DvibO5IjCZDiB7LtlMOQ,6134
-rapidata-2.42.2.dist-info/METADATA,sha256=E5-4G2VCDEv5xV4NuLau3VIG3Cb66V8VT6qTH1fTOeY,1479
-rapidata-2.42.2.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-rapidata-2.42.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-rapidata-2.42.2.dist-info/RECORD,,
+rapidata-2.42.3.dist-info/METADATA,sha256=VMEnGlq258AvdqaQP1OiIN6VHKMkiPQgfwXKY-I84rA,1479
+rapidata-2.42.3.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+rapidata-2.42.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+rapidata-2.42.3.dist-info/RECORD,,