rapidata 2.3.2__tar.gz → 2.4.0__tar.gz

{rapidata-2.3.2 → rapidata-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rapidata
-Version: 2.3.2
+Version: 2.4.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

{rapidata-2.3.2 → rapidata-2.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rapidata"
-version = "2.3.2"
+version = "2.4.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-2.3.2 → rapidata-2.4.0}/src/rapidata/__init__.py

@@ -30,4 +30,4 @@ from .rapidata_client import (
     MultiAsset,
     RapidataDataTypes,
     Box,
-    )
+)

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/api_client/__init__.py

@@ -254,12 +254,14 @@ from rapidata.api_client.models.query_workflows_model import QueryWorkflowsModel
 from rapidata.api_client.models.ranked_datapoint_model import RankedDatapointModel
 from rapidata.api_client.models.rapid_answer import RapidAnswer
 from rapidata.api_client.models.rapid_answer_result import RapidAnswerResult
+from rapidata.api_client.models.rapid_issue import RapidIssue
 from rapidata.api_client.models.rapid_result_model import RapidResultModel
 from rapidata.api_client.models.rapid_result_model_result import RapidResultModelResult
 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.report_model import ReportModel
 from rapidata.api_client.models.root_filter import RootFilter
 from rapidata.api_client.models.scrub_payload import ScrubPayload
 from rapidata.api_client.models.scrub_range import ScrubRange

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/api_client/api/rapid_api.py

@@ -24,6 +24,7 @@ from rapidata.api_client.models.query_model import QueryModel
 from rapidata.api_client.models.query_validation_rapids_result_paged_result import QueryValidationRapidsResultPagedResult
 from rapidata.api_client.models.rapid_result_model import RapidResultModel
 from rapidata.api_client.models.rapid_skipped_model import RapidSkippedModel
+from rapidata.api_client.models.report_model import ReportModel
 
 from rapidata.api_client.api_client import ApiClient, RequestSerialized
 from rapidata.api_client.api_response import ApiResponse
@@ -871,6 +872,273 @@ class RapidApi:
 
 
 
+    @validate_call
+    def rapid_report_post(
+        self,
+        report_model: Optional[ReportModel] = 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:
+        """Used to report an issue with a rapid.
+
+
+        :param report_model: 
+        :type report_model: ReportModel
+        :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._rapid_report_post_serialize(
+            report_model=report_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': 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 rapid_report_post_with_http_info(
+        self,
+        report_model: Optional[ReportModel] = 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]:
+        """Used to report an issue with a rapid.
+
+
+        :param report_model: 
+        :type report_model: ReportModel
+        :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._rapid_report_post_serialize(
+            report_model=report_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': 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 rapid_report_post_without_preload_content(
+        self,
+        report_model: Optional[ReportModel] = 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:
+        """Used to report an issue with a rapid.
+
+
+        :param report_model: 
+        :type report_model: ReportModel
+        :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._rapid_report_post_serialize(
+            report_model=report_model,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '204': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _rapid_report_post_serialize(
+        self,
+        report_model,
+        _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
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if report_model is not None:
+            _body_params = report_model
+
+
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json', 
+                        'text/json', 
+                        'application/*+json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearer', 
+            'oauth2'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/Rapid/Report',
+            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
+        )
+
+
+
+
     @validate_call
     def rapid_skip_user_guess_post(
         self,

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/api_client/models/__init__.py

@@ -222,12 +222,14 @@ from rapidata.api_client.models.query_workflows_model import QueryWorkflowsModel
 from rapidata.api_client.models.ranked_datapoint_model import RankedDatapointModel
 from rapidata.api_client.models.rapid_answer import RapidAnswer
 from rapidata.api_client.models.rapid_answer_result import RapidAnswerResult
+from rapidata.api_client.models.rapid_issue import RapidIssue
 from rapidata.api_client.models.rapid_result_model import RapidResultModel
 from rapidata.api_client.models.rapid_result_model_result import RapidResultModelResult
 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.report_model import ReportModel
 from rapidata.api_client.models.root_filter import RootFilter
 from rapidata.api_client.models.scrub_payload import ScrubPayload
 from rapidata.api_client.models.scrub_range import ScrubRange

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/api_client/models/add_validation_rapid_model.py

@@ -34,7 +34,8 @@ class AddValidationRapidModel(BaseModel):
     metadata: List[DatapointMetadataModelMetadataInner] = Field(description="Some metadata to attach to the rapid.")
     truth: AddValidationRapidModelTruth
     random_correct_probability: Optional[Union[StrictFloat, StrictInt]] = Field(description="The probability for an answer to be correct when randomly guessing.", alias="randomCorrectProbability")
-    __properties: ClassVar[List[str]] = ["validationSetId", "payload", "metadata", "truth", "randomCorrectProbability"]
+    explanation: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["validationSetId", "payload", "metadata", "truth", "randomCorrectProbability", "explanation"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -93,6 +94,11 @@ class AddValidationRapidModel(BaseModel):
         if self.random_correct_probability is None and "random_correct_probability" in self.model_fields_set:
             _dict['randomCorrectProbability'] = None
 
+        # set to None if explanation (nullable) is None
+        # and model_fields_set contains the field
+        if self.explanation is None and "explanation" in self.model_fields_set:
+            _dict['explanation'] = None
+
         return _dict
 
     @classmethod
@@ -109,7 +115,8 @@ class AddValidationRapidModel(BaseModel):
             "payload": AddValidationRapidModelPayload.from_dict(obj["payload"]) if obj.get("payload") is not None else None,
             "metadata": [DatapointMetadataModelMetadataInner.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None,
             "truth": AddValidationRapidModelTruth.from_dict(obj["truth"]) if obj.get("truth") is not None else None,
-            "randomCorrectProbability": obj.get("randomCorrectProbability")
+            "randomCorrectProbability": obj.get("randomCorrectProbability"),
+            "explanation": obj.get("explanation")
         })
         return _obj
 

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/api_client/models/add_validation_text_rapid_model.py

@@ -35,7 +35,8 @@ class AddValidationTextRapidModel(BaseModel):
     truth: AddValidationRapidModelTruth
     texts: List[StrictStr] = Field(description="The texts to use for the rapid.")
     random_correct_probability: Optional[Union[StrictFloat, StrictInt]] = Field(description="The probability for an answer to be correct when randomly guessing.", alias="randomCorrectProbability")
-    __properties: ClassVar[List[str]] = ["validationSetId", "payload", "metadata", "truth", "texts", "randomCorrectProbability"]
+    explanation: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["validationSetId", "payload", "metadata", "truth", "texts", "randomCorrectProbability", "explanation"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -94,6 +95,11 @@ class AddValidationTextRapidModel(BaseModel):
         if self.random_correct_probability is None and "random_correct_probability" in self.model_fields_set:
             _dict['randomCorrectProbability'] = None
 
+        # set to None if explanation (nullable) is None
+        # and model_fields_set contains the field
+        if self.explanation is None and "explanation" in self.model_fields_set:
+            _dict['explanation'] = None
+
         return _dict
 
     @classmethod
@@ -111,7 +117,8 @@ class AddValidationTextRapidModel(BaseModel):
             "metadata": [DatapointMetadataModelMetadataInner.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None,
             "truth": AddValidationRapidModelTruth.from_dict(obj["truth"]) if obj.get("truth") is not None else None,
             "texts": obj.get("texts"),
-            "randomCorrectProbability": obj.get("randomCorrectProbability")
+            "randomCorrectProbability": obj.get("randomCorrectProbability"),
+            "explanation": obj.get("explanation")
         })
         return _obj
 

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/api_client/models/query_validation_rapids_result.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from rapidata.api_client.models.file_asset_model1_metadata_inner import FileAssetModel1MetadataInner
 from rapidata.api_client.models.query_validation_rapids_result_asset import QueryValidationRapidsResultAsset
@@ -35,7 +35,9 @@ class QueryValidationRapidsResult(BaseModel):
     truth: Optional[QueryValidationRapidsResultTruth] = None
     payload: QueryValidationRapidsResultPayload
     metadata: List[FileAssetModel1MetadataInner]
-    __properties: ClassVar[List[str]] = ["type", "asset", "truth", "payload", "metadata"]
+    correct_validation_count: StrictInt = Field(alias="correctValidationCount")
+    invalid_validation_count: StrictInt = Field(alias="invalidValidationCount")
+    __properties: ClassVar[List[str]] = ["type", "asset", "truth", "payload", "metadata", "correctValidationCount", "invalidValidationCount"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -118,7 +120,9 @@ class QueryValidationRapidsResult(BaseModel):
             "asset": QueryValidationRapidsResultAsset.from_dict(obj["asset"]) if obj.get("asset") is not None else None,
             "truth": QueryValidationRapidsResultTruth.from_dict(obj["truth"]) if obj.get("truth") is not None else None,
             "payload": QueryValidationRapidsResultPayload.from_dict(obj["payload"]) if obj.get("payload") is not None else None,
-            "metadata": [FileAssetModel1MetadataInner.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None
+            "metadata": [FileAssetModel1MetadataInner.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None,
+            "correctValidationCount": obj.get("correctValidationCount"),
+            "invalidValidationCount": obj.get("invalidValidationCount")
         })
         return _obj
 

rapidata-2.4.0/src/rapidata/api_client/models/rapid_issue.py

@@ -0,0 +1,41 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class RapidIssue(str, Enum):
+    """
+    RapidIssue
+    """
+
+    """
+    allowed enum values
+    """
+    OTHER = 'Other'
+    CANNOTSUBMIT = 'CannotSubmit'
+    NOASSET = 'NoAsset'
+    INAPPROPRIATE = 'Inappropriate'
+    NOCORRECTOPTION = 'NoCorrectOption'
+    WRONGLANGUAGE = 'WrongLanguage'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RapidIssue from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata-2.4.0/src/rapidata/api_client/models/report_model.py

@@ -0,0 +1,103 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ReportModel(BaseModel):
+    """
+    The model for reporting an issue with a rapid.
+    """ # noqa: E501
+    rapid_id: StrictStr = Field(alias="rapidId")
+    issue: StrictStr
+    message: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["rapidId", "issue", "message"]
+
+    @field_validator('issue')
+    def issue_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['Other', 'CannotSubmit', 'NoAsset', 'Inappropriate', 'NoCorrectOption', 'WrongLanguage']):
+            raise ValueError("must be one of enum values ('Other', 'CannotSubmit', 'NoAsset', 'Inappropriate', 'NoCorrectOption', 'WrongLanguage')")
+        return value
+
+    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 ReportModel 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 message (nullable) is None
+        # and model_fields_set contains the field
+        if self.message is None and "message" in self.model_fields_set:
+            _dict['message'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ReportModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "rapidId": obj.get("rapidId"),
+            "issue": obj.get("issue"),
+            "message": obj.get("message")
+        })
+        return _obj
+
+

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/api_client_README.md

@@ -127,6 +127,7 @@ Class | Method | HTTP request | Description
 *RapidApi* | [**rapid_add_user_guess_post**](rapidata/api_client/docs/RapidApi.md#rapid_add_user_guess_post) | **POST** /Rapid/AddUserGuess | Submits a user guess for a Rapid.
 *RapidApi* | [**rapid_create_demographic_rapid_post**](rapidata/api_client/docs/RapidApi.md#rapid_create_demographic_rapid_post) | **POST** /Rapid/CreateDemographicRapid | Creates a new Demographic Rapid.
 *RapidApi* | [**rapid_query_validation_rapids_get**](rapidata/api_client/docs/RapidApi.md#rapid_query_validation_rapids_get) | **GET** /Rapid/QueryValidationRapids | Queries the validation rapids for a specific validation set.
+*RapidApi* | [**rapid_report_post**](rapidata/api_client/docs/RapidApi.md#rapid_report_post) | **POST** /Rapid/Report | Used to report an issue with a rapid.
 *RapidApi* | [**rapid_skip_user_guess_post**](rapidata/api_client/docs/RapidApi.md#rapid_skip_user_guess_post) | **POST** /Rapid/SkipUserGuess | Skips a Rapid for the user.
 *RapidApi* | [**rapid_validate_current_rapid_bag_get**](rapidata/api_client/docs/RapidApi.md#rapid_validate_current_rapid_bag_get) | **GET** /Rapid/ValidateCurrentRapidBag | Validates that the rapids associated with the current user are active.
 *RapidataIdentityAPIApi* | [**root_get**](rapidata/api_client/docs/RapidataIdentityAPIApi.md#root_get) | **GET** / | 
@@ -357,12 +358,14 @@ Class | Method | HTTP request | Description
  - [RankedDatapointModel](rapidata/api_client/docs/RankedDatapointModel.md)
  - [RapidAnswer](rapidata/api_client/docs/RapidAnswer.md)
  - [RapidAnswerResult](rapidata/api_client/docs/RapidAnswerResult.md)
+ - [RapidIssue](rapidata/api_client/docs/RapidIssue.md)
  - [RapidResultModel](rapidata/api_client/docs/RapidResultModel.md)
  - [RapidResultModelResult](rapidata/api_client/docs/RapidResultModelResult.md)
  - [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)
+ - [ReportModel](rapidata/api_client/docs/ReportModel.md)
  - [RootFilter](rapidata/api_client/docs/RootFilter.md)
  - [ScrubPayload](rapidata/api_client/docs/ScrubPayload.md)
  - [ScrubRange](rapidata/api_client/docs/ScrubRange.md)

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/rapidata_client/assets/_media_asset.py

@@ -165,7 +165,6 @@ class MediaAsset(BaseAsset):
         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)

{rapidata-2.3.2 → rapidata-2.4.0}/src/rapidata/rapidata_client/selection/rapidata_selections.py

@@ -8,7 +8,16 @@ from rapidata.rapidata_client.selection import (
 class RapidataSelections:
     """RapidataSelections Classes
 
-    Selections are used to define what type of tasks and in what order they are shown to the user.
+    Selections are used to define what type of tasks and in what order they are shown to the user. 
+    All Tasks are called a "Session". A session can contain multiple tasks of different types.
+
+    Example:
+    ```python
+        selections=[ValidationSelection("your-validation-set-id", 1), 
+                    LabelingSelection(2)]
+    ```
+
+    The above example will create a session with a validation task followed by two labeling tasks.
 
     Attributes:
         labeling (LabelingSelection): The LabelingSelection instance.
@@ -16,6 +25,7 @@ class RapidataSelections:
         conditional_validation (ConditionalValidationSelection): The ConditionalValidationSelection instance.
         demographic (DemographicSelection): The DemographicSelection instance.
         capped (CappedSelection): The CappedSelection instance."""
+    
     labeling = LabelingSelection
     validation = ValidationSelection
     conditional_validation = ConditionalValidationSelection

rapidata-2.4.0/src/rapidata/rapidata_client/validation/rapidata_validation_set.py

@@ -0,0 +1,21 @@
+class RapidataValidationSet:
+    """A class for interacting with a Rapidata validation set.
+
+    Represents a set of all the validation tasks that can be added to an order.
+
+    When added to an order, the tasks will be selected randomly from the set.
+
+    Attributes:
+        id (str): The ID of the validation set.
+        name (str): The name of the validation set.
+    """
+
+    def __init__(self, validation_set_id, name: str):
+        self.id = validation_set_id
+        self.name = name
+
+    def __str__(self):
+        return f"name: '{self.name}' id: {self.id}"
+
+    def __repr__(self):
+        return f"name: '{self.name}' id: {self.id}"