pangea-sdk 5.5.0b1__py3-none-any.whl → 5.5.0b3__py3-none-any.whl

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/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/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/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/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/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/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/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.dist-info → pangea_sdk-5.5.0b3.dist-info}/METADATA

@@ -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.dist-info → pangea_sdk-5.5.0b3.dist-info}/RECORD

@@ -1,9 +1,9 @@
-pangea/__init__.py,sha256=wdTGmwo1JC7NzREP3iXJP02Jv2SYmmPLT543aYxuQeA,251
+pangea/__init__.py,sha256=oR8inTyWgORDk9j8o76EPF3uU09SynZlOMqk3ZP36dk,251
 pangea/asyncio/__init__.py,sha256=kjEMkqMQ521LlMSu5jn3_WgweyArwVZ2C-s3x7mR6Pk,45
 pangea/asyncio/file_uploader.py,sha256=wI7epib7Rc5jtZw4eJ1L1SlmutDG6CPv59C8N2UPhtY,1436
 pangea/asyncio/request.py,sha256=lpLY-o405r3-VUfrAE5uxYxI8UjM4hjPqUzAUtOGE5o,18040
 pangea/asyncio/services/__init__.py,sha256=L6Tdhjfx_ZECHskhLMPaCcOefi-r-imw6q_zlU4j-FY,464
-pangea/asyncio/services/ai_guard.py,sha256=GNDXooxEvEkifNef9sPBaM6ymlwdogto6oLPf10gPgo,5601
+pangea/asyncio/services/ai_guard.py,sha256=7Zr4jjCmOcPOFgHesM4MYgDosqfNjF_Foj5e_EyMZ70,5677
 pangea/asyncio/services/audit.py,sha256=rPaCx4cMzj-g9WFMRIysFCJAz6Btp6YrhcKe_exky8k,26283
 pangea/asyncio/services/authn.py,sha256=rPeLJweL8mYH_t4ebcQn4n_Wglr3kClKNnCXNCimZU4,46622
 pangea/asyncio/services/authz.py,sha256=B_0_nhDMJcjNpjpCx3Vi2LDRhlmfV9325GKbUZ8reos,10025
@@ -11,13 +11,13 @@ pangea/asyncio/services/base.py,sha256=vRFVcO_uEAGJte3OUUBLD43RoiiFB1vC7SPyN6yEM
 pangea/asyncio/services/embargo.py,sha256=ctzj3kip6xos-Eu3JuOskrCGYC8T3JlsgAopZHiPSXM,3068
 pangea/asyncio/services/file_scan.py,sha256=PLG1O-PL4Yk9uY9D6NbMrZ5LHg70Z311s7bFe46UMZA,7108
 pangea/asyncio/services/intel.py,sha256=BcxGKSoZ1nJiEHyZM9yOwKSSPJUrB6ibJ19KR27VlgQ,40261
-pangea/asyncio/services/prompt_guard.py,sha256=KMScsVybwQEwipN7CaC4AX4KRqlIkC8xZ2j7m-BDL9E,2349
+pangea/asyncio/services/prompt_guard.py,sha256=rTFylG9zyMauhpzb6BsccmmMK3qRwtrsoMjemLDJ2Bs,2835
 pangea/asyncio/services/redact.py,sha256=JPJcmeKFloMZRpkjAHAZbpZJpO993WsTfEwA-S5ov18,7951
 pangea/asyncio/services/sanitize.py,sha256=EbSdq_v9yZWce9xEYWvZharE9bJcxw8cg5Pv8LVxdxc,8627
-pangea/asyncio/services/share.py,sha256=AXXtFtmbXud0dAAom7qqHVOK9zBfX5S10MFS_1DQvio,30767
+pangea/asyncio/services/share.py,sha256=Qd2Oh4UsLwu7Zo4Xy1KABHuP4TJ9AtcN-XzldvilFVo,30773
 pangea/asyncio/services/vault.py,sha256=VqrJGSEdq6MlZRI6cJpkthhIsqLClSQdgVxwYCbIwEk,77079
 pangea/audit_logger.py,sha256=gRkCfUUT5LDNaycwxkhZUySgY47jDfn1ZeKOul4XCQI,3842
-pangea/config.py,sha256=mQUu8GX_6weIuv3vjNdG5plppXskXYASmxMWtFQh-hc,1662
+pangea/config.py,sha256=qe1ZhvDxNQxNXUpAtzF6nPLjyRpPVG9sjhLZV6Pkyn8,1766
 pangea/crypto/rsa.py,sha256=mwSiNy571KAGr3F6oEM0CXWkl9D023ch8ldbZZeLj_4,4747
 pangea/deep_verify.py,sha256=ZGraaL7TCxwRBIDqjBFR0clKlhAC-Yce6kD-1LClhG8,8616
 pangea/deprecated.py,sha256=IjFYEVvY1E0ld0SMkEYC1o62MAleX3nnT1If2dFVbHo,608
@@ -28,7 +28,7 @@ pangea/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pangea/request.py,sha256=vGB8owXUiNQoeiiACFvfXvg44JJo_L6WfcHlF6ug8co,25082
 pangea/response.py,sha256=lPAcYsF9Xg166CiyhCofVmQA-W4jevh0MQXxUa8Re68,7737
 pangea/services/__init__.py,sha256=h36HzyIGaI5kO6l3UCwKHx_Kd-m_9mYVwn5MLRVzblI,408
-pangea/services/ai_guard.py,sha256=Pe-j4WrMQg5fO8T6LkygQ1qwBWbN0Ha28aEHl4uw6dY,6905
+pangea/services/ai_guard.py,sha256=jbXzcUaR7j-6ytW9QRCGn9WtlrCCcB6Ia_2J-3AY-X4,7763
 pangea/services/audit/audit.py,sha256=7-c9l7jyGtpG7SqRUMpqsAzcUDhMZ5izgPalxHXsUvM,39320
 pangea/services/audit/exceptions.py,sha256=bhVuYe4ammacOVxwg98CChxvwZf5FKgR2DcgqILOcwc,471
 pangea/services/audit/models.py,sha256=1h1B9eSYQMYG3f8WNi1UcDX2-impRrET_ErjJYUnj7M,14678
@@ -41,11 +41,11 @@ pangea/services/base.py,sha256=43pWQcR9CeT4sGzgctF3Sy4M_h7DaUzkuZD2Z7CcDUU,3845
 pangea/services/embargo.py,sha256=9Wfku4td5ORaIENKmnGmS5jxJJIRfWp6Q51L36Jsy0I,3897
 pangea/services/file_scan.py,sha256=QiO80uKqB_BnAOiYQKznXfxpa5j40qqETE3-zBRT_QE,7813
 pangea/services/intel.py,sha256=y1EX2ctYIxQc52lmHp6-Q_UIDM--t3fOpXDssWiRPfo,56474
-pangea/services/prompt_guard.py,sha256=k-b8ukyXaHruqC4S2NjFKhDLcvY5Wp8Ga0g_Ep3WFKY,3244
+pangea/services/prompt_guard.py,sha256=5KqML4IleB_4a7_PDqWLk9WGQVJ0j4vOdqgVGGkQ6z8,3724
 pangea/services/redact.py,sha256=ovIcT0jkXe57O7keGzSClWNCic8y-4NZoemXoSKjjww,12913
 pangea/services/sanitize.py,sha256=eAN1HhObiKqygy6HHcfl0NmxYfPMvqSKepwEAVVIIEE,12936
 pangea/services/share/file_format.py,sha256=1svO1ee_aenA9zoO_AaU-Rk5Ulp7kcPOc_KwNoluyQE,2797
-pangea/services/share/share.py,sha256=b1Iuuog0XWXaI6rImoj0OeEx3DXbYqLWsLbCC_Zp6eg,52343
+pangea/services/share/share.py,sha256=hlhkIr6ScJ5oMFUs9no4HtHNoUEbYU4KoLkiGLxex30,52343
 pangea/services/vault/models/asymmetric.py,sha256=vspijmEvHm5WXri_fjOWfQc4maYyZfhDkLuaTM8-PZo,4991
 pangea/services/vault/models/common.py,sha256=PSZRFqHTUtEMJJGwywEFM2AU3aV8S-sbcoo3LLQ6uTc,17981
 pangea/services/vault/models/keys.py,sha256=duAuTiOby_D7MloRvN4gNj0P-b-jx9sdtplAWFxsShw,2786
@@ -55,6 +55,6 @@ pangea/services/vault/vault.py,sha256=ow-Zm7PYzfWIfUcA4UNnpeL2DHfZM4C7inRDmNR3zQ
 pangea/tools.py,sha256=2-Y4SAHWFv6Ocj42J_bWrVy27M5G3wi7a8LJn0dabHc,6427
 pangea/utils.py,sha256=dZ6MwFVEWXUgXvvDg-k6JnvVfsgslvtaBd7ez7afrqk,4983
 pangea/verify_audit.py,sha256=nSP17OzoSPdvezRExwfcf45H8ZPZnxZu-CbEp3qFJO0,17354
-pangea_sdk-5.5.0b1.dist-info/METADATA,sha256=CHx5MOHw5eW7kRbPN0EzsggBDkqbcQApROvM-78tM1A,7011
-pangea_sdk-5.5.0b1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-pangea_sdk-5.5.0b1.dist-info/RECORD,,
+pangea_sdk-5.5.0b3.dist-info/METADATA,sha256=_fwk4xCZECycgGNKq8eWhvber6bDr2EWYt1lycQMyi4,7017
+pangea_sdk-5.5.0b3.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+pangea_sdk-5.5.0b3.dist-info/RECORD,,