pangea-sdk 5.5.0b4__py3-none-any.whl → 6.0.0__py3-none-any.whl

pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "5.5.0beta4"
+__version__ = "6.0.0"
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig

pangea/asyncio/services/ai_guard.py

@@ -7,7 +7,7 @@ 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 LogFields, TextGuardResult
+from pangea.services.ai_guard import LogFields, Overrides, TextGuardResult
 
 _T = TypeVar("_T")
 
@@ -58,7 +58,7 @@ class AIGuardAsync(ServiceBaseAsync):
         *,
         recipe: str | None = None,
         debug: bool | None = None,
-        llm_info: str | None = None,
+        overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
     ) -> PangeaResponse[TextGuardResult[None]]:
         """
@@ -78,7 +78,6 @@ 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
-            llm_info: Short string hint for the LLM Provider information
             log_field: Additional fields to include in activity log
 
         Examples:
@@ -92,7 +91,7 @@ class AIGuardAsync(ServiceBaseAsync):
         messages: _T,
         recipe: str | None = None,
         debug: bool | None = None,
-        llm_info: str | None = None,
+        overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
     ) -> PangeaResponse[TextGuardResult[_T]]:
         """
@@ -113,59 +112,20 @@ 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
-            llm_info: Short string hint for the LLM Provider information
             log_field: Additional fields to include in activity log
 
         Examples:
             response = await ai_guard.guard_text(messages=[{"role": "user", "content": "hello world"}])
         """
 
-    @overload
-    async def guard_text(
-        self,
-        *,
-        llm_input: _T,
-        recipe: str | None = None,
-        debug: bool | None = None,
-        llm_info: str | None = None,
-        log_fields: LogFields | None = None,
-    ) -> PangeaResponse[TextGuardResult[_T]]:
-        """
-        Text Guard for scanning LLM inputs and outputs
-
-        Analyze and redact text to avoid manipulation of the model, addition of
-        malicious content, and other undesirable data transfers.
-
-        OperationId: ai_guard_post_v1_text_guard
-
-        Args:
-            llm_input: Structured full llm payload 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 JSON 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
-            llm_info: Short string hint for the LLM Provider information
-            log_field: Additional fields to include in activity log
-
-        Examples:
-            response = await ai_guard.guard_text(
-                llm_input={"model": "gpt-4o", "messages": [{"role": "user", "content": "hello world"}]}
-            )
-        """
-
     async def guard_text(  # type: ignore[misc]
         self,
         text: str | None = None,
         *,
         messages: _T | None = None,
-        llm_input: _T | None = None,
         recipe: str | None = None,
         debug: bool | None = None,
-        llm_info: str | None = None,
+        overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
     ) -> PangeaResponse[TextGuardResult[None]]:
         """
@@ -184,27 +144,19 @@ class AIGuardAsync(ServiceBaseAsync):
                 PII, sensitive data, malicious content, and other data types
                 defined by the configuration. Supports processing up to 10KB of
                 JSON text
-            llm_input: Structured full llm payload 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 JSON 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
-            llm_info: Short string hint for the LLM Provider information
             log_field: Additional fields to include in activity log
 
         Examples:
             response = await ai_guard.guard_text("text")
         """
 
-        if not any((text, messages, llm_input)):
-            raise ValueError("Exactly one of `text`, `messages`, or `llm_input` must be given")
-
-        if sum((text is not None, messages is not None, llm_input is not None)) > 1:
-            raise ValueError("Only one of `text`, `messages`, or `llm_input` can be given at once")
+        if text is not None and messages is not None:
+            raise ValueError("Exactly one of `text` or `messages` must be given")
 
         return await self.request.post(
             "v1/text/guard",
@@ -212,10 +164,9 @@ class AIGuardAsync(ServiceBaseAsync):
             data={
                 "text": text,
                 "messages": messages,
-                "llm_input": llm_input,
                 "recipe": recipe,
                 "debug": debug,
-                "llm_info": llm_info,
+                "overrides": overrides,
                 "log_fields": log_fields,
             },
         )

pangea/asyncio/services/audit.py

@@ -86,11 +86,6 @@ class AuditAsync(ServiceBaseAsync, AuditBase):
              config = PangeaConfig(domain="pangea_domain")
              audit = AuditAsync(token="pangea_token", config=config)
         """
