pangea-sdk 6.2.0b1__py3-none-any.whl → 6.2.0b2__py3-none-any.whl

pangea/services/prompt_guard.py

@@ -1,9 +1,12 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Literal, Optional
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
+
+from pydantic import BaseModel, Field
 
 from pangea.config import PangeaConfig
-from pangea.response import APIRequestModel, APIResponseModel, PangeaResponse, PangeaResponseResult
+from pangea.response import APIRequestModel, APIResponseModel, PangeaDateTime, PangeaResponse, PangeaResponseResult
 from pangea.services.base import ServiceBase
 
 if TYPE_CHECKING:
@@ -46,6 +49,92 @@ class GuardResult(PangeaResponseResult):
     """List of classification results with labels and confidence scores"""
 
 
+class Areas(BaseModel):
+    malicious_prompt: Optional[bool] = None
+    benign_prompt: Optional[bool] = None
+
+
+class AuditDataActivityConfig(BaseModel):
+    enabled: bool
+    audit_service_config_id: str
+    areas: Areas
+
+
+class ServiceConfig(BaseModel):
+    id: Optional[str] = None
+    version: Optional[str] = None
+    analyzers: Optional[dict[str, bool]] = None
+    malicious_detection_threshold: Annotated[Optional[float], Field(ge=0.0, le=1.0)] = None
+    benign_detection_threshold: Annotated[Optional[float], Field(ge=0.0, le=1.0)] = None
+    audit_data_activity: Optional[AuditDataActivityConfig] = None
+
+
+class ServiceConfigFilter(BaseModel):
+    id: Optional[str] = None
+    """
+    Only records where id equals this value.
+    """
+    id__contains: Optional[list[str]] = None
+    """
+    Only records where id includes each substring.
+    """
+    id__in: Optional[list[str]] = None
+    """
+    Only records where id equals one of the provided substrings.
+    """
+    created_at: Optional[PangeaDateTime] = None
+    """
+    Only records where created_at equals this value.
+    """
+    created_at__gt: Optional[PangeaDateTime] = None
+    """
+    Only records where created_at is greater than this value.
+    """
+    created_at__gte: Optional[PangeaDateTime] = None
+    """
+    Only records where created_at is greater than or equal to this value.
+    """
+    created_at__lt: Optional[PangeaDateTime] = None
+    """
+    Only records where created_at is less than this value.
+    """
+    created_at__lte: Optional[PangeaDateTime] = None
+    """
+    Only records where created_at is less than or equal to this value.
+    """
+    updated_at: Optional[PangeaDateTime] = None
+    """
+    Only records where updated_at equals this value.
+    """
+    updated_at__gt: Optional[PangeaDateTime] = None
+    """
+    Only records where updated_at is greater than this value.
+    """
+    updated_at__gte: Optional[PangeaDateTime] = None
+    """
+    Only records where updated_at is greater than or equal to this value.
+    """
+    updated_at__lt: Optional[PangeaDateTime] = None
+    """
+    Only records where updated_at is less than this value.
+    """
+    updated_at__lte: Optional[PangeaDateTime] = None
+    """
+    Only records where updated_at is less than or equal to this value.
+    """
+
+
+class ServiceConfigsPage(PangeaResponseResult):
+    count: Optional[int] = None
+    """The total number of service configs matched by the list request."""
+    last: Optional[str] = None
+    """
+    Used to fetch the next page of the current listing when provided in a
+    repeated request's last parameter.
+    """
+    items: Optional[list[ServiceConfig]] = None
+
+
 class PromptGuard(ServiceBase):
     """Prompt Guard service client.
 
@@ -116,3 +205,105 @@ class PromptGuard(ServiceBase):
             GuardResult,
             data={"messages": messages, "analyzers": analyzers, "classify": classify},
         )
+
+    def get_service_config(
+        self,
+        *,
+        id: str | None = None,
+        version: str | None = None,
+        analyzers: Mapping[str, bool] | None = None,
+        malicious_detection_threshold: float | None = None,
+        benign_detection_threshold: float | None = None,
+        audit_data_activity: AuditDataActivityConfig | None = None,
+    ) -> PangeaResponse[PangeaResponseResult]:
+        """
+        OperationId: prompt_guard_post_v1beta_config
+        """
+        return self.request.post(
+            "v1beta/config",
+            data={
+                "id": id,
+                "version": version,
+                "analyzers": analyzers,
+                "malicious_detection_threshold": malicious_detection_threshold,
+                "benign_detection_threshold": benign_detection_threshold,
+                "audit_data_activity": audit_data_activity,
+            },
+            result_class=PangeaResponseResult,
+        )
+
+    def create_service_config(
+        self,
+        *,
+        id: str | None = None,
+        version: str | None = None,
+        analyzers: Mapping[str, bool] | None = None,
+        malicious_detection_threshold: float | None = None,
+        benign_detection_threshold: float | None = None,
+        audit_data_activity: AuditDataActivityConfig | None = None,
+    ) -> PangeaResponse[PangeaResponseResult]:
+        """
+        OperationId: prompt_guard_post_v1beta_config_create
+        """
+        return self.request.post(
+            "v1beta/config/create",
+            data={
+                "id": id,
+                "version": version,
+                "analyzers": analyzers,
+                "malicious_detection_threshold": malicious_detection_threshold,
+                "benign_detection_threshold": benign_detection_threshold,
+                "audit_data_activity": audit_data_activity,
+            },
+            result_class=PangeaResponseResult,
+        )
+
+    def update_service_config(
+        self,
+        *,
+        id: str | None = None,
+        version: str | None = None,
+        analyzers: Mapping[str, bool] | None = None,
+        malicious_detection_threshold: float | None = None,
+        benign_detection_threshold: float | None = None,
+        audit_data_activity: AuditDataActivityConfig | None = None,
+    ) -> PangeaResponse[PangeaResponseResult]:
+        """
+        OperationId: prompt_guard_post_v1beta_config_update
+        """
+        return self.request.post(
+            "v1beta/config/update",
+            data={
+                "id": id,
+                "version": version,
+                "analyzers": analyzers,
+                "malicious_detection_threshold": malicious_detection_threshold,
+                "benign_detection_threshold": benign_detection_threshold,
+                "audit_data_activity": audit_data_activity,
+            },
+            result_class=PangeaResponseResult,
+        )
+
+    def delete_service_config(self, id: str) -> PangeaResponse[PangeaResponseResult]:
+        """
+        OperationId: prompt_guard_post_v1beta_config_delete
+        """
+        return self.request.post("v1beta/config/delete", data={"id": id}, result_class=PangeaResponseResult)
+
+    def list_service_configs(
+        self,
+        *,
+        filter: ServiceConfigFilter | None = None,
+        last: str | None = None,
+        order: Literal["asc", "desc"] | None = None,
+        order_by: Literal["id", "created_at", "updated_at"] | None = None,
+        size: int | None = None,
+    ) -> PangeaResponse[ServiceConfigsPage]:
+        """
+        OperationId: prompt_guard_post_v1beta_config_list
+        """
+        return self.request.post(
+            "v1beta/config/list",
+            data={"filter": filter, "last": last, "order": order, "order_by": order_by, "size": size},
+            result_class=ServiceConfigsPage,
+        )

pangea/services/redact.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import enum
@@ -481,7 +485,7 @@ class Redact(ServiceBase):
         Returns:
             Pangea Response with redacted text in the response.result property,
                 available response fields can be found in our
-                [API Documentation](https://pangea.cloud/docs/api/redact#redact).
+                [API Documentation](https://pangea.cloud/docs/api/redact#redact-post).
 
         Examples:
             response = redact.redact(text="Jenny Jenny... 555-867-5309")
@@ -540,7 +544,7 @@ class Redact(ServiceBase):
         Returns:
             Pangea Response with redacted data in the response.result field,
                 available response fields can be found in our
-                [API Documentation](https://pangea.cloud/docs/api/redact#redact-structured)
+                [API Documentation](https://pangea.cloud/docs/api/redact#redact-structured-post)
 
         Examples:
             data = {
@@ -583,7 +587,7 @@ class Redact(ServiceBase):
         Returns:
             Pangea Response with redacted data in the response.result field,
                 available response fields can be found in our
-                [API Documentation](https://pangea.cloud/docs/api/redact#unredact)
+                [API Documentation](https://pangea.cloud/docs/api/redact#unredact-post)
         """
         input = UnredactRequest(redacted_data=redacted_data, fpe_context=fpe_context)
         return self.request.post("v1/unredact", UnredactResult, data=input.model_dump(exclude_none=True))

pangea/services/sanitize.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import io
@@ -267,7 +271,7 @@ class Sanitize(ServiceBase):
         files: Optional[List[Tuple]] = None
         if file or file_path:
             if file_path:
-                file = open(file_path, "rb")
+                file = open(file_path, "rb")  # noqa: SIM115
             if (
                 transfer_method == TransferMethod.POST_URL
                 and file

pangea/services/share/share.py

@@ -1,10 +1,16 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import enum
 import io
-from typing import Dict, List, NewType, Optional, Tuple, Union
+from typing import Dict, List, Optional, Tuple, Union
+
+from pydantic import RootModel
 
 from pangea.config import PangeaConfig
 from pangea.response import APIRequestModel, PangeaResponse, PangeaResponseResult, TransferMethod
@@ -12,8 +18,8 @@ from pangea.services.base import ServiceBase
 from pangea.services.share.file_format import FileFormat
 from pangea.utils import get_file_size, get_file_upload_params
 
-Metadata = NewType("Metadata", Dict[str, str])
-Tags = NewType("Tags", List[str])
+Metadata = RootModel[dict[str, str]]
+Tags = RootModel[list[str]]
 
 
 class ItemOrder(str, enum.Enum):
@@ -916,10 +922,10 @@ class Share(ServiceBase):
 
     def get_archive(
         self,
-        ids: List[str] = [],
-        format: Optional[ArchiveFormat] = None,
-        transfer_method: Optional[TransferMethod] = None,
-        bucket_id: Optional[str] = None,
+        ids: list[str],
+        format: ArchiveFormat | None = None,
+        transfer_method: TransferMethod | None = None,
+        bucket_id: str | None = None,
     ) -> PangeaResponse[GetArchiveResult]:
         """
         Get archive

pangea/services/vault/models/asymmetric.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 from enum import Enum

pangea/services/vault/models/common.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 import enum

pangea/services/vault/models/symmetric.py

@@ -1,5 +1,9 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+
+# TODO: Use `list` instead of `List`.
+# ruff: noqa: UP006, UP035
+
 from __future__ import annotations
 
 from enum import Enum

pangea/services/vault/vault.py

@@ -2,10 +2,9 @@
 # Author: Pangea Cyber Corporation
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, List, Literal, Optional, Union, cast, overload
+from typing import TYPE_CHECKING, Annotated, Any, Literal, Optional, Union, cast, overload
 
 from pydantic import Field, TypeAdapter
-from typing_extensions import Annotated
 
 from pangea.response import PangeaResponse, PangeaResponseResult
 from pangea.services.base import ServiceBase
@@ -34,7 +33,6 @@ from pangea.services.vault.models.common import (
     EncryptTransformRequest,
     EncryptTransformResult,
     ExportEncryptionAlgorithm,
-    ExportEncryptionType,
     ExportRequest,
     ExportResult,
     Folder,
@@ -98,7 +96,7 @@ vault_item_adapter: TypeAdapter[VaultItem] = TypeAdapter(VaultItem)
 
 
 class GetBulkResponse(PangeaResponseResult):
-    items: List[VaultItem]
+    items: list[VaultItem]
 
 
 class Vault(ServiceBase):
@@ -164,7 +162,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the id of the deleted secret or key
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#delete).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/delete-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -197,7 +195,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the secret or key
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#retrieve).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/get-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -285,7 +283,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where a list of secrets or keys
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#list).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/list-post).
 
         Examples:
             response = vault.list(
@@ -344,7 +342,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the item ID is returned in the
             response.result field. Available response fields can be found in our
-            [API documentation](https://pangea.cloud/docs/api/vault#update).
+            [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/update-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1679,7 +1677,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the encrypted message in base64 is returned
             in the response.result field. Available response fields can be found
-            in our [API documentation](https://pangea.cloud/docs/api/vault#encrypt).
+            in our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/encrypt-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1715,7 +1713,7 @@ class Vault(ServiceBase):
 
         Returns:
             A PangeaResponse where the decrypted message in base64 is returned
-            in the response.result field. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#decrypt).
+            in the response.result field. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/decrypt-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1749,7 +1747,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the signature of the message in base64 is
             returned in the response.result field. Available response fields can
-            be found in our [API documentation](https://pangea.cloud/docs/api/vault#sign).
+            be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/sign-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1785,7 +1783,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the signature is valid
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#verify).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/verify-post).
 
         Examples:
             response = vault.verify(
@@ -1823,7 +1821,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the signature is valid
                 is returned in the response.result field.
-                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault#verify-jwt).
+                Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-jwt#/v1/key/verify/jwt-post).
 
         Examples:
             response = vault.jwt_verify(jws="ewogICJhbGciO...")
@@ -1848,7 +1846,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the signed JSON Web Token (JWS) is returned
             in the response.result field. Available response fields can be found
-            in our [API documentation](https://pangea.cloud/docs/api/vault#sign-a-jwt).
+            in our [API documentation](https://pangea.cloud/docs/api/vault/v1-jwt#/v1/key/sign/jwt-post).
 
         Examples:
             response = vault.jwt_sign(
@@ -1878,7 +1876,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the JSON Web Key Set (JWKS) object is
             returned in the response.result field. Available response fields can
-            be found in our [API documentation](https://pangea.cloud/docs/api/vault#retrieve-jwk).
+            be found in our [API documentation](https://pangea.cloud/docs/api/vault/v1-jwt#/v1/get/jwk-post).
 
         Examples:
             response = vault.jwk_get("pvi_p6g5i3gtbvqvc3u6zugab6qs6r63tqf5")
@@ -1910,7 +1908,7 @@ class Vault(ServiceBase):
         Returns:
             A PangeaResponse where the state change object is returned in the
             response.result field. Available response fields can be found in our
-            [API documentation](https://pangea.cloud/docs/api/vault#change-state).
+            [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/state/change-post).
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -2011,7 +2009,7 @@ class Vault(ServiceBase):
         Returns:
             A `PangeaResponse` where the encrypted object is returned in the
             `response.result` field. Available response fields can be found in
-            our [API documentation](https://pangea.cloud/docs/api/vault#encrypt-structured).
+            our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/encrypt/structured-post).
 
         Raises:
             PangeaAPIException: If an API error happens.
@@ -2067,7 +2065,7 @@ class Vault(ServiceBase):
         Returns:
             A `PangeaResponse` where the decrypted object is returned in the
             `response.result` field. Available response fields can be found in
-            our [API documentation](https://pangea.cloud/docs/api/vault#decrypt-structured).
+            our [API documentation](https://pangea.cloud/docs/api/vault/v1-keys#/v1/key/decrypt/structured-post).
 
         Examples:
             data = {"field1": [1, 2, "kxcbC9E9IlgVaSCChPWUMgUC3ko=", "6FfI/LCzatLRLNAc8SuBK/TDnGxp"], "field2": "data2"}
@@ -2211,7 +2209,7 @@ class Vault(ServiceBase):
         Returns:
             A `PangeaResponse` where the exported key is returned in the
             `response.result` field. Available response fields can be found in
-            our [API documentation](https://pangea.cloud/docs/api/vault#export).
+            our [API documentation](https://pangea.cloud/docs/api/vault/v1-general#/v1/export-post).
 
         Raises:
             PangeaAPIException: If an API error happens.

pangea/tools.py

@@ -1,5 +1,6 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from __future__ import annotations
 
 import enum
 import io
@@ -7,9 +8,10 @@ import json
 import logging
 import os
 import sys
+from collections.abc import Iterator
 from datetime import datetime, timezone
 from logging.handlers import TimedRotatingFileHandler
-from typing import Dict, Iterator, List, Optional
+from typing import Optional
 
 from pangea.config import PangeaConfig
 from pangea.exceptions import PangeaException
@@ -17,6 +19,8 @@ from pangea.services import Audit
 
 
 class TestEnvironment(str, enum.Enum):
+    __test__ = False
+
     DEVELOP = "DEV"
     LIVE = "LVE"
     STAGING = "STG"
@@ -28,15 +32,15 @@ class TestEnvironment(str, enum.Enum):
         return str(self.value)
 
 
-class Root(Dict):
+class Root(dict):
     size: int
     tree_name: str
 
 
-class Event(Dict):
+class Event(dict):
     membership_proof: str
     leaf_index: Optional[int]
-    event: Dict
+    event: dict
     hash: str
     tree_size: Optional[int]
 
@@ -68,7 +72,7 @@ def exit_with_error(message: str):
     sys.exit(1)
 
 
-def file_events(root_hashes: Dict[int, str], f: io.TextIOWrapper) -> Iterator[Event]:
+def file_events(root_hashes: dict[int, str], f: io.TextIOWrapper) -> Iterator[Event]:
     """
     Reads a file containing Events in JSON format with the following fields:
     - membership_proof: str
@@ -111,8 +115,8 @@ def make_aware_datetime(d: datetime) -> datetime:
     return d
 
 
-def filter_deep_none(data: Dict) -> Dict:
-    return {k: v if not isinstance(v, Dict) else filter_deep_none(v) for k, v in data.items() if v is not None}
+def filter_deep_none(data: dict) -> dict:
+    return {k: v if not isinstance(v, dict) else filter_deep_none(v) for k, v in data.items() if v is not None}
 
 
 def _load_env_var(env_var_name: str) -> str:
@@ -183,7 +187,7 @@ class SequenceFollower:
             self.numbers.remove(min_val)
             min_val += 1
 
-    def holes(self) -> List[int]:
+    def holes(self) -> list[int]:
         if not self.numbers:
             return []
 
@@ -192,7 +196,7 @@ class SequenceFollower:
         return [val for val in range(min_val, max_val) if val not in self.numbers]
 
 
-loggers: Dict[str, bool] = {}
+loggers: dict[str, bool] = {}
 
 
 def logger_set_pangea_config(logger_name: str, level=logging.DEBUG):

pangea/utils.py

@@ -60,7 +60,7 @@ def canonicalize(data: dict) -> str:
         return json.dumps(
             data, ensure_ascii=False, allow_nan=False, separators=(",", ":"), sort_keys=True, default=default_encoder
         )
-    elif isinstance(data, datetime.datetime) or isinstance(data, datetime.date):
+    elif isinstance(data, (datetime.datetime, datetime.date)):
         return format_datetime(data)
     else:
         return str(data)
@@ -151,10 +151,8 @@ def get_crc32c(data: str) -> str:
 
 
 def hash_256_filepath(filepath: str) -> str:
-    data = open(filepath, "rb")
-    hash = sha256(data.read()).hexdigest()
-    data.close()
-    return hash
+    with open(filepath, "rb") as data:
+        return sha256(data.read()).hexdigest()
 
 
 def get_prefix(hash: str, len: int = 5):