pangea-sdk 5.4.0b2__tar.gz → 5.5.0b1__tar.gz

{pangea_sdk-5.4.0b2 → pangea_sdk-5.5.0b1}/PKG-INFO

@@ -1,23 +1,23 @@
 Metadata-Version: 2.3
 Name: pangea-sdk
-Version: 5.4.0b2
+Version: 5.5.0b1
 Summary: Pangea API SDK
 License: MIT
 Keywords: Pangea,SDK,Audit
 Author: Glenn Gallien
 Author-email: glenn.gallien@pangea.cloud
-Requires-Python: >=3.9
+Requires-Python: >=3.9,<4.0.0
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: aiohttp
-Requires-Dist: cryptography
-Requires-Dist: deprecated
-Requires-Dist: google-crc32c
-Requires-Dist: pydantic
-Requires-Dist: python-dateutil
-Requires-Dist: requests
-Requires-Dist: requests-toolbelt
-Requires-Dist: typing-extensions
+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: requests-toolbelt (>=1.0.0,<2.0.0)
+Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
 Description-Content-Type: text/markdown
 
 <a href="https://pangea.cloud?utm_source=github&utm_medium=python-sdk" target="_blank" rel="noopener noreferrer">
@@ -63,13 +63,13 @@ the same compatibility guarantees as stable releases.
 Via pip:
 
 ```bash
-$ pip3 install pangea-sdk==5.4.0b2
+$ pip3 install pangea-sdk==5.5.0b1
 ```
 
 Via poetry:
 
 ```bash
-$ poetry add pangea-sdk==5.4.0b2
+$ poetry add pangea-sdk==5.5.0b1
 ```
 
 ## Usage

{pangea_sdk-5.4.0b2 → pangea_sdk-5.5.0b1}/README.md

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

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

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

pangea_sdk-5.5.0b1/pangea/asyncio/services/ai_guard.py

@@ -0,0 +1,156 @@
+from __future__ import annotations
+
+from typing import overload
+
+from typing_extensions import TypeVar
+
+from pangea.asyncio.services.base import ServiceBaseAsync
+from pangea.config import PangeaConfig
+from pangea.response import PangeaResponse
+from pangea.services.ai_guard import TextGuardResult
+
+_T = TypeVar("_T")
+
+
+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)
+
+    @overload
+    async def guard_text(
+        self,
+        text_or_messages: str,
+        *,
+        recipe: str = "pangea_prompt_guard",
+        debug: bool = False,
+    ) -> PangeaResponse[TextGuardResult[None]]:
+        """
+        Text Guard for scanning LLM inputs and outputs (Beta)
+
+        Analyze and redact text to avoid manipulation of the model, addition of
+        malicious content, and other undesirable data transfers.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: ai_guard_post_v1beta_text_guard
+
+        Args:
+            text: Text to be scanned by AI Guard for PII, sensitive data,
+                malicious content, and other data types defined by the
+                configuration. Supports processing up to 10KB of text.
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                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")
+        """
+
+    @overload
+    async def guard_text(
+        self,
+        text_or_messages: _T,
+        *,
+        recipe: str = "pangea_prompt_guard",
+        debug: bool = False,
+    ) -> PangeaResponse[TextGuardResult[_T]]:
+        """
+        Text Guard for scanning LLM inputs and outputs (Beta)
+
+        Analyze and redact text to avoid manipulation of the model, addition of
+        malicious content, and other undesirable data transfers.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: ai_guard_post_v1beta_text_guard
+
+        Args:
+            text_or_messages: Structured data to be scanned by AI Guard for PII,
+                sensitive data, malicious content, and other data types defined
+                by the configuration. Supports processing up to 10KB of text.
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                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([
+                {"role": "user", "content": "hello world"}
+            ])
+        """
+
+    async def guard_text(
+        self,
+        text_or_messages: str | _T,
+        *,
+        recipe: str = "pangea_prompt_guard",
+        debug: bool = False,
+    ) -> PangeaResponse[TextGuardResult[_T]]:
+        """
+        Text Guard for scanning LLM inputs and outputs (Beta)
+
+        Analyze and redact text to avoid manipulation of the model, addition of
+        malicious content, and other undesirable data transfers.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: ai_guard_post_v1beta_text_guard
+
+        Args:
+            text_or_messages: Text or structured data to be scanned by AI Guard
+                for PII, sensitive data, malicious content, and other data types
+                defined by the configuration. Supports processing up to 10KB of text.
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                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
+        """
+
+        return await self.request.post(
+            "v1beta/text/guard",
+            TextGuardResult,
+            data={
+                "text" if isinstance(text_or_messages, str) else "messages": text_or_messages,
+                "recipe": recipe,
+                "debug": debug,
+            },
+        )

pangea_sdk-5.5.0b1/pangea/services/ai_guard.py