-
-        # FIXME: Temporary check to deprecate config_id from PangeaConfig.
-        # Delete it when deprecate PangeaConfig.config_id
-        if config_id and config is not None and config.config_id is not None:
-            config_id = config.config_id
         ServiceBaseAsync.__init__(self, token, config=config, logger_name=logger_name, config_id=config_id)
         AuditBase.__init__(
             self, private_key_file=private_key_file, public_key_info=public_key_info, tenant_id=tenant_id

pangea/config.py

@@ -1,39 +1,30 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from __future__ import annotations
 
-from dataclasses import dataclass
-from typing import Literal, Optional
+from typing import Any, Optional
 
+from pydantic import BaseModel, model_validator
 
-@dataclass
-class PangeaConfig:
-    """Holds run time configuration information used by SDK components."""
-
-    domain: str = "aws.us.pangea.cloud"
-    """
-    Used to set Pangea domain (and port if needed), it should not include service subdomain
-    just for particular use cases when environment = "local", domain could be set to an url including:
-    scheme (http:// or https://), subdomain, domain and port.
-    """
-
-    environment: Literal["production", "local"] = "production"
-    """
-    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.
-    """
+class PangeaConfig(BaseModel):
+    """Holds run time configuration information used by SDK components."""
 
-    config_id: Optional[str] = None
+    base_url_template: str = "https://{SERVICE_NAME}.aws.us.pangea.cloud"
     """
-    Only used for services that support multiconfig (e.g.: Audit service)
-
-    @deprecated("config_id will be deprecated from PangeaConfig. Set it on service initialization instead")
+    Template for constructing the base URL for API requests. The placeholder
+    `{SERVICE_NAME}` will be replaced with the service name slug. This is a
+    more powerful version of `domain` that allows for setting more than just
+    the host of the API server. Defaults to
+    `https://{SERVICE_NAME}.aws.us.pangea.cloud`.
     """
 
-    insecure: bool = False
+    domain: str = "aws.us.pangea.cloud"
     """
-    Set to true to use plain http
+    Base domain for API requests. This is a weaker version of `base_url_template`
+    that only allows for setting the host of the API server. Use
+    `base_url_template` for more control over the URL, such as setting
+    service-specific paths. Defaults to `aws.us.pangea.cloud`.
     """
 
     request_retries: int = 3
@@ -65,3 +56,10 @@ class PangeaConfig:
     """
     Extra user agent to be added to request user agent
     """
+
+    @model_validator(mode="before")
+    @classmethod
+    def _domain_backwards_compat(cls, data: Any) -> Any:
+        if isinstance(data, dict) and "base_url_template" not in data and "domain" in data:
+            return {**data, "base_url_template": f"https://{{SERVICE_NAME}}.{data['domain']}"}
+        return data

pangea/request.py

@@ -14,6 +14,7 @@ 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
+from yarl import URL
 
 import pangea
 import pangea.exceptions as pe
@@ -107,16 +108,8 @@ class PangeaRequestBase:
         return f"request/{request_id}"
 
     def _url(self, path: str) -> str:
-        if self.config.domain.startswith("http://") or self.config.domain.startswith("https://"):
-            # it's URL
-            url = f"{self.config.domain}/{path}"
-        else:
-            schema = "http://" if self.config.insecure else "https://"
-            domain = (
-                self.config.domain if self.config.environment == "local" else f"{self.service}.{self.config.domain}"
-            )
-            url = f"{schema}{domain}/{path}"
-        return url
+        url = URL(self.config.base_url_template.format(SERVICE_NAME=self.service))
+        return str(url / path)
 
     def _headers(self) -> dict:
         headers = {
@@ -124,7 +117,7 @@ class PangeaRequestBase:
             "Authorization": f"Bearer {self.token}",
         }
 
-        # We want to ignore previous headers if user tryed to set them, so we will overwrite them.
+        # We want to ignore previous headers if user tried to set them, so we will overwrite them.
         self._extra_headers.update(headers)
         return self._extra_headers
 
@@ -628,9 +621,7 @@ class PangeaRequest(PangeaRequestBase):
         adapter = HTTPAdapter(max_retries=retry_config)
         session = requests.Session()
 
-        if self.config.insecure:
-            session.mount("http://", adapter)
-        else:
-            session.mount("https://", adapter)
+        session.mount("http://", adapter)
+        session.mount("https://", adapter)
 
         return session

pangea/services/ai_guard.py

@@ -1,11 +1,155 @@
 from __future__ import annotations
 
-from typing import Any, Dict, Generic, List, Optional, TypeVar, overload
+from typing import Any, Dict, Generic, List, Literal, Optional, TypeVar, overload
 
 from pangea.config import PangeaConfig
 from pangea.response import APIRequestModel, APIResponseModel, PangeaResponse, PangeaResponseResult
 from pangea.services.base import ServiceBase
 
+# This is named "prompt injection" in the API spec even though it is also used
+# for many other detectors.
+PromptInjectionAction = Literal["report", "block"]
+
+MaliciousEntityAction = Literal["report", "defang", "disabled", "block"]
+
+# This is named "PII entity" in the API spec even though it is also used for the
+# secrets detector.
+PiiEntityAction = Literal["disabled", "report", "block", "mask", "partial_masking", "replacement", "hash", "fpe"]
+
+
+class CodeDetectionOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    action: Optional[Literal["report", "block"]] = None
+
+
+class LanguageDetectionOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    allow: Optional[List[str]] = None
+    block: Optional[List[str]] = None
+    report: Optional[List[str]] = None
+
+
+class TopicDetectionOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    block: Optional[List[str]] = None
+
+
+class PromptInjectionOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    action: Optional[PromptInjectionAction] = None
+
+
+class SelfHarmOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    action: Optional[PromptInjectionAction] = None
+    threshold: Optional[float] = None
+
+
+class GibberishOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    action: Optional[PromptInjectionAction] = None
+
+
+class RoleplayOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    action: Optional[PromptInjectionAction] = None
+
+
+class SentimentOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    action: Optional[PromptInjectionAction] = None
+    threshold: Optional[float] = None
+
+
+class MaliciousEntityOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    ip_address: Optional[MaliciousEntityAction] = None
+    url: Optional[MaliciousEntityAction] = None
+    domain: Optional[MaliciousEntityAction] = None
+
+
+class CompetitorsOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    action: Optional[PromptInjectionAction] = None
+
+
+class PiiEntityOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    email_address: Optional[PiiEntityAction] = None
+    nrp: Optional[PiiEntityAction] = None
+    location: Optional[PiiEntityAction] = None
+    person: Optional[PiiEntityAction] = None
+    phone_number: Optional[PiiEntityAction] = None
+    date_time: Optional[PiiEntityAction] = None
+    ip_address: Optional[PiiEntityAction] = None
+    url: Optional[PiiEntityAction] = None
+    money: Optional[PiiEntityAction] = None
+    credit_card: Optional[PiiEntityAction] = None
+    crypto: Optional[PiiEntityAction] = None
+    iban_code: Optional[PiiEntityAction] = None
+    us_bank_number: Optional[PiiEntityAction] = None
+    nif: Optional[PiiEntityAction] = None
+    au_abn: Optional[PiiEntityAction] = None
+    au_acn: Optional[PiiEntityAction] = None
+    au_tfn: Optional[PiiEntityAction] = None
+    medical_license: Optional[PiiEntityAction] = None
+    uk_nhs: Optional[PiiEntityAction] = None
+    au_medicare: Optional[PiiEntityAction] = None
+    us_drivers_license: Optional[PiiEntityAction] = None
+    us_itin: Optional[PiiEntityAction] = None
+    us_passport: Optional[PiiEntityAction] = None
+    us_ssn: Optional[PiiEntityAction] = None
+
+
+class SecretsDetectionOverride(APIRequestModel):
+    disabled: Optional[bool] = None
+    slack_token: Optional[PiiEntityAction] = None
+    rsa_private_key: Optional[PiiEntityAction] = None
+    ssh_dsa_private_key: Optional[PiiEntityAction] = None
+    ssh_ec_private_key: Optional[PiiEntityAction] = None
+    pgp_private_key_block: Optional[PiiEntityAction] = None
+    amazon_aws_access_key_id: Optional[PiiEntityAction] = None
+    amazon_aws_secret_access_key: Optional[PiiEntityAction] = None
+    amazon_mws_auth_token: Optional[PiiEntityAction] = None
+    facebook_access_token: Optional[PiiEntityAction] = None
+    github_access_token: Optional[PiiEntityAction] = None
+    jwt_token: Optional[PiiEntityAction] = None
+    google_api_key: Optional[PiiEntityAction] = None
+    google_cloud_platform_api_key: Optional[PiiEntityAction] = None
+    google_drive_api_key: Optional[PiiEntityAction] = None
+    google_cloud_platform_service_account: Optional[PiiEntityAction] = None
+    google_gmail_api_key: Optional[PiiEntityAction] = None
+    youtube_api_key: Optional[PiiEntityAction] = None
+    mailchimp_api_key: Optional[PiiEntityAction] = None
+    mailgun_api_key: Optional[PiiEntityAction] = None
+    basic_auth: Optional[PiiEntityAction] = None
+    picatic_api_key: Optional[PiiEntityAction] = None
+    slack_webhook: Optional[PiiEntityAction] = None
+    stripe_api_key: Optional[PiiEntityAction] = None
+    stripe_restricted_api_key: Optional[PiiEntityAction] = None
+    square_access_token: Optional[PiiEntityAction] = None
+    square_oauth_secret: Optional[PiiEntityAction] = None
+    twilio_api_key: Optional[PiiEntityAction] = None
+    pangea_token: Optional[PiiEntityAction] = None
+
+
+class Overrides(APIRequestModel):
+    ignore_recipe: Optional[bool] = None
+    """Bypass existing Recipe content and create an on-the-fly Recipe."""
+
+    code_detection: Optional[CodeDetectionOverride] = None
+    competitors: Optional[CompetitorsOverride] = None
+    gibberish: Optional[GibberishOverride] = None
+    language_detection: Optional[LanguageDetectionOverride] = None
+    malicious_entity: Optional[MaliciousEntityOverride] = None
+    pii_entity: Optional[PiiEntityOverride] = None
+    prompt_injection: Optional[PromptInjectionOverride] = None
+    roleplay: Optional[RoleplayOverride] = None
+    secrets_detection: Optional[SecretsDetectionOverride] = None
+    selfharm: Optional[SelfHarmOverride] = None
+    sentiment: Optional[SentimentOverride] = None
+    topic_detection: Optional[TopicDetectionOverride] = None
+
 
 class LogFields(APIRequestModel):
     """Additional fields to include in activity log"""
@@ -33,6 +177,8 @@ class AnalyzerResponse(APIResponseModel):
 
 class PromptInjectionResult(APIResponseModel):
     action: str
+    """The action taken by this Detector"""
+
     analyzer_responses: List[AnalyzerResponse]
     """Triggered prompt injection analyzers."""
 
@@ -41,11 +187,13 @@ class PiiEntity(APIResponseModel):
     type: str
     value: str
     action: str
+    """The action taken on this Entity"""
     start_pos: Optional[int] = None
 
 
 class PiiEntityResult(APIResponseModel):
     entities: List[PiiEntity]
+    """Detected redaction rules."""
 
 
 class MaliciousEntity(APIResponseModel):
@@ -58,35 +206,59 @@ class MaliciousEntity(APIResponseModel):
 
 class MaliciousEntityResult(APIResponseModel):
     entities: List[MaliciousEntity]
+    """Detected harmful items."""
+
+
+class CustomEntity(APIResponseModel):
+    type: str
+    value: str
+    action: str
+    """The action taken on this Entity"""
+    start_pos: Optional[int] = None
+    raw: Optional[Dict[str, Any]] = None
+
+
+class CustomEntityResult(APIResponseModel):
+    entities: List[CustomEntity]
+    """Detected redaction rules."""
 
 
 class SecretsEntity(APIResponseModel):
     type: str
     value: str
     action: str
+    """The action taken on this Entity"""
     start_pos: Optional[int] = None
     redacted_value: Optional[str] = None
 
 
 class SecretsEntityResult(APIResponseModel):
     entities: List[SecretsEntity]
+    """Detected redaction rules."""
 
 
 class LanguageDetectionResult(APIResponseModel):
     language: str
     action: str
+    """The action taken by this Detector"""
+
+
+class TopicDetectionResult(APIResponseModel):
+    action: str
+    """The action taken by this Detector"""
 
 
 class CodeDetectionResult(APIResponseModel):
     language: str
     action: str
+    """The action taken by this Detector"""
 
 
 _T = TypeVar("_T")
 
 
 class TextGuardDetector(APIResponseModel, Generic[_T]):
-    detected: bool
+    detected: Optional[bool] = None
     data: Optional[_T] = None
 
 
@@ -94,10 +266,11 @@ class TextGuardDetectors(APIResponseModel):
     prompt_injection: Optional[TextGuardDetector[PromptInjectionResult]] = None
     pii_entity: Optional[TextGuardDetector[PiiEntityResult]] = None
     malicious_entity: Optional[TextGuardDetector[MaliciousEntityResult]] = None
+    custom_entity: Optional[TextGuardDetector[Any]] = 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
+    topic_detection: Optional[TextGuardDetector[TopicDetectionResult]] = None
     code_detection: Optional[TextGuardDetector[CodeDetectionResult]] = None
 
 
@@ -112,6 +285,16 @@ class TextGuardResult(PangeaResponseResult, Generic[_T]):
     """Updated structured prompt, if applicable."""
 
     blocked: bool
+    """Whether or not the prompt triggered a block detection."""
+
+    recipe: str
+    """The Recipe that was used."""
+
+    fpe_context: Optional[str] = None
+    """
+    If an FPE redaction method returned results, this will be the context passed
+    to unredact.
+    """
 
 
 class AIGuard(ServiceBase):
@@ -160,7 +343,7 @@ class AIGuard(ServiceBase):
         *,
         recipe: str | None = None,
         debug: bool | None = None,
-        llm_info: str | None = None,
+        overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
     ) -> PangeaResponse[TextGuardResult[None]]:
         """
@@ -180,7 +363,6 @@ 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
-            llm_info: Short string hint for the LLM Provider information
             log_field: Additional fields to include in activity log
 
         Examples:
@@ -194,7 +376,7 @@ class AIGuard(ServiceBase):
         messages: _T,
         recipe: str | None = None,
         debug: bool | None = None,
-        llm_info: str | None = None,
+        overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
     ) -> PangeaResponse[TextGuardResult[_T]]:
         """
