pangea-sdk 5.3.0__tar.gz → 5.4.0b2__tar.gz

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pangea-sdk
-Version: 5.3.0
+Version: 5.4.0b2
 Summary: Pangea API SDK
 License: MIT
 Keywords: Pangea,SDK,Audit
@@ -63,13 +63,13 @@ the same compatibility guarantees as stable releases.
 Via pip:
 
 ```bash
-$ pip3 install pangea-sdk==5.2.0b2
+$ pip3 install pangea-sdk==5.4.0b2
 ```
 
 Via poetry:
 
 ```bash
-$ poetry add pangea-sdk==5.2.0b2
+$ poetry add pangea-sdk==5.4.0b2
 ```
 
 ## Usage

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/README.md

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

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "5.3.0"
+__version__ = "5.4.0beta2"
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/pangea/asyncio/request.py

@@ -5,11 +5,12 @@ from __future__ import annotations
 import asyncio
 import json
 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
@@ -52,20 +53,27 @@ class PangeaRequestAsync(PangeaRequestBase):
         if isinstance(data, BaseModel):
             data = data.model_dump(exclude_none=True)
 
+        if isinstance(data, dict):
+            # Remove `None` values.
+            data = {k: v for k, v in data.items() if v is not None}
+
         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_sdk-5.3.0 → pangea_sdk-5.4.0b2}/pangea/asyncio/services/__init__.py

@@ -1,9 +1,11 @@
+from .ai_guard import AIGuardAsync
 from .audit import AuditAsync
 from .authn import AuthNAsync
 from .authz import AuthZAsync
 from .embargo import EmbargoAsync
 from .file_scan import FileScanAsync
 from .intel import DomainIntelAsync, FileIntelAsync, IpIntelAsync, UrlIntelAsync, UserIntelAsync
+from .prompt_guard import PromptGuardAsync
 from .redact import RedactAsync
 from .sanitize import SanitizeAsync
 from .share import ShareAsync

