rapidata 2.35.1__py3-none-any.whl → 3.0.0a8__py3-none-any.whl

rapidata/api_client/models/definition_type.py

@@ -0,0 +1,49 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class DefinitionType(str, Enum):
+    """
+    DefinitionType
+    """
+
+    """
+    allowed enum values
+    """
+    UNKNOWN = 'Unknown'
+    CLASSIFY = 'Classify'
+    COMPARE = 'Compare'
+    BOUNDINGBOX = 'BoundingBox'
+    LINE = 'Line'
+    POLYGON = 'Polygon'
+    LOCATE = 'Locate'
+    TRANSCRIPTION = 'Transcription'
+    NAMEDENTITY = 'NamedEntity'
+    FREETEXT = 'FreeText'
+    SCRUB = 'Scrub'
+    RANKING = 'Ranking'
+    GROUPEDRANKING = 'GroupedRanking'
+    EVALUATION = 'Evaluation'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DefinitionType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/demographic_filter.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DemographicFilter(BaseModel):
+    """
+    DemographicFilter
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for DemographicFilter", alias="_t")
+    identifier: StrictStr
+    values: List[StrictStr]
+    execution_order: Optional[StrictInt] = Field(default=None, alias="executionOrder")
+    __properties: ClassVar[List[str]] = ["_t", "identifier", "values", "executionOrder"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['DemographicFilter']):
+            raise ValueError("must be one of enum values ('DemographicFilter')")
+        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 DemographicFilter 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 DemographicFilter 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 'DemographicFilter',
+            "identifier": obj.get("identifier"),
+            "values": obj.get("values"),
+            "executionOrder": obj.get("executionOrder")
+        })
+        return _obj
+
+

rapidata/api_client/models/dynamic_client_registration_request.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)
@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from rapidata.api_client.models.json_web_key_set import JsonWebKeySet
 from typing import Optional, Set
@@ -25,20 +25,20 @@ from typing_extensions import Self
 
 class DynamicClientRegistrationRequest(BaseModel):
     """
-    The request body for dynamic client registration.
+    DynamicClientRegistrationRequest
     """ # noqa: E501
-    redirect_uris: Optional[List[StrictStr]] = Field(default=None, description="Array of redirection URI strings for use in redirect-based flows such as the authorization code and implicit flows.")
-    grant_types: Optional[List[StrictStr]] = Field(default=None, description="Array of OAuth 2.0 grant type strings that the client can use at the token endpoint.")
-    response_types: Optional[List[StrictStr]] = Field(default=None, description="Array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint.")
-    client_id: Optional[StrictStr] = Field(default=None, description="Unique identifier for the client.")
-    client_name: Optional[StrictStr] = Field(default=None, description="Human-readable string name of the client to be presented to the end-user during authorization.")
-    client_uri: Optional[StrictStr] = Field(default=None, description="URL string of a web page providing information about the client.")
-    logo_uri: Optional[StrictStr] = Field(default=None, description="URL string that references a logo for the client.")
-    scope: Optional[StrictStr] = Field(default=None, description="String containing a space-separated list of scope values that the client can use when requesting access tokens.")
-    contacts: Optional[List[StrictStr]] = Field(default=None, description="Array of strings representing ways to contact people responsible for this client, typically email addresses.")
-    tos_uri: Optional[StrictStr] = Field(default=None, description="URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.")
-    policy_uri: Optional[StrictStr] = Field(default=None, description="URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.")
-    jwks_uri: Optional[StrictStr] = Field(default=None, description="URL string referencing the client's JSON Web Key document, which contains the client's public keys.")
+    redirect_uris: Optional[List[StrictStr]] = None
+    grant_types: Optional[List[StrictStr]] = None
+    response_types: Optional[List[StrictStr]] = None
+    client_id: Optional[StrictStr] = None
+    client_name: Optional[StrictStr] = None
+    client_uri: Optional[StrictStr] = None
+    logo_uri: Optional[StrictStr] = None
+    scope: Optional[StrictStr] = None
+    contacts: Optional[List[StrictStr]] = None
+    tos_uri: Optional[StrictStr] = None
+    policy_uri: Optional[StrictStr] = None
+    jwks_uri: Optional[StrictStr] = None
     jwks: Optional[JsonWebKeySet] = None
     __properties: ClassVar[List[str]] = ["redirect_uris", "grant_types", "response_types", "client_id", "client_name", "client_uri", "logo_uri", "scope", "contacts", "tos_uri", "policy_uri", "jwks_uri", "jwks"]
 
@@ -84,21 +84,6 @@ class DynamicClientRegistrationRequest(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of jwks
         if self.jwks:
             _dict['jwks'] = self.jwks.to_dict()
-        # set to None if redirect_uris (nullable) is None
-        # and model_fields_set contains the field
-        if self.redirect_uris is None and "redirect_uris" in self.model_fields_set:
-            _dict['redirect_uris'] = None
-
-        # set to None if grant_types (nullable) is None
-        # and model_fields_set contains the field
-        if self.grant_types is None and "grant_types" in self.model_fields_set:
-            _dict['grant_types'] = None
-
-        # set to None if response_types (nullable) is None
-        # and model_fields_set contains the field
-        if self.response_types is None and "response_types" in self.model_fields_set:
-            _dict['response_types'] = None
-
         # set to None if client_id (nullable) is None
         # and model_fields_set contains the field
         if self.client_id is None and "client_id" in self.model_fields_set:
@@ -124,11 +109,6 @@ class DynamicClientRegistrationRequest(BaseModel):
         if self.scope is None and "scope" in self.model_fields_set:
             _dict['scope'] = None
 
-        # set to None if contacts (nullable) is None
-        # and model_fields_set contains the field
-        if self.contacts is None and "contacts" in self.model_fields_set:
-            _dict['contacts'] = None
-
         # set to None if tos_uri (nullable) is None
         # and model_fields_set contains the field
         if self.tos_uri is None and "tos_uri" in self.model_fields_set:
@@ -144,6 +124,11 @@ class DynamicClientRegistrationRequest(BaseModel):
         if self.jwks_uri is None and "jwks_uri" in self.model_fields_set:
             _dict['jwks_uri'] = None
 
+        # set to None if jwks (nullable) is None
+        # and model_fields_set contains the field
+        if self.jwks is None and "jwks" in self.model_fields_set:
+            _dict['jwks'] = None
+
         return _dict
 
     @classmethod

rapidata/api_client/models/early_stopping_referee_model.py

@@ -24,11 +24,11 @@ from typing_extensions import Self
 
 class EarlyStoppingRefereeModel(BaseModel):
     """
