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

rapidata/api_client/models/create_job_definition_endpoint_output.py

@@ -0,0 +1,89 @@
+# 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 CreateJobDefinitionEndpointOutput(BaseModel):
+    """
+    CreateJobDefinitionEndpointOutput
+    """ # noqa: E501
+    definition_id: StrictStr = Field(alias="definitionId")
+    pipeline_id: StrictStr = Field(alias="pipelineId")
+    __properties: ClassVar[List[str]] = ["definitionId", "pipelineId"]
+
+    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 CreateJobDefinitionEndpointOutput 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 CreateJobDefinitionEndpointOutput 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"),
+            "pipelineId": obj.get("pipelineId")
+        })
+        return _obj
+
+

rapidata/api_client/models/create_job_endpoint_input.py

@@ -0,0 +1,100 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateJobEndpointInput(BaseModel):
+    """
+    CreateJobEndpointInput
+    """ # noqa: E501
+    job_definition_id: StrictStr = Field(alias="jobDefinitionId")
+    audience_id: StrictStr = Field(alias="audienceId")
+    revision_number: Optional[StrictInt] = Field(default=None, alias="revisionNumber")
+    name: Optional[StrictStr] = None
+    priority: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["jobDefinitionId", "audienceId", "revisionNumber", "name", "priority"]
+
+    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 CreateJobEndpointInput 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateJobEndpointInput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "jobDefinitionId": obj.get("jobDefinitionId"),
+            "audienceId": obj.get("audienceId"),
+            "revisionNumber": obj.get("revisionNumber"),
+            "name": obj.get("name"),
+            "priority": obj.get("priority")
+        })
+        return _obj
+
+

rapidata/api_client/models/create_job_endpoint_output.py

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

rapidata/api_client/models/create_job_revision_endpoint_input.py

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

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

rapidata/api_client/models/create_leaderboard_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)
@@ -19,24 +19,29 @@ 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):
     """
-    The CreateLeaderboardModel class represents the model for creating a leaderboard.
+    CreateLeaderboardModel
     """ # noqa: E501
-    benchmark_id: Optional[StrictStr] = Field(default=None, description="If a leaderboard should be added to a preexisting benchmark, the benchmark Id can be provided.", alias="benchmarkId")
-    benchmark_name: Optional[StrictStr] = Field(default=None, description="If no BenchmarkId is provided a new benchmark will be created. if no name is supplied the benchmark will be called the same as the leaderboard.", alias="benchmarkName")
-    name: StrictStr = Field(description="The name of the leaderboard.")
-    instruction: StrictStr = Field(description="The instruction datapoints will be matched up against.")
-    show_prompt: StrictBool = Field(description="Indicates if the prompt is shown on the rapids.", alias="showPrompt")
-    show_prompt_asset: Optional[StrictBool] = Field(default=None, description="Whether the prompt asset should be shown on the rapids.", alias="showPromptAsset")
-    response_budget: Optional[StrictInt] = Field(default=None, description="Total amount of responses that get collected per run", alias="responseBudget")
-    min_responses: Optional[StrictInt] = Field(default=None, description="The minimum amount of responses that need to be collected per comparison.", alias="minResponses")
-    is_inversed: Optional[StrictBool] = Field(default=None, description="If the results should be inversed, meaning people should select the worse model.", alias="isInversed")
-    validation_set_id: Optional[StrictStr] = Field(default=None, description="The Validation set that should be attached to every run.", alias="validationSetId")
-    __properties: ClassVar[List[str]] = ["benchmarkId", "benchmarkName", "name", "instruction", "showPrompt", "showPromptAsset", "responseBudget", "minResponses", "isInversed", "validationSetId"]
+    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,
@@ -77,6 +82,20 @@ class CreateLeaderboardModel(BaseModel):
             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:
@@ -92,6 +111,11 @@ class CreateLeaderboardModel(BaseModel):
         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
@@ -113,7 +137,10 @@ class CreateLeaderboardModel(BaseModel):
             "responseBudget": obj.get("responseBudget"),
             "minResponses": obj.get("minResponses"),
             "isInversed": obj.get("isInversed"),
-            "validationSetId": obj.get("validationSetId")
+            "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_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)