pangea-sdk 5.5.0b1__tar.gz → 5.5.0b3__tar.gz

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pangea-sdk
-Version: 5.5.0b1
+Version: 5.5.0b3
 Summary: Pangea API SDK
 License: MIT
 Keywords: Pangea,SDK,Audit
@@ -11,11 +11,11 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: aiohttp (>=3.11.11,<4.0.0)
 Requires-Dist: cryptography (>=43.0.3,<44.0.0)
-Requires-Dist: deprecated (>=1.2.15,<2.0.0)
-Requires-Dist: google-crc32c (>=1.5.0,<2.0.0)
-Requires-Dist: pydantic (>=2.10.5,<3.0.0)
-Requires-Dist: python-dateutil (>=2.9.0,<3.0.0)
-Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: deprecated (>=1.2.18,<2.0.0)
+Requires-Dist: google-crc32c (>=1.6.0,<2.0.0)
+Requires-Dist: pydantic (>=2.10.6,<3.0.0)
+Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
 Requires-Dist: requests-toolbelt (>=1.0.0,<2.0.0)
 Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
 Description-Content-Type: text/markdown
@@ -63,13 +63,13 @@ the same compatibility guarantees as stable releases.
 Via pip:
 
 ```bash
-$ pip3 install pangea-sdk==5.5.0b1
+$ pip3 install pangea-sdk==5.5.0b3
 ```
 
 Via poetry:
 
 ```bash
-$ poetry add pangea-sdk==5.5.0b1
+$ poetry add pangea-sdk==5.5.0b3
 ```
 
 ## Usage

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/README.md

@@ -41,13 +41,13 @@ the same compatibility guarantees as stable releases.
 Via pip:
 
 ```bash
-$ pip3 install pangea-sdk==5.5.0b1
+$ pip3 install pangea-sdk==5.5.0b3
 ```
 
 Via poetry:
 
 ```bash
-$ poetry add pangea-sdk==5.5.0b1
+$ poetry add pangea-sdk==5.5.0b3
 ```
 
 ## Usage

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "5.5.0beta1"
+__version__ = "5.5.0beta3"
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pangea/asyncio/services/ai_guard.py

@@ -143,6 +143,9 @@ class AIGuardAsync(ServiceBaseAsync):
                 are to be applied to the text, such as defang malicious URLs.
             debug: Setting this value to true will provide a detailed analysis
                 of the text data
+
+        Examples:
+            response = await ai_guard.guard_text("text")
         """
 
         return await self.request.post(

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pangea/asyncio/services/prompt_guard.py

@@ -52,7 +52,12 @@ class PromptGuardAsync(ServiceBaseAsync):
         super().__init__(token, config, logger_name, config_id)
 
     async def guard(
-        self, messages: Iterable[Message], *, analyzers: Iterable[str] | None = None
+        self,
+        messages: Iterable[Message],
+        *,
+        analyzers: Iterable[str] | None = None,
+        classify: bool | None = None,
+        threshold: float | None = None,
     ) -> PangeaResponse[GuardResult]:
         """
         Guard (Beta)
@@ -64,8 +69,12 @@ class PromptGuardAsync(ServiceBaseAsync):
         OperationId: prompt_guard_post_v1beta_guard
 
         Args:
-            messages: Messages.
-            analyzers: Specific analyzers to be used in the call.
+            messages: Prompt content and role array in JSON format. The
+              `content` is the text that will be analyzed for redaction.
+            analyzers: Specific analyzers to be used in the call
+            classify: Boolean to enable classification of the content
+            threshold: Threshold for the confidence score to consider the prompt
+              as malicious
 
         Examples:
             from pangea.asyncio.services.prompt_guard import Message
@@ -73,4 +82,8 @@ class PromptGuardAsync(ServiceBaseAsync):
             response = await prompt_guard.guard([Message(role="user", content="hello world")])
         """
 
-        return await self.request.post("v1beta/guard", GuardResult, data={"messages": messages, "analyzers": analyzers})
+        return await self.request.post(
+            "v1beta/guard",
+            GuardResult,
+            data={"messages": messages, "analyzers": analyzers, "classify": classify, "threshold": threshold},
+        )

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pangea/asyncio/services/share.py

@@ -34,7 +34,7 @@ class ShareAsync(ServiceBaseAsync):
 
         Examples:
              config = PangeaConfig(domain="aws.us.pangea.cloud")
-             authz = ShareAsync(token="pangea_token", config=config)
+             share = ShareAsync(token="pangea_token", config=config)
         """
 
         super().__init__(token, config, logger_name, config_id=config_id)
@@ -51,7 +51,7 @@ class ShareAsync(ServiceBaseAsync):
             A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
 
         Examples:
-            response = share.buckets()
+            response = await share.buckets()
         """
 
         return await self.request.post("v1/buckets", m.BucketsResult)

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pangea/config.py

@@ -2,7 +2,7 @@
 # Author: Pangea Cyber Corporation
 
 from dataclasses import dataclass
-from typing import Optional
+from typing import Literal, Optional
 
 
 @dataclass
@@ -16,10 +16,12 @@ class PangeaConfig:
     scheme (http:// or https://), subdomain, domain and port.
     """
 
-    environment: str = "production"
+    environment: Literal["production", "local"] = "production"
     """
-    Used to generate service url.
-    It should be only 'production' or 'local' in cases of particular services that can run locally as Redact.
+    Pangea environment, used to construct service URLs.
+
+    If set to "local", then `domain` must be the full host (i.e., hostname and
+    port) for the Pangea service that this `PangeaConfig` will be used for.
     """
 
     config_id: Optional[str] = None

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pangea/services/ai_guard.py

@@ -13,6 +13,7 @@ class AnalyzerResponse(APIResponseModel):
 
 
 class PromptInjectionResult(APIResponseModel):
+    action: str
     analyzer_responses: List[AnalyzerResponse]
     """Triggered prompt injection analyzers."""
 
@@ -20,7 +21,7 @@ class PromptInjectionResult(APIResponseModel):
 class PiiEntity(APIResponseModel):
     type: str
     value: str
-    redacted: bool
+    action: str
     start_pos: Optional[int] = None
 
 
@@ -31,7 +32,7 @@ class PiiEntityResult(APIResponseModel):
 class MaliciousEntity(APIResponseModel):
     type: str
     value: str
-    redacted: Optional[bool] = None
+    action: str
     start_pos: Optional[int] = None
     raw: Optional[Dict[str, Any]] = None
 
@@ -40,6 +41,28 @@ class MaliciousEntityResult(APIResponseModel):
     entities: List[MaliciousEntity]
 
 
+class SecretsEntity(APIResponseModel):
+    type: str
+    value: str
+    action: str
+    start_pos: Optional[int] = None
+    redacted_value: Optional[str] = None
+
+
+class SecretsEntityResult(APIResponseModel):
+    entities: List[SecretsEntity]
+
+
+class LanguageDetectionResult(APIResponseModel):
+    language: str
+    action: str
+
+
+class CodeDetectionResult(APIResponseModel):
+    language: str
+    action: str
+
+
 _T = TypeVar("_T")
 
 
@@ -52,6 +75,11 @@ class TextGuardDetectors(APIResponseModel):
     prompt_injection: Optional[TextGuardDetector[PromptInjectionResult]] = None
     pii_entity: Optional[TextGuardDetector[PiiEntityResult]] = None
     malicious_entity: Optional[TextGuardDetector[MaliciousEntityResult]] = None
+    secrets_detection: Optional[TextGuardDetector[SecretsEntityResult]] = None
+    profanity_and_toxicity: Optional[TextGuardDetector[Any]] = None
+    custom_entity: Optional[TextGuardDetector[Any]] = None
+    language_detection: Optional[TextGuardDetector[LanguageDetectionResult]] = None
+    code_detection: Optional[TextGuardDetector[CodeDetectionResult]] = None
 
 
 class TextGuardResult(PangeaResponseResult, Generic[_T]):
@@ -64,6 +92,8 @@ class TextGuardResult(PangeaResponseResult, Generic[_T]):
     prompt_messages: Optional[_T] = None
     """Updated structured prompt, if applicable."""
 
+    blocked: bool
+
 
 class AIGuard(ServiceBase):
     """AI Guard service client.
@@ -196,6 +226,9 @@ class AIGuard(ServiceBase):
                 are to be applied to the text, such as defang malicious URLs.
             debug: Setting this value to true will provide a detailed analysis
                 of the text data
+
+        Examples:
+            response = ai_guard.guard_text("text")
         """
 
         return self.request.post(

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pangea/services/prompt_guard.py

@@ -19,8 +19,8 @@ class Classification(APIResponseModel):
     category: str
     """Classification category"""
 
-    label: str
-    """Classification label"""
+    detected: bool
+    """Classification detection result"""
 
     confidence: float
     """Confidence score for the classification"""
@@ -86,7 +86,12 @@ class PromptGuard(ServiceBase):
         super().__init__(token, config, logger_name, config_id)
 
     def guard(
-        self, messages: Iterable[Message], *, analyzers: Iterable[str] | None = None
+        self,
+        messages: Iterable[Message],
+        *,
+        analyzers: Iterable[str] | None = None,
+        classify: bool | None = None,
+        threshold: float | None = None,
     ) -> PangeaResponse[GuardResult]:
         """
         Guard (Beta)
@@ -98,8 +103,12 @@ class PromptGuard(ServiceBase):
         OperationId: prompt_guard_post_v1beta_guard
 
         Args:
-            messages: Prompt content and role array.
-            analyzers: Specific analyzers to be used in the call.
+            messages: Prompt content and role array in JSON format. The
+              `content` is the text that will be analyzed for redaction.
+            analyzers: Specific analyzers to be used in the call
+            classify: Boolean to enable classification of the content
+            threshold: Threshold for the confidence score to consider the prompt
+              as malicious
 
         Examples:
             from pangea.services.prompt_guard import Message
@@ -107,4 +116,8 @@ class PromptGuard(ServiceBase):
             response = prompt_guard.guard([Message(role="user", content="hello world")])
         """
 
-        return self.request.post("v1beta/guard", GuardResult, data={"messages": messages, "analyzers": analyzers})
+        return self.request.post(
+            "v1beta/guard",
+            GuardResult,
+            data={"messages": messages, "analyzers": analyzers, "classify": classify, "threshold": threshold},
+        )

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pangea/services/share/share.py

@@ -762,7 +762,7 @@ class Share(ServiceBase):
 
         Examples:
              config = PangeaConfig(domain="aws.us.pangea.cloud")
-             authz = Share(token="pangea_token", config=config)
+             share = Share(token="pangea_token", config=config)
         """
 
         super().__init__(token, config, logger_name, config_id=config_id)

{pangea_sdk-5.5.0b1 → pangea_sdk-5.5.0b3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pangea-sdk"
-version = "5.5.0beta1"
+version = "5.5.0beta3"
 description = "Pangea API SDK"
 authors = [
     {name = "Glenn Gallien", email = "glenn.gallien@pangea.cloud"}
@@ -18,11 +18,11 @@ requires-python = ">=3.9,<4.0.0"
 dependencies = [
   "aiohttp (>=3.11.11,<4.0.0)",
   "cryptography (>=43.0.3,<44.0.0)",
-  "deprecated (>=1.2.15,<2.0.0)",
-  "google-crc32c (>=1.5.0,<2.0.0)",
-  "pydantic (>=2.10.5,<3.0.0)",
-  "python-dateutil (>=2.9.0,<3.0.0)",
-  "requests (>=2.31.0,<3.0.0)",
+  "deprecated (>=1.2.18,<2.0.0)",
+  "google-crc32c (>=1.6.0,<2.0.0)",
+  "pydantic (>=2.10.6,<3.0.0)",
+  "python-dateutil (>=2.9.0.post0,<3.0.0)",
+  "requests (>=2.32.3,<3.0.0)",
   "requests-toolbelt (>=1.0.0,<2.0.0)",
   "typing-extensions (>=4.12.2,<5.0.0)"
 ]
@@ -33,9 +33,9 @@ packages = [
 ]
 
 [tool.poetry.group.dev.dependencies]
-black = "^24.10.0"
+black = "^25.1.0"
 docstring-parser = "^0.15"
-isort = "^5.13.2"
+isort = "^6.0.0"
 mypy = "1.14.1"
 types-Deprecated = "^1.2.9.3"
 types-python-dateutil = "^2.8.19.14"