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

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
+
+

arthur_client/api_bindings/models/model_metric_spec.py

@@ -0,0 +1,97 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from arthur_client.api_bindings.models.aggregation_spec import AggregationSpec
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModelMetricSpec(BaseModel):
+    """
+    ModelMetricSpec
+    """ # noqa: E501
+    aggregation_specs: List[AggregationSpec] = Field(description="List of aggregations configured for the metric spec.")
+    id: StrictStr = Field(description="Unique ID of the metric spec.")
+    __properties: ClassVar[List[str]] = ["aggregation_specs", "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 ModelMetricSpec 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 aggregation_specs (list)
+        _items = []
+        if self.aggregation_specs:
+            for _item_aggregation_specs in self.aggregation_specs:
+                if _item_aggregation_specs:
+                    _items.append(_item_aggregation_specs.to_dict())
+            _dict['aggregation_specs'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ModelMetricSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "aggregation_specs": [AggregationSpec.from_dict(_item) for _item in obj["aggregation_specs"]] if obj.get("aggregation_specs") is not None else None,
+            "id": obj.get("id")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/model_metrics_schedule.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 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 ModelMetricsSchedule(BaseModel):
+    """
+    ModelMetricsSchedule
+    """ # noqa: E501
+    cron: StrictStr = Field(description="Cron expression defining a cadence to run the model's metrics job on. Must specify a period greater than or equal to 5 minutes.")
+    lookback_period_seconds: StrictInt = Field(description="Lookback period of the scheduled job.")
+    name: Optional[StrictStr] = None
+    id: StrictStr = Field(description="Unique id of the schedule.")
+    __properties: ClassVar[List[str]] = ["cron", "lookback_period_seconds", "name", "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 ModelMetricsSchedule 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 ModelMetricsSchedule from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "cron": obj.get("cron"),
+            "lookback_period_seconds": obj.get("lookback_period_seconds"),
+            "name": obj.get("name"),
+            "id": obj.get("id")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/model_problem_type.py

@@ -0,0 +1,40 @@
+# 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 ModelProblemType(str, Enum):
+    """
+    ModelProblemType
+    """
+
+    """
+    allowed enum values
+    """
+    REGRESSION = 'regression'
+    BINARY_CLASSIFICATION = 'binary_classification'
+    ARTHUR_SHIELD = 'arthur_shield'
+    CUSTOM = 'custom'
+    MULTICLASS_CLASSIFICATION = 'multiclass_classification'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ModelProblemType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/models_sort.py

@@ -0,0 +1,38 @@
+# 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 ModelsSort(str, Enum):
+    """
+    ModelsSort
+    """
+
+    """
+    allowed enum values
+    """
+    CREATED_AT = 'created_at'
+    UPDATED_AT = 'updated_at'
+    NAME = 'name'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ModelsSort from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/new_rule_request.py

@@ -0,0 +1,104 @@
+# 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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.config import Config
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NewRuleRequest(BaseModel):
+    """
+    NewRuleRequest
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of the rule")
+    type: StrictStr = Field(description="Type of the rule. It can only be one of KeywordRule, RegexRule, ModelSensitiveDataRule, ModelHallucinationRule, ModelHallucinationRuleV2, PromptInjectionRule, PIIDataRule")
+    apply_to_prompt: StrictBool = Field(description="Boolean value to enable or disable the rule for llm prompt")
+    apply_to_response: StrictBool = Field(description="Boolean value to enable or disable the rule for llm response")
+    config: Optional[Config] = None
+    __properties: ClassVar[List[str]] = ["name", "type", "apply_to_prompt", "apply_to_response", "config"]
+
+    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 NewRuleRequest 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 config
+        if self.config:
+            _dict['config'] = self.config.to_dict()
+        # set to None if config (nullable) is None
+        # and model_fields_set contains the field
+        if self.config is None and "config" in self.model_fields_set:
+            _dict['config'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NewRuleRequest 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"),
+            "type": obj.get("type"),
+            "apply_to_prompt": obj.get("apply_to_prompt"),
+            "apply_to_response": obj.get("apply_to_response"),
+            "config": Config.from_dict(obj["config"]) if obj.get("config") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/not_found_error.py

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