@@ -215,59 +397,20 @@ 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
-            llm_info: Short string hint for the LLM Provider information
             log_field: Additional fields to include in activity log
 
         Examples:
             response = ai_guard.guard_text(messages=[{"role": "user", "content": "hello world"}])
         """
 
-    @overload
-    def guard_text(
-        self,
-        *,
-        llm_input: _T,
-        recipe: str | None = None,
-        debug: bool | None = None,
-        llm_info: str | None = None,
-        log_fields: LogFields | None = None,
-    ) -> PangeaResponse[TextGuardResult[_T]]:
-        """
-        Text Guard for scanning LLM inputs and outputs
-
-        Analyze and redact text to avoid manipulation of the model, addition of
-        malicious content, and other undesirable data transfers.
-
-        OperationId: ai_guard_post_v1_text_guard
-
-        Args:
-            llm_input: Structured full llm payload 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 JSON 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
-            llm_info: Short string hint for the LLM Provider information
-            log_field: Additional fields to include in activity log
-
-        Examples:
-            response = ai_guard.guard_text(
-                llm_input={"model": "gpt-4o", "messages": [{"role": "user", "content": "hello world"}]}
-            )
-        """
-
     def guard_text(  # type: ignore[misc]
         self,
         text: str | None = None,
         *,
         messages: _T | None = None,
-        llm_input: _T | None = None,
         recipe: str | None = None,
         debug: bool | None = None,
-        llm_info: str | None = None,
+        overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
     ) -> PangeaResponse[TextGuardResult[None]]:
         """
