rapidata 1.7.1__py3-none-any.whl → 1.8.1__py3-none-any.whl

rapidata/api_client/__init__.py

@@ -245,6 +245,7 @@ from rapidata.api_client.models.rapid_result_model_result import RapidResultMode
 from rapidata.api_client.models.rapid_skipped_model import RapidSkippedModel
 from rapidata.api_client.models.read_bridge_token_keys_result import ReadBridgeTokenKeysResult
 from rapidata.api_client.models.register_temporary_customer_model import RegisterTemporaryCustomerModel
+from rapidata.api_client.models.register_temporary_customer_result import RegisterTemporaryCustomerResult
 from rapidata.api_client.models.root_filter import RootFilter
 from rapidata.api_client.models.send_completion_mail_step_model import SendCompletionMailStepModel
 from rapidata.api_client.models.shape import Shape

rapidata/api_client/api/identity_api.py

@@ -22,6 +22,7 @@ from typing_extensions import Annotated
 from rapidata.api_client.models.create_bridge_token_result import CreateBridgeTokenResult
 from rapidata.api_client.models.read_bridge_token_keys_result import ReadBridgeTokenKeysResult
 from rapidata.api_client.models.register_temporary_customer_model import RegisterTemporaryCustomerModel
+from rapidata.api_client.models.register_temporary_customer_result import RegisterTemporaryCustomerResult
 
 from rapidata.api_client.api_client import ApiClient, RequestSerialized
 from rapidata.api_client.api_response import ApiResponse
@@ -589,7 +590,7 @@ class IdentityApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> None:
+    ) -> RegisterTemporaryCustomerResult:
         """Registers and logs in a temporary customer.
 
 
@@ -626,7 +627,7 @@ class IdentityApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "RegisterTemporaryCustomerResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -655,7 +656,7 @@ class IdentityApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[None]:
+    ) -> ApiResponse[RegisterTemporaryCustomerResult]:
         """Registers and logs in a temporary customer.
 
 
@@ -692,7 +693,7 @@ class IdentityApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "RegisterTemporaryCustomerResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -758,7 +759,7 @@ class IdentityApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': None,
+            '200': "RegisterTemporaryCustomerResult",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -799,6 +800,15 @@ class IdentityApi:
             _body_params = register_temporary_customer_model
 
 
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'text/plain', 
+                    'application/json', 
+                    'text/json'
+                ]
+            )
 
         # set the HTTP header `Content-Type`
         if _content_type:

rapidata/api_client/models/__init__.py

@@ -213,6 +213,7 @@ from rapidata.api_client.models.rapid_result_model_result import RapidResultMode
 from rapidata.api_client.models.rapid_skipped_model import RapidSkippedModel
 from rapidata.api_client.models.read_bridge_token_keys_result import ReadBridgeTokenKeysResult
 from rapidata.api_client.models.register_temporary_customer_model import RegisterTemporaryCustomerModel
+from rapidata.api_client.models.register_temporary_customer_result import RegisterTemporaryCustomerResult
 from rapidata.api_client.models.root_filter import RootFilter
 from rapidata.api_client.models.send_completion_mail_step_model import SendCompletionMailStepModel
 from rapidata.api_client.models.shape import Shape

rapidata/api_client/models/evaluation_workflow_config.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List
 from rapidata.api_client.models.compare_workflow_model1_referee import CompareWorkflowModel1Referee
 from typing import Optional, Set
@@ -30,7 +30,8 @@ class EvaluationWorkflowConfig(BaseModel):
     t: StrictStr = Field(description="Discriminator value for EvaluationWorkflowConfig", alias="_t")
     validation_set_id: StrictStr = Field(alias="validationSetId")
     referee: CompareWorkflowModel1Referee
-    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "referee"]
+    should_accept_incorrect: StrictBool = Field(alias="shouldAcceptIncorrect")
+    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "referee", "shouldAcceptIncorrect"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -95,7 +96,8 @@ class EvaluationWorkflowConfig(BaseModel):
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'EvaluationWorkflowConfig',
             "validationSetId": obj.get("validationSetId"),
-            "referee": CompareWorkflowModel1Referee.from_dict(obj["referee"]) if obj.get("referee") is not None else None
+            "referee": CompareWorkflowModel1Referee.from_dict(obj["referee"]) if obj.get("referee") is not None else None,
+            "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect")
         })
         return _obj
 

