rapidata 2.23.2__py3-none-any.whl → 3.0.1__py3-none-any.whl

rapidata/api_client/models/create_leaderboard_model.py

@@ -0,0 +1,147 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.feature_flag_model import FeatureFlagModel
+from rapidata.api_client.models.i_user_filter_model import IUserFilterModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateLeaderboardModel(BaseModel):
+    """
+    CreateLeaderboardModel
+    """ # noqa: E501
+    benchmark_id: Optional[StrictStr] = Field(default=None, alias="benchmarkId")
+    benchmark_name: Optional[StrictStr] = Field(default=None, alias="benchmarkName")
+    name: StrictStr
+    instruction: StrictStr
+    show_prompt: StrictBool = Field(alias="showPrompt")
+    show_prompt_asset: Optional[StrictBool] = Field(default=None, alias="showPromptAsset")
+    response_budget: Optional[StrictInt] = Field(default=None, alias="responseBudget")
+    min_responses: Optional[StrictInt] = Field(default=None, alias="minResponses")
+    is_inversed: Optional[StrictBool] = Field(default=None, alias="isInversed")
+    validation_set_id: Optional[StrictStr] = Field(default=None, alias="validationSetId")
+    audience_id: Optional[StrictStr] = Field(default=None, alias="audienceId")
+    filters: Optional[List[IUserFilterModel]] = None
+    feature_flags: Optional[List[FeatureFlagModel]] = Field(default=None, alias="featureFlags")
+    __properties: ClassVar[List[str]] = ["benchmarkId", "benchmarkName", "name", "instruction", "showPrompt", "showPromptAsset", "responseBudget", "minResponses", "isInversed", "validationSetId", "audienceId", "filters", "featureFlags"]
+
+    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 CreateLeaderboardModel 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
+        # 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
+        # set to None if benchmark_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.benchmark_id is None and "benchmark_id" in self.model_fields_set:
+            _dict['benchmarkId'] = None
+
+        # set to None if benchmark_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.benchmark_name is None and "benchmark_name" in self.model_fields_set:
+            _dict['benchmarkName'] = None
+
+        # set to None if validation_set_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.validation_set_id is None and "validation_set_id" in self.model_fields_set:
+            _dict['validationSetId'] = None
+
+        # set to None if audience_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.audience_id is None and "audience_id" in self.model_fields_set:
+            _dict['audienceId'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateLeaderboardModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "benchmarkId": obj.get("benchmarkId"),
+            "benchmarkName": obj.get("benchmarkName"),
+            "name": obj.get("name"),
+            "instruction": obj.get("instruction"),
+            "showPrompt": obj.get("showPrompt"),
+            "showPromptAsset": obj.get("showPromptAsset"),
+            "responseBudget": obj.get("responseBudget"),
+            "minResponses": obj.get("minResponses"),
+            "isInversed": obj.get("isInversed"),
+            "validationSetId": obj.get("validationSetId"),
+            "audienceId": obj.get("audienceId"),
+            "filters": [IUserFilterModel.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None,
+            "featureFlags": [FeatureFlagModel.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None
+        })
+        return _obj
+
+

rapidata/api_client/models/create_leaderboard_participant_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 CreateLeaderboardParticipantModel(BaseModel):
+    """
+    The model to create a participant in a leaderboard
+    """ # noqa: E501
+    name: StrictStr = Field(description="The name of the participant.")
+    __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 CreateLeaderboardParticipantModel 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 CreateLeaderboardParticipantModel 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/create_leaderboard_participant_result.py

@@ -0,0 +1,89 @@
+# 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 CreateLeaderboardParticipantResult(BaseModel):
+    """
+    CreateLeaderboardParticipantResult
+    """ # noqa: E501
+    participant_id: StrictStr = Field(alias="participantId")
+    dataset_id: StrictStr = Field(alias="datasetId")
+    __properties: ClassVar[List[str]] = ["participantId", "datasetId"]
+
+    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 CreateLeaderboardParticipantResult 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 CreateLeaderboardParticipantResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "participantId": obj.get("participantId"),
+            "datasetId": obj.get("datasetId")
+        })
+        return _obj
+
+

rapidata/api_client/models/create_leaderboard_result.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateLeaderboardResult(BaseModel):
+    """
+    CreateLeaderboardResult
+    """ # noqa: E501
+    id: StrictStr
+    benchmark_id: StrictStr = Field(alias="benchmarkId")
+    show_prompt: StrictBool = Field(alias="showPrompt")
+    show_prompt_asset: StrictBool = Field(alias="showPromptAsset")
+    response_budget: StrictInt = Field(alias="responseBudget")
+    min_responses: StrictInt = Field(alias="minResponses")
+    is_inversed: StrictBool = Field(alias="isInversed")
+    __properties: ClassVar[List[str]] = ["id", "benchmarkId", "showPrompt", "showPromptAsset", "responseBudget", "minResponses", "isInversed"]
+
+    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 CreateLeaderboardResult 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 CreateLeaderboardResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "benchmarkId": obj.get("benchmarkId"),
+            "showPrompt": obj.get("showPrompt"),
+            "showPromptAsset": obj.get("showPromptAsset"),
+            "responseBudget": obj.get("responseBudget"),
+            "minResponses": obj.get("minResponses"),
+            "isInversed": obj.get("isInversed")
+        })
+        return _obj
+
+

rapidata/api_client/models/create_order_definition_model.py

@@ -0,0 +1,119 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.aggregator_type import AggregatorType
+from rapidata.api_client.models.feature_flag import FeatureFlag
+from rapidata.api_client.models.i_order_workflow_model import IOrderWorkflowModel
+from rapidata.api_client.models.i_referee_model import IRefereeModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateOrderDefinitionModel(BaseModel):
+    """
+    CreateOrderDefinitionModel
+    """ # noqa: E501
+    definition_name: StrictStr = Field(alias="definitionName")
+    workflow: IOrderWorkflowModel
+    referee: IRefereeModel
+    dataset_id: StrictStr = Field(alias="datasetId")
+    feature_flags: Optional[List[FeatureFlag]] = Field(default=None, alias="featureFlags")
+    aggregator_type: Optional[AggregatorType] = Field(default=None, alias="aggregatorType")
+    __properties: ClassVar[List[str]] = ["definitionName", "workflow", "referee", "datasetId", "featureFlags", "aggregatorType"]
+
+    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 CreateOrderDefinitionModel 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 workflow
+        if self.workflow:
+            _dict['workflow'] = self.workflow.to_dict()
+        # 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
+        # set to None if aggregator_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.aggregator_type is None and "aggregator_type" in self.model_fields_set:
+            _dict['aggregatorType'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateOrderDefinitionModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "definitionName": obj.get("definitionName"),
+            "workflow": IOrderWorkflowModel.from_dict(obj["workflow"]) if obj.get("workflow") is not None else None,
+            "referee": IRefereeModel.from_dict(obj["referee"]) if obj.get("referee") is not None else None,
+            "datasetId": obj.get("datasetId"),
+            "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None,
+            "aggregatorType": obj.get("aggregatorType")
+        })
+        return _obj
+
+

rapidata/api_client/models/create_order_definition_result.py

@@ -0,0 +1,87 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateOrderDefinitionResult(BaseModel):
+    """
+    CreateOrderDefinitionResult
+    """ # noqa: E501
+    definition_id: StrictStr = Field(alias="definitionId")
+    __properties: ClassVar[List[str]] = ["definitionId"]
+
+    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 CreateOrderDefinitionResult 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 CreateOrderDefinitionResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "definitionId": obj.get("definitionId")
+        })
+        return _obj
+
+