arthur-client 1.4.1233__py3-none-any.whl → 1.4.1234__py3-none-any.whl

arthur_client/api_bindings/models/post_custom_aggregation_spec_schema.py

@@ -0,0 +1,111 @@
+# 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.custom_aggregation_spec_schema_aggregate_args_inner import CustomAggregationSpecSchemaAggregateArgsInner
+from arthur_client.api_bindings.models.reported_custom_aggregation import ReportedCustomAggregation
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostCustomAggregationSpecSchema(BaseModel):
+    """
+    PostCustomAggregationSpecSchema
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of the custom aggregation function.")
+    description: StrictStr = Field(description="Description of the custom aggregation function and what it aggregates.")
+    reported_aggregations: List[ReportedCustomAggregation] = Field(description="Metadata for every aggregation the custom aggregation reports.")
+    aggregate_args: List[CustomAggregationSpecSchemaAggregateArgsInner] = Field(description="List of parameters to the custom aggregation's query function.")
+    sql: StrictStr = Field(description="DuckDBSQL query for the custom aggregation.")
+    __properties: ClassVar[List[str]] = ["name", "description", "reported_aggregations", "aggregate_args", "sql"]
+
+    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 PostCustomAggregationSpecSchema 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 reported_aggregations (list)
+        _items = []
+        if self.reported_aggregations:
+            for _item_reported_aggregations in self.reported_aggregations:
+                if _item_reported_aggregations:
+                    _items.append(_item_reported_aggregations.to_dict())
+            _dict['reported_aggregations'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in aggregate_args (list)
+        _items = []
+        if self.aggregate_args:
+            for _item_aggregate_args in self.aggregate_args:
+                if _item_aggregate_args:
+                    _items.append(_item_aggregate_args.to_dict())
+            _dict['aggregate_args'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostCustomAggregationSpecSchema 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"),
+            "description": obj.get("description"),
+            "reported_aggregations": [ReportedCustomAggregation.from_dict(_item) for _item in obj["reported_aggregations"]] if obj.get("reported_aggregations") is not None else None,
+            "aggregate_args": [CustomAggregationSpecSchemaAggregateArgsInner.from_dict(_item) for _item in obj["aggregate_args"]] if obj.get("aggregate_args") is not None else None,
+            "sql": obj.get("sql")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/put_custom_aggregation_spec_schema.py

@@ -0,0 +1,111 @@
+# 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.custom_aggregation_spec_schema_aggregate_args_inner import CustomAggregationSpecSchemaAggregateArgsInner
+from arthur_client.api_bindings.models.reported_custom_aggregation import ReportedCustomAggregation
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PutCustomAggregationSpecSchema(BaseModel):
+    """
+    PutCustomAggregationSpecSchema
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of the custom aggregation function.")
+    description: StrictStr = Field(description="Description of the custom aggregation function and what it aggregates.")
+    reported_aggregations: List[ReportedCustomAggregation] = Field(description="Metadata for every aggregation the custom aggregation reports.")
+    aggregate_args: List[CustomAggregationSpecSchemaAggregateArgsInner] = Field(description="List of parameters to the custom aggregation's query function.")
+    sql: StrictStr = Field(description="DuckDBSQL query for the custom aggregation.")
+    __properties: ClassVar[List[str]] = ["name", "description", "reported_aggregations", "aggregate_args", "sql"]
+
+    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 PutCustomAggregationSpecSchema 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 reported_aggregations (list)
+        _items = []
+        if self.reported_aggregations:
+            for _item_reported_aggregations in self.reported_aggregations:
+                if _item_reported_aggregations:
+                    _items.append(_item_reported_aggregations.to_dict())
+            _dict['reported_aggregations'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in aggregate_args (list)
+        _items = []
+        if self.aggregate_args:
+            for _item_aggregate_args in self.aggregate_args:
+                if _item_aggregate_args:
+                    _items.append(_item_aggregate_args.to_dict())
+            _dict['aggregate_args'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PutCustomAggregationSpecSchema 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"),
+            "description": obj.get("description"),
+            "reported_aggregations": [ReportedCustomAggregation.from_dict(_item) for _item in obj["reported_aggregations"]] if obj.get("reported_aggregations") is not None else None,
+            "aggregate_args": [CustomAggregationSpecSchemaAggregateArgsInner.from_dict(_item) for _item in obj["aggregate_args"]] if obj.get("aggregate_args") is not None else None,
+            "sql": obj.get("sql")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/reported_custom_aggregation.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from arthur_client.api_bindings.models.aggregation_metric_type import AggregationMetricType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ReportedCustomAggregation(BaseModel):
+    """
+    ReportedCustomAggregation
+    """ # noqa: E501
+    metric_name: StrictStr = Field(description="Name of the reported aggregation metric.")
+    description: StrictStr = Field(description="Description of the reported aggregation metric and what it aggregates.")
+    value_column: StrictStr = Field(description="Name of the column returned from the SQL query holding the metric value.")
+    timestamp_column: StrictStr = Field(description="Name of the column returned from the SQL query holding the timestamp buckets.")
+    metric_kind: AggregationMetricType = Field(description="Return type of the reported aggregation metric value.")
+    dimension_columns: List[StrictStr] = Field(description="Name of any dimension columns returned from the SQL query. Max length is 1.")
+    __properties: ClassVar[List[str]] = ["metric_name", "description", "value_column", "timestamp_column", "metric_kind", "dimension_columns"]
+
+    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 ReportedCustomAggregation 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 ReportedCustomAggregation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "metric_name": obj.get("metric_name"),
+            "description": obj.get("description"),
+            "value_column": obj.get("value_column"),
+            "timestamp_column": obj.get("timestamp_column"),
+            "metric_kind": obj.get("metric_kind"),
+            "dimension_columns": obj.get("dimension_columns")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/resource_kind.py

@@ -42,6 +42,7 @@ class ResourceKind(str, Enum):
     DATA_PLANE = 'data_plane'
     ALERT_RULE = 'alert_rule'
     WEBHOOK = 'webhook'
+    CUSTOM_AGGREGATION = 'custom_aggregation'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

arthur_client/api_bindings/models/rule_type.py

@@ -27,9 +27,7 @@ class RuleType(str, Enum):
     allowed enum values
     """
     KEYWORDRULE = 'KeywordRule'
-    MODELHALLUCINATIONRULE = 'ModelHallucinationRule'
     MODELHALLUCINATIONRULEV2 = 'ModelHallucinationRuleV2'
-    MODELHALLUCINATIONRULEV3 = 'ModelHallucinationRuleV3'
     MODELSENSITIVEDATARULE = 'ModelSensitiveDataRule'
     PIIDATARULE = 'PIIDataRule'
     PROMPTINJECTIONRULE = 'PromptInjectionRule'

arthur_client/api_bindings/models/validation_outcome.py

@@ -0,0 +1,37 @@
+# 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 ValidationOutcome(str, Enum):
+    """
+    Generic class to indicate if a validation passed or failed.
+    """
+
+    """
+    allowed enum values
+    """
+    PASS = 'pass'
+    FAIL = 'fail'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ValidationOutcome from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/validation_result.py

@@ -0,0 +1,90 @@
+# 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.validation_outcome import ValidationOutcome
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ValidationResult(BaseModel):
+    """
+    Generic class to indicate a single validation and its outcome.
+    """ # noqa: E501
+    validation_description: StrictStr = Field(description="Description of validation requirement.")
+    validation_outcome: ValidationOutcome = Field(description="Outcome of the validation requirement.")
+    __properties: ClassVar[List[str]] = ["validation_description", "validation_outcome"]
+
+    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 ValidationResult 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 ValidationResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "validation_description": obj.get("validation_description"),
+            "validation_outcome": obj.get("validation_outcome")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/validation_results.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
+from typing import Any, ClassVar, Dict, List
+from arthur_client.api_bindings.models.validation_result import ValidationResult
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ValidationResults(BaseModel):
+    """
+    This class is a generic class for any endpoints returning multiple validation errors.
+    """ # noqa: E501
+    validation_results: List[ValidationResult]
+    __properties: ClassVar[List[str]] = ["validation_results"]
+
+    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 ValidationResults 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 validation_results (list)
+        _items = []
+        if self.validation_results:
+            for _item_validation_results in self.validation_results:
+                if _item_validation_results:
+                    _items.append(_item_validation_results.to_dict())
+            _dict['validation_results'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ValidationResults from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "validation_results": [ValidationResult.from_dict(_item) for _item in obj["validation_results"]] if obj.get("validation_results") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/test/test_aggregation_spec_schema_init_args_inner.py

@@ -36,11 +36,11 @@ class TestAggregationSpecSchemaInitArgsInner(unittest.TestCase):
         if include_optional:
             return AggregationSpecSchemaInitArgsInner(
                 parameter_key = '',
-                optional = True,
                 friendly_name = '',
                 description = '',
                 parameter_type = 'column_list',
                 model_problem_type = 'regression',
+                optional = True,
                 parameter_dtype = 'undefined',
                 tag_hints = [
                     'llm_context'

arthur_client/api_bindings/test/test_base_column_parameter_schema.py

@@ -0,0 +1,66 @@
+# 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
+
+
+import unittest
+
+from arthur_client.api_bindings.models.base_column_parameter_schema import BaseColumnParameterSchema
+
+class TestBaseColumnParameterSchema(unittest.TestCase):
+    """BaseColumnParameterSchema unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> BaseColumnParameterSchema:
+        """Test BaseColumnParameterSchema
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `BaseColumnParameterSchema`
+        """
+        model = BaseColumnParameterSchema()
+        if include_optional:
+            return BaseColumnParameterSchema(
+                parameter_key = '',
+                friendly_name = '',
+                description = '',
+                tag_hints = [
+                    'llm_context'
+                    ],
+                source_dataset_parameter_key = '',
+                allowed_column_types = [
+                    null
+                    ],
+                allow_any_column_type = True,
+                parameter_type = 'column'
+            )
+        else:
+            return BaseColumnParameterSchema(
+                parameter_key = '',
+                friendly_name = '',
+                description = '',
+                source_dataset_parameter_key = '',
+        )
+        """
+
+    def testBaseColumnParameterSchema(self):
+        """Test BaseColumnParameterSchema"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()