-    The Early Stopping Referee can currently only be used for classification tasks and will stop once a certain threshold is reached or the maximum number of votes is collected.
+    EarlyStoppingRefereeModel
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for EarlyStoppingReferee", alias="_t")
-    max_votes: StrictInt = Field(description="The upper limit of votes that will be collected for each task.", alias="maxVotes")
-    threshold: Union[StrictFloat, StrictInt] = Field(description="The threshold that needs to be reached to stop collecting votes.")
+    max_votes: StrictInt = Field(alias="maxVotes")
+    threshold: Union[StrictFloat, StrictInt]
     __properties: ClassVar[List[str]] = ["_t", "maxVotes", "threshold"]
 
     @field_validator('t')

rapidata/api_client/models/effort_capped_selection.py

@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.retrieval_mode import RetrievalMode
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +29,7 @@ class EffortCappedSelection(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for EffortCappedSelection", alias="_t")
     effort_budget: StrictInt = Field(alias="effortBudget")
-    retrieval_mode: Optional[StrictStr] = Field(default=None, alias="retrievalMode")
+    retrieval_mode: Optional[RetrievalMode] = Field(default=None, alias="retrievalMode")
     max_iterations: Optional[StrictInt] = Field(default=None, alias="maxIterations")
     __properties: ClassVar[List[str]] = ["_t", "effortBudget", "retrievalMode", "maxIterations"]
 
@@ -39,16 +40,6 @@ class EffortCappedSelection(BaseModel):
             raise ValueError("must be one of enum values ('EffortCappedSelection')")
         return value
 
-    @field_validator('retrieval_mode')
-    def retrieval_mode_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['Random', 'Shuffled', 'Sequential']):
-            raise ValueError("must be one of enum values ('Random', 'Shuffled', 'Sequential')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/elo_config.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/elo_config_model.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)
@@ -24,11 +24,11 @@ from typing_extensions import Self
 
 class EloConfigModel(BaseModel):
     """
-    These parameters affect how the ELO algorithms behaves
+    EloConfigModel
     """ # noqa: E501
-    starting_elo: Optional[StrictInt] = Field(default=None, description="The starting ELO score for each datapoint.", alias="startingElo")
-    k_factor: Optional[StrictInt] = Field(default=None, description="The K-factor to use in the ELO calculation. Determines the maximum possible change in a player's Elo rating after a single match. Higher K-Factor values result in larger rating changes.", alias="kFactor")
-    scaling_factor: Optional[StrictInt] = Field(default=None, description="Scaling factor to use in the ELO calculation. Adjusts the sensitivity of the Elo rating system to differences in player ratings. It affects how much the rating changes based on the expected outcome versus the actual outcome.", alias="scalingFactor")
+    starting_elo: Optional[StrictInt] = Field(default=None, alias="startingElo")
+    k_factor: Optional[StrictInt] = Field(default=None, alias="kFactor")
+    scaling_factor: Optional[StrictInt] = Field(default=None, alias="scalingFactor")
     __properties: ClassVar[List[str]] = ["startingElo", "kFactor", "scalingFactor"]
 
     model_config = ConfigDict(

rapidata/api_client/models/entity_tag_header_value.py

@@ -0,0 +1,93 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.string_segment import StringSegment
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EntityTagHeaderValue(BaseModel):
+    """
+    EntityTagHeaderValue
+    """ # noqa: E501
+    tag: Optional[StringSegment] = None
+    is_weak: Optional[StrictBool] = Field(default=None, alias="isWeak")
+    __properties: ClassVar[List[str]] = ["tag", "isWeak"]
+
+    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 EntityTagHeaderValue 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 tag
+        if self.tag:
+            _dict['tag'] = self.tag.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EntityTagHeaderValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tag": StringSegment.from_dict(obj["tag"]) if obj.get("tag") is not None else None,
+            "isWeak": obj.get("isWeak")
+        })
+        return _obj
+
+