@@ -0,0 +1,209 @@
+from __future__ import annotations
+
+from typing import Any, Dict, Generic, List, Optional, TypeVar, overload
+
+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, Generic[_T]):
+    detectors: TextGuardDetectors
+    """Result of the recipe analyzing and input prompt."""
+
+    prompt_text: Optional[str] = None
+    """Updated prompt text, if applicable."""
+
+    prompt_messages: Optional[_T] = None
+    """Updated structured prompt, if applicable."""
+
+
+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)
+
+    @overload
+    def guard_text(
+        self,
+        text_or_messages: str,
+        *,
+        recipe: str = "pangea_prompt_guard",
+        debug: bool = False,
+    ) -> PangeaResponse[TextGuardResult[None]]:
+        """
+        Text Guard for scanning LLM inputs and outputs (Beta)
+
+        Analyze and redact text to avoid manipulation of the model, addition of
+        malicious content, and other undesirable data transfers.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: ai_guard_post_v1beta_text_guard
+
+        Args:
+            text: Text to be scanned by AI Guard for PII, sensitive data,
+                malicious content, and other data types defined by the
+                configuration. Supports processing up to 10KB of text.
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                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")
+        """
+
+    @overload
+    def guard_text(
+        self,
+        text_or_messages: _T,
+        *,
+        recipe: str = "pangea_prompt_guard",
+        debug: bool = False,
+    ) -> PangeaResponse[TextGuardResult[_T]]:
+        """
+        Text Guard for scanning LLM inputs and outputs (Beta)
+
+        Analyze and redact text to avoid manipulation of the model, addition of
+        malicious content, and other undesirable data transfers.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: ai_guard_post_v1beta_text_guard
+
+        Args:
+            text_or_messages: Structured data to be scanned by AI Guard for PII,
+                sensitive data, malicious content, and other data types defined
+                by the configuration. Supports processing up to 10KB of text.
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                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([
+                {"role": "user", "content": "hello world"}
+            ])
+        """
+
+    def guard_text(
+        self,
+        text_or_messages: str | _T,
+        *,
+        recipe: str = "pangea_prompt_guard",
+        debug: bool = False,
+    ) -> PangeaResponse[TextGuardResult[_T]]:
+        """
+        Text Guard for scanning LLM inputs and outputs (Beta)
+
+        Analyze and redact text to avoid manipulation of the model, addition of
+        malicious content, and other undesirable data transfers.
+
+        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+
+        OperationId: ai_guard_post_v1beta_text_guard
+
+        Args:
+            text_or_messages: Text or structured data to be scanned by AI Guard
+                for PII, sensitive data, malicious content, and other data types
+                defined by the configuration. Supports processing up to 10KB of text.
+            recipe: Recipe key of a configuration of data types and settings
+                defined in the Pangea User Console. It specifies the rules that
+                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
+        """
+
+        return self.request.post(
+            "v1beta/text/guard",
+            TextGuardResult,
+            data={
+                "text" if isinstance(text_or_messages, str) else "messages": text_or_messages,
+                "recipe": recipe,
+                "debug": debug,
+            },
+        )

{pangea_sdk-5.4.0b2 → pangea_sdk-5.5.0b1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pangea-sdk"
-version = "5.4.0beta2"
+version = "5.5.0beta1"
 description = "Pangea API SDK"
 authors = [
     {name = "Glenn Gallien", email = "glenn.gallien@pangea.cloud"}
@@ -14,17 +14,17 @@ classifiers = [
     "Topic :: Software Development",
     "Topic :: Software Development :: Libraries",
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.9,<4.0.0"
 dependencies = [
-  "aiohttp",
-  "cryptography",
-  "deprecated",
-  "google-crc32c",
-  "pydantic",
-  "python-dateutil",
-  "requests-toolbelt",
-  "requests",
-  "typing-extensions"
+  "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)",
+  "requests-toolbelt (>=1.0.0,<2.0.0)",
+  "typing-extensions (>=4.12.2,<5.0.0)"
 ]
 
 [tool.poetry]
@@ -32,18 +32,6 @@ packages = [
     { include = "pangea" }
 ]
 
-[tool.poetry.dependencies]
-python = "^3.9.0"
-aiohttp = "^3.11.11"
-cryptography = "^43.0.3"
-deprecated = "^1.2.15"
-google-crc32c = "^1.5.0"
-pydantic = "^2.10.5"
-python-dateutil = "^2.9.0"
-requests = "^2.31.0"
-requests-toolbelt = "^1.0.0"
-typing-extensions = "^4.12.2"
-
 [tool.poetry.group.dev.dependencies]
 black = "^24.10.0"
 docstring-parser = "^0.15"

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

@@ -1,75 +0,0 @@
-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/services/ai_guard.py

@@ -1,128 +0,0 @@
-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}
-        )