@@ -286,27 +429,19 @@ class AIGuard(ServiceBase):
                 PII, sensitive data, malicious content, and other data types
                 defined by the configuration. Supports processing up to 10KB of
                 JSON text
-            llm_input: Structured full llm payload 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 JSON 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
-            llm_info: Short string hint for the LLM Provider information
             log_field: Additional fields to include in activity log
 
         Examples:
             response = ai_guard.guard_text("text")
         """
 
-        if not any((text, messages, llm_input)):
-            raise ValueError("At least one of `text`, `messages`, or `llm_input` must be given")
-
-        if sum((text is not None, messages is not None, llm_input is not None)) > 1:
-            raise ValueError("Only one of `text`, `messages`, or `llm_input` can be given at once")
+        if text is not None and messages is not None:
+            raise ValueError("Exactly one of `text` or `messages` must be given")
 
         return self.request.post(
             "v1/text/guard",
@@ -314,10 +449,9 @@ class AIGuard(ServiceBase):
             data={
                 "text": text,
                 "messages": messages,
-                "llm_input": llm_input,
                 "recipe": recipe,
                 "debug": debug,
-                "llm_info": llm_info,
+                "overrides": overrides,
                 "log_fields": log_fields,
             },
         )

pangea/services/audit/audit.py

@@ -408,10 +408,6 @@ class Audit(ServiceBase, AuditBase):
              config = PangeaConfig(domain="pangea_domain")
              audit = Audit(token="pangea_token", config=config)
         """