rapidata/api_client/models/evaluation_workflow_model.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
@@ -28,7 +28,8 @@ class EvaluationWorkflowModel(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for EvaluationWorkflow", alias="_t")
     validation_set_id: StrictStr = Field(description="The Validation Set Id is used to as a source for the tasks that will be sent to the user.", alias="validationSetId")
-    __properties: ClassVar[List[str]] = ["_t", "validationSetId"]
+    should_accept_incorrect: StrictBool = Field(description="Indicates if the user should get feedback on their answers if they answer wrong. If set to true the user will not  notice that he was tested.", alias="shouldAcceptIncorrect")
+    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "shouldAcceptIncorrect"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -89,7 +90,8 @@ class EvaluationWorkflowModel(BaseModel):
 
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'EvaluationWorkflow',
-            "validationSetId": obj.get("validationSetId")
+            "validationSetId": obj.get("validationSetId"),
+            "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect")
         })
         return _obj
 

rapidata/api_client/models/read_bridge_token_keys_result.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
@@ -27,8 +27,12 @@ class ReadBridgeTokenKeysResult(BaseModel):
     ReadBridgeTokenKeysResult
     """ # noqa: E501
     access_token: Optional[StrictStr] = Field(alias="accessToken")
+    expires_in: Optional[StrictInt] = Field(alias="expiresIn")
     refresh_token: Optional[StrictStr] = Field(alias="refreshToken")
-    __properties: ClassVar[List[str]] = ["accessToken", "refreshToken"]
+    id_token: Optional[StrictStr] = Field(alias="idToken")
+    token_type: Optional[StrictStr] = Field(alias="tokenType")
+    scope: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["accessToken", "expiresIn", "refreshToken", "idToken", "tokenType", "scope"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -74,11 +78,31 @@ class ReadBridgeTokenKeysResult(BaseModel):
         if self.access_token is None and "access_token" in self.model_fields_set:
             _dict['accessToken'] = None
 
+        # set to None if expires_in (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires_in is None and "expires_in" in self.model_fields_set:
+            _dict['expiresIn'] = None
+
         # set to None if refresh_token (nullable) is None
         # and model_fields_set contains the field
         if self.refresh_token is None and "refresh_token" in self.model_fields_set:
             _dict['refreshToken'] = None
 
+        # set to None if id_token (nullable) is None
+        # and model_fields_set contains the field
+        if self.id_token is None and "id_token" in self.model_fields_set:
+            _dict['idToken'] = None
+
+        # set to None if token_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.token_type is None and "token_type" in self.model_fields_set:
+            _dict['tokenType'] = None
+
+        # set to None if scope (nullable) is None
+        # and model_fields_set contains the field
+        if self.scope is None and "scope" in self.model_fields_set:
+            _dict['scope'] = None
+
         return _dict
 
     @classmethod
@@ -92,7 +116,11 @@ class ReadBridgeTokenKeysResult(BaseModel):
 
         _obj = cls.model_validate({
             "accessToken": obj.get("accessToken"),
-            "refreshToken": obj.get("refreshToken")
+            "expiresIn": obj.get("expiresIn"),
+            "refreshToken": obj.get("refreshToken"),
+            "idToken": obj.get("idToken"),
+            "tokenType": obj.get("tokenType"),
+            "scope": obj.get("scope")
         })
         return _obj
 

rapidata/api_client/models/register_temporary_customer_result.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RegisterTemporaryCustomerResult(BaseModel):
+    """
+    The access parameters of the newly registered temporary customer.
+    """ # noqa: E501
+    access_token: StrictStr = Field(description="The access token to authenticate the user.")
+    expires_in: Optional[StrictInt] = Field(default=None, description="The time in seconds until the access token expires.")
+    refresh_token: Optional[StrictStr] = Field(default=None, description="The refresh token to refresh the access token.")
+    id_token: StrictStr = Field(description="The id token to identify the user.")
+    token_type: StrictStr = Field(description="The type of token. Usually, this is \"Bearer\".")
+    scope: Optional[StrictStr] = Field(default=None, description="The scope of access the token has.")
+    __properties: ClassVar[List[str]] = ["access_token", "expires_in", "refresh_token", "id_token", "token_type", "scope"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of RegisterTemporaryCustomerResult from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if expires_in (nullable) is None
+        # and model_fields_set contains the field
+        if self.expires_in is None and "expires_in" in self.model_fields_set:
+            _dict['expires_in'] = None
+
+        # set to None if refresh_token (nullable) is None
+        # and model_fields_set contains the field
+        if self.refresh_token is None and "refresh_token" in self.model_fields_set:
+            _dict['refresh_token'] = None
+
+        # set to None if scope (nullable) is None
+        # and model_fields_set contains the field
+        if self.scope is None and "scope" in self.model_fields_set:
+            _dict['scope'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RegisterTemporaryCustomerResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "access_token": obj.get("access_token"),
+            "expires_in": obj.get("expires_in"),
+            "refresh_token": obj.get("refresh_token"),
+            "id_token": obj.get("id_token"),
+            "token_type": obj.get("token_type"),
+            "scope": obj.get("scope")
+        })
+        return _obj
+
+

rapidata/api_client_README.md

@@ -344,6 +344,7 @@ Class | Method | HTTP request | Description
  - [RapidSkippedModel](rapidata/api_client/docs/RapidSkippedModel.md)
  - [ReadBridgeTokenKeysResult](rapidata/api_client/docs/ReadBridgeTokenKeysResult.md)
  - [RegisterTemporaryCustomerModel](rapidata/api_client/docs/RegisterTemporaryCustomerModel.md)
+ - [RegisterTemporaryCustomerResult](rapidata/api_client/docs/RegisterTemporaryCustomerResult.md)
  - [RootFilter](rapidata/api_client/docs/RootFilter.md)
  - [SendCompletionMailStepModel](rapidata/api_client/docs/SendCompletionMailStepModel.md)
  - [Shape](rapidata/api_client/docs/Shape.md)

rapidata/rapidata_client/assets/__init__.py

@@ -2,7 +2,7 @@
 
 This package provides classes for different types of assets, including MediaAsset, TextAsset, and MultiAsset.
 """