rapidata/api_client/models/evaluation_workflow_config.py

@@ -18,8 +18,9 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from rapidata.api_client.models.compare_workflow_model1_referee import CompareWorkflowModel1Referee
+from rapidata.api_client.models.feature_flag import FeatureFlag
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -31,7 +32,8 @@ class EvaluationWorkflowConfig(BaseModel):
     validation_set_id: StrictStr = Field(alias="validationSetId")
     referee: CompareWorkflowModel1Referee
     should_accept_incorrect: StrictBool = Field(alias="shouldAcceptIncorrect")
-    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "referee", "shouldAcceptIncorrect"]
+    feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags")
+    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "referee", "shouldAcceptIncorrect", "featureFlags"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -82,6 +84,13 @@ class EvaluationWorkflowConfig(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of referee
         if self.referee:
             _dict['referee'] = self.referee.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list)
+        _items = []
+        if self.feature_flags:
+            for _item_feature_flags in self.feature_flags:
+                if _item_feature_flags:
+                    _items.append(_item_feature_flags.to_dict())
+            _dict['featureFlags'] = _items
         return _dict
 
     @classmethod
@@ -97,7 +106,8 @@ class EvaluationWorkflowConfig(BaseModel):
             "_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,
-            "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect")
+            "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect"),
+            "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None
         })
         return _obj
 

rapidata/api_client/models/evaluation_workflow_model.py

@@ -18,18 +18,20 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.feature_flag import FeatureFlag
 from typing import Optional, Set
 from typing_extensions import Self
 
 class EvaluationWorkflowModel(BaseModel):
     """
-    If the EvaluationWorkflow is chosen a validation set will be used as a source for all tasks. It functions similarly to the SimpleWorkflow as there is a 1:1 mapping between validation rapids and tasks.
+    EvaluationWorkflowModel
     """ # 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")
-    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"]
+    validation_set_id: StrictStr = Field(alias="validationSetId")
+    should_accept_incorrect: StrictBool = Field(alias="shouldAcceptIncorrect")
+    feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags")
+    __properties: ClassVar[List[str]] = ["_t", "validationSetId", "shouldAcceptIncorrect", "featureFlags"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -77,6 +79,13 @@ class EvaluationWorkflowModel(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of each item in feature_flags (list)
+        _items = []
+        if self.feature_flags:
+            for _item_feature_flags in self.feature_flags:
+                if _item_feature_flags:
+                    _items.append(_item_feature_flags.to_dict())
+            _dict['featureFlags'] = _items
         return _dict
 
     @classmethod
@@ -91,7 +100,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"),
-            "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect")
+            "shouldAcceptIncorrect": obj.get("shouldAcceptIncorrect"),
+            "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None
         })
         return _obj
 

rapidata/api_client/models/existing_asset_input.py

@@ -0,0 +1,109 @@
+# 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_metadata_input import IMetadataInput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ExistingAssetInput(BaseModel):
+    """
+    ExistingAssetInput
+    """ # noqa: E501
+    name: StrictStr
+    metadata: Optional[Dict[str, IMetadataInput]] = None
+    identifier: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "metadata", "identifier"]
+
+    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 ExistingAssetInput 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 value in metadata (dict)
+        _field_dict = {}
+        if self.metadata:
+            for _key_metadata in self.metadata:
+                if self.metadata[_key_metadata]:
+                    _field_dict[_key_metadata] = self.metadata[_key_metadata].to_dict()
+            _dict['metadata'] = _field_dict
+        # set to None if identifier (nullable) is None
+        # and model_fields_set contains the field
+        if self.identifier is None and "identifier" in self.model_fields_set:
+            _dict['identifier'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExistingAssetInput 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"),
+            "metadata": dict(
+                (_k, IMetadataInput.from_dict(_v))
+                for _k, _v in obj["metadata"].items()
+            )
+            if obj.get("metadata") is not None
+            else None,
+            "identifier": obj.get("identifier")
+        })
+        return _obj
+
+