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

arthur_client/api_bindings/models/rule_response.py

@@ -0,0 +1,121 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.rule_response_config import RuleResponseConfig
+from arthur_client.api_bindings.models.rule_scope import RuleScope
+from arthur_client.api_bindings.models.rule_type import RuleType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RuleResponse(BaseModel):
+    """
+    RuleResponse
+    """ # noqa: E501
+    id: StrictStr = Field(description="ID of the Rule")
+    name: StrictStr = Field(description="Name of the Rule")
+    type: RuleType = Field(description="Type of Rule")
+    apply_to_prompt: StrictBool = Field(description="Rule applies to prompt")
+    apply_to_response: StrictBool = Field(description="Rule applies to response")
+    enabled: Optional[StrictBool] = None
+    scope: RuleScope = Field(description="Scope of the rule. The rule can be set at default level or task level.")
+    created_at: StrictInt = Field(description="Time the rule was created in unix milliseconds")
+    updated_at: StrictInt = Field(description="Time the rule was updated in unix milliseconds")
+    config: Optional[RuleResponseConfig] = None
+    __properties: ClassVar[List[str]] = ["id", "name", "type", "apply_to_prompt", "apply_to_response", "enabled", "scope", "created_at", "updated_at", "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 RuleResponse 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 enabled (nullable) is None
+        # and model_fields_set contains the field
+        if self.enabled is None and "enabled" in self.model_fields_set:
+            _dict['enabled'] = None
+
+        # 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 RuleResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "type": obj.get("type"),
+            "apply_to_prompt": obj.get("apply_to_prompt"),
+            "apply_to_response": obj.get("apply_to_response"),
+            "enabled": obj.get("enabled"),
+            "scope": obj.get("scope"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "config": RuleResponseConfig.from_dict(obj["config"]) if obj.get("config") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/rule_response_config.py

@@ -0,0 +1,185 @@
+# 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.examples_config import ExamplesConfig
+from arthur_client.api_bindings.models.keywords_config import KeywordsConfig
+from arthur_client.api_bindings.models.pii_config import PIIConfig
+from arthur_client.api_bindings.models.regex_config import RegexConfig
+from arthur_client.api_bindings.models.toxicity_config import ToxicityConfig
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+RULERESPONSECONFIG_ANY_OF_SCHEMAS = ["ExamplesConfig", "KeywordsConfig", "PIIConfig", "RegexConfig", "ToxicityConfig"]
+
+class RuleResponseConfig(BaseModel):
+    """
+    Config of the rule
+    """
+
+    # data type: KeywordsConfig
+    anyof_schema_1_validator: Optional[KeywordsConfig] = None
+    # data type: RegexConfig
+    anyof_schema_2_validator: Optional[RegexConfig] = None
+    # data type: ExamplesConfig
+    anyof_schema_3_validator: Optional[ExamplesConfig] = None
+    # data type: ToxicityConfig
+    anyof_schema_4_validator: Optional[ToxicityConfig] = None
+    # data type: PIIConfig
+    anyof_schema_5_validator: Optional[PIIConfig] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[ExamplesConfig, KeywordsConfig, PIIConfig, RegexConfig, ToxicityConfig]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "ExamplesConfig", "KeywordsConfig", "PIIConfig", "RegexConfig", "ToxicityConfig" }
+
+    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):
+        if v is None:
+            return v
+
+        instance = RuleResponseConfig.model_construct()
+        error_messages = []
+        # validate data type: KeywordsConfig
+        if not isinstance(v, KeywordsConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `KeywordsConfig`")
+        else:
+            return v
+
+        # validate data type: RegexConfig
+        if not isinstance(v, RegexConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `RegexConfig`")
+        else:
+            return v
+
+        # validate data type: ExamplesConfig
+        if not isinstance(v, ExamplesConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ExamplesConfig`")
+        else:
+            return v
+
+        # validate data type: ToxicityConfig
+        if not isinstance(v, ToxicityConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ToxicityConfig`")
+        else:
+            return v
+
+        # validate data type: PIIConfig
+        if not isinstance(v, PIIConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PIIConfig`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in RuleResponseConfig with anyOf schemas: ExamplesConfig, KeywordsConfig, PIIConfig, RegexConfig, ToxicityConfig. 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()
+        if json_str is None:
+            return instance
+
+        error_messages = []
+        # anyof_schema_1_validator: Optional[KeywordsConfig] = None
+        try:
+            instance.actual_instance = KeywordsConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[RegexConfig] = None
+        try:
+            instance.actual_instance = RegexConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[ExamplesConfig] = None
+        try:
+            instance.actual_instance = ExamplesConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_4_validator: Optional[ToxicityConfig] = None
+        try:
+            instance.actual_instance = ToxicityConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_5_validator: Optional[PIIConfig] = None
+        try:
+            instance.actual_instance = PIIConfig.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 RuleResponseConfig with anyOf schemas: ExamplesConfig, KeywordsConfig, PIIConfig, RegexConfig, ToxicityConfig. 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], ExamplesConfig, KeywordsConfig, PIIConfig, RegexConfig, ToxicityConfig]]:
+        """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/rule_scope.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 RuleScope(str, Enum):
+    """
+    RuleScope
+    """
+
+    """
+    allowed enum values
+    """
+    DEFAULT = 'default'
+    TASK = 'task'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RuleScope from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/rule_type.py

@@ -0,0 +1,44 @@
+# 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 RuleType(str, Enum):
+    """
+    RuleType
+    """
+
+    """
+    allowed enum values
+    """
+    KEYWORDRULE = 'KeywordRule'
+    MODELHALLUCINATIONRULE = 'ModelHallucinationRule'
+    MODELHALLUCINATIONRULEV2 = 'ModelHallucinationRuleV2'
+    MODELHALLUCINATIONRULEV3 = 'ModelHallucinationRuleV3'
+    MODELSENSITIVEDATARULE = 'ModelSensitiveDataRule'
+    PIIDATARULE = 'PIIDataRule'
+    PROMPTINJECTIONRULE = 'PromptInjectionRule'
+    REGEXRULE = 'RegexRule'
+    TOXICITYRULE = 'ToxicityRule'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RuleType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/scalar_type.py

@@ -0,0 +1,88 @@
+# 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.d_type import DType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScalarType(BaseModel):
+    """
+    ScalarType
+    """ # noqa: E501
+    dtype: DType
+    __properties: ClassVar[List[str]] = ["dtype"]
+
+    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 ScalarType 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 ScalarType from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dtype": obj.get("dtype")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/schedule_jobs_job_spec.py

@@ -0,0 +1,102 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScheduleJobsJobSpec(BaseModel):
+    """
+    ScheduleJobsJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'schedule_jobs'
+    scope_model_id: StrictStr = Field(description="The ID of the model to source the schedule from.")
+    start_timestamp: datetime = Field(description="Inclusive timestamp marking the start of the job series.")
+    __properties: ClassVar[List[str]] = ["job_type", "scope_model_id", "start_timestamp"]
+
+    @field_validator('job_type')
+    def job_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['schedule_jobs']):
+            raise ValueError("must be one of enum values ('schedule_jobs')")
+        return value
+
+    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 ScheduleJobsJobSpec 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 ScheduleJobsJobSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_type": obj.get("job_type") if obj.get("job_type") is not None else 'schedule_jobs',
+            "scope_model_id": obj.get("scope_model_id"),
+            "start_timestamp": obj.get("start_timestamp")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/schema_inspection_job_spec.py

@@ -0,0 +1,101 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SchemaInspectionJobSpec(BaseModel):
+    """
+    SchemaInspectionJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'schema_inspection'
+    connector_id: StrictStr = Field(description="The id of the connector to list datasets.")
+    available_dataset_id: StrictStr = Field(description="The id of the dataset within the connector to inspect the schema.")
+    __properties: ClassVar[List[str]] = ["job_type", "connector_id", "available_dataset_id"]
+
+    @field_validator('job_type')
+    def job_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['schema_inspection']):
+            raise ValueError("must be one of enum values ('schema_inspection')")
+        return value
+
+    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 SchemaInspectionJobSpec 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 SchemaInspectionJobSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_type": obj.get("job_type") if obj.get("job_type") is not None else 'schema_inspection',
+            "connector_id": obj.get("connector_id"),
+            "available_dataset_id": obj.get("available_dataset_id")
+        })
+        return _obj
+
+