-
+from .base_asset import BaseAsset
 from .media_asset import MediaAsset
 from .text_asset import TextAsset
 from .multi_asset import MultiAsset

rapidata/rapidata_client/assets/media_asset.py

@@ -31,6 +31,9 @@ class MediaAsset(BaseAsset):
         Raises:
             FileNotFoundError: If the provided file path does not exist.
         """
+        if not isinstance(path, str):
+            raise ValueError("Media must be a string, either a local file path or an image URL")
+
         if re.match(r'^https?://', path):
             self.path = MediaAsset.get_image_bytes(path)
             self.name = path.split('/')[-1]

rapidata/rapidata_client/assets/text_asset.py

@@ -22,4 +22,7 @@ class TextAsset(BaseAsset):
         Args:
             text (str): The textual content of the asset.
         """
+        if not isinstance(text, str):
+            raise ValueError("Text must be a string")
+        
         self.text = text

rapidata/rapidata_client/country_codes/country_codes.py

@@ -16,4 +16,4 @@ class CountryCodes:
         "GB",
         "US",
     ]
-    GERMAN_SPEAKING = (["AT", "DE"],)
+    GERMAN_SPEAKING = ["AT", "DE"]

rapidata/rapidata_client/dataset/rapid_builders/__init__.py

@@ -0,0 +1,4 @@
+from .classify_rapid_builders import ClassifyRapidQuestionBuilder
+from .compare_rapid_builders import CompareRapidCriteriaBuilder
+from .transcription_rapid_builders import TranscriptionRapidInstructionBuilder
+from .base_rapid_builder import BaseRapidBuilder

rapidata/rapidata_client/dataset/rapid_builders/base_rapid_builder.py

@@ -0,0 +1,33 @@
+from rapidata.service.openapi_service import OpenAPIService
+from rapidata.rapidata_client.dataset.rapid_builders import ClassifyRapidQuestionBuilder, CompareRapidCriteriaBuilder, TranscriptionRapidInstructionBuilder
+
+class BaseRapidBuilder:
+    """Base class for creating different types of rapids.
+    
+    This class provides factory methods to create specific rapids
+    """
+
+    def classify_rapid(self):
+        """Creates a classification rapid.
+        
+        Returns:
+            ClassifyRapidQuestionBuilder: A builder for creating the classification question.
+        """
+        return ClassifyRapidQuestionBuilder()
+    
+    def compare_rapid(self):    
+        """Creates a compare rapid.
+        
+        Returns:
+            CompareRapidCriteriaBuilder: A builder for creating a comparison criteria.
+        """
+        return CompareRapidCriteriaBuilder()
+    
+    def transcription_rapid(self):
+        """Creates a transcription rapid.
+        
+        Returns:
+            TranscriptionRapidInstructionBuilder: A builder for creating the transcription instruction.
+        """
+        return TranscriptionRapidInstructionBuilder()
+        

rapidata/rapidata_client/dataset/rapid_builders/classify_rapid_builders.py

