arthur-client 1.4.0__py3-none-any.whl → 1.4.1186__py3-none-any.whl

arthur_client/api_bindings/models/metrics_upload.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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
+from typing import Any, ClassVar, Dict, List
+from arthur_client.api_bindings.models.metrics_upload_metrics_inner import MetricsUploadMetricsInner
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricsUpload(BaseModel):
+    """
+    The set of metrics that are available to submit via the PostMetrics API Notably, this does not include systems metrics jobs
+    """ # noqa: E501
+    metrics: List[MetricsUploadMetricsInner] = Field(description="List of metrics to upload.")
+    __properties: ClassVar[List[str]] = ["metrics"]
+
+    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 MetricsUpload 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 metrics (list)
+        _items = []
+        if self.metrics:
+            for _item_metrics in self.metrics:
+                if _item_metrics:
+                    _items.append(_item_metrics.to_dict())
+            _dict['metrics'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MetricsUpload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "metrics": [MetricsUploadMetricsInner.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/metrics_upload_metrics_inner.py

@@ -0,0 +1,134 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from arthur_client.api_bindings.models.numeric_metric import NumericMetric
+from arthur_client.api_bindings.models.sketch_metric import SketchMetric
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+METRICSUPLOADMETRICSINNER_ANY_OF_SCHEMAS = ["NumericMetric", "SketchMetric"]
+
+class MetricsUploadMetricsInner(BaseModel):
+    """
+    MetricsUploadMetricsInner
+    """
+
+    # data type: NumericMetric
+    anyof_schema_1_validator: Optional[NumericMetric] = None
+    # data type: SketchMetric
+    anyof_schema_2_validator: Optional[SketchMetric] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[NumericMetric, SketchMetric]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "NumericMetric", "SketchMetric" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = MetricsUploadMetricsInner.model_construct()
+        error_messages = []
+        # validate data type: NumericMetric
+        if not isinstance(v, NumericMetric):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NumericMetric`")
+        else:
+            return v
+
+        # validate data type: SketchMetric
+        if not isinstance(v, SketchMetric):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `SketchMetric`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in MetricsUploadMetricsInner with anyOf schemas: NumericMetric, SketchMetric. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[NumericMetric] = None
+        try:
+            instance.actual_instance = NumericMetric.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[SketchMetric] = None
+        try:
+            instance.actual_instance = SketchMetric.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into MetricsUploadMetricsInner with anyOf schemas: NumericMetric, SketchMetric. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], NumericMetric, SketchMetric]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

arthur_client/api_bindings/models/metrics_upload_result.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MetricsUploadResult(BaseModel):
+    """
+    MetricsUploadResult
+    """ # noqa: E501
+    total_metrics: StrictInt = Field(description="Total number of metrics uploaded.")
+    num_counter_metrics: StrictInt = Field(description="Number of counter type metrics uploaded.")
+    num_sketch_metrics: StrictInt = Field(description="Number of sketch type metrics uploaded.")
+    num_series: StrictInt = Field(description="Number of series uploaded.")
+    __properties: ClassVar[List[str]] = ["total_metrics", "num_counter_metrics", "num_sketch_metrics", "num_series"]
+
+    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 MetricsUploadResult 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 MetricsUploadResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total_metrics": obj.get("total_metrics"),
+            "num_counter_metrics": obj.get("num_counter_metrics"),
+            "num_sketch_metrics": obj.get("num_sketch_metrics"),
+            "num_series": obj.get("num_series")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/metrics_version.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 datetime import datetime
+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 MetricsVersion(BaseModel):
+    """
+    MetricsVersion
+    """ # noqa: E501
+    created_at: datetime = Field(description="Time of record creation.")
+    updated_at: datetime = Field(description="Time of last record update.")
+    version_num: StrictInt = Field(description="Version id for the set of metrics for this model.")
+    scope_model_id: StrictStr = Field(description="Model id of the model for this metric version.")
+    range_start: datetime = Field(description="Start timestamp of the metrics range included in this metric version.")
+    range_end: datetime = Field(description="End timestamp of the metrics range included in this metric version.")
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "version_num", "scope_model_id", "range_start", "range_end"]
+
+    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 MetricsVersion 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 MetricsVersion from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "version_num": obj.get("version_num"),
+            "scope_model_id": obj.get("scope_model_id"),
+            "range_start": obj.get("range_start"),
+            "range_end": obj.get("range_end")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/metrics_versions_sort.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 MetricsVersionsSort(str, Enum):
+    """
+    MetricsVersionsSort
+    """
+
+    """
+    allowed enum values
+    """
+    CREATED_AT = 'created_at'
+    UPDATED_AT = 'updated_at'
+    RANGE_START = 'range_start'
+    RANGE_END = 'range_end'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MetricsVersionsSort from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/model.py

@@ -0,0 +1,153 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.dataset_reference import DatasetReference
+from arthur_client.api_bindings.models.model_metric_spec import ModelMetricSpec
+from arthur_client.api_bindings.models.model_metrics_schedule import ModelMetricsSchedule
+from arthur_client.api_bindings.models.model_problem_type import ModelProblemType
+from arthur_client.api_bindings.models.user import User
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Model(BaseModel):
+    """
+    Model
+    """ # noqa: E501
+    created_at: datetime = Field(description="Time of record creation.")
+    updated_at: datetime = Field(description="Time of last record update.")
+    id: StrictStr = Field(description="ID of the model.")
+    project_id: StrictStr = Field(description="ID of the parent project.")
+    name: StrictStr = Field(description="Name of the model.")
+    description: Optional[StrictStr]
+    onboarding_identifier: Optional[StrictStr] = None
+    last_updated_by_user: Optional[User] = None
+    metric_config: ModelMetricSpec = Field(description="Metric configuration of the model.")
+    schedule: Optional[ModelMetricsSchedule] = None
+    model_problem_types: List[ModelProblemType] = Field(description="Unique model problem types of associated datasets.")
+    datasets: List[DatasetReference] = Field(description="Datasets for the model.")
+    data_plane_id: StrictStr = Field(description="ID of the data plane backing this model.")
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "id", "project_id", "name", "description", "onboarding_identifier", "last_updated_by_user", "metric_config", "schedule", "model_problem_types", "datasets", "data_plane_id"]
+
+    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 Model 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 last_updated_by_user
+        if self.last_updated_by_user:
+            _dict['last_updated_by_user'] = self.last_updated_by_user.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of metric_config
+        if self.metric_config:
+            _dict['metric_config'] = self.metric_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of schedule
+        if self.schedule:
+            _dict['schedule'] = self.schedule.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in datasets (list)
+        _items = []
+        if self.datasets:
+            for _item_datasets in self.datasets:
+                if _item_datasets:
+                    _items.append(_item_datasets.to_dict())
+            _dict['datasets'] = _items
+        # set to None if description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        # set to None if onboarding_identifier (nullable) is None
+        # and model_fields_set contains the field
+        if self.onboarding_identifier is None and "onboarding_identifier" in self.model_fields_set:
+            _dict['onboarding_identifier'] = None
+
+        # set to None if last_updated_by_user (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_updated_by_user is None and "last_updated_by_user" in self.model_fields_set:
+            _dict['last_updated_by_user'] = None
+
+        # set to None if schedule (nullable) is None
+        # and model_fields_set contains the field
+        if self.schedule is None and "schedule" in self.model_fields_set:
+            _dict['schedule'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Model from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "id": obj.get("id"),
+            "project_id": obj.get("project_id"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "onboarding_identifier": obj.get("onboarding_identifier"),
+            "last_updated_by_user": User.from_dict(obj["last_updated_by_user"]) if obj.get("last_updated_by_user") is not None else None,
+            "metric_config": ModelMetricSpec.from_dict(obj["metric_config"]) if obj.get("metric_config") is not None else None,
+            "schedule": ModelMetricsSchedule.from_dict(obj["schedule"]) if obj.get("schedule") is not None else None,
+            "model_problem_types": obj.get("model_problem_types"),
+            "datasets": [DatasetReference.from_dict(_item) for _item in obj["datasets"]] if obj.get("datasets") is not None else None,
+            "data_plane_id": obj.get("data_plane_id")
+        })
+        return _obj
+
+