pangea_sdk-5.4.0b2/pangea/asyncio/services/ai_guard.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from pangea.asyncio.services.base import ServiceBaseAsync
+from pangea.config import PangeaConfig
+from pangea.response import PangeaResponse
+from pangea.services.ai_guard import TextGuardResult
+
+
+class AIGuardAsync(ServiceBaseAsync):
+    """AI Guard service client.
+
+    Provides methods to interact with Pangea's AI Guard service.
+
+    Examples:
+        from pangea import PangeaConfig
+        from pangea.asyncio.services import AIGuardAsync
+
+        config = PangeaConfig(domain="aws.us.pangea.cloud")
+        ai_guard = AIGuardAsync(token="pangea_token", config=config)
+    """
+
+    service_name = "ai-guard"
+
+    def __init__(
+        self, token: str, config: PangeaConfig | None = None, logger_name: str = "pangea", config_id: str | None = None
+    ) -> None:
+        """
+        AI Guard service client.
+
+        Initializes a new AI Guard client.
+
+        Args:
+            token: Pangea API token.
+            config: Pangea service configuration.
+            logger_name: Logger name.
+            config_id: Configuration ID.
+
+        Examples:
+            from pangea import PangeaConfig
+            from pangea.asyncio.services import AIGuardAsync
+
+            config = PangeaConfig(domain="aws.us.pangea.cloud")
+            ai_guard = AIGuardAsync(token="pangea_token", config=config)
+        """
+
+        super().__init__(token, config, logger_name, config_id)
+
+    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: ai_guard_post_v1beta_text_guard
+
+        Args:
+            text: Text.
+            recipe: Recipe.
+            debug: Debug.
+
+        Examples:
+            response = await ai_guard.guard_text("text")
+        """
+
+        return await self.request.post(
+            "v1beta/text/guard", TextGuardResult, data={"text": text, "recipe": recipe, "debug": debug}
+        )

pangea_sdk-5.4.0b2/pangea/asyncio/services/prompt_guard.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from pangea.asyncio.services.base import ServiceBaseAsync
+from pangea.config import PangeaConfig
+from pangea.services.prompt_guard import GuardResult, Message
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+    from pangea.response import PangeaResponse
+
+
+class PromptGuardAsync(ServiceBaseAsync):
+    """Prompt Guard service client.
+
+    Provides methods to interact with Pangea's Prompt Guard service.
+
+    Examples:
+        from pangea import PangeaConfig
+        from pangea.asyncio.services import PromptGuardAsync
+
+        config = PangeaConfig(domain="aws.us.pangea.cloud")
+        prompt_guard = PromptGuardAsync(token="pangea_token", config=config)
+    """
+
+    service_name = "prompt-guard"
+
+    def __init__(
+        self, token: str, config: PangeaConfig | None = None, logger_name: str = "pangea", config_id: str | None = None
+    ) -> None:
+        """
+        Prompt Guard service client.
+
+        Initializes a new Prompt Guard client.
+
+        Args:
+            token: Pangea API token.
+            config: Pangea service configuration.
+            logger_name: Logger name.
+            config_id: Configuration ID.
+
+        Examples:
+            from pangea import PangeaConfig
+            from pangea.asyncio.services import PromptGuardAsync
+
+            config = PangeaConfig(domain="aws.us.pangea.cloud")
+            prompt_guard = PromptGuardAsync(token="pangea_token", config=config)
+        """
+
+        super().__init__(token, config, logger_name, config_id)
+
+    async def guard(
+        self, messages: Iterable[Message], *, analyzers: Iterable[str] | None = None
+    ) -> PangeaResponse[GuardResult]:
+        """
+        Guard (Beta)
+
+        Guard messages.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: prompt_guard_post_v1beta_guard
+
+        Args:
+            messages: Messages.
+            analyzers: Specific analyzers to be used in the call.
+
+        Examples:
+            from pangea.asyncio.services.prompt_guard import Message
+
+            response = await prompt_guard.guard([Message(role="user", content="hello world")])
+        """
+
+        return await self.request.post("v1beta/guard", GuardResult, data={"messages": messages, "analyzers": analyzers})

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/pangea/asyncio/services/sanitize.py

@@ -97,7 +97,7 @@ class SanitizeAsync(ServiceBaseAsync):
             performed.
 
         Examples:
-            with open("/path/to/file.pdf", "rb") as f:
+            with open("/path/to/file.txt", "rb") as f:
                 response = await sanitize.sanitize(
                     file=f,
                     transfer_method=TransferMethod.POST_URL,

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/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[import-untyped]
 from typing_extensions import TypeVar
@@ -229,9 +230,16 @@ class PangeaRequest(PangeaRequestBase):
         if isinstance(data, BaseModel):
             data = data.model_dump(exclude_none=True)
 
+        if isinstance(data, dict):
+            # Remove `None` values.
+            data = {k: v for k, v in data.items() if v is not None}
+
         if data is None:
             data = {}
 
+        # Normalize.
+        data = cast(dict[str, Any], to_jsonable_python(data))
+
         if url is None:
             url = self._url(endpoint)
 

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/pangea/services/__init__.py

@@ -1,9 +1,11 @@
+from .ai_guard import AIGuard
 from .audit.audit import Audit
 from .authn.authn import AuthN
 from .authz import AuthZ
 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_sdk-5.4.0b2/pangea/services/ai_guard.py

@@ -0,0 +1,128 @@
+from __future__ import annotations
+
+from typing import Any, Dict, Generic, List, Optional, TypeVar
+
+from pangea.config import PangeaConfig
+from pangea.response import APIResponseModel, PangeaResponse, PangeaResponseResult
+from pangea.services.base import ServiceBase
+
+
+class AnalyzerResponse(APIResponseModel):
+    analyzer: str
+    confidence: float
+
+
+class PromptInjectionResult(APIResponseModel):
+    analyzer_responses: List[AnalyzerResponse]
+    """Triggered prompt injection analyzers."""
+
+
+class PiiEntity(APIResponseModel):
+    type: str
+    value: str
+    redacted: bool
+    start_pos: Optional[int] = None
+
+
+class PiiEntityResult(APIResponseModel):
+    entities: List[PiiEntity]
+
+
+class MaliciousEntity(APIResponseModel):
+    type: str
+    value: str
+    redacted: Optional[bool] = None
+    start_pos: Optional[int] = None
+    raw: Optional[Dict[str, Any]] = None
+
+
+class MaliciousEntityResult(APIResponseModel):
+    entities: List[MaliciousEntity]
+
+
+T = TypeVar("T")
+
+
+class TextGuardDetector(APIResponseModel, Generic[T]):
+    detected: bool
+    data: Optional[T] = None
+
+
+class TextGuardDetectors(APIResponseModel):
+    prompt_injection: Optional[TextGuardDetector[PromptInjectionResult]] = None
+    pii_entity: Optional[TextGuardDetector[PiiEntityResult]] = None
+    malicious_entity: Optional[TextGuardDetector[MaliciousEntityResult]] = None
+
+
+class TextGuardResult(PangeaResponseResult):
+    detectors: TextGuardDetectors
+    prompt: str
+
+
+class AIGuard(ServiceBase):
+    """AI Guard service client.
+
+    Provides methods to interact with Pangea's AI Guard service.
+
+    Examples:
+        from pangea import PangeaConfig
+        from pangea.services import AIGuard
+
+        config = PangeaConfig(domain="aws.us.pangea.cloud")
+        ai_guard = AIGuard(token="pangea_token", config=config)
+    """
+
+    service_name = "ai-guard"
+
+    def __init__(
+        self, token: str, config: PangeaConfig | None = None, logger_name: str = "pangea", config_id: str | None = None
+    ) -> None:
+        """
+        AI Guard service client.
+
+        Initializes a new AI Guard client.
+
+        Args:
+            token: Pangea API token.
+            config: Pangea service configuration.
+            logger_name: Logger name.
+            config_id: Configuration ID.
+
+        Examples:
+            from pangea import PangeaConfig
+            from pangea.services import AIGuard
+
+            config = PangeaConfig(domain="aws.us.pangea.cloud")
+            ai_guard = AIGuard(token="pangea_token", config=config)
+        """
+
+        super().__init__(token, config, logger_name, config_id)
+
+    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: ai_guard_post_v1beta_text_guard
+
+        Args:
+            text: Text.
+            recipe: Recipe.
+            debug: Debug.
+
+        Examples:
+            response = ai_guard.guard_text("text")
+        """
+
+        return self.request.post(
+            "v1beta/text/guard", TextGuardResult, data={"text": text, "recipe": recipe, "debug": debug}
+        )