-        # FIXME: Temporary check to deprecate config_id from PangeaConfig.
-        # Delete it when deprecate PangeaConfig.config_id
-        if config_id and config is not None and config.config_id is not None:
-            config_id = config.config_id
         ServiceBase.__init__(self, token, config=config, logger_name=logger_name, config_id=config_id)
         AuditBase.__init__(
             self, private_key_file=private_key_file, public_key_info=public_key_info, tenant_id=tenant_id

pangea/services/prompt_guard.py

@@ -36,8 +36,8 @@ class GuardResult(PangeaResponseResult):
     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"""
+    confidence: float
+    """Percent of confidence in the detection result, ranging from 0 to 1"""
 
     info: Optional[str] = None
     """Extra information about the detection result"""

pangea/services/redact.py

@@ -155,12 +155,19 @@ class StructuredRequest(APIRequestModel):
 class StructuredResult(PangeaResponseResult):
     """
     Result class after a structured redact request
-
     """
 
     redacted_data: Optional[Union[Dict, str]] = None
+    """Redacted data result"""
+
     count: int
+    """Number of redactions present in the text"""
+
     report: Optional[DebugReport] = None
+    """Describes the decision process for redactions"""
+
+    fpe_context: Optional[str] = None
+    """FPE context used to encrypt and redact data"""
 
 
 class UnredactRequest(APIRequestModel):
@@ -170,7 +177,6 @@ class UnredactRequest(APIRequestModel):
     Arguments:
     redacted_data: Data to unredact
     fpe_context (base64): FPE context used to decrypt and unredact data
-
     """
 
     redacted_data: RedactedData
@@ -183,7 +189,6 @@ RedactedData = Union[str, Dict]
 class UnredactResult(PangeaResponseResult):
     """
     Result class after an unredact request
-
     """
 
     data: RedactedData

pangea/tools.py

@@ -151,20 +151,17 @@ def get_config_id(environment: TestEnvironment, service: str, config_number: int
 
 def get_custom_schema_test_token(environment: TestEnvironment):
     env_var_name = f"PANGEA_INTEGRATION_CUSTOM_SCHEMA_TOKEN_{environment}"
-    value = os.getenv(env_var_name)
-    if not value:
-        raise PangeaException(f"{env_var_name} env var need to be set")
-
-    return value
+    return _load_env_var(env_var_name)
 
 
 def get_custom_schema_vault_test_token(environment: TestEnvironment):
     env_var_name = f"PANGEA_INTEGRATION_CUSTOM_SCHEMA_TOKEN_{environment}"
-    value = os.getenv(env_var_name)
-    if not value:
-        raise PangeaException(f"{env_var_name} env var need to be set")
+    return _load_env_var(env_var_name)
 
-    return value
+
+def get_vault_fpe_key_id(environment: TestEnvironment):
+    env_var_name = f"PANGEA_INTEGRATION_FPE_KEY_ID_{environment}"
+    return _load_env_var(env_var_name)
 
 
 class SequenceFollower:

{pangea_sdk-5.5.0b4.dist-info → pangea_sdk-6.0.0.dist-info}/METADATA

@@ -1,23 +1,24 @@
 Metadata-Version: 2.3
 Name: pangea-sdk
-Version: 5.5.0b4
+Version: 6.0.0
 Summary: Pangea API SDK
 License: MIT
 Keywords: Pangea,SDK,Audit
 Author: Glenn Gallien
 Author-email: glenn.gallien@pangea.cloud
-Requires-Python: >=3.9,<4.0.0
+Requires-Python: >=3.9.2,<4.0.0
 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: aiohttp (>=3.11.16,<4.0.0)
+Requires-Dist: cryptography (>=44.0.2,<44.0.3)
 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: google-crc32c (>=1.7.1,<2.0.0)
+Requires-Dist: pydantic (>=2.11.3,<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)
+Requires-Dist: typing-extensions (>=4.13.2,<5.0.0)
+Requires-Dist: yarl (>=1.20.0,<2.0.0)
 Description-Content-Type: text/markdown
 
 <a href="https://pangea.cloud?utm_source=github&utm_medium=python-sdk" target="_blank" rel="noopener noreferrer">
@@ -26,12 +27,11 @@ Description-Content-Type: text/markdown
 
 <br />
 
-[![documentation](https://img.shields.io/badge/documentation-pangea-blue?style=for-the-badge&labelColor=551B76)][Documentation]
-[![Discourse](https://img.shields.io/badge/Discourse-4A154B?style=for-the-badge&logo=discourse&logoColor=white)][Discourse]
+[![Documentation](https://img.shields.io/badge/documentation-pangea-blue?style=for-the-badge&labelColor=551B76)][Documentation]
 
 # Pangea Python SDK
 
-A Python SDK for integrating with Pangea services. Supports Python v3.9 and
+A Python SDK for integrating with Pangea services. Supports Python v3.9.2 and
 above.
 
 ## Installation
@@ -63,13 +63,13 @@ the same compatibility guarantees as stable releases.
 Via pip:
 
 ```bash
-$ pip3 install pangea-sdk==5.5.0b4
+$ pip3 install pangea-sdk==5.5.0b2
 ```
 
 Via poetry:
 
 ```bash
-$ poetry add pangea-sdk==5.5.0b4
+$ poetry add pangea-sdk==5.5.0b2
 ```
 
 ## Usage
@@ -223,6 +223,5 @@ It accepts multiple file formats:
    [GA Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
    [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
    [Pangea Console]: https://console.pangea.cloud/
-   [Discourse]: https://l.pangea.cloud/Jd4wlGs
    [Secure Audit Log]: https://pangea.cloud/docs/audit
 

{pangea_sdk-5.5.0b4.dist-info → pangea_sdk-6.0.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-pangea/__init__.py,sha256=fCxvmybvVb3077qDVFJbBz4QSz5gOCC6lb36iuU2BxY,251
+pangea/__init__.py,sha256=WlZa15dkqzwfQrtPRyiGS0sYP9wBJcaBvWFl_kcNUjs,246
 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=Q_Q_1xKvxXsW6jHsEDjPVHAOYYvz7bmulC5480vRc-s,8541
-pangea/asyncio/services/audit.py,sha256=rPaCx4cMzj-g9WFMRIysFCJAz6Btp6YrhcKe_exky8k,26283
+pangea/asyncio/services/ai_guard.py,sha256=rFksT8LQkyioW3QOq4fLCEZbW5SXiYWpWjLbVovRouE,6294
+pangea/asyncio/services/audit.py,sha256=Ue3KDmTn-a2KsqlzxbakLQJAWiRyLaJrYVi1hO7a6sw,26030
 pangea/asyncio/services/authn.py,sha256=rPeLJweL8mYH_t4ebcQn4n_Wglr3kClKNnCXNCimZU4,46622
 pangea/asyncio/services/authz.py,sha256=B_0_nhDMJcjNpjpCx3Vi2LDRhlmfV9325GKbUZ8reos,10025
 pangea/asyncio/services/base.py,sha256=vRFVcO_uEAGJte3OUUBLD43RoiiFB1vC7SPyN6yEMoA,3158
@@ -17,7 +17,7 @@ pangea/asyncio/services/sanitize.py,sha256=EbSdq_v9yZWce9xEYWvZharE9bJcxw8cg5Pv8
 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=qe1ZhvDxNQxNXUpAtzF6nPLjyRpPVG9sjhLZV6Pkyn8,1766
+pangea/config.py,sha256=Z2WT_UG0qBQzzVzBfloXYFxS21mSg1YXQ36cAVCqrJk,1963
 pangea/crypto/rsa.py,sha256=mwSiNy571KAGr3F6oEM0CXWkl9D023ch8ldbZZeLj_4,4747
 pangea/deep_verify.py,sha256=ZGraaL7TCxwRBIDqjBFR0clKlhAC-Yce6kD-1LClhG8,8616
 pangea/deprecated.py,sha256=IjFYEVvY1E0ld0SMkEYC1o62MAleX3nnT1If2dFVbHo,608
@@ -25,11 +25,11 @@ pangea/dump_audit.py,sha256=IevqaUUh7GDepdIW7slSxeZbkPrWIVbcX3sr4DgpJXI,7090
 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=vGB8owXUiNQoeiiACFvfXvg44JJo_L6WfcHlF6ug8co,25082
+pangea/request.py,sha256=4ZVD1F3CS4XdLM45vfhlCazZ5NQF1jUzu4j31yjH3KE,24689
 pangea/response.py,sha256=lPAcYsF9Xg166CiyhCofVmQA-W4jevh0MQXxUa8Re68,7737
 pangea/services/__init__.py,sha256=h36HzyIGaI5kO6l3UCwKHx_Kd-m_9mYVwn5MLRVzblI,408
-pangea/services/ai_guard.py,sha256=tBr3GEbrobjECs51cRR63Q8AICMl-K3tQD1FdyZkR4s,11129
-pangea/services/audit/audit.py,sha256=7-c9l7jyGtpG7SqRUMpqsAzcUDhMZ5izgPalxHXsUvM,39320
+pangea/services/ai_guard.py,sha256=X1DR1JTYZnLqBFFAHgmRk4xqyGF3GQMO1B3_cqLLVfU,15774
+pangea/services/audit/audit.py,sha256=TbDiO5eAHWCWAynQ4PChonTEN7z7ehZaR-duxbIFZ6Q,39068
 pangea/services/audit/exceptions.py,sha256=bhVuYe4ammacOVxwg98CChxvwZf5FKgR2DcgqILOcwc,471
 pangea/services/audit/models.py,sha256=1h1B9eSYQMYG3f8WNi1UcDX2-impRrET_ErjJYUnj7M,14678
 pangea/services/audit/signing.py,sha256=5A4hvPtpfP2kMz8bsiiKUACriXbh5dv9gb_rbqiUtuI,5583
@@ -41,8 +41,8 @@ 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=uMpofGKltmlNklF8znhRLuY6siyjDf-Zw-4Hwy2oJtc,3446
-pangea/services/redact.py,sha256=ovIcT0jkXe57O7keGzSClWNCic8y-4NZoemXoSKjjww,12913
+pangea/services/prompt_guard.py,sha256=Cq8ume2_YPfHre4iN6FYkyTV7NrdwLXlr_wnilfKotE,3446
+pangea/services/redact.py,sha256=ZTZgx3w4X923ZjWcBpI4c0gVh9cpJpcUpWuTNVVuHeY,13143
 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=hlhkIr6ScJ5oMFUs9no4HtHNoUEbYU4KoLkiGLxex30,52343
@@ -52,9 +52,9 @@ pangea/services/vault/models/keys.py,sha256=duAuTiOby_D7MloRvN4gNj0P-b-jx9sdtplA
 pangea/services/vault/models/secret.py,sha256=ItGdkulM-SEySfcm4a5yGxMvo_omjC7kChv6gdbFnn8,1142
 pangea/services/vault/models/symmetric.py,sha256=t8xCM1wGGKDBpOqTggFueO4-4-2IFmyxqcs7_PDr7U0,2562
 pangea/services/vault/vault.py,sha256=ow-Zm7PYzfWIfUcA4UNnpeL2DHfZM4C7inRDmNR3zQU,76196
-pangea/tools.py,sha256=2-Y4SAHWFv6Ocj42J_bWrVy27M5G3wi7a8LJn0dabHc,6427
+pangea/tools.py,sha256=icHduOfZLi02UYdGb5Xl1fQqu-PBRB4tiDPT_nL2Q8E,6380
 pangea/utils.py,sha256=dZ6MwFVEWXUgXvvDg-k6JnvVfsgslvtaBd7ez7afrqk,4983
 pangea/verify_audit.py,sha256=nSP17OzoSPdvezRExwfcf45H8ZPZnxZu-CbEp3qFJO0,17354
-pangea_sdk-5.5.0b4.dist-info/METADATA,sha256=KtUZWuQgJVjZipQZ77PbZw33faRG6M_425ZGLxvxCA4,7017
-pangea_sdk-5.5.0b4.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-pangea_sdk-5.5.0b4.dist-info/RECORD,,
+pangea_sdk-6.0.0.dist-info/METADATA,sha256=X9QYxYoEw53LK2rdWTOvEs9I24--d27P7Xeft4DTGzM,6886
+pangea_sdk-6.0.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+pangea_sdk-6.0.0.dist-info/RECORD,,

{pangea_sdk-5.5.0b4.dist-info → pangea_sdk-6.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.0.1
+Generator: poetry-core 2.1.2
 Root-Is-Purelib: true
 Tag: py3-none-any