rapidata 2.2.1__py3-none-any.whl → 2.3.1__py3-none-any.whl

rapidata/api_client/api/client_api.py

@@ -834,3 +834,257 @@ class ClientApi:
         )
 
 
+
+
+    @validate_call
+    def client_set_referrer_post(
+        self,
+        referrer: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> None:
+        """Sets the referrer for the current customer.
+
+
+        :param referrer: 
+        :type referrer: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._client_set_referrer_post_serialize(
+            referrer=referrer,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def client_set_referrer_post_with_http_info(
+        self,
+        referrer: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[None]:
+        """Sets the referrer for the current customer.
+
+
+        :param referrer: 
+        :type referrer: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._client_set_referrer_post_serialize(
+            referrer=referrer,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def client_set_referrer_post_without_preload_content(
+        self,
+        referrer: Optional[StrictStr] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Sets the referrer for the current customer.
+
+
+        :param referrer: 
+        :type referrer: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._client_set_referrer_post_serialize(
+            referrer=referrer,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _client_set_referrer_post_serialize(
+        self,
+        referrer,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if referrer is not None:
+            
+            _query_params.append(('referrer', referrer))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearer', 
+            'oauth2'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/Client/SetReferrer',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

rapidata/api_client/models/aggregator_type.py

@@ -37,6 +37,7 @@ class AggregatorType(str, Enum):
     TRANSCRIPTION = 'Transcription'
     SINGLEPOINTLOCATE = 'SinglePointLocate'
     FREETEXT = 'FreeText'
+    SCRUB = 'Scrub'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

rapidata/api_client/models/create_order_model.py

@@ -57,8 +57,8 @@ class CreateOrderModel(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText']):
-            raise ValueError("must be one of enum values ('NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText')")
+        if value not in set(['NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText', 'Scrub']):
+            raise ValueError("must be one of enum values ('NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText', 'Scrub')")
         return value
 
     model_config = ConfigDict(

rapidata/api_client/models/transcription_truth.py

@@ -17,8 +17,8 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from rapidata.api_client.models.transcription_word import TranscriptionWord
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,7 +30,9 @@ class TranscriptionTruth(BaseModel):
     t: StrictStr = Field(description="Discriminator value for TranscriptionTruth", alias="_t")
     correct_words: List[TranscriptionWord] = Field(alias="correctWords")
     strict_grading: Optional[StrictBool] = Field(default=None, alias="strictGrading")
-    __properties: ClassVar[List[str]] = ["_t", "correctWords", "strictGrading"]
+    required_precision: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="requiredPrecision")
+    required_completeness: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="requiredCompleteness")
+    __properties: ClassVar[List[str]] = ["_t", "correctWords", "strictGrading", "requiredPrecision", "requiredCompleteness"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -85,6 +87,21 @@ class TranscriptionTruth(BaseModel):
                 if _item_correct_words:
                     _items.append(_item_correct_words.to_dict())
             _dict['correctWords'] = _items
+        # set to None if strict_grading (nullable) is None
+        # and model_fields_set contains the field
+        if self.strict_grading is None and "strict_grading" in self.model_fields_set:
+            _dict['strictGrading'] = None
+
+        # set to None if required_precision (nullable) is None
+        # and model_fields_set contains the field
+        if self.required_precision is None and "required_precision" in self.model_fields_set:
+            _dict['requiredPrecision'] = None
+
+        # set to None if required_completeness (nullable) is None
+        # and model_fields_set contains the field
+        if self.required_completeness is None and "required_completeness" in self.model_fields_set:
+            _dict['requiredCompleteness'] = None
+
         return _dict
 
     @classmethod
@@ -99,7 +116,9 @@ class TranscriptionTruth(BaseModel):
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'TranscriptionTruth',
             "correctWords": [TranscriptionWord.from_dict(_item) for _item in obj["correctWords"]] if obj.get("correctWords") is not None else None,
-            "strictGrading": obj.get("strictGrading")
+            "strictGrading": obj.get("strictGrading"),
+            "requiredPrecision": obj.get("requiredPrecision"),
+            "requiredCompleteness": obj.get("requiredCompleteness")
         })
         return _obj
 

rapidata/api_client/models/workflow_aggregation_step_model.py

@@ -46,8 +46,8 @@ class WorkflowAggregationStepModel(BaseModel):
         if value is None:
             return value
 
-        if value not in set(['NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText']):
-            raise ValueError("must be one of enum values ('NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText')")
+        if value not in set(['NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText', 'Scrub']):
+            raise ValueError("must be one of enum values ('NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText', 'Scrub')")
         return value
 
     model_config = ConfigDict(

rapidata/api_client_README.md

@@ -78,6 +78,7 @@ Class | Method | HTTP request | Description
 *ClientApi* | [**client_client_id_delete**](rapidata/api_client/docs/ClientApi.md#client_client_id_delete) | **DELETE** /Client/{clientId} | Deletes a customers client.
 *ClientApi* | [**client_post**](rapidata/api_client/docs/ClientApi.md#client_post) | **POST** /Client | Creates a new client for the current customer.
 *ClientApi* | [**client_query_get**](rapidata/api_client/docs/ClientApi.md#client_query_get) | **GET** /Client/Query | Gets the clients for the current customer.
+*ClientApi* | [**client_set_referrer_post**](rapidata/api_client/docs/ClientApi.md#client_set_referrer_post) | **POST** /Client/SetReferrer | Sets the referrer for the current customer.
 *CocoApi* | [**coco_submit_post**](rapidata/api_client/docs/CocoApi.md#coco_submit_post) | **POST** /Coco/Submit | Creates a new validation set based on a previously uploaded CoCo set.
 *CocoApi* | [**coco_upload_post**](rapidata/api_client/docs/CocoApi.md#coco_upload_post) | **POST** /Coco/Upload | Uploads a CoCo set to the system.
 *CompareWorkflowApi* | [**compare_workflow_get_result_overview_get**](rapidata/api_client/docs/CompareWorkflowApi.md#compare_workflow_get_result_overview_get) | **GET** /CompareWorkflow/GetResultOverview | Get the result overview for a compare workflow.

rapidata/rapidata_client/assets/_media_asset.py

@@ -11,6 +11,8 @@ import re
 from PIL import Image
 from tinytag import TinyTag
 import tempfile
+from pydantic import StrictStr, StrictBytes
+
 
 class MediaAsset(BaseAsset):
     """MediaAsset Class
@@ -161,3 +163,10 @@ class MediaAsset(BaseAsset):
 
         content = BytesIO(response.content)
         return content.getvalue()
+    
+    def to_file(self) -> StrictStr | tuple[StrictStr, StrictBytes] | StrictBytes: # types for autogenerated models
+        files = []
+        if isinstance(self.path, str):
+            return self.path
+        else: # isinstance(self.path, bytes)
+            return (self.name, self.path)

rapidata/rapidata_client/demographic/demographic_manager.py

@@ -0,0 +1,27 @@
+from rapidata.service.openapi_service import OpenAPIService
+from rapidata.rapidata_client.assets import MediaAsset
+from rapidata.api_client.models.create_demographic_rapid_model import CreateDemographicRapidModel
+from rapidata.api_client.models.classify_payload import ClassifyPayload
+
+
+class DemographicManager:
+    def __init__(self, openapi_service: OpenAPIService):
+        self._openapi_service = openapi_service
+    
+    def create_demographic_rapid(self, 
+                                 instruction: str,
+                                 answer_options: list[str],
+                                 datapoint: str,
+                                 key: str):
+        
+        media = MediaAsset(path=datapoint)
+        model = CreateDemographicRapidModel(
+            key=key,
+            payload=ClassifyPayload(
+                _t="ClassifyPayload",
+                possibleCategories=answer_options,
+                title=instruction
+            )
+        )
+        self._openapi_service.rapid_api.rapid_create_demographic_rapid_post(model=model, file=[media.to_file()])
+        

rapidata/rapidata_client/order/_rapidata_dataset.py

@@ -14,6 +14,7 @@ from rapidata.service.openapi_service import OpenAPIService
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from tqdm import tqdm
 
+from pydantic import StrictBytes, StrictStr
 from typing import cast, Sequence
 
 
@@ -100,17 +101,14 @@ class RapidataDataset:
                 ),
             )
 
-            files: list[tuple[str, bytes] | str] = []
+            files: list[tuple[StrictStr, StrictBytes] | StrictStr | StrictBytes] = []
             for asset in assets:
                 if isinstance(asset, MediaAsset):
-                    if isinstance(asset.path, bytes):
-                        files.append((asset.name, asset.path))
-                    else:
-                        files.append(cast(str, asset.path))
+                    files.append(asset.to_file())
 
             upload_response = self.openapi_service.dataset_api.dataset_create_datapoint_post(
                 model=model,
-                files=files # type: ignore
+                files=files
             )
             if upload_response.errors:
                 raise ValueError(f"Error uploading datapoint: {upload_response.errors}")

rapidata/rapidata_client/rapidata_client.py

@@ -4,6 +4,7 @@ from rapidata.rapidata_client.order.rapidata_order_manager import RapidataOrderM
 
 from rapidata.rapidata_client.validation.validation_set_manager import ValidationSetManager
 
+from rapidata.rapidata_client.demographic.demographic_manager import DemographicManager
 
 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."""
@@ -39,3 +40,5 @@ class RapidataClient:
         self.order = RapidataOrderManager(openapi_service=self._openapi_service)
         
         self.validation = ValidationSetManager(openapi_service=self._openapi_service)
+
+        self._demographic = DemographicManager(openapi_service=self._openapi_service)

rapidata/rapidata_client/validation/_validation_set_builder.py

@@ -107,7 +107,14 @@ class ValidationSetBuilder:
             self.__add_compare_rapid(rapid.asset, rapid.instruction, rapid.truth, rapid.metadata)
 
         elif isinstance(rapid, SelectWordsRapid):
-            self.__add_select_words_rapid(rapid.asset, rapid.instruction, rapid.sentence, rapid.truths, rapid.strict_grading)
+            self.__add_select_words_rapid(
+                rapid.asset, 
+                rapid.instruction, 
+                rapid.sentence, 
+                rapid.truths, 
+                rapid.required_precision,
+                rapid.required_completeness, 
+                rapid.metadata)
         
         elif isinstance(rapid, LocateRapid):
             self.__add_locate_rapid(rapid.asset, rapid.instruction, rapid.truths, rapid.metadata)
@@ -213,7 +220,8 @@ class ValidationSetBuilder:
         instruction: str,
         select_words: str,
         truths: list[int],
-        strict_grading: bool | None = None,
+        required_precision: float,
+        required_completeness: float,
         metadata: Sequence[Metadata] = [],
     ):
         """Add a select words rapid to the validation set.
@@ -223,7 +231,8 @@ class ValidationSetBuilder:
             instruction (str): The instruction for the rapid.
             select words (list[str]): The select words for the rapid.
             truths (list[int]): The list of indices of the true word selections.
-            strict_grading (bool | None, optional): The strict grading for the rapid. Defaults to None.
+            required_precision (float): The required precision for the rapid (minimum ratio of selected words that are correct).
+            required_completeness (float): The required completeness for the rapid (miminum ratio of total correct words selected).
             metadata (Sequence[Metadata], optional): The metadata for the rapid.
 
         Returns:
@@ -251,7 +260,8 @@ class ValidationSetBuilder:
         model_truth = TranscriptionTruth(
             _t="TranscriptionTruth",
             correctWords=true_words,
-            strictGrading=strict_grading,
+            requiredPrecision=required_precision,
+            requiredCompleteness=required_completeness,
         )
 
         self._rapid_parts.append(

rapidata/rapidata_client/validation/rapidata_validation_set.py

@@ -70,12 +70,8 @@ class RapidataValidationSet:
         """
         files = []
         for asset in assets:
-            if isinstance(asset.path, str):
-                files.append(asset.path)
-            elif isinstance(asset.path, bytes):
-                files.append((asset.name, asset.path))
-            else:
-                raise ValueError("upload file failed")
+            files.append(asset.to_file())
+            
         self.__openapi_service.validation_api.validation_add_validation_rapid_post(
             model=model, files=files
         )        

rapidata/rapidata_client/validation/rapids/rapids.py

@@ -55,12 +55,23 @@ class SelectWordsRapid(Rapid):
             True means that all correct words and no wrong words have to be selected for the rapid to be marked as correct.
             False means that at least one correct word and no wrong words have to be selected for the rapid to be marked as correct.
     """
-    def __init__(self, instruction: str, truths: list[int], asset: MediaAsset, sentence: str, strict_grading: bool):
+    def __init__(self, instruction: str, truths: list[int], asset: MediaAsset, sentence: str, required_precision: float, required_completeness: float, metadata: Sequence[Metadata]):
+        if not isinstance(truths, list):
+            raise ValueError("The truths must be a list of integers.")
+        if not all(isinstance(x, int) for x in truths):
+            raise ValueError("The truths must be a list of integers.")
+        if required_completeness <= 0 or required_completeness > 1:
+            raise ValueError("The required completeness must be > 0 and <= 1.")
+        if required_precision <= 0 or required_precision > 1:
+            raise ValueError("The required precision must be > 0 and <= 1.")
+        
         self.instruction = instruction
         self.truths = truths
         self.asset = asset
         self.sentence = sentence
-        self.strict_grading = strict_grading
+        self.required_precision = required_precision
+        self.required_completeness = required_completeness
+        self.metadata = metadata
 
 class LocateRapid(Rapid):
     """

rapidata/rapidata_client/validation/rapids/rapids_manager.py

@@ -91,7 +91,9 @@ class RapidsManager:
             truths: list[int],
             datapoint: str,
             sentence: str,
-            strict_grading: bool = True,
+            required_precision: float = 1,
+            required_completeness: float = 1,
+            metadata: Sequence[Metadata] = [],
     ) -> SelectWordsRapid:
         """Build a select words rapid
 
@@ -100,9 +102,9 @@ class RapidsManager:
             truths (list[int]): The indices of the words that are the correct answers.
             datapoint (str): The asset that the labeler will be selecting words from.
             sentence (str): The sentence that the labeler will be selecting words from. (split up by spaces)
-            strict_grading (bool, optional): Whether the grading should be strict or not. 
-                True means that all correct words and no wrong words have to be selected for the rapid to be marked as correct.
-                False means that at least one correct word and no wrong words have to be selected for the rapid to be marked as correct. Defaults to True.
+            required_precision (float): The required precision for the labeler to get the rapid correct (minimum ratio of the words selected that need to be correct). defaults to 1. (no wrong words can be selected)
+            required_completeness (float): The required completeness for the labeler to get the rapid correct (miminum ratio of total correct words selected). defaults to 1. (all correct words need to be selected)
+            metadata (Sequence[Metadata], optional): The metadata that is attached to the rapid. Defaults to [].
         """
         
         asset = MediaAsset(datapoint)
@@ -112,7 +114,9 @@ class RapidsManager:
                 truths=truths,
                 asset=asset,
                 sentence=sentence,
-                strict_grading=strict_grading,
+                required_precision=required_precision,
+                required_completeness=required_completeness,
+                metadata=metadata,
                 )
     
     def locate_rapid(self,

rapidata/rapidata_client/validation/validation_set_manager.py

@@ -149,7 +149,8 @@ class ValidationSetManager:
         truths: list[list[int]],
         datapoints: list[str],
         sentences: list[str],
-        strict_grading: bool = True,
+        required_precision: float = 1.0,
+        required_completeness: float = 1.0,
         print_confirmation: bool = True
     ) -> RapidataValidationSet:
         """Create a select words validation set.
@@ -165,9 +166,8 @@ class ValidationSetManager:
             datapoints (list[str]): The datapoints that will be used for validation.
             sentences (list[str]): The sentences that will be used for validation. The sentece will be split up by spaces to be selected by the labeler.
                 Must be the same length as datapoints.
-            strict_grading (bool, optional): Whether to grade strictly. Defaults to True.\n
-                If True, the labeler must select all correct words to be graded as correct. (and no wrong words)
-                If False, the labeler must select at least one correct word to be graded as correct. (and no wrong words)
+            required_precision (float, optional): The required precision for the labeler to get the rapid correct (minimum ratio of the words selected that need to be correct). Defaults to 1.0 (no wrong word can be selected).
+            required_completeness (float, optional): The required completeness for the labeler to get the rapid correct (miminum ratio of total correct words selected). Defaults to 1.0 (all correct words need to be selected).
             print_confirmation (bool, optional): Whether to print a confirmation message that validation set has been created. Defaults to True.
             """
         
@@ -185,7 +185,8 @@ class ValidationSetManager:
                     truths=truths[i],
                     datapoint=datapoints[i],
                     sentence=sentences[i],
-                    strict_grading=strict_grading
+                    required_precision=required_precision,
+                    required_completeness=required_completeness
                 )
             )
 

{rapidata-2.2.1.dist-info → rapidata-2.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rapidata
-Version: 2.2.1
+Version: 2.3.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-2.2.1.dist-info → rapidata-2.3.1.dist-info}/RECORD

@@ -2,7 +2,7 @@ rapidata/__init__.py,sha256=fQDxHG9k8jBQ0Tm5f2XoKZwcEUaAXbUltwsoEXTBXRA,611
 rapidata/api_client/__init__.py,sha256=sDQWfUMNIuHPtylab64lr3uy1uFfkd0toh5cS-q_Syc,25564
 rapidata/api_client/api/__init__.py,sha256=h0wnYolEBVduAU_7YBLFnwHcwXgZg_krSgarsWxz4zs,1061
 rapidata/api_client/api/campaign_api.py,sha256=DxPFqt9F6c9OpXu_Uxhsrib2NVwnbcZFa3Vkrj7cIuA,40474
-rapidata/api_client/api/client_api.py,sha256=hJR9NO3YMHE-7SYwFM88p1aBW5qdmkOf7AKdq7-QZ4A,32719
+rapidata/api_client/api/client_api.py,sha256=P--1kvxHhC3mu6VQMgf6DyRV2FyC64-eyHP1X60bBSM,42259
 rapidata/api_client/api/coco_api.py,sha256=WQKGMJ568P5bcIDLyV8u6NAhp8URSItdY6PSeTgh5Go,23224
 rapidata/api_client/api/compare_workflow_api.py,sha256=2P5Z1zvlEc6zmrmeSN67l1LONpchz6g0v0olfD8M_o8,12652
 rapidata/api_client/api/datapoint_api.py,sha256=CdLFVMrVylj2_D6Ll58_4ME604-7mgWCyXF5SpKmyfI,31668
@@ -33,7 +33,7 @@ rapidata/api_client/models/admin_order_model.py,sha256=-QBgxsw7MTOYEjwOnKSndJTCW
 rapidata/api_client/models/admin_order_model_paged_result.py,sha256=edgeuvJ8yDMjKDB8vYa2YdbO7brdcgj6AMXPQTLeRbc,3494
 rapidata/api_client/models/age_group.py,sha256=XZLFEKvPveCJOCN0byJ_p1rhbIEsAeETSpUX1gAfWMc,877
 rapidata/api_client/models/age_user_filter_model.py,sha256=nlJX6bigfRyUcyenNz6oDf6idKwwIpvraYstYVo_Zns,3035
-rapidata/api_client/models/aggregator_type.py,sha256=IR1uVYj85BF3OCQoPLjBhmuYmf3qY-8jeVHWnjyLYAk,1073
+rapidata/api_client/models/aggregator_type.py,sha256=XGtJ_CiKVjehno8R2bygna9JL41_qXXgqYoDttbo0KQ,1093
 rapidata/api_client/models/attach_category_rapid_blueprint.py,sha256=sdPTViyuCnEz4KNnNxIc_sSD0Qv3ux9y6tY4--hGISM,3164
 rapidata/api_client/models/attach_category_result.py,sha256=xLM9576NxYblinC2bjUGAQ7eAqp8H1YK8i7_zS5S278,3095
 rapidata/api_client/models/attach_category_truth.py,sha256=XAc0_cCEPP0iNEaak6ihK9_lExQSGboMBIlO6SebU6o,3062
@@ -102,7 +102,7 @@ rapidata/api_client/models/create_independent_workflow_model_workflow_config.py,
 rapidata/api_client/models/create_independent_workflow_result.py,sha256=JOhS75mAH-VvarvDDFsycahPlIezVKT1upuqIo93hC0,2719
 rapidata/api_client/models/create_legacy_client_model.py,sha256=8LcKnjv3Lq6w28ku6NG6nG9qfxWQnfPow53maGlwNdE,2802
 rapidata/api_client/models/create_legacy_order_result.py,sha256=BR1XqPKq9QkDe0UytTW6dpihAeNyfCc4C1m0XfY53hQ,2672
-rapidata/api_client/models/create_order_model.py,sha256=FTdioNA4Y0OSu4CCxZ3hZvC4ihL6LqpGLmUc5YChCt0,9119
+rapidata/api_client/models/create_order_model.py,sha256=DYLdYs4sfw0rdgN7g7XIjOUMLQx0dPAi2m1W3pBSDOU,9137
 rapidata/api_client/models/create_order_model_referee.py,sha256=dxQ9SDiBjFIKYjctVNeiuGvjZwzIa0Q8JpW7iRei00I,5748
 rapidata/api_client/models/create_order_model_selections_inner.py,sha256=9p9BJKHN3WhRiu-FwWf421COAxeGmm1KkkyDT7UW5uc,8354
 rapidata/api_client/models/create_order_model_user_filters_inner.py,sha256=ARw0SIa1PXVKts5-L6eGEH-GXZYeR93qDA5k3gphh0U,10299
@@ -308,7 +308,7 @@ rapidata/api_client/models/transcription_metadata_model.py,sha256=hKqGgS8sjqXwvT
 rapidata/api_client/models/transcription_payload.py,sha256=9_l_B74rb4DQLWxWXjzrAPQhbnumEQrKtmNjPMMIp1A,3638
 rapidata/api_client/models/transcription_rapid_blueprint.py,sha256=8Cq2SaI1zaoI3LXCPRU8M4eWRCHcwrb99xCuRXYaAoo,3016
 rapidata/api_client/models/transcription_result.py,sha256=JtZpt6KbrsNOSP9JAhzleApw8dh4sWOxx8sfLz5brIA,3702
-rapidata/api_client/models/transcription_truth.py,sha256=09JR6SdR1Osrw0eVdjqwt8nnCfn9COd6UEWBYRw4yPw,3758
+rapidata/api_client/models/transcription_truth.py,sha256=Iinnfff66M6oHB3ygNI44hhf0w88gSBB2DOK5DeWL08,4956
 rapidata/api_client/models/transcription_word.py,sha256=cX_ExJVYVOhi0z2tyOr15VuMIPdHec-8E48H4DG_DNQ,2621
 rapidata/api_client/models/translated_prompt_metadata_model.py,sha256=anQhY7nzrWEFqvcoF6Gd28y5-rf0zf9cmyxNHUQRzi0,3434
 rapidata/api_client/models/translated_string.py,sha256=AeftEOw-sR4sMaQNOPy5iSo38kXmbyMIi7MmpbLvYew,2900
@@ -334,7 +334,7 @@ rapidata/api_client/models/validation_set_model.py,sha256=79-5JwNDk51WtlXO0CHfjn
 rapidata/api_client/models/validation_set_model_paged_result.py,sha256=KFdXjw6qkzGXLIHYlVSxfSYPpBPHTxEi4e6qGBzCIlk,3518
 rapidata/api_client/models/validation_set_overview_model.py,sha256=wlrjXg1dmlFmP8rIKDR88pGzpUEg15t8esr63BfYaaE,2693
 rapidata/api_client/models/validation_set_paged_result.py,sha256=3ch0KcbcH7qn8iJPY90WIiTF_MAIPJxWa3DUNfKwSI0,3477
-rapidata/api_client/models/workflow_aggregation_step_model.py,sha256=6LWLE1aY9P5u3YbbMZFcUDrREP8YiYypOw6Wrmxc0gs,4467
+rapidata/api_client/models/workflow_aggregation_step_model.py,sha256=AN7hdOdEay1ZKT_M2lxB4UrDnEQG8N-ri6po4x7vDWs,4485
 rapidata/api_client/models/workflow_artifact_model.py,sha256=B9fjf2gS-exr0t4ZbIq5OvE_OCnVCuR3o8eqAjnfRC4,3126
 rapidata/api_client/models/workflow_config_artifact_model.py,sha256=bzPK2eNzizC5ZGw-8kW_8Gvym6jkSyu5gT5OimcakWU,3650
 rapidata/api_client/models/workflow_config_artifact_model_workflow_config.py,sha256=FVsB4eqUdO5TbHn1u9NEtCt5r-suzGpNafQW43SMJ7k,6768
@@ -343,16 +343,18 @@ rapidata/api_client/models/workflow_split_model.py,sha256=zthOSaUl8dbLhLymLK_lrP
 rapidata/api_client/models/workflow_split_model_filter_configs_inner.py,sha256=1Fx9uZtztiiAdMXkj7YeCqt7o6VkG9lKf7D7UP_h088,7447
 rapidata/api_client/models/workflow_state.py,sha256=5LAK1se76RCoozeVB6oxMPb8p_5bhLZJqn7q5fFQWis,850
 rapidata/api_client/rest.py,sha256=zmCIFQC2l1t-KZcq-TgEm3vco3y_LK6vRm3Q07K-xRI,9423
-rapidata/api_client_README.md,sha256=igEl_lLPbOaBwJJVE7IEdS29Nok33nO0edcnv_OFHh0,38372
+rapidata/api_client_README.md,sha256=ggzFrD19E_A4jX9Oz9VfKgmgyz6ywnnA7OwScumZcSU,38558
 rapidata/rapidata_client/__init__.py,sha256=kkT6FMU4P8rTdYKTJgZNcyptr-Rq1iZmsyLIyRCwpYA,896
 rapidata/rapidata_client/assets/__init__.py,sha256=hKgrOSn8gJcBSULaf4auYhH1S1N5AfcwIhBSq1BOKwQ,323
 rapidata/rapidata_client/assets/_base_asset.py,sha256=B2YWH1NgaeYUYHDW3OPpHM_bqawHbH4EjnRCE2BYwiM,298
-rapidata/rapidata_client/assets/_media_asset.py,sha256=zVmYb5ETp1vDJ-lY3FnFOByuL5m2WJz9BLN9NCmxchg,5629
+rapidata/rapidata_client/assets/_media_asset.py,sha256=-b4x4q1fAN-pwd07R3QCa_Hl2hgYrTDzTEhUE6unBoU,5968
 rapidata/rapidata_client/assets/_multi_asset.py,sha256=o4_-OvovADSVpl0tr6fPzRR_gHCcIQKfeZKcoFDFBLo,1667
 rapidata/rapidata_client/assets/_text_asset.py,sha256=itoe3vicn41LbdJ7UeydImORUo9iDL0SZu-ptOlbMRM,618
 rapidata/rapidata_client/assets/data_type_enum.py,sha256=ELC-ymeKnQlfNAzfqsI7MmUuRiGYamCHVcTc0qR6Fm4,185
 rapidata/rapidata_client/country_codes/__init__.py,sha256=FB9Dcks44J6C6YBSYmTmNZ71tE130x6NO_3aLJ8fKzQ,40
 rapidata/rapidata_client/country_codes/country_codes.py,sha256=ePHqeb7y9DWQZAnddBzPx1puYBcrgUjdR2sbFijuFD8,283
+rapidata/rapidata_client/demographic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rapidata/rapidata_client/demographic/demographic_manager.py,sha256=nJLB8xCdyINmzO10QW4KvbXxaL2mdfuEQXcQrguVASw,1090
 rapidata/rapidata_client/filter/__init__.py,sha256=5V2xc_TiDireub3c4OKkcWi4hCnln2M-q8sGOKKNhX8,350
 rapidata/rapidata_client/filter/_base_filter.py,sha256=ytiSyeb9dvNZf93zwgb4PRDzf9ebsAu4wHBn4x49Re0,195
 rapidata/rapidata_client/filter/age_filter.py,sha256=oRjGY65gE_X8oa0D0XRyvKAb4_Z6XOOaGTWykRSfLFA,739
@@ -373,11 +375,11 @@ rapidata/rapidata_client/metadata/_prompt_metadata.py,sha256=lbtUP9lwUHFfrY_MVlq
 rapidata/rapidata_client/metadata/_public_text_metadata.py,sha256=BWEI8kAk3FivXmK82BEVRqy4R4EU_I9NQUSyBDSd_bs,513
 rapidata/rapidata_client/metadata/_select_words_metadata.py,sha256=I4qVtCkj60ljkiYfFO0PbRMqjscSMFCMra60a0P2G-Y,728
 rapidata/rapidata_client/order/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rapidata/rapidata_client/order/_rapidata_dataset.py,sha256=LxLXVg_d8mhkvifmhity0Miva5cnoePcNfWBl4pjUdo,5392
+rapidata/rapidata_client/order/_rapidata_dataset.py,sha256=t1OFfHXz3Pe0S8qVGdReZm4aGVvxpVWH-VUgfnNtcgQ,5300
 rapidata/rapidata_client/order/_rapidata_order_builder.py,sha256=R4iOWy8nfIHpzqqqQcQhLgpdB8z_tUrkL2M_8rZUw9M,13121
 rapidata/rapidata_client/order/rapidata_order.py,sha256=ti5fHd-KAvI_WRwe9UWF6QDx-VYzlU_Kqmi44wphJzc,6588
 rapidata/rapidata_client/order/rapidata_order_manager.py,sha256=0sbQWNHUjwKPTwAB-a_fOeOLuJYK7xl6rAj54BTn2gg,27201
-rapidata/rapidata_client/rapidata_client.py,sha256=9SMOouDBwe-aIi9rnPtnL2vrqnlQHDKxOUpw-Eh3Fsg,1782
+rapidata/rapidata_client/rapidata_client.py,sha256=A9mnSX6wzVF9TxS1YH87hTi4jCn75dIuP3KZj5Y_vFg,1957
 rapidata/rapidata_client/referee/__init__.py,sha256=q0Hv9nmfEpyChejtyMLT8hWKL0vTTf_UgUXPYNJ-H6M,153
 rapidata/rapidata_client/referee/_base_referee.py,sha256=MdFOhdxt3sRnWXLDKLJZKFdVpjBGn9jypPnWWQ6msQA,496
 rapidata/rapidata_client/referee/_early_stopping_referee.py,sha256=ULbokQZ91wc9D_20qHUhe55D28D9eTY1J1cMp_-oIDc,2088
@@ -403,13 +405,13 @@ rapidata/rapidata_client/settings/rapidata_settings.py,sha256=Kjxm4GStrpfLKylx84
 rapidata/rapidata_client/settings/translation_behaviour.py,sha256=i9n_H0eKJyKW6m3MKH_Cm1XEKWVEWsAV_79xGmGIC-4,742
 rapidata/rapidata_client/validation/__init__.py,sha256=s5wHVtcJkncXSFuL9I0zNwccNOKpWAqxqUjkeohzi2E,24
 rapidata/rapidata_client/validation/_validation_rapid_parts.py,sha256=U2aHIuCni7FjofcyY-iTeGAOt2r0DztUtiH5Qk_xgpc,2529
-rapidata/rapidata_client/validation/_validation_set_builder.py,sha256=0ZdGdWKXVj-i2O15dp6gRYpwIZ67mrY6lyBp0DTy1x4,17593
-rapidata/rapidata_client/validation/rapidata_validation_set.py,sha256=Kf4jbJaISB4zC17XfgEvpcshmjkfWrb_TYc9882kTTw,11945
+rapidata/rapidata_client/validation/_validation_set_builder.py,sha256=nOiGumrok_tt8DhmaOIM5fPwkvj_RsLPbbUPnz8Ap8M,18010
+rapidata/rapidata_client/validation/rapidata_validation_set.py,sha256=u0F_FePpDUU_b2aPomjam8-1-zQh6ckEFPePZ6SZZtM,11739
 rapidata/rapidata_client/validation/rapids/__init__.py,sha256=WU5PPwtTJlte6U90MDakzx4I8Y0laj7siw9teeXj5R0,21
 rapidata/rapidata_client/validation/rapids/box.py,sha256=t3_Kn6doKXdnJdtbwefXnYKPiTKHneJl9E2inkDSqL8,589
-rapidata/rapidata_client/validation/rapids/rapids.py,sha256=guaByk4yxMhWKVSaDSO-Umc3o4LhPAHT8BBI5dhvgdk,5980
-rapidata/rapidata_client/validation/rapids/rapids_manager.py,sha256=MxtwnjDIqMfaPsx3438IvXgWLAdejcUx88RZaLWzrXo,7435
-rapidata/rapidata_client/validation/validation_set_manager.py,sha256=FRaoaI-hm--jGbhT5_RvpABnnpAPviY0QVyn7f68-LI,19651
+rapidata/rapidata_client/validation/rapids/rapids.py,sha256=rdkdN7Z7oJXJihi7tfs0vb7l5qQxL6gP_tNKuFpc26M,6680
+rapidata/rapidata_client/validation/rapids/rapids_manager.py,sha256=1h8GVdq6UG_aWsAHEFPnwmpTLaApsYoTeUER1hD8TsA,7802
+rapidata/rapidata_client/validation/validation_set_manager.py,sha256=fHfOu3GnrmWZ_0f2l6CjPtGEYt1xR1NZJbykJABpM9M,19897
 rapidata/rapidata_client/workflow/__init__.py,sha256=eFRx0fm280alXpds6hYcnxN_yERlabF9B5sTdPFsL1g,430
 rapidata/rapidata_client/workflow/_base_workflow.py,sha256=XyIZFKS_RxAuwIHS848S3AyLEHqd07oTD_5jm2oUbsw,762
 rapidata/rapidata_client/workflow/_classify_workflow.py,sha256=9bT54wxVJgxC-zLk6MVNbseFpzYrvFPjt7DHvxqYfnk,1736
@@ -425,7 +427,7 @@ rapidata/service/credential_manager.py,sha256=Of0BQs_V1T7rkrWX9groLX790nOknaARwn
 rapidata/service/local_file_service.py,sha256=pgorvlWcx52Uh3cEG6VrdMK_t__7dacQ_5AnfY14BW8,877
 rapidata/service/openapi_service.py,sha256=Z4NrAuilLlIWBdGOv6otz36tHS_vvU36w5jmvOUTmqo,3198
 rapidata/service/token_manager.py,sha256=JZ5YbR5Di8dO3H4kK11d0kzWlrXxjgCmeNkHA4AapCM,6425
-rapidata-2.2.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-rapidata-2.2.1.dist-info/METADATA,sha256=GkuSboECcOxKXhk8BXPJKes8cL_YuZDvJXRkQiuQaBk,1107
-rapidata-2.2.1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-rapidata-2.2.1.dist-info/RECORD,,
+rapidata-2.3.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+rapidata-2.3.1.dist-info/METADATA,sha256=rxttDNDRggMxYyi1yxbWQP0fK7upUGJe8Nc0e4-CgyA,1107
+rapidata-2.3.1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+rapidata-2.3.1.dist-info/RECORD,,