rapidata 2.15.0__py3-none-any.whl → 2.17.0__py3-none-any.whl

rapidata/api_client/models/rapid_issue.py

@@ -32,6 +32,10 @@ class RapidIssue(str, Enum):
     INAPPROPRIATE = 'Inappropriate'
     NOCORRECTOPTION = 'NoCorrectOption'
     WRONGLANGUAGE = 'WrongLanguage'
+    DONOTUNDERSTAND = 'DoNotUnderstand'
+    DONOTCARE = 'DoNotCare'
+    NOTSEEOPTIONSORMEDIADIDNTLOAD = 'NotSeeOptionsOrMediaDidntLoad'
+    MYANSWERISCORRECT = 'MyAnswerIsCorrect'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

rapidata/api_client/models/report_model.py

@@ -26,17 +26,17 @@ class ReportModel(BaseModel):
     """
     The model for reporting an issue with a rapid.
     """ # noqa: E501
-    rapid_id: StrictStr = Field(description="The rapid an issue was encountered with", alias="rapidId")
+    rapid_id: Optional[StrictStr] = Field(default=None, description="The rapid an issue was encountered with.", alias="rapidId")
     issue: StrictStr
     message: Optional[StrictStr] = Field(default=None, description="An optional message typed by the user.")
-    dump: Optional[StrictStr] = Field(default=None, description="A dump, that the frontend defines and can read again")
+    dump: Optional[StrictStr] = Field(default=None, description="A dump, that the frontend defines and can read again.")
     __properties: ClassVar[List[str]] = ["rapidId", "issue", "message", "dump"]
 
     @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')")
+        if value not in set(['Other', 'CannotSubmit', 'NoAsset', 'Inappropriate', 'NoCorrectOption', 'WrongLanguage', 'DoNotUnderstand', 'DoNotCare', 'NotSeeOptionsOrMediaDidntLoad', 'MyAnswerIsCorrect']):
+            raise ValueError("must be one of enum values ('Other', 'CannotSubmit', 'NoAsset', 'Inappropriate', 'NoCorrectOption', 'WrongLanguage', 'DoNotUnderstand', 'DoNotCare', 'NotSeeOptionsOrMediaDidntLoad', 'MyAnswerIsCorrect')")
         return value
 
     model_config = ConfigDict(

rapidata/api_client/models/shuffling_selection.py

@@ -0,0 +1,106 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShufflingSelection(BaseModel):
+    """
+    ShufflingSelection
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for ShufflingSelection", alias="_t")
+    selections: List[AbTestSelectionAInner]
+    __properties: ClassVar[List[str]] = ["_t", "selections"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['ShufflingSelection']):
+            raise ValueError("must be one of enum values ('ShufflingSelection')")
+        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 ShufflingSelection 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in selections (list)
+        _items = []
+        if self.selections:
+            for _item_selections in self.selections:
+                if _item_selections:
+                    _items.append(_item_selections.to_dict())
+            _dict['selections'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShufflingSelection from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "_t": obj.get("_t") if obj.get("_t") is not None else 'ShufflingSelection',
+            "selections": [AbTestSelectionAInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None
+        })
+        return _obj
+
+from rapidata.api_client.models.ab_test_selection_a_inner import AbTestSelectionAInner
+# TODO: Rewrite to not use raise_errors
+ShufflingSelection.model_rebuild(raise_errors=False)
+

rapidata/api_client/models/simple_workflow_config_model.py

@@ -26,7 +26,7 @@ from typing_extensions import Self
 
 class SimpleWorkflowConfigModel(BaseModel):
     """
-    The configuration for a simple workflow.  A simple workflow creates a rapid for each datapoint in its dataset.  It is considered complete when all rapids have been completed.
+    The configuration for a simple workflow. A simple workflow creates a rapid for each datapoint in its dataset. It is considered complete when all rapids have been completed.
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for SimpleWorkflowConfig", alias="_t")
     referee: CompareWorkflowModel1Referee

rapidata/api_client/models/simple_workflow_config_model_blueprint.py

@@ -35,7 +35,7 @@ SIMPLEWORKFLOWCONFIGMODELBLUEPRINT_ONE_OF_SCHEMAS = ["AttachCategoryRapidBluepri
 
 class SimpleWorkflowConfigModelBlueprint(BaseModel):
     """
-    The blueprint to use when creating rapids for this workflow.  The blueprint determines what kind of rapids will be created and what data they will contain.
+    The blueprint to use when creating rapids for this workflow. The blueprint determines what kind of rapids will be created and what data they will contain.
     """
     # data type: TranscriptionRapidBlueprint
     oneof_schema_1_validator: Optional[TranscriptionRapidBlueprint] = None

rapidata/api_client/models/simple_workflow_model.py

@@ -25,7 +25,7 @@ from typing_extensions import Self
 
 class SimpleWorkflowModel(BaseModel):
     """
-    If the SimpleWorkflow is chosen, each datapoint uploaded will correspond to a single task to be solved.  This is the most commonly chosen workflow.
+    If the SimpleWorkflow is chosen, each datapoint uploaded will correspond to a single task to be solved. This is the most commonly chosen workflow.
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for SimpleWorkflow", alias="_t")
     blueprint: SimpleWorkflowModelBlueprint

rapidata/api_client/models/simple_workflow_model_blueprint.py

@@ -35,7 +35,7 @@ SIMPLEWORKFLOWMODELBLUEPRINT_ONE_OF_SCHEMAS = ["AttachCategoryRapidBlueprint", "
 
 class SimpleWorkflowModelBlueprint(BaseModel):
     """
-    The blueprint is used to create the tasks that will be shown to the users. They contain the common information  across all tasks. For example, the tasks question.
+    The blueprint is used to create the tasks that will be shown to the users. They contain the common information across all tasks. For example, the tasks question.
     """
     # data type: TranscriptionRapidBlueprint
     oneof_schema_1_validator: Optional[TranscriptionRapidBlueprint] = None

rapidata/api_client/models/update_campaign_model.py

@@ -26,7 +26,7 @@ class UpdateCampaignModel(BaseModel):
     """
     The model containing the new configuration for a campaign.
     """ # noqa: E501
-    priority: Optional[StrictInt] = Field(default=None, description="A value above 0 indicating how much the campaign should be prioritized.  The higher the value the more weight it will be given during campaign selection.")
+    priority: Optional[StrictInt] = Field(default=None, description="A value above 0 indicating how much the campaign should be prioritized. The higher the value the more weight it will be given during campaign selection.")
     feature_flags: Optional[Dict[str, StrictStr]] = Field(default=None, description="The feature flags to assign this campaign.", alias="featureFlags")
     __properties: ClassVar[List[str]] = ["priority", "featureFlags"]
 

rapidata/api_client/models/update_dataset_name_model.py

@@ -0,0 +1,87 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdateDatasetNameModel(BaseModel):
+    """
+    The body request for updating the name of a dataset.
+    """ # noqa: E501
+    name: StrictStr = Field(description="The new name of the dataset.")
+    __properties: ClassVar[List[str]] = ["name"]
+
+    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 UpdateDatasetNameModel 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateDatasetNameModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name")
+        })
+        return _obj
+
+

rapidata/api_client/models/update_order_name_model.py

@@ -0,0 +1,87 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdateOrderNameModel(BaseModel):
+    """
+    The model for updating the name of an order.
+    """ # noqa: E501
+    name: StrictStr = Field(description="The new name of the order")
+    __properties: ClassVar[List[str]] = ["name"]
+
+    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 UpdateOrderNameModel 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateOrderNameModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name")
+        })
+        return _obj
+
+

rapidata/api_client/models/upload_text_sources_to_dataset_model.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
-from rapidata.api_client.models.create_datapoint_from_urls_model_metadata_inner import CreateDatapointFromUrlsModelMetadataInner
+from rapidata.api_client.models.create_datapoint_from_files_model_metadata_inner import CreateDatapointFromFilesModelMetadataInner
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,7 +30,7 @@ class UploadTextSourcesToDatasetModel(BaseModel):
     dataset_id: StrictStr = Field(description="The id of the dataset to upload the text sources to.", alias="datasetId")
     text_sources: List[StrictStr] = Field(description="The text sources to upload.", alias="textSources")
     sort_index: Optional[StrictInt] = Field(default=None, description="The index will be used to keep the datapoints in order. Useful if upload is parallelized", alias="sortIndex")
-    metadata: Optional[List[CreateDatapointFromUrlsModelMetadataInner]] = Field(default=None, description="Additional metadata to attach to the datapoint.  Most commonly used to add a prompt to the datapoint using the Rapidata.Shared.Assets.Abstraction.Models.Metadata.Input.PromptMetadataInput.")
+    metadata: Optional[List[CreateDatapointFromFilesModelMetadataInner]] = Field(default=None, description="Additional metadata to attach to the datapoint. Most commonly used to add a prompt to the datapoint using the Rapidata.Shared.Assets.Abstraction.Models.Metadata.Input.PromptMetadataInput.")
     __properties: ClassVar[List[str]] = ["datasetId", "textSources", "sortIndex", "metadata"]
 
     model_config = ConfigDict(
@@ -104,7 +104,7 @@ class UploadTextSourcesToDatasetModel(BaseModel):
             "datasetId": obj.get("datasetId"),
             "textSources": obj.get("textSources"),
             "sortIndex": obj.get("sortIndex"),
-            "metadata": [CreateDatapointFromUrlsModelMetadataInner.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None
+            "metadata": [CreateDatapointFromFilesModelMetadataInner.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None
         })
         return _obj
 

rapidata/api_client/models/user_score_user_filter_model.py

@@ -29,7 +29,8 @@ class UserScoreUserFilterModel(BaseModel):
     t: StrictStr = Field(description="Discriminator value for UserScoreFilter", alias="_t")
     lowerbound: Optional[Union[StrictFloat, StrictInt]] = None
     upperbound: Optional[Union[StrictFloat, StrictInt]] = None
-    __properties: ClassVar[List[str]] = ["_t", "lowerbound", "upperbound"]
+    dimension: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["_t", "lowerbound", "upperbound", "dimension"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -77,6 +78,11 @@ class UserScoreUserFilterModel(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # set to None if dimension (nullable) is None
+        # and model_fields_set contains the field
+        if self.dimension is None and "dimension" in self.model_fields_set:
+            _dict['dimension'] = None
+
         return _dict
 
     @classmethod
@@ -91,7 +97,8 @@ class UserScoreUserFilterModel(BaseModel):
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'UserScoreFilter',
             "lowerbound": obj.get("lowerbound"),
-            "upperbound": obj.get("upperbound")
+            "upperbound": obj.get("upperbound"),
+            "dimension": obj.get("dimension")
         })
         return _obj