scope-client 1.4.912__py3-none-any.whl → 1.4.913__py3-none-any.whl

scope_client/api_bindings/models/keywords_config.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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class KeywordsConfig(BaseModel):
+    """
+    KeywordsConfig
+    """ # noqa: E501
+    keywords: List[StrictStr] = Field(description="List of Keywords")
+    __properties: ClassVar[List[str]] = ["keywords"]
+
+    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 KeywordsConfig 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 KeywordsConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "keywords": obj.get("keywords")
+        })
+        return _obj
+
+

scope_client/api_bindings/models/metrics_query_result.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -26,7 +26,7 @@ class MetricsQueryResult(BaseModel):
     """
     MetricsQueryResult
     """ # noqa: E501
-    results: List[Dict[str, Any]] = Field(description="Results of the metrics query.")
+    results: List[Optional[Dict[str, Any]]] = Field(description="Results of the metrics query.")
     __properties: ClassVar[List[str]] = ["results"]
 
     model_config = ConfigDict(

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

scope_client/api_bindings/models/patch_task_request.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
+from typing import Any, ClassVar, Dict, List, Optional
+from scope_client.api_bindings.models.new_rule_request import NewRuleRequest
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PatchTaskRequest(BaseModel):
+    """
+    PatchTaskRequest
+    """ # noqa: E501
+    rules_to_enable: Optional[List[StrictStr]] = Field(default=None, description="List of rule IDs to enable on the task.")
+    rules_to_disable: Optional[List[StrictStr]] = Field(default=None, description="List of rule IDs to disable on the task.")
+    rules_to_archive: Optional[List[StrictStr]] = Field(default=None, description="List of rule IDs to archive on the task.")
+    rules_to_add: Optional[List[NewRuleRequest]] = Field(default=None, description="List of new rules to add to the task.")
+    __properties: ClassVar[List[str]] = ["rules_to_enable", "rules_to_disable", "rules_to_archive", "rules_to_add"]
+
+    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 PatchTaskRequest 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 rules_to_add (list)
+        _items = []
+        if self.rules_to_add:
+            for _item_rules_to_add in self.rules_to_add:
+                if _item_rules_to_add:
+                    _items.append(_item_rules_to_add.to_dict())
+            _dict['rules_to_add'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PatchTaskRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "rules_to_enable": obj.get("rules_to_enable"),
+            "rules_to_disable": obj.get("rules_to_disable"),
+            "rules_to_archive": obj.get("rules_to_archive"),
+            "rules_to_add": [NewRuleRequest.from_dict(_item) for _item in obj["rules_to_add"]] if obj.get("rules_to_add") is not None else None
+        })
+        return _obj
+
+

scope_client/api_bindings/models/permission_name.py

@@ -83,6 +83,7 @@ class PermissionName(str, Enum):
     PROJECT_CREATE_ROLE_BINDING = 'project_create_role_binding'
     PROJECT_LIST_ROLE_BINDINGS = 'project_list_role_bindings'
     PROJECT_GENERATE_METRICS_SPEC = 'project_generate_metrics_spec'
+    PROJECT_CREATE_MODEL_TASK = 'project_create_model_task'
     MODEL_READ = 'model_read'
     MODEL_UPDATE = 'model_update'
     MODEL_DELETE = 'model_delete'
@@ -97,6 +98,11 @@ class PermissionName(str, Enum):
     MODEL_QUERY_METRICS = 'model_query_metrics'
     MODEL_METRICS_SCHEDULE_UPDATE = 'model_metrics_schedule_update'
     MODEL_METRICS_SCHEDULE_DELETE = 'model_metrics_schedule_delete'
+    MODEL_TASK_READ = 'model_task_read'
+    MODEL_TASK_UPDATE = 'model_task_update'
+    MODEL_TASK_DELETE = 'model_task_delete'
+    MODEL_TASK_SYNC = 'model_task_sync'
+    MODEL_TASK_PUT_STATE_CACHE = 'model_task_put_state_cache'
     CONNECTOR_READ = 'connector_read'
     CONNECTOR_UPDATE = 'connector_update'
     CONNECTOR_DELETE = 'connector_delete'

scope_client/api_bindings/models/pii_config.py

@@ -0,0 +1,106 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PIIConfig(BaseModel):
+    """
+    PIIConfig
+    """ # noqa: E501
+    disabled_pii_entities: Optional[List[StrictStr]] = None
+    confidence_threshold: Optional[Union[StrictFloat, StrictInt]] = None
+    allow_list: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["disabled_pii_entities", "confidence_threshold", "allow_list"]
+
+    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 PIIConfig 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 disabled_pii_entities (nullable) is None
+        # and model_fields_set contains the field
+        if self.disabled_pii_entities is None and "disabled_pii_entities" in self.model_fields_set:
+            _dict['disabled_pii_entities'] = None
+
+        # set to None if confidence_threshold (nullable) is None
+        # and model_fields_set contains the field
+        if self.confidence_threshold is None and "confidence_threshold" in self.model_fields_set:
+            _dict['confidence_threshold'] = None
+
+        # set to None if allow_list (nullable) is None
+        # and model_fields_set contains the field
+        if self.allow_list is None and "allow_list" in self.model_fields_set:
+            _dict['allow_list'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PIIConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "disabled_pii_entities": obj.get("disabled_pii_entities"),
+            "confidence_threshold": obj.get("confidence_threshold"),
+            "allow_list": obj.get("allow_list")
+        })
+        return _obj
+
+

scope_client/api_bindings/models/post_task_request.py

@@ -0,0 +1,105 @@
+# 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, Optional
+from typing_extensions import Annotated
+from scope_client.api_bindings.models.new_rule_request import NewRuleRequest
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PostTaskRequest(BaseModel):
+    """
+    PostTaskRequest
+    """ # noqa: E501
+    name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="The name of the task")
+    onboarding_identifier: Optional[StrictStr] = None
+    rules_to_add: Optional[List[NewRuleRequest]] = Field(default=None, description="List of rules to add to the task.")
+    __properties: ClassVar[List[str]] = ["name", "onboarding_identifier", "rules_to_add"]
+
+    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 PostTaskRequest 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 rules_to_add (list)
+        _items = []
+        if self.rules_to_add:
+            for _item_rules_to_add in self.rules_to_add:
+                if _item_rules_to_add:
+                    _items.append(_item_rules_to_add.to_dict())
+            _dict['rules_to_add'] = _items
+        # 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PostTaskRequest 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"),
+            "onboarding_identifier": obj.get("onboarding_identifier"),
+            "rules_to_add": [NewRuleRequest.from_dict(_item) for _item in obj["rules_to_add"]] if obj.get("rules_to_add") is not None else None
+        })
+        return _obj
+
+

scope_client/api_bindings/models/put_task_state_cache_request.py

@@ -0,0 +1,91 @@
+# 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 scope_client.api_bindings.models.task_response import TaskResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PutTaskStateCacheRequest(BaseModel):
+    """
+    PutTaskStateCacheRequest
+    """ # noqa: E501
+    task: TaskResponse = Field(description="Copy of the task state to cache in the control plane.")
+    __properties: ClassVar[List[str]] = ["task"]
+
+    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 PutTaskStateCacheRequest 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 task
+        if self.task:
+            _dict['task'] = self.task.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PutTaskStateCacheRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "task": TaskResponse.from_dict(obj["task"]) if obj.get("task") is not None else None
+        })
+        return _obj
+
+