pangea_sdk-5.4.0b2/pangea/services/prompt_guard.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Literal, Optional
+
+from pangea.config import PangeaConfig
+from pangea.response import APIRequestModel, APIResponseModel, PangeaResponse, PangeaResponseResult
+from pangea.services.base import ServiceBase
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+
+class Message(APIRequestModel):
+    role: str
+    content: str
+
+
+class Classification(APIResponseModel):
+    category: str
+    """Classification category"""
+
+    label: str
+    """Classification label"""
+
+    confidence: float
+    """Confidence score for the classification"""
+
+
+class GuardResult(PangeaResponseResult):
+    detected: bool
+    """Boolean response for if the prompt was considered malicious or not"""
+
+    type: Optional[Literal["direct", "indirect"]] = None
+    """Type of analysis, either direct or indirect"""
+
+    analyzer: Optional[str] = None
+    """Prompt Analyzers for identifying and rejecting properties of prompts"""
+
+    confidence: int
+    """Percent of confidence in the detection result, ranging from 0 to 100"""
+
+    info: Optional[str] = None
+    """Extra information about the detection result"""
+
+    classifications: list[Classification]
+    """List of classification results with labels and confidence scores"""
+
+
+class PromptGuard(ServiceBase):
+    """Prompt Guard service client.
+
+    Provides methods to interact with Pangea's Prompt Guard service.
+
+    Examples:
+        from pangea import PangeaConfig
+        from pangea.services import PromptGuard
+
+        config = PangeaConfig(domain="aws.us.pangea.cloud")
+        prompt_guard = PromptGuard(token="pangea_token", config=config)
+    """
+
+    service_name = "prompt-guard"
+
+    def __init__(
+        self, token: str, config: PangeaConfig | None = None, logger_name: str = "pangea", config_id: str | None = None
+    ) -> None:
+        """
+        Prompt Guard service client.
+
+        Initializes a new Prompt Guard client.
+
+        Args:
+            token: Pangea API token.
+            config: Pangea service configuration.
+            logger_name: Logger name.
+            config_id: Configuration ID.
+
+        Examples:
+            from pangea import PangeaConfig
+            from pangea.services import PromptGuard
+
+            config = PangeaConfig(domain="aws.us.pangea.cloud")
+            prompt_guard = PromptGuard(token="pangea_token", config=config)
+        """
+
+        super().__init__(token, config, logger_name, config_id)
+
+    def guard(
+        self, messages: Iterable[Message], *, analyzers: Iterable[str] | None = None
+    ) -> PangeaResponse[GuardResult]:
+        """
+        Guard (Beta)
+
+        Guard messages.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: prompt_guard_post_v1beta_guard
+
+        Args:
+            messages: Prompt content and role array.
+            analyzers: Specific analyzers to be used in the call.
+
+        Examples:
+            from pangea.services.prompt_guard import Message
+
+            response = prompt_guard.guard([Message(role="user", content="hello world")])
+        """
+
+        return self.request.post("v1beta/guard", GuardResult, data={"messages": messages, "analyzers": analyzers})

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/pangea/services/sanitize.py