@@ -0,0 +1,166 @@
+from rapidata.rapidata_client.assets import MediaAsset, TextAsset
+from rapidata.rapidata_client.metadata import PromptMetadata
+from rapidata.rapidata_client.dataset.rapid_builders.rapids import ClassificationRapid
+
+class ClassifyRapidBuilder:
+    """Final builder class for classification rapid.
+    
+    This class handles the final construction of a classification rapid with all required parameters.
+    """
+    def __init__(self, question: str, options: list[str], truths: list[str], asset: MediaAsset | TextAsset):
+        self._question = question
+        self._options = options
+        self._truths = truths
+        self._asset = asset
+        self._metadata = []
+
+    def prompt(self, prompt: str):
+        """Add a prompt to provide additional context for the classification task.
+        
+        Args:
+            prompt (str): Additional instructions or context
+            
+        Returns:
+            ClassifyRapidBuilder: The builder instance for method chaining
+        """
+        self._metadata.append(PromptMetadata(prompt))
+        return self
+    
+    def build(self):
+        """Constructs and returns the final classification rapid.
+        
+        Returns:
+            ClassificationRapid: The constructed classification rapid 
+        """
+        return ClassificationRapid(
+            question=self._question,
+            options=self._options,
+            truths=self._truths,
+            asset=self._asset,
+            metadata=self._metadata
+        )
+    
+class ClassifyRapidTruthBuilder:
+    """Builder class for the truths of the classification rapid.
+
+    This adds the truths to the classification rapid.
+    """
+    def __init__(self, question: str, options: list[str], asset: MediaAsset | TextAsset):
+        self._question = question
+        self._options = options
+        self._asset = asset
+        self._truths = None
+
+    def truths(self, truths: list[str]):
+        """Set the truths for the classification rapid.
+
+        Args:
+            truths (list[str]): The correct answers for the classification task"""
+        
+        if not isinstance(truths, list) or not all(isinstance(truth, str) for truth in truths):
+            raise ValueError("Truths must be a list of strings")
+        
+        if not all(truth in self._options for truth in truths):
+            raise ValueError("Truths must be one of the selectable options")
+        
+        self._truths = truths
+        return self._build()
+    
+    def _build(self):
+        if self._truths is None:
+            raise ValueError("Truths are required")
+        return ClassifyRapidBuilder(
+            question=self._question,
+            options=self._options,
+            asset=self._asset,
+            truths=self._truths,
+        )
+    
+class ClassifyRapidMediaBuilder:
+    """Builder class for the media asset of the classification rapid.
+
+    This class adds the media asset to the classification rapid.
+    """
+    def __init__(self, question: str, options: list[str]):
+        self._question = question
+        self._options = options
+        self._asset: MediaAsset | TextAsset | None = None
+
+    def media(self, media: str):
+        """Set the media asset for the classification rapid.
+
+        Args:
+            media (str): A local file path or an image URL. The image will be displayed with the classification task"""        
+        self._asset = MediaAsset(media)
+
+        return self._build()
+
+    def text(self, text: str):
+        """Set the text asset for the classification rapid.
+
+        Args:
+            text (str): The text to be displayed with the classification task"""
+        self._asset = TextAsset(text)
+
+        return self._build()
+
+    def _build(self):
+        if self._asset is None:
+            raise ValueError("Assets are required")
+        
+        return ClassifyRapidTruthBuilder(
+            question=self._question,
+            options=self._options,
+            asset=self._asset,
+        )
+
+class ClassifyRapidOptionsBuilder:
+    def __init__(self, question: str):
+        self._question = question
+        self._options = None
+
+    def options(self, options: list[str]):
+        """Set the options for the classification rapid.
+
+        Args:
+            options (list[str]): The selectable options for the classification task"""
+
+        if not isinstance(options, list) or not all(isinstance(option, str) for option in options):
+            raise ValueError("Options must be a list of strings")
+        
+        self._options = options
+        return self._build()
+    
+    def _build(self):
+        if self._options is None:
+            raise ValueError("Options are required")
+        
+        return ClassifyRapidMediaBuilder(
+            question=self._question,
+            options=self._options,
+        )
+
+
+class ClassifyRapidQuestionBuilder:
+    def __init__(self):
+        self._question = None
+
+    def question(self, question: str):
+        """Set the question for the classification rapid.
+
+        Args:
+            question (str): The question to be answered by the classification task"""
+        
+        if not isinstance(question, str):
+            raise ValueError("Question must be a string")
+        
+        self._question = question
+        return self._build()
+    
+    def _build(self):
+        if self._question is None:
+            raise ValueError("Question is required")
+        
+        return ClassifyRapidOptionsBuilder(
+            question=self._question,
+        )