rapidata 1.8.3__py3-none-any.whl → 2.44.4__py3-none-any.whl

rapidata/api_client/models/text_metadata.py

@@ -18,7 +18,7 @@ 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 Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,10 +27,9 @@ class TextMetadata(BaseModel):
     TextMetadata
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for TextMetadata", alias="_t")
-    text: StrictStr
-    identifier: StrictStr
-    visibilities: StrictStr
-    __properties: ClassVar[List[str]] = ["_t", "text", "identifier", "visibilities"]
+    text: Optional[StrictStr] = None
+    visibilities: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["_t", "text", "visibilities"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -39,6 +38,17 @@ class TextMetadata(BaseModel):
             raise ValueError("must be one of enum values ('TextMetadata')")
         return value
 
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -78,6 +88,11 @@ class TextMetadata(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # set to None if text (nullable) is None
+        # and model_fields_set contains the field
+        if self.text is None and "text" in self.model_fields_set:
+            _dict['text'] = None
+
         return _dict
 
     @classmethod
@@ -92,7 +107,6 @@ class TextMetadata(BaseModel):
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'TextMetadata',
             "text": obj.get("text"),
-            "identifier": obj.get("identifier"),
             "visibilities": obj.get("visibilities")
         })
         return _obj

rapidata/api_client/models/text_metadata_input.py

@@ -0,0 +1,111 @@
+# 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 TextMetadataInput(BaseModel):
+    """
+    TextMetadataInput
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for TextMetadataInput", alias="_t")
+    text: Optional[StrictStr] = None
+    visibilities: List[StrictStr]
+    __properties: ClassVar[List[str]] = ["_t", "text", "visibilities"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['TextMetadataInput']):
+            raise ValueError("must be one of enum values ('TextMetadataInput')")
+        return value
+
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        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 TextMetadataInput 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 text (nullable) is None
+        # and model_fields_set contains the field
+        if self.text is None and "text" in self.model_fields_set:
+            _dict['text'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TextMetadataInput 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 'TextMetadataInput',
+            "text": obj.get("text"),
+            "visibilities": obj.get("visibilities")
+        })
+        return _obj
+
+

rapidata/api_client/models/text_metadata_model.py

@@ -18,7 +18,7 @@ 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 Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,9 +27,8 @@ class TextMetadataModel(BaseModel):
     TextMetadataModel
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for TextMetadata", alias="_t")
-    text: StrictStr
-    identifier: StrictStr
-    __properties: ClassVar[List[str]] = ["_t", "text", "identifier"]
+    text: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["_t", "text"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -77,6 +76,11 @@ class TextMetadataModel(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # set to None if text (nullable) is None
+        # and model_fields_set contains the field
+        if self.text is None and "text" in self.model_fields_set:
+            _dict['text'] = None
+
         return _dict
 
     @classmethod
@@ -90,8 +94,7 @@ class TextMetadataModel(BaseModel):
 
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'TextMetadata',
-            "text": obj.get("text"),
-            "identifier": obj.get("identifier")
+            "text": obj.get("text")
         })
         return _obj
 

rapidata/api_client/models/transcription_metadata.py

@@ -28,9 +28,8 @@ class TranscriptionMetadata(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for TranscriptionMetadata", alias="_t")
     transcription: StrictStr
-    identifier: StrictStr
-    visibilities: StrictStr
-    __properties: ClassVar[List[str]] = ["_t", "transcription", "identifier", "visibilities"]
+    visibilities: List[StrictStr]
+    __properties: ClassVar[List[str]] = ["_t", "transcription", "visibilities"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -39,6 +38,14 @@ class TranscriptionMetadata(BaseModel):
             raise ValueError("must be one of enum values ('TranscriptionMetadata')")
         return value
 
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -92,7 +99,6 @@ class TranscriptionMetadata(BaseModel):
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'TranscriptionMetadata',
             "transcription": obj.get("transcription"),
-            "identifier": obj.get("identifier"),
             "visibilities": obj.get("visibilities")
         })
         return _obj

rapidata/api_client/models/transcription_metadata_input.py

@@ -24,12 +24,11 @@ from typing_extensions import Self
 
 class TranscriptionMetadataInput(BaseModel):
     """
