pangea-sdk 6.6.0__tar.gz → 6.8.0__tar.gz

{pangea_sdk-6.6.0 → pangea_sdk-6.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pangea-sdk
-Version: 6.6.0
+Version: 6.8.0
 Summary: Pangea API SDK
 Keywords: Pangea,SDK,Audit
 Author: Glenn Gallien
@@ -8,16 +8,16 @@ Author-email: Glenn Gallien <glenn.gallien@pangea.cloud>
 License-Expression: MIT
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: aiohttp>=3.12.15,<4.0.0
-Requires-Dist: cryptography>=45.0.6,<46.0.0
+Requires-Dist: aiohttp>=3.13.0,<4.0.0
+Requires-Dist: cryptography>=46.0.2,<47.0.0
 Requires-Dist: deprecated>=1.2.18,<2.0.0
 Requires-Dist: google-crc32c>=1.7.1,<2.0.0
-Requires-Dist: pydantic>=2.11.7,<3.0.0
+Requires-Dist: pydantic>=2.12.0,<3.0.0
 Requires-Dist: python-dateutil>=2.9.0.post0,<3.0.0
 Requires-Dist: requests>=2.32.5,<3.0.0
 Requires-Dist: requests-toolbelt>=1.0.0,<2.0.0
 Requires-Dist: typing-extensions>=4.15.0,<5.0.0
-Requires-Dist: yarl>=1.20.1,<2.0.0
+Requires-Dist: yarl>=1.22.0,<2.0.0
 Requires-Python: >=3.9.2, <4.0.0
 Project-URL: repository, https://github.com/pangeacyber/pangea-python
 Description-Content-Type: text/markdown

{pangea_sdk-6.6.0 → pangea_sdk-6.8.0}/pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "6.6.0"
+__version__ = "6.8.0"
 
 from pangea.config import PangeaConfig
 from pangea.file_uploader import FileUploader

{pangea_sdk-6.6.0 → pangea_sdk-6.8.0}/pangea/asyncio/services/ai_guard.py

@@ -1,12 +1,16 @@
 from __future__ import annotations
 
-from collections.abc import Sequence
+from collections.abc import Mapping, Sequence
 from typing import overload
 
+from typing_extensions import Any, Literal
+
 from pangea.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
 from pangea.response import PangeaResponse
 from pangea.services.ai_guard import (
+    ExtraInfo,
+    GuardResult,
     LogFields,
     McpToolsMessage,
     Message,
@@ -194,3 +198,79 @@ class AIGuardAsync(ServiceBaseAsync):
             )  # type: ignore[assignment]
 
         return response
+
+    async def guard(
+        self,
+        input: Mapping[str, Any],
+        *,
+        recipe: str | None = None,
+        debug: bool | None = None,
+        overrides: Overrides | None = None,
+        app_id: str | None = None,
+        actor_id: str | None = None,
+        llm_provider: str | None = None,
+        model: str | None = None,
+        model_version: str | None = None,
+        request_token_count: int | None = None,
+        response_token_count: int | None = None,
+        source_ip: str | None = None,
+        source_location: str | None = None,
+        tenant_id: str | None = None,
+        event_type: Literal["input", "output", "tool_input", "tool_output", "tool_listing"] | None = None,
+        collector_instance_id: str | None = None,
+        extra_info: ExtraInfo | None = None,
+        count_tokens: bool | None = None,
+    ) -> PangeaResponse[GuardResult]:
+        """
+        Guard LLM input and output
+
+        Analyze and redact content to avoid manipulation of the model, addition
+        of malicious content, and other undesirable data transfers.
+
+        OperationId: ai_guard_post_v1_guard
+
+        Args:
+            input: 'messages' (required) contains Prompt content and role array
+                in JSON format. The `content` is the multimodal text or image
+                input that will be analyzed. Additional properties such as
+                'tools' may be provided for analysis.
+            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
+            app_name: Name of source application.
+            llm_provider: Underlying LLM.  Example: 'OpenAI'.
+            model: Model used to perform the event. Example: 'gpt'.
+            model_version: Model version used to perform the event. Example: '3.5'.
+            request_token_count: Number of tokens in the request.
+            response_token_count: Number of tokens in the response.
+            source_ip: IP address of user or app or agent.
+            source_location: Location of user or app or agent.
+            tenant_id: For gateway-like integrations with multi-tenant support.
+            event_type: (AIDR) Event Type.
+            collector_instance_id: (AIDR) collector instance id.
+            extra_info: (AIDR) Logging schema.
+            count_tokens: Provide input and output token count.
+        """
+        return await self.request.post(
+            "v1/guard",
+            GuardResult,
+            data={
+                "input": input,
+                "recipe": recipe,
+                "debug": debug,
+                "overrides": overrides,
+                "app_id": app_id,
+                "actor_id": actor_id,
+                "llm_provider": llm_provider,
+                "model": model,
+                "model_version": model_version,
+                "request_token_count": request_token_count,
+                "response_token_count": response_token_count,
+                "source_ip": source_ip,
+                "source_location": source_location,
+                "tenant_id": tenant_id,
+                "event_type": event_type,
+                "collector_instance_id": collector_instance_id,
+                "extra_info": extra_info,
+                "count_tokens": count_tokens,
+            },
+        )

{pangea_sdk-6.6.0 → pangea_sdk-6.8.0}/pangea/asyncio/services/prompt_guard.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+from pangea._typing import SequenceNotStr
 from pangea.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
 from pangea.services.prompt_guard import GuardResult, Message
@@ -58,7 +59,7 @@ class PromptGuardAsync(ServiceBaseAsync):
         self,
         messages: Iterable[Message],
         *,
-        analyzers: Iterable[str] | None = None,
+        analyzers: SequenceNotStr[str] | None = None,
         classify: bool | None = None,
     ) -> PangeaResponse[GuardResult]:
         """

{pangea_sdk-6.6.0 → pangea_sdk-6.8.0}/pangea/services/ai_guard.py

@@ -1,7 +1,9 @@
 from __future__ import annotations
 
-from collections.abc import Sequence
-from typing import Any, Generic, Literal, Optional, overload
+from collections.abc import Mapping, Sequence
+from typing import Annotated, Any, Generic, Literal, Optional, overload
+
+from pydantic import BaseModel, ConfigDict, Field, RootModel
 
 from pangea._typing import T
 from pangea.config import PangeaConfig
@@ -148,6 +150,13 @@ class SecretsDetectionOverride(APIRequestModel):
     pangea_token: Optional[PiiEntityAction] = None
 
 
+class ImageDetectionItems(APIRequestModel):
+    disabled: Optional[bool] = None
+    action: Optional[Literal["", "report", "block"]] = ""
+    topics: Optional[list[str]] = None
+    threshold: Annotated[Optional[float], Field(ge=0.0, le=1.0, multiple_of=0.01)] = None
+
+
 class Overrides(APIRequestModel):
     """Overrides flags."""
 
@@ -157,6 +166,7 @@ class Overrides(APIRequestModel):
     code_detection: Optional[CodeDetectionOverride] = None
     competitors: Optional[CompetitorsOverride] = None
     gibberish: Optional[GibberishOverride] = None
+    image: Optional[ImageDetectionItems] = None
     language_detection: Optional[LanguageDetectionOverride] = None
     malicious_entity: Optional[MaliciousEntityOverride] = None
     pii_entity: Optional[PiiEntityOverride] = None
@@ -280,26 +290,26 @@ class CodeDetectionResult(APIResponseModel):
     """The action taken by this Detector"""
 
 
-class TextGuardDetector(APIResponseModel, Generic[T]):
+class GuardDetector(APIResponseModel, Generic[T]):
     detected: Optional[bool] = None
     data: Optional[T] = None
 
 
 class TextGuardDetectors(APIResponseModel):
-    code_detection: Optional[TextGuardDetector[CodeDetectionResult]] = None
-    competitors: Optional[TextGuardDetector[object]] = None
-    custom_entity: Optional[TextGuardDetector[object]] = None
-    gibberish: Optional[TextGuardDetector[object]] = None
-    hardening: Optional[TextGuardDetector[object]] = None
-    language_detection: Optional[TextGuardDetector[LanguageDetectionResult]] = None
-    malicious_entity: Optional[TextGuardDetector[MaliciousEntityResult]] = None
-    pii_entity: Optional[TextGuardDetector[PiiEntityResult]] = None
-    profanity_and_toxicity: Optional[TextGuardDetector[object]] = None
-    prompt_injection: Optional[TextGuardDetector[PromptInjectionResult]] = None
-    secrets_detection: Optional[TextGuardDetector[SecretsEntityResult]] = None
-    selfharm: Optional[TextGuardDetector[object]] = None
-    sentiment: Optional[TextGuardDetector[object]] = None
-    topic: Optional[TextGuardDetector[TopicDetectionResult]] = None
+    code_detection: Optional[GuardDetector[CodeDetectionResult]] = None
+    competitors: Optional[GuardDetector[object]] = None
+    custom_entity: Optional[GuardDetector[object]] = None
+    gibberish: Optional[GuardDetector[object]] = None
+    hardening: Optional[GuardDetector[object]] = None
+    language_detection: Optional[GuardDetector[LanguageDetectionResult]] = None
+    malicious_entity: Optional[GuardDetector[MaliciousEntityResult]] = None
+    pii_entity: Optional[GuardDetector[PiiEntityResult]] = None
+    profanity_and_toxicity: Optional[GuardDetector[object]] = None
+    prompt_injection: Optional[GuardDetector[PromptInjectionResult]] = None
+    secrets_detection: Optional[GuardDetector[SecretsEntityResult]] = None
+    selfharm: Optional[GuardDetector[object]] = None
+    sentiment: Optional[GuardDetector[object]] = None
+    topic: Optional[GuardDetector[TopicDetectionResult]] = None
 
 
 class PromptMessage(APIResponseModel):
@@ -336,6 +346,121 @@ class TextGuardResult(PangeaResponseResult):
     """Whether or not the original input was transformed."""
 
 
+class Tool(RootModel[str]):
+    root: Annotated[str, Field(min_length=1)]
+    """Tool name"""
+
+
+class McpTool(APIRequestModel):
+    server_name: Annotated[str, Field(min_length=1)]
+    """MCP server name"""
+
+    tools: Annotated[list[Tool], Field(min_length=1)]
+
+
+class ExtraInfo(BaseModel):
+    """(AIDR) Logging schema."""
+
+    # Additional properties are allowed here.
+    model_config = ConfigDict(extra="allow")
+
+    app_name: Optional[str] = None
+    """Name of source application/agent."""
+
+    app_group: Optional[str] = None
+    """The group of source application/agent."""
+
+    app_version: Optional[str] = None
+    """Version of the source application/agent."""
+
+    actor_name: Optional[str] = None
+    """Name of subject actor/service account."""
+
+    actor_group: Optional[str] = None
+    """The group of subject actor."""
+
+    source_region: Optional[str] = None
+    """Geographic region or data center."""
+
+    sub_tenant: Optional[str] = None
+    """Sub tenant of the user or organization"""
+    mcp_tools: Optional[Sequence[McpTool]] = None
+
+    """Each item groups tools for a given MCP server."""
+
+
+class AccessRuleResult(APIResponseModel):
+    """
+    Details about the evaluation of a single rule, including whether it matched,
+    the action to take, the rule name, and optional debugging information.
+    """
+
+    matched: bool
+    """Whether this rule's logic evaluated to true for the input."""
+
+    action: str
+    """
+    The action resulting from the rule evaluation. One of 'allowed', 'blocked',
+    or 'reported'.
+    """
+
+    name: str
+    """A human-readable name for the rule."""
+
+    logic: Optional[dict[str, Any]] = None
+    """The JSON logic expression evaluated for this rule."""
+
+    attributes: Optional[dict[str, Any]] = None
+    """The input attribute values that were available during rule evaluation."""
+
+
+class GuardDetectors(APIResponseModel):
+    """Result of the recipe analyzing and input prompt."""
+
+    code: Optional[GuardDetector[CodeDetectionResult]] = None
+    competitors: Optional[GuardDetector[object]] = None
+    confidential_and_pii_entity: Optional[GuardDetector[PiiEntityResult]] = None
+    custom_entity: Optional[GuardDetector[object]] = None
+    language: Optional[GuardDetector[LanguageDetectionResult]] = None
+    malicious_entity: Optional[GuardDetector[MaliciousEntityResult]] = None
+    malicious_prompt: Optional[GuardDetector[PromptInjectionResult]] = None
+    prompt_hardening: Optional[GuardDetector[object]] = None
+    secret_and_key_entity: Optional[GuardDetector[SecretsEntityResult]] = None
+    topic: Optional[GuardDetector[TopicDetectionResult]] = None
+
+
+class GuardResult(PangeaResponseResult):
+    output: Optional[dict[str, Any]] = None
+    """Updated structured prompt."""
+
+    blocked: Optional[bool] = None
+    """Whether or not the prompt triggered a block detection."""
+
+    transformed: Optional[bool] = None
+    """Whether or not the original input was transformed."""
+
+    recipe: Optional[str] = None
+    """The Recipe that was used."""
+
+    detectors: GuardDetectors
+    """Result of the recipe analyzing and input prompt."""
+
+    access_rules: Optional[dict[str, AccessRuleResult]] = None
+    """Result of the recipe evaluating configured rules"""
+
+    fpe_context: Optional[str] = None
+    """
+    If an FPE redaction method returned results, this will be the context passed
+    to unredact.
+    """
+
+    input_token_count: Optional[float] = None
+    """Number of tokens counted in the input"""
+
+    output_token_count: Optional[float] = None
+    """Number of tokens counted in the output"""
+
+
 class AIGuard(ServiceBase):
     """AI Guard service client.
 
@@ -514,6 +639,82 @@ class AIGuard(ServiceBase):
 
         return response
 
+    def guard(
+        self,
+        input: Mapping[str, Any],
+        *,
+        recipe: str | None = None,
+        debug: bool | None = None,
+        overrides: Overrides | None = None,
+        app_id: str | None = None,
+        actor_id: str | None = None,
+        llm_provider: str | None = None,
+        model: str | None = None,
+        model_version: str | None = None,
+        request_token_count: int | None = None,
+        response_token_count: int | None = None,
+        source_ip: str | None = None,
+        source_location: str | None = None,
+        tenant_id: str | None = None,
+        event_type: Literal["input", "output", "tool_input", "tool_output", "tool_listing"] | None = None,
+        collector_instance_id: str | None = None,
+        extra_info: ExtraInfo | None = None,
+        count_tokens: bool | None = None,
+    ) -> PangeaResponse[GuardResult]:
+        """
+        Guard LLM input and output
+
+        Analyze and redact content to avoid manipulation of the model, addition
+        of malicious content, and other undesirable data transfers.
+
+        OperationId: ai_guard_post_v1_guard
+
+        Args:
+            input: 'messages' (required) contains Prompt content and role array
+                in JSON format. The `content` is the multimodal text or image
+                input that will be analyzed. Additional properties such as
+                'tools' may be provided for analysis.
+            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
+            app_name: Name of source application.
+            llm_provider: Underlying LLM.  Example: 'OpenAI'.
+            model: Model used to perform the event. Example: 'gpt'.
+            model_version: Model version used to perform the event. Example: '3.5'.
+            request_token_count: Number of tokens in the request.
+            response_token_count: Number of tokens in the response.
+            source_ip: IP address of user or app or agent.
+            source_location: Location of user or app or agent.
+            tenant_id: For gateway-like integrations with multi-tenant support.
+            event_type: (AIDR) Event Type.
+            collector_instance_id: (AIDR) collector instance id.
+            extra_info: (AIDR) Logging schema.
+            count_tokens: Provide input and output token count.
+        """
+        return self.request.post(
+            "v1/guard",
+            GuardResult,
+            data={
+                "input": input,
+                "recipe": recipe,
+                "debug": debug,
+                "overrides": overrides,
+                "app_id": app_id,
+                "actor_id": actor_id,
+                "llm_provider": llm_provider,
+                "model": model,
+                "model_version": model_version,
+                "request_token_count": request_token_count,
+                "response_token_count": response_token_count,
+                "source_ip": source_ip,
+                "source_location": source_location,
+                "tenant_id": tenant_id,
+                "event_type": event_type,
+                "collector_instance_id": collector_instance_id,
+                "extra_info": extra_info,
+                "count_tokens": count_tokens,
+            },
+        )
+
 
 def get_relevant_content(
     messages: Sequence[Message | McpToolsMessage],

{pangea_sdk-6.6.0 → pangea_sdk-6.8.0}/pangea/services/prompt_guard.py

@@ -1,7 +1,10 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Literal, Optional
+from typing import TYPE_CHECKING, Annotated, Literal, Optional
 
+from pydantic import Field
+
+from pangea._typing import SequenceNotStr
 from pangea.config import PangeaConfig
 from pangea.response import APIRequestModel, APIResponseModel, PangeaResponse, PangeaResponseResult
 from pangea.services.base import ServiceBase
@@ -33,19 +36,18 @@ class GuardResult(PangeaResponseResult):
     detected: bool
     """Boolean response for if the prompt was considered malicious or not"""
 
+    analyzer: Optional[str] = None
+
     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: float
+    confidence: Annotated[Optional[float], Field(ge=0.0, le=1.0)] = None
     """Percent of confidence in the detection result, ranging from 0 to 1"""
 
     info: Optional[str] = None
     """Extra information about the detection result"""
 
-    classifications: list[Classification]
+    classifications: Optional[list[Classification]] = None
     """List of classification results with labels and confidence scores"""
 
 
@@ -92,7 +94,7 @@ class PromptGuard(ServiceBase):
         self,
         messages: Iterable[Message],
         *,
-        analyzers: Iterable[str] | None = None,
+        analyzers: SequenceNotStr[str] | None = None,
         classify: bool | None = None,
     ) -> PangeaResponse[GuardResult]:
         """