@@ -46,12 +46,6 @@ class SanitizeContent(APIRequestModel):
     analysis engine results. Only works if redact is enabled.
     """
 
-    remove_attachments: Optional[bool] = None
-    """Remove file attachments (PDF only)."""
-
-    remove_interactive: Optional[bool] = None
-    """Remove interactive content (PDF only)."""
-
 
 class SanitizeShareOutput(APIRequestModel):
     enabled: Optional[bool] = None
@@ -144,14 +138,6 @@ class RedactData(PangeaResponseResult):
     """The scoring result of a set of rules."""
 
 
-class CDR(PangeaResponseResult):
-    file_attachments_removed: Optional[int] = None
-    """Number of file attachments removed."""
-
-    interactive_contents_removed: Optional[int] = None
-    """Number of interactive content items removed."""
-
-
 class SanitizeData(PangeaResponseResult):
     defang: Optional[DefangData] = None
     """Defang."""
@@ -162,9 +148,6 @@ class SanitizeData(PangeaResponseResult):
     malicious_file: Optional[bool] = None
     """If the file scanned was malicious."""
 
-    cdr: Optional[CDR] = None
-    """Content Disarm and Reconstruction."""
-
 
 class SanitizeResult(PangeaResponseResult):
     dest_url: Optional[str] = None
@@ -265,7 +248,7 @@ class Sanitize(ServiceBase):
             performed.
 
         Examples:
-            with open("/path/to/file.pdf", "rb") as f:
+            with open("/path/to/file.txt", "rb") as f:
                 response = sanitize.sanitize(
                     file=f,
                     transfer_method=TransferMethod.POST_URL,

{pangea_sdk-5.3.0 → pangea_sdk-5.4.0b2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pangea-sdk"
-version = "5.3.0"
+version = "5.4.0beta2"
 description = "Pangea API SDK"
 authors = [
     {name = "Glenn Gallien", email = "glenn.gallien@pangea.cloud"}
@@ -71,5 +71,5 @@ show_column_numbers = true
 warn_unused_ignores = true
 
 [build-system]
-requires = ["poetry-core>=2.0.0"]
+requires = ["poetry-core>=2.0.1"]
 build-backend = "poetry.core.masonry.api"