rapidata 1.7.1__tar.gz → 1.8.0__tar.gz

{rapidata-1.7.1 → rapidata-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rapidata
-Version: 1.7.1
+Version: 1.8.0
 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
@@ -24,5 +24,5 @@ Description-Content-Type: text/markdown
 # Rapidata Python Client
 Python client to interface with the Rapidata API.
 
-Docs: https://rapidataai.github.io/rapidata-python-sdk
+Docs: https://docs.rapidata.ai/
 

{rapidata-1.7.1 → rapidata-1.8.0}/README.md

@@ -1,4 +1,4 @@
 # Rapidata Python Client
 Python client to interface with the Rapidata API.
 
-Docs: https://rapidataai.github.io/rapidata-python-sdk
+Docs: https://docs.rapidata.ai/

{rapidata-1.7.1 → rapidata-1.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rapidata"
-version = "1.7.1"
+version = "1.8.0"
 description = "Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way."
 authors = ["Rapidata AG <info@rapidata.ai>"]
 license = "Apache-2.0"

{rapidata-1.7.1 → rapidata-1.8.0}/src/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-1.7.1 → rapidata-1.8.0}/src/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-1.7.1 → rapidata-1.8.0}/src/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-1.7.1 → rapidata-1.8.0}/src/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-1.7.1 → rapidata-1.8.0}/src/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-1.7.1 → rapidata-1.8.0}/src/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-1.7.1 → rapidata-1.8.0}/src/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-1.8.0/src/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-1.8.0/src/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-1.8.0/src/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,
+        )

rapidata-1.8.0/src/rapidata/rapidata_client/dataset/rapid_builders/compare_rapid_builders.py

@@ -0,0 +1,145 @@
+from rapidata.rapidata_client.assets import MultiAsset, TextAsset, MediaAsset
+from rapidata.rapidata_client.metadata import PromptMetadata
+from rapidata.rapidata_client.dataset.rapid_builders.rapids import CompareRapid
+import re
+
+class CompareRapidBuilder:
+    """Final builder class for comparison rapid.
+    
+    This class handles the final construction of a comparison rapid with all required parameters.
+    """
+    def __init__(self, criteria: str, truth: str, asset: MultiAsset):
+        """Initialize the comparison rapid builder.
+        
+        Args:
+            criteria (str): The criteria for comparison
+            truth (str): The correct answer
+            asset (MultiAsset): Collection of assets to be compared
+        """
+        self._criteria = criteria
+        self._truth = truth
+        self._asset = asset
+        self._metadata = []
+
+    def prompt(self, prompt: str):
+        """Add a prompt to provide additional context for the comparison.
+        
+        Args:
+            prompt (str): Additional instructions or context
+            
+        Returns:
+            CompareRapidBuilder: The builder instance for method chaining
+        """
+        self._metadata.append(PromptMetadata(prompt))
+        return self
+
+    def build(self):
+        """Constructs and returns the final comparison rapid.
+        
+        Returns:
+            CompareRapid: The constructed comparison rapid
+        """
+        return CompareRapid(
+            criteria=self._criteria,
+            asset=self._asset,
+            truth=self._truth,
+            metadata=self._metadata
+        )
+
+class CompareRapidTruthBuilder:
+    """Builder class for the truth of the comparison rapid.
+
+    This adds the truth to the comparison rapid.    
+    """
+    def __init__(self, criteria: str, asset: MultiAsset):
+        self._criteria = criteria
+        self._asset = asset
+        self._truth = None
+    
+    def truth(self, truth: str):
+        """Set the truth for the comparison rapid.
+
+        Args:
+            truth (str): The correct answer for the comparison task. Is the string of the correct media/text asset"""
+        
+        if not isinstance(truth, str):
+            raise ValueError("Truth must be a string.")
+        
+        self._truth = MediaAsset(truth).name
+        
+        return self._build()
+    
+    def _build(self):
+        if self._truth is None:
+            raise ValueError("Truth is required")
+        
+        return CompareRapidBuilder(
+            criteria=self._criteria,
+            asset=self._asset,
+            truth=self._truth,
+        )
+
+class CompareRapidAssetBuilder:
+    """Builder class for the asset of the comparison rapid.
+
+    This adds the asset to the comparison rapid.
+    """
+    def __init__(self, criteria: str):
+        self._criteria = criteria
+        self._asset: MultiAsset | None = None
+
+    def media(self, medias: list[str]):
+        """Set the media assets for the comparison rapid.
+
+        Args:
+            medias (list[str]): The local file paths or links of the media assets to be compared"""
+        
+        media_assets = [MediaAsset(media) for media in medias]
+        self._asset = MultiAsset(media_assets)
+        return self._build()
+    
+    def text(self, texts: list[str]):
+        """Set the text assets for the comparison rapid.
+
+        Args:
+            texts (list[str]): The texts to be compared"""
+        
+        text_assets = [TextAsset(text) for text in texts]
+        self._asset = MultiAsset(text_assets)
+        return self._build()
+    
+    def _build(self):
+        if self._asset is None:
+            raise ValueError("Asset is required")
+
+        return CompareRapidTruthBuilder(
+            criteria=self._criteria,
+            asset=self._asset,
+        )
+
+class CompareRapidCriteriaBuilder:
+    """Builder class for the criteria of the comparison rapid.
+
+    This adds the criteria to the comparison rapid."""
+    def __init__(self):
+        self._criteria = None
+
+    def criteria(self, criteria: str):
+        """Set the criteria for the comparison rapid.
+
+        Args:
+            criteria (str): The criteria for comparison"""
+        
+        if not isinstance(criteria, str):
+            raise ValueError("Criteria must be a string")
+        
+        self._criteria = criteria
+        return self._build()
+
+    def _build(self):
+        if self._criteria is None:
+            raise ValueError("Criteria is required")
+
+        return CompareRapidAssetBuilder(
+            criteria=self._criteria,
+        )

rapidata-1.8.0/src/rapidata/rapidata_client/dataset/rapid_builders/rapids.py

@@ -0,0 +1,32 @@
+from rapidata.rapidata_client.assets import MediaAsset, TextAsset, MultiAsset
+from rapidata.rapidata_client.metadata import Metadata
+
+class Rapid:
+    pass
+
+class ClassificationRapid(Rapid):
+    """A classification rapid. This represents the question, options, truths, asset and metadata that will be given to the user."""
+    def __init__(self, question: str, options: list[str], truths: list[str], asset: MediaAsset | TextAsset, metadata: list[Metadata]):
+        self.question = question
+        self.options = options
+        self.truths = truths
+        self.asset = asset
+        self.metadata = metadata
+
+class CompareRapid(Rapid):
+    """A comparison rapid. This represents the criteria, asset, truth and metadata that will be given to the user."""
+    def __init__(self, criteria: str, truth: str, asset: MultiAsset, metadata: list[Metadata]):
+        self.criteria = criteria
+        self.asset = asset
+        self.truth = truth
+        self.metadata = metadata
+
+class TranscriptionRapid(Rapid):
+    """A transcription rapid. This represents the instruction, truths, asset, transcription and strict grading that will be given to the user."""
+    def __init__(self, instruction: str, truths: list[int], asset: MediaAsset, transcription: str, strict_grading: bool):
+        self.instruction = instruction
+        self.truths = truths
+        self.asset = asset
+        self.transcription = transcription
+        self.strict_grading = strict_grading
+