{pangea_sdk-6.6.0 → pangea_sdk-6.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pangea-sdk"
-version = "6.6.0"
+version = "6.8.0"
 description = "Pangea API SDK"
 authors = [
     {name = "Glenn Gallien", email = "glenn.gallien@pangea.cloud"}
@@ -14,16 +14,16 @@ classifiers = [
 ]
 requires-python = ">=3.9.2,<4.0.0"
 dependencies = [
-  "aiohttp (>=3.12.15,<4.0.0)",
-  "cryptography (>=45.0.6,<46.0.0)",
+  "aiohttp (>=3.13.0,<4.0.0)",
+  "cryptography (>=46.0.2,<47.0.0)",
   "deprecated (>=1.2.18,<2.0.0)",
   "google-crc32c (>=1.7.1,<2.0.0)",
-  "pydantic (>=2.11.7,<3.0.0)",
+  "pydantic (>=2.12.0,<3.0.0)",
   "python-dateutil (>=2.9.0.post0,<3.0.0)",
   "requests (>=2.32.5,<3.0.0)",
   "requests-toolbelt (>=1.0.0,<2.0.0)",
   "typing-extensions (>=4.15.0,<5.0.0)",
-  "yarl (>=1.20.1,<2.0.0)"
+  "yarl (>=1.22.0,<2.0.0)"
 ]
 
 [project.urls]
@@ -32,15 +32,15 @@ repository = "https://github.com/pangeacyber/pangea-python"
 [dependency-groups]
 dev = [
   "docstring-parser ==0.17.0",
-  "pytest-asyncio ==1.1.0",
+  "pytest-asyncio ==1.2.0",
   "pytest_httpserver ==1.1.3",
   "types-Deprecated ==1.2.15.20250304",
-  "types-python-dateutil ==2.9.0.20250822",
-  "types-requests ==2.32.4.20250809",
+  "types-python-dateutil ==2.9.0.20251008",
+  "types-requests ==2.32.4.20250913",
 ]
 
 [build-system]
-requires = ["uv_build==0.8.14"]
+requires = ["uv_build==0.9.2"]
 build-backend = "uv_build"
 
 [tool.mypy]
@@ -54,7 +54,7 @@ warn_unused_ignores = true
 plugins = ['pydantic.mypy']
 
 [tool.pydantic-mypy]
-init_forbid_extra = true
+init_forbid_extra = false
 init_typed = true
 warn_required_dynamic_aliases = true