rapidata 0.1.12__tar.gz → 0.1.14__tar.gz

{rapidata-0.1.12 → rapidata-0.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rapidata
-Version: 0.1.12
+Version: 0.1.14
 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-0.1.12 → rapidata-0.1.14}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rapidata"
-version = "0.1.12"
+version = "0.1.14"
 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-0.1.12 → rapidata-0.1.14}/rapidata/rapidata_client/dataset/rapidata_validation_set.py

@@ -14,6 +14,7 @@ from rapidata.api_client.models.bounding_box_truth import BoundingBoxTruth
 from rapidata.api_client.models.classify_payload import ClassifyPayload
 from rapidata.api_client.models.compare_payload import ComparePayload
 from rapidata.api_client.models.compare_truth import CompareTruth
+from rapidata.api_client.models.datapoint_metadata_model_metadata_inner import DatapointMetadataModelMetadataInner
 from rapidata.api_client.models.empty_validation_truth import EmptyValidationTruth
 from rapidata.api_client.models.free_text_payload import FreeTextPayload
 from rapidata.api_client.models.line_payload import LinePayload
@@ -27,6 +28,7 @@ from rapidata.api_client.models.polygon_truth import PolygonTruth
 from rapidata.api_client.models.transcription_payload import TranscriptionPayload
 from rapidata.api_client.models.transcription_truth import TranscriptionTruth
 from rapidata.rapidata_client.dataset.validation_rapid_parts import ValidatioRapidParts
+from rapidata.rapidata_client.metadata.base_metadata import Metadata
 from rapidata.rapidata_client.types import RapidAsset
 from rapidata.service.openapi_service import OpenAPIService
 
@@ -61,7 +63,7 @@ class RapidataValidationSet:
             | PolygonTruth
             | TranscriptionTruth
         ),
-        metadata: Any,
+        metadata: list[Metadata],
         media_paths: RapidAsset,
         randomCorrectProbability: float,
     ):
@@ -69,7 +71,7 @@ class RapidataValidationSet:
             validationSetId=self.id,
             payload=AddValidationRapidModelPayload(payload),
             truth=AddValidationRapidModelTruth(truths),
-            metadata=metadata or [],
+            metadata=[DatapointMetadataModelMetadataInner(meta.to_model()) for meta in metadata],
             randomCorrectProbability=randomCorrectProbability,
         )
 

{rapidata-0.1.12 → rapidata-0.1.14}/rapidata/rapidata_client/dataset/validation_rapid_parts.py

@@ -19,6 +19,7 @@ from rapidata.api_client.models.polygon_payload import PolygonPayload
 from rapidata.api_client.models.polygon_truth import PolygonTruth
 from rapidata.api_client.models.transcription_payload import TranscriptionPayload
 from rapidata.api_client.models.transcription_truth import TranscriptionTruth
+from rapidata.rapidata_client.metadata.base_metadata import Metadata
 from rapidata.rapidata_client.types import RapidAsset
 
 
@@ -48,5 +49,5 @@ class ValidatioRapidParts:
         | PolygonTruth
         | TranscriptionTruth
     )
-    metadata: Any
+    metadata: list[Metadata]
     randomCorrectProbability: float

{rapidata-0.1.12 → rapidata-0.1.14}/rapidata/rapidata_client/dataset/validation_set_builder.py

@@ -1,13 +1,4 @@
-from dataclasses import dataclass
 import os
-from typing import Any, Union
-from rapidata.api_client.models.add_validation_rapid_model import AddValidationRapidModel
-from rapidata.api_client.models.add_validation_rapid_model_payload import (
-    AddValidationRapidModelPayload,
-)
-from rapidata.api_client.models.add_validation_rapid_model_truth import (
-    AddValidationRapidModelTruth,
-)
 from rapidata.api_client.models.attach_category_truth import AttachCategoryTruth
 from rapidata.api_client.models.classify_payload import ClassifyPayload
 from rapidata.api_client.models.compare_payload import ComparePayload
@@ -15,14 +6,14 @@ from rapidata.api_client.models.compare_truth import CompareTruth
 from rapidata.api_client.models.transcription_payload import TranscriptionPayload
 from rapidata.api_client.models.transcription_truth import TranscriptionTruth
 from rapidata.api_client.models.transcription_word import TranscriptionWord
-from rapidata.rapidata_client.dataset.rapidata_validation_set import RapidataValidationSet
+from rapidata.rapidata_client.dataset.rapidata_validation_set import (
+    RapidataValidationSet,
+)
 from rapidata.rapidata_client.dataset.validation_rapid_parts import ValidatioRapidParts
+from rapidata.rapidata_client.metadata.base_metadata import Metadata
 from rapidata.service.openapi_service import OpenAPIService
 
 
-
-
-
 class ValidationSetBuilder:
 
     def __init__(self, name: str, openapi_service: OpenAPIService):
@@ -42,7 +33,10 @@ class ValidationSetBuilder:
         if self.validation_set_id is None:
             raise ValueError("Failed to create validation set")
 
-        validation_set = RapidataValidationSet(validation_set_id=self.validation_set_id, openapi_service=self.openapi_service)
+        validation_set = RapidataValidationSet(
+            validation_set_id=self.validation_set_id,
+            openapi_service=self.openapi_service,
+        )
 
         for rapid_part in self._rapid_parts:
             validation_set.add_validation_rapid(
@@ -52,14 +46,19 @@ class ValidationSetBuilder:
                 media_paths=rapid_part.media_paths,
                 randomCorrectProbability=rapid_part.randomCorrectProbability,
             )
-            
+
         return validation_set
 
     def add_classify_rapid(
-        self, media_path: str, question: str, categories: list[str], truths: list[str]
+        self,
+        media_path: str,
+        question: str,
+        categories: list[str],
+        truths: list[str],
+        metadata: list[Metadata] = [],
     ):
         payload = ClassifyPayload(
-            _t="ClassifyPaylod", possibleCategories=categories, title=question
+            _t="ClassifyPayload", possibleCategories=categories, title=question
         )
         model_truth = AttachCategoryTruth(
             correctCategories=truths, _t="AttachCategoryTruth"
@@ -71,14 +70,20 @@ class ValidationSetBuilder:
                 media_paths=media_path,
                 payload=payload,
                 truths=model_truth,
-                metadata=None,
+                metadata=metadata,
                 randomCorrectProbability=len(truths) / len(categories),
             )
         )
 
         return self
 
-    def add_compare_rapid(self, media_paths: list[str], question: str, truth: str):
+    def add_compare_rapid(
+        self,
+        media_paths: list[str],
+        question: str,
+        truth: str,
+        metadata: list[Metadata] = [],
+    ):
         payload = ComparePayload(_t="ComparePayload", criteria=question)
         # take only last part of truth path
         truth = os.path.basename(truth)
@@ -91,7 +96,6 @@ class ValidationSetBuilder:
         for media_path in media_paths:
             if not os.path.exists(media_path):
                 raise FileNotFoundError(f"File not found: {media_path}")
-            
 
         self._rapid_parts.append(
             ValidatioRapidParts(
@@ -99,7 +103,7 @@ class ValidationSetBuilder:
                 media_paths=media_paths,
                 payload=payload,
                 truths=model_truth,
-                metadata=None,
+                metadata=metadata,
                 randomCorrectProbability=1 / len(media_paths),
             )
         )
@@ -113,6 +117,7 @@ class ValidationSetBuilder:
         transcription: list[str],
         correct_words: list[str],
         strict_grading: bool | None = None,
+        metadata: list[Metadata] = [],
     ):
         transcription_words = [
             TranscriptionWord(word=word, wordIndex=i)
@@ -143,7 +148,7 @@ class ValidationSetBuilder:
                 media_paths=media_path,
                 payload=payload,
                 truths=model_truth,
-                metadata=None,
+                metadata=metadata,
                 randomCorrectProbability=1 / len(transcription),
             )
         )

{rapidata-0.1.12 → rapidata-0.1.14}/rapidata/rapidata_client/order/rapidata_order_builder.py

@@ -3,9 +3,13 @@ from rapidata.api_client.models.create_order_model import CreateOrderModel
 from rapidata.api_client.models.create_order_model_referee import (
     CreateOrderModelReferee,
 )
+from rapidata.api_client.models.create_order_model_user_filters_inner import (
+    CreateOrderModelUserFiltersInner,
+)
 from rapidata.api_client.models.create_order_model_workflow import (
     CreateOrderModelWorkflow,
 )
+from rapidata.api_client.models.country_user_filter_model import CountryUserFilterModel
 from rapidata.rapidata_client.feature_flags import FeatureFlags
 from rapidata.rapidata_client.metadata.base_metadata import Metadata
 from rapidata.rapidata_client.dataset.rapidata_dataset import RapidataDataset
@@ -16,6 +20,7 @@ from rapidata.rapidata_client.order.rapidata_order import RapidataOrder
 from rapidata.rapidata_client.referee import Referee
 from rapidata.service.openapi_service import OpenAPIService
 
+
 class RapidataOrderBuilder:
     """
     Builder object for creating Rapidata orders.
@@ -42,26 +47,30 @@ class RapidataOrderBuilder:
         self._aggregator: AggregatorType | None = None
         self._validation_set_id: str | None = None
         self._feature_flags: FeatureFlags | None = None
+        self._country_codes: list[str] | None = None
 
-    def create(self, submit=True) -> RapidataOrder:
-        """
-        Actually makes the API calls to create the order based on how the order builder was configures. Returns a RapidataOrder instance based on the created order with order_id and dataset_id.
-
-        :return: The created RapidataOrder instance.
-        :rtype: RapidataOrder
-        :raises ValueError: If no workflow is provided.
-        """
+    def _to_model(self) -> CreateOrderModel:
         if self._workflow is None:
             raise ValueError("You must provide a blueprint to create an order.")
 
         if self._referee is None:
             print("No referee provided, using default NaiveReferee.")
             self._referee = NaiveReferee()
+        if self._country_codes is None:
+            country_filter = None
+        else:
+            country_filter = CountryUserFilterModel(
+                _t="CountryFilter", countries=self._country_codes
+            )
 
-        order_model = CreateOrderModel(
+        return CreateOrderModel(
             orderName=self._name,
             workflow=CreateOrderModelWorkflow(self._workflow.to_model()),
-            userFilters=[],
+            userFilters=(
+                [CreateOrderModelUserFiltersInner(country_filter)]
+                if country_filter
+                else []
+            ),
             referee=CreateOrderModelReferee(self._referee.to_model()),
             validationSetId=self._validation_set_id,
             featureFlags=(
@@ -71,6 +80,16 @@ class RapidataOrderBuilder:
             ),
         )
 
+    def create(self, submit=True) -> RapidataOrder:
+        """
+        Actually makes the API calls to create the order based on how the order builder was configures. Returns a RapidataOrder instance based on the created order with order_id and dataset_id.
+
+        :return: The created RapidataOrder instance.
+        :rtype: RapidataOrder
+        :raises ValueError: If no workflow is provided.
+        """
+        order_model = self._to_model()
+
         result = self._openapi_service.order_api.order_create_post(
             create_order_model=order_model
         )
@@ -143,7 +162,7 @@ class RapidataOrderBuilder:
         self._feature_flags = feature_flags
         return self
 
-    def target_country_codes(self, country_codes: list[str]):
+    def country_filter(self, country_codes: list[str]):
         """
         Set the target country codes for the order.
 
@@ -152,12 +171,7 @@ class RapidataOrderBuilder:
         :return: The updated RapidataOrderBuilder instance.
         :rtype: RapidataOrderBuilder
         """
-        if self._workflow is None:
-            raise ValueError(
-                "You must set the workflow before setting the target country codes."
-            )
-
-        self._workflow.target_country_codes(country_codes)
+        self._country_codes = country_codes
         return self
 
     def aggregator(self, aggregator: AggregatorType):
@@ -172,7 +186,7 @@ class RapidataOrderBuilder:
         self._aggregator = aggregator
         return self
 
-    def validation_set(self, validation_set_id: str):
+    def validation_set_id(self, validation_set_id: str):
         """
         Set the validation set for the order.