-    TranscriptionMetadataInput
+    Input model for transcription metadata.
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for TranscriptionMetadataInput", alias="_t")
-    transcription: StrictStr
-    identifier: StrictStr
-    __properties: ClassVar[List[str]] = ["_t", "transcription", "identifier"]
+    transcription: StrictStr = Field(description="The transcription text.")
+    __properties: ClassVar[List[str]] = ["_t", "transcription"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -90,8 +89,7 @@ class TranscriptionMetadataInput(BaseModel):
 
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'TranscriptionMetadataInput',
-            "transcription": obj.get("transcription"),
-            "identifier": obj.get("identifier")
+            "transcription": obj.get("transcription")
         })
         return _obj
 

rapidata/api_client/models/transcription_metadata_model.py

@@ -27,9 +27,8 @@ class TranscriptionMetadataModel(BaseModel):
     TranscriptionMetadataModel
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for TranscriptionMetadataModel", alias="_t")
-    identifier: StrictStr
     transcription: StrictStr
-    __properties: ClassVar[List[str]] = ["_t", "identifier", "transcription"]
+    __properties: ClassVar[List[str]] = ["_t", "transcription"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -90,7 +89,6 @@ class TranscriptionMetadataModel(BaseModel):
 
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'TranscriptionMetadataModel',
-            "identifier": obj.get("identifier"),
             "transcription": obj.get("transcription")
         })
         return _obj

rapidata/api_client/models/transcription_truth.py

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

rapidata/api_client/models/transcription_word.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)

rapidata/api_client/models/translated_prompt_metadata_model.py

@@ -29,8 +29,7 @@ class TranslatedPromptMetadataModel(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for TranslatedPromptMetadata", alias="_t")
     prompt: TranslatedString
-    identifier: StrictStr
-    __properties: ClassVar[List[str]] = ["_t", "prompt", "identifier"]
+    __properties: ClassVar[List[str]] = ["_t", "prompt"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -94,8 +93,7 @@ class TranslatedPromptMetadataModel(BaseModel):
 
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'TranslatedPromptMetadata',
-            "prompt": TranslatedString.from_dict(obj["prompt"]) if obj.get("prompt") is not None else None,
-            "identifier": obj.get("identifier")
+            "prompt": TranslatedString.from_dict(obj["prompt"]) if obj.get("prompt") is not None else None
         })
         return _obj
 

rapidata/api_client/models/translated_string.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)

rapidata/api_client/models/unlock_order_result.py

@@ -1,9 +1,9 @@
 # coding: utf-8
 
 """
-    Rapidata.Dataset
+    Rapidata Asset API
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+    The API for the Rapidata Asset service
 
     The version of the OpenAPI document: v1
     Generated by OpenAPI Generator (https://openapi-generator.tech)

rapidata/api_client/models/update_access_model.py

@@ -26,7 +26,7 @@ class UpdateAccessModel(BaseModel):
     """
     The model for updating the access of an order.
     """ # noqa: E501
-    is_public: StrictBool = Field(description="Whether the order is public", alias="isPublic")
+    is_public: StrictBool = Field(description="A flag indicating whether to update the order to be public or not.", alias="isPublic")
     __properties: ClassVar[List[str]] = ["isPublic"]
 
     model_config = ConfigDict(

rapidata/api_client/models/update_audience_request.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.i_campaign_filter import ICampaignFilter
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdateAudienceRequest(BaseModel):
+    """
+    UpdateAudienceRequest
+    """ # noqa: E501
+    name: Optional[StrictStr] = None
+    filters: Optional[List[ICampaignFilter]] = None
+    __properties: ClassVar[List[str]] = ["name", "filters"]
+
+    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 UpdateAudienceRequest 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 filters (list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(_item_filters.to_dict())
+            _dict['filters'] = _items
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateAudienceRequest 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"),
+            "filters": [ICampaignFilter.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None
+        })
+        return _obj
+
+

rapidata/api_client/models/update_benchmark_model.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    Rapidata Asset API
+
+    The API for the Rapidata Asset service
+
+    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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdateBenchmarkModel(BaseModel):
+    """
+    UpdateBenchmarkModel
+    """ # noqa: E501
+    name: Optional[StrictStr] = None
+    is_public: Optional[StrictBool] = Field(default=None, alias="isPublic")
+    __properties: ClassVar[List[str]] = ["name", "isPublic"]
+
+    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 UpdateBenchmarkModel 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 name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if is_public (nullable) is None
+        # and model_fields_set contains the field
+        if self.is_public is None and "is_public" in self.model_fields_set:
+            _dict['isPublic'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateBenchmarkModel 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"),
+            "isPublic": obj.get("isPublic")
+        })
+        return _obj
+
+