pangea-sdk 5.1.0__py3-none-any.whl → 5.2.0b1__py3-none-any.whl

pangea/__init__.py

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

pangea/asyncio/request.py

@@ -4,13 +4,13 @@ from __future__ import annotations
 
 import asyncio
 import json
-import os
 import time
-from typing import Any, Dict, List, Optional, Sequence, Tuple, Type, Union
+from typing import Dict, List, Optional, Sequence, Tuple, Type, Union, cast
 
 import aiohttp
 from aiohttp import FormData
 from pydantic import BaseModel
+from pydantic_core import to_jsonable_python
 from typing_extensions import Any, TypeVar
 
 import pangea.exceptions as pe
@@ -56,17 +56,20 @@ class PangeaRequestAsync(PangeaRequestBase):
         if data is None:
             data = {}
 
+        # Normalize.
+        data = cast(dict[str, Any], to_jsonable_python(data))
+
         if url is None:
             url = self._url(endpoint)
 
         # Set config ID if available
-        if self.config_id and data.get("config_id", None) is None:  # type: ignore[union-attr]
-            data["config_id"] = self.config_id  # type: ignore[index]
+        if self.config_id and data.get("config_id", None) is None:
+            data["config_id"] = self.config_id
 
         self.logger.debug(
             json.dumps({"service": self.service, "action": "post", "url": url, "data": data}, default=default_encoder)
         )
-        transfer_method = data.get("transfer_method", None)  # type: ignore[union-attr]
+        transfer_method = data.get("transfer_method", None)
 
         if files and type(data) is dict and (transfer_method == TransferMethod.POST_URL.value):
             requests_response = await self._full_post_presigned_url(

pangea/asyncio/services/data_guard.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from pangea.asyncio.services.base import ServiceBaseAsync
+from pangea.response import PangeaResponse, PangeaResponseResult
+from pangea.services.data_guard import TextGuardResult
+
+
+class DataGuard(ServiceBaseAsync):
+    """Data Guard service client.
+
+    Provides methods to interact with Pangea's Data Guard service.
+    """
+
+    service_name = "data-guard"
+
+    async def guard_text(
+        self,
+        text: str,
+        *,
+        recipe: str = "pangea_prompt_guard",
+        debug: bool = False,
+    ) -> PangeaResponse[TextGuardResult]:
+        """
+        Text guard (Beta)
+
+        Guard text.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: data_guard_post_v1_text_guard
+
+        Args:
+            text: Text.
+            recipe: Recipe.
+            debug: Debug.
+
+        Examples:
+            response = await data_guard.guard_text("text")
+        """
+
+        return await self.request.post(
+            "v1/text/guard", TextGuardResult, data={"text": text, "recipe": recipe, "debug": debug}
+        )
+
+    async def guard_file(
+        self,
+        file_url: str,
+    ) -> PangeaResponse[PangeaResponseResult]:
+        """
+        File guard (Beta)
+
+        Guard a file URL.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: data_guard_post_v1_file_guard
+
+        Args:
+            file_url: File URL.
+
+        Examples:
+            response = await data_guard.guard_file("https://example.org/file.txt")
+        """
+
+        return await self.request.post("v1/file/guard", PangeaResponseResult, data={"file_url": file_url})

pangea/asyncio/services/prompt_guard.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pangea.asyncio.services.base import ServiceBaseAsync
+from pangea.services.prompt_guard import GuardResult, Message
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+    from pangea.response import PangeaResponse
+
+
+class PromptGuard(ServiceBaseAsync):
+    """Prompt Guard service client.
+
+    Provides methods to interact with Pangea's Prompt Guard service.
+    """
+
+    service_name = "prompt-guard"
+
+    async def guard(self, messages: Iterable[Message]) -> PangeaResponse[GuardResult]:
+        """
+        Guard (Beta)
+
+        Guard messages.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: prompt_guard_post_v1_guard
+
+        Args:
+            messages: Messages..
+
+        Examples:
+            response = await prompt_guard.guard([Message(role="user", content="hello world")])
+        """
+
+        return await self.request.post("v1/guard", GuardResult, data={"messages": messages})

pangea/request.py

@@ -6,10 +6,11 @@ import copy
 import json
 import logging
 import time
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Sequence, Tuple, Type, Union
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Sequence, Tuple, Type, Union, cast
 
 import requests
 from pydantic import BaseModel
+from pydantic_core import to_jsonable_python
 from requests.adapters import HTTPAdapter, Retry
 from requests_toolbelt import MultipartDecoder  # type: ignore
 from typing_extensions import TypeVar
@@ -232,6 +233,9 @@ class PangeaRequest(PangeaRequestBase):
         if data is None:
             data = {}
 
+        # Normalize.
+        data = cast(dict[str, Any], to_jsonable_python(data))
+
         if url is None:
             url = self._url(endpoint)
 

pangea/services/__init__.py

@@ -1,9 +1,11 @@
 from .audit.audit import Audit
 from .authn.authn import AuthN
 from .authz import AuthZ
+from .data_guard import DataGuard
 from .embargo import Embargo
 from .file_scan import FileScan
 from .intel import DomainIntel, FileIntel, IpIntel, UrlIntel, UserIntel
+from .prompt_guard import PromptGuard
 from .redact import Redact
 from .sanitize import Sanitize
 from .share.share import Share

pangea/services/data_guard.py

@@ -0,0 +1,147 @@
+from __future__ import annotations
+
+from typing import List, Optional
+
+from typing_extensions import Literal
+
+from pangea.response import PangeaResponse, PangeaResponseResult
+from pangea.services.base import ServiceBase
+from pangea.services.intel import UserBreachedData
+
+
+class TextGuardSecurityIssues(PangeaResponseResult):
+    compromised_email_addresses: int
+    malicious_domain_count: int
+    malicious_ip_count: int
+    malicious_url_count: int
+    redacted_item_count: int
+
+
+class TextGuardFindings(PangeaResponseResult):
+    artifact_count: int
+    malicious_count: int
+    security_issues: TextGuardSecurityIssues
+
+
+class RedactRecognizerResult(PangeaResponseResult):
+    field_type: str
+    """The entity name."""
+
+    score: float
+    """The certainty score that the entity matches this specific snippet."""
+
+    text: str
+    """The text snippet that matched."""
+
+    start: int
+    """The starting index of a snippet."""
+
+    end: int
+    """The ending index of a snippet."""
+
+    redacted: bool
+    """Indicates if this rule was used to anonymize a text snippet."""
+
+
+class RedactReport(PangeaResponseResult):
+    count: int
+    recognizer_results: List[RedactRecognizerResult]
+
+
+class IntelResults(PangeaResponseResult):
+    category: List[str]
+    """
+    The categories that apply to this indicator as determined by the provider.
+    """
+
+    score: int
+    """The score, given by the Pangea service, for the indicator."""
+
+    verdict: Literal["malicious", "suspicious", "unknown", "benign"]
+
+
+class TextGuardReport(PangeaResponseResult):
+    domain_intel: Optional[IntelResults] = None
+    ip_intel: Optional[IntelResults] = None
+    redact: RedactReport
+    url_intel: Optional[IntelResults] = None
+    user_intel: Optional[UserBreachedData] = None
+
+
+class TextGuardArtifact(PangeaResponseResult):
+    defanged: bool
+    end: int
+    start: int
+    type: str
+    value: str
+    verdict: Optional[str] = None
+    """The verdict, given by the Pangea service, for the indicator."""
+
+
+class TextGuardResult(PangeaResponseResult):
+    artifacts: Optional[List[TextGuardArtifact]] = None
+    findings: TextGuardFindings
+    redacted_prompt: str
+
+    # `debug=True` only.
+    report: Optional[TextGuardReport] = None
+
+
+class DataGuard(ServiceBase):
+    """Data Guard service client.
+
+    Provides methods to interact with Pangea's Data Guard service.
+    """
+
+    service_name = "data-guard"
+
+    def guard_text(
+        self,
+        text: str,
+        *,
+        recipe: str = "pangea_prompt_guard",
+        debug: bool = False,
+    ) -> PangeaResponse[TextGuardResult]:
+        """
+        Text guard (Beta)
+
+        Guard text.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: data_guard_post_v1_text_guard
+
+        Args:
+            text: Text.
+            recipe: Recipe.
+            debug: Debug.
+
+        Examples:
+            response = data_guard.guard_text("text")
+        """
+
+        return self.request.post(
+            "v1/text/guard", TextGuardResult, data={"text": text, "recipe": recipe, "debug": debug}
+        )
+
+    def guard_file(
+        self,
+        file_url: str,
+    ) -> PangeaResponse[PangeaResponseResult]:
+        """
+        File guard (Beta)
+
+        Guard a file URL.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: data_guard_post_v1_file_guard
+
+        Args:
+            file_url: File URL.
+
+        Examples:
+            response = data_guard.guard_file("https://example.org/file.txt")
+        """
+
+        return self.request.post("v1/file/guard", PangeaResponseResult, data={"file_url": file_url})

pangea/services/prompt_guard.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Optional
+
+from pangea.response import APIRequestModel, PangeaResponse, PangeaResponseResult
+from pangea.services.base import ServiceBase
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+
+class Message(APIRequestModel):
+    role: str
+    content: str
+
+
+class GuardResult(PangeaResponseResult):
+    prompt_injection_detected: bool
+    prompt_injection_type: Optional[str] = None
+    prompt_injection_detector: Optional[str] = None
+
+
+class PromptGuard(ServiceBase):
+    """Prompt Guard service client.
+
+    Provides methods to interact with Pangea's Prompt Guard service.
+    """
+
+    service_name = "prompt-guard"
+
+    def guard(self, messages: Iterable[Message]) -> PangeaResponse[GuardResult]:
+        """
+        Guard (Beta)
+
+        Guard messages.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: prompt_guard_post_v1_guard
+
+        Args:
+            messages: Messages.
+
+        Examples:
+            response = prompt_guard.guard([Message(role="user", content="hello world")])
+        """
+
+        return self.request.post("v1/guard", GuardResult, data={"messages": messages})

{pangea_sdk-5.1.0.dist-info → pangea_sdk-5.2.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pangea-sdk
-Version: 5.1.0
+Version: 5.2.0b1
 Summary: Pangea API SDK
 Home-page: https://pangea.cloud/docs/sdk/python/
 License: MIT
@@ -71,13 +71,13 @@ compatibility guarantees as stable releases. [Beta changelog](https://github.com
 Via pip:
 
 ```bash
-$ pip3 install pangea-sdk==3.8.0b2
+$ pip3 install pangea-sdk==5.2.0b1
 ```
 
 Via poetry:
 
 ```bash
-$ poetry add pangea-sdk==3.8.0b2
+$ poetry add pangea-sdk==5.2.0b1
 ```
 
 ## Usage

{pangea_sdk-5.1.0.dist-info → pangea_sdk-5.2.0b1.dist-info}/RECORD

@@ -1,15 +1,17 @@
-pangea/__init__.py,sha256=ie7DdC7-YE5szWaPCHAlk2umsSOUBPoE_0HSaSazcqE,246
+pangea/__init__.py,sha256=DOhpkGYAdPZn1XFB2SFVZRtUkHB0rrqx21nRI5UVs08,251
 pangea/asyncio/__init__.py,sha256=kjEMkqMQ521LlMSu5jn3_WgweyArwVZ2C-s3x7mR6Pk,45
 pangea/asyncio/file_uploader.py,sha256=wI7epib7Rc5jtZw4eJ1L1SlmutDG6CPv59C8N2UPhtY,1436
-pangea/asyncio/request.py,sha256=b9GNZl-gOk-NhJtOU0Ds7RCF88c_mHpNo0H-3H-hK9I,17478
+pangea/asyncio/request.py,sha256=Pwk3dAzO_A7I1NyrIqK5V80xvtAL80KiNSjbrXjzQzA,17519
 pangea/asyncio/services/__init__.py,sha256=3IkiTqY_RtFndI7aoDTrb1yLv8xos_cKhmGS1TULcmw,386
 pangea/asyncio/services/audit.py,sha256=bZ7gdkVWkzqLqUVc1Wnf3oDAaCLg97-zTWhY8UdX0_Y,26549
 pangea/asyncio/services/authn.py,sha256=rPeLJweL8mYH_t4ebcQn4n_Wglr3kClKNnCXNCimZU4,46622
 pangea/asyncio/services/authz.py,sha256=HgW9R8DeW19wS7fpgq0NWOx41wZWcn6NYS4NMbi8p1A,9482
 pangea/asyncio/services/base.py,sha256=4FtKtlq74NmE9myrgIt9HMA6JDnP4mPZ6krafWr286o,2663
+pangea/asyncio/services/data_guard.py,sha256=f6VzZCcfAHpttCjqt5SExtbsrH1HkIRFmZ2c3nRlcwU,1713
 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=cCm3VwWxUzEUCNhuPCeejJvr4uOeLXuYDbDwTzNG6Aw,38121
+pangea/asyncio/services/prompt_guard.py,sha256=oKnJM-ykWmFdbcdYzDPmjgY4P09a3fyzYuCDc2p0G5M,1044
 pangea/asyncio/services/redact.py,sha256=jRNtXr_DZ_cY7guhut-eZmOEhy2uN_VCXrjGH6bkh74,7265
 pangea/asyncio/services/sanitize.py,sha256=bf98J-s-P51oSKqNBgR0wj5mlHOCBwpjWz7k0NdXCKQ,7899
 pangea/asyncio/services/share.py,sha256=UYJeUKA3NLSFA8R0X7B6yBi2U1g4q04O4ftrp9SMCzA,26097
@@ -23,9 +25,9 @@ pangea/dump_audit.py,sha256=1Je8D2fXwU4PWcZ-ZD4icfO3DNFvWqJkwsac4qFEhOo,7025
 pangea/exceptions.py,sha256=OBtzUECpNa6vNp8ySkHC-tm4QjFRCOAHBkMHqzAlOu8,5656
 pangea/file_uploader.py,sha256=4RQ44xt-faApC61nn2PlwHT7XYrJ4GeQA8Ug4tySEAg,1227
 pangea/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pangea/request.py,sha256=-XC1azZtymldOAQLbrSRzNX-h0B_lK-bQcinXyK0QKs,24410
+pangea/request.py,sha256=ZRH4NCnbzjpzkcNnOomelK5uB49T_20PfHP_j4Swgmw,24545
 pangea/response.py,sha256=lPAcYsF9Xg166CiyhCofVmQA-W4jevh0MQXxUa8Re68,7737
-pangea/services/__init__.py,sha256=-QsZxRzRq_V1x1lmS_mu4310MNm0DkM4r6g6rfVGnOc,340
+pangea/services/__init__.py,sha256=LmW8wdR3Vyi2_-rI9xqc9eHeQIjbfaO4e_Z3FMjNEFc,412
 pangea/services/audit/audit.py,sha256=IFv7jANA8S2SypQVS47x94_Cr5Z9zSsL9Dp9eXw9RHk,39593
 pangea/services/audit/exceptions.py,sha256=bhVuYe4ammacOVxwg98CChxvwZf5FKgR2DcgqILOcwc,471
 pangea/services/audit/models.py,sha256=1h1B9eSYQMYG3f8WNi1UcDX2-impRrET_ErjJYUnj7M,14678
@@ -35,9 +37,11 @@ pangea/services/authn/authn.py,sha256=cZKl2Ixc6HwHnkRecpSaAGTQUgaZUtxfLa0T3S03HM
 pangea/services/authn/models.py,sha256=HH5su6jx3O9AwVGzASXZ99-eIWjgXEP5LhIVdewM13s,22394
 pangea/services/authz.py,sha256=HfDnovAokzAHvnjYdOCwceM-1sCmzODnjNEbQBUSfo8,12222
 pangea/services/base.py,sha256=lwhHoe5Juy28Ir3Mfj2lHdM58gxZRaxa2SRFi4_DBRw,3453
+pangea/services/data_guard.py,sha256=CzJ4Q-aakmWm8NhaWNWkT0QA6zFlyY49j2yerGOPUmc,3689
 pangea/services/embargo.py,sha256=9Wfku4td5ORaIENKmnGmS5jxJJIRfWp6Q51L36Jsy0I,3897
 pangea/services/file_scan.py,sha256=QiO80uKqB_BnAOiYQKznXfxpa5j40qqETE3-zBRT_QE,7813
 pangea/services/intel.py,sha256=CziBhC5K6O_kBXpD8zgJLpDtLHzBRgATGW4gHHFJT48,52039
+pangea/services/prompt_guard.py,sha256=i0wlUjOMhdAuJytXp72OXcSzQwaWcXUiJxon7xVOJqg,1233
 pangea/services/redact.py,sha256=ZYXkzEoriLJyCqaj5dqmgsC56mIz4T3pPToZ7TcNfhg,11465
 pangea/services/sanitize.py,sha256=XP5D4CcbCZfzgU567X6H5eFBWwZuYSsHdvsdrQAZekY,12767
 pangea/services/share/file_format.py,sha256=1svO1ee_aenA9zoO_AaU-Rk5Ulp7kcPOc_KwNoluyQE,2797
@@ -51,6 +55,6 @@ pangea/services/vault/vault.py,sha256=ow-Zm7PYzfWIfUcA4UNnpeL2DHfZM4C7inRDmNR3zQ
 pangea/tools.py,sha256=2-Y4SAHWFv6Ocj42J_bWrVy27M5G3wi7a8LJn0dabHc,6427
 pangea/utils.py,sha256=KNkWK8o9j4iRDLUfAiobL-Hy5fcAxjl0DOFWXAqLK3E,5032
 pangea/verify_audit.py,sha256=nSP17OzoSPdvezRExwfcf45H8ZPZnxZu-CbEp3qFJO0,17354
-pangea_sdk-5.1.0.dist-info/METADATA,sha256=5vdMrWyqNEhM-sU0GbglC7Y8VfLkTVDe5_Z32-TNT8E,7495
-pangea_sdk-5.1.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-pangea_sdk-5.1.0.dist-info/RECORD,,
+pangea_sdk-5.2.0b1.dist-info/METADATA,sha256=WZN1H9C4M0BcIs3Tk9Mm950jBEv3pX_2YKH8l9F4Quk,7497
+pangea_sdk-5.2.0b1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+pangea_sdk-5.2.0b1.dist-info/RECORD,,