pangea-sdk 6.2.0b2__py3-none-any.whl → 6.4.0__py3-none-any.whl

pangea/__init__.py

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

pangea/asyncio/request.py

@@ -10,13 +10,13 @@ import asyncio
 import json
 import time
 from collections.abc import Iterable, Mapping
-from typing import Dict, List, Optional, Sequence, Tuple, Type, Union, cast, overload
+from typing import Dict, List, Optional, Sequence, Tuple, Type, Union, cast
 
 import aiohttp
 from aiohttp import FormData
-from pydantic import BaseModel, TypeAdapter
+from pydantic import BaseModel
 from pydantic_core import to_jsonable_python
-from typing_extensions import Any, Literal, TypeAlias, TypeVar, override
+from typing_extensions import Any, TypeAlias, TypeVar, override
 
 import pangea.exceptions as pe
 from pangea.request import MultipartResponse, PangeaRequestBase
@@ -32,6 +32,10 @@ _FileSpecTuple3: TypeAlias = tuple[_FileName, _FileContent, _FileContentType]
 _FileSpecTuple4: TypeAlias = tuple[_FileName, _FileContent, _FileContentType, _FileCustomHeaders]
 _FileSpec: TypeAlias = Union[_FileContent, _FileSpecTuple2, _FileSpecTuple3, _FileSpecTuple4]
 _Files: TypeAlias = Union[Mapping[str, _FileSpec], Iterable[tuple[str, _FileSpec]]]
+_LooseHeaders = Union[
+    Mapping[str, str],
+    Iterable[tuple[str, str]],
+]
 
 
 TResult = TypeVar("TResult", bound=PangeaResponseResult)
@@ -46,24 +50,6 @@ class PangeaRequestAsync(PangeaRequestBase):
     be set in PangeaConfig.
     """
 
-    async def delete(self, endpoint: str) -> None:
-        """
-        Makes a DELETE call to a Pangea endpoint.
-
-        Args:
-            endpoint: The Pangea API endpoint.
-        """
-
-        url = self._url(endpoint)
-
-        self.logger.debug(
-            json.dumps({"service": self.service, "action": "delete", "url": url}, default=default_encoder)
-        )
-
-        requests_response = await self._http_delete(url, headers=self._headers())
-        await self._check_http_errors(requests_response)
-
-    @overload
     async def post(
         self,
         endpoint: str,
@@ -72,60 +58,18 @@ class PangeaRequestAsync(PangeaRequestBase):
         files: Optional[List[Tuple]] = None,
         poll_result: bool = True,
         url: Optional[str] = None,
-        *,
-        pangea_response: Literal[True] = True,
     ) -> PangeaResponse[TResult]:
-        """
-        Makes a POST call to a Pangea Service endpoint.
+        """Makes the POST call to a Pangea Service endpoint.
 
         Args:
-            endpoint: The Pangea Service API endpoint.
-            data: The POST body payload object
+            endpoint(str): The Pangea Service API endpoint.
+            data(dict): The POST body payload object
 
         Returns:
             PangeaResponse which contains the response in its entirety and
                various properties to retrieve individual fields
         """
 
-    @overload
-    async def post(
-        self,
-        endpoint: str,
-        result_class: Type[TResult],
-        data: str | BaseModel | Mapping[str, Any] | None = None,
-        files: Optional[List[Tuple]] = None,
-        poll_result: bool = True,
-        url: Optional[str] = None,
-        *,
-        pangea_response: Literal[False],
-    ) -> TResult:
-        """
-        Makes a POST call to a Pangea Service endpoint.
-
-        Args:
-            endpoint: The Pangea Service API endpoint.
-            data: The POST body payload object
-        """
-
-    async def post(
-        self,
-        endpoint: str,
-        result_class: Type[TResult],
-        data: str | BaseModel | Mapping[str, Any] | None = None,
-        files: Optional[List[Tuple]] = None,
-        poll_result: bool = True,
-        url: Optional[str] = None,
-        *,
-        pangea_response: bool = True,
-    ) -> PangeaResponse[TResult] | TResult:
-        """
-        Makes a POST call to a Pangea Service endpoint.
-
-        Args:
-            endpoint: The Pangea Service API endpoint.
-            data: The POST body payload object
-        """
-
         if isinstance(data, BaseModel):
             data = data.model_dump(exclude_none=True)
 
@@ -165,13 +109,9 @@ class PangeaRequestAsync(PangeaRequestBase):
 
         await self._check_http_errors(requests_response)
 
-        if not pangea_response:
-            type_adapter = TypeAdapter(result_class)
-            return type_adapter.validate_python(await requests_response.json())
-
         if "multipart/form-data" in requests_response.headers.get("content-type", ""):
             multipart_response = await self._process_multipart_response(requests_response)
-            pangea_response_obj: PangeaResponse = PangeaResponse(
+            pangea_response: PangeaResponse = PangeaResponse(
                 requests_response,
                 result_class=result_class,
                 json=multipart_response.pangea_json,
@@ -184,110 +124,49 @@ class PangeaRequestAsync(PangeaRequestBase):
                     json.dumps({"service": self.service, "action": "post", "url": url, "response": json_resp})
                 )
 
-                pangea_response_obj = PangeaResponse(requests_response, result_class=result_class, json=json_resp)
+                pangea_response = PangeaResponse(requests_response, result_class=result_class, json=json_resp)
             except aiohttp.ContentTypeError as e:
                 raise pe.PangeaException(
                     f"Failed to decode json response. {e}. Body: {await requests_response.text()}"
                 ) from e
 
         if poll_result:
-            pangea_response_obj = await self._handle_queued_result(pangea_response_obj)
+            pangea_response = await self._handle_queued_result(pangea_response)
 
-        return self._check_response(pangea_response_obj)
+        return self._check_response(pangea_response)
 
-    @overload
-    async def get(
-        self,
-        path: str,
-        result_class: Type[TResult],
-        check_response: bool = True,
-        *,
-        params: (
-            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
-            | None
-        ) = None,
-        pangea_response: Literal[True] = True,
-    ) -> PangeaResponse[TResult]:
-        """
-        Makes the GET call to a Pangea Service endpoint.
+    async def get(self, path: str, result_class: Type[TResult], check_response: bool = True) -> PangeaResponse[TResult]:
+        """Makes the GET call to a Pangea Service endpoint.
 
         Args:
-            path: Additional URL path
-            params: Dictionary of querystring data to attach to the request
+            endpoint(str): The Pangea Service API endpoint.
+            path(str): Additional URL path
 
         Returns:
             PangeaResponse which contains the response in its entirety and
                various properties to retrieve individual fields
         """
 
-    @overload
-    async def get(
-        self,
-        path: str,
-        result_class: Type[TResult],
-        check_response: bool = True,
-        *,
-        params: (
-            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
-            | None
-        ) = None,
-        pangea_response: Literal[False] = False,
-    ) -> TResult:
-        """
-        Makes the GET call to a Pangea Service endpoint.
-
-        Args:
-            path: Additional URL path
-            params: Dictionary of querystring data to attach to the request
-        """
-
-    async def get(
-        self,
-        path: str,
-        result_class: Type[TResult],
-        check_response: bool = True,
-        *,
-        params: (
-            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
-            | None
-        ) = None,
-        pangea_response: bool = True,
-    ) -> PangeaResponse[TResult] | TResult:
-        """
-        Makes the GET call to a Pangea Service endpoint.
-
-        Args:
-            path: Additional URL path
-            params: Dictionary of querystring data to attach to the request
-            pangea_response: Whether or not the response body follows Pangea's
-              standard response schema
-        """
-
         url = self._url(path)
         self.logger.debug(json.dumps({"service": self.service, "action": "get", "url": url}))
 
-        async with self.session.get(url, params=params, headers=self._headers()) as requests_response:
+        async with self.session.get(url, headers=self._headers()) as requests_response:
             await self._check_http_errors(requests_response)
-
-            if not pangea_response:
-                type_adapter = TypeAdapter(result_class)
-                return type_adapter.validate_python(await requests_response.json())
-
-            pangea_response_obj = PangeaResponse(
+            pangea_response = PangeaResponse(
                 requests_response, result_class=result_class, json=await requests_response.json()
             )
 
         self.logger.debug(
             json.dumps(
-                {"service": self.service, "action": "get", "url": url, "response": pangea_response_obj.json},
+                {"service": self.service, "action": "get", "url": url, "response": pangea_response.json},
                 default=default_encoder,
             )
         )
 
         if check_response is False:
-            return pangea_response_obj
+            return pangea_response
 
-        return self._check_response(pangea_response_obj)
+        return self._check_response(pangea_response)
 
     async def _check_http_errors(self, resp: aiohttp.ClientResponse):
         if resp.status == 503:
@@ -421,18 +300,10 @@ class PangeaRequestAsync(PangeaRequestBase):
         attached_files = await self._get_attached_files(multipart_reader)
         return MultipartResponse(pangea_json, attached_files)  # type: ignore[arg-type]
 
-    async def _http_delete(
-        self,
-        url: str,
-        *,
-        headers: Mapping[str, str | bytes | None] = {},
-    ) -> aiohttp.ClientResponse:
-        return await self.session.delete(url, headers=headers)
-
     async def _http_post(
         self,
         url: str,
-        headers: Mapping[str, str] = {},
+        headers: _LooseHeaders = {},  # noqa: B006
         data: str | dict[str, Any] | None = None,
         files: _Files | None = None,
         presigned_url_post: bool = False,
@@ -469,7 +340,7 @@ class PangeaRequestAsync(PangeaRequestBase):
         self,
         url: str,
         files: Sequence[Tuple],
-        headers: Mapping[str, str] = {},
+        headers: _LooseHeaders = {},  # noqa: B006
     ) -> aiohttp.ClientResponse:
         self.logger.debug(
             json.dumps({"service": self.service, "action": "http_put", "url": url}, default=default_encoder)

pangea/asyncio/services/__init__.py

@@ -7,7 +7,6 @@ from .authz import AuthZAsync
 from .embargo import EmbargoAsync
 from .file_scan import FileScanAsync
 from .intel import DomainIntelAsync, FileIntelAsync, IpIntelAsync, UrlIntelAsync, UserIntelAsync
-from .management import ManagementAsync
 from .prompt_guard import PromptGuardAsync
 from .redact import RedactAsync
 from .sanitize import SanitizeAsync

pangea/asyncio/services/ai_guard.py

@@ -1,26 +1,12 @@
 from __future__ import annotations
 
-from collections.abc import Mapping
+from collections.abc import Sequence
 from typing import overload
 
-from typing_extensions import Literal, TypeVar
-
 from pangea.asyncio.services.base import ServiceBaseAsync
 from pangea.config import PangeaConfig
 from pangea.response import PangeaResponse
-from pangea.services.ai_guard import (
-    AuditDataActivityConfig,
-    ConnectionsConfig,
-    LogFields,
-    Overrides,
-    RecipeConfig,
-    ServiceConfig,
-    ServiceConfigFilter,
-    ServiceConfigsPage,
-    TextGuardResult,
-)
-
-_T = TypeVar("_T")
+from pangea.services.ai_guard import LogFields, Message, Overrides, TextGuardResult
 
 
 class AIGuardAsync(ServiceBaseAsync):
@@ -29,11 +15,9 @@ class AIGuardAsync(ServiceBaseAsync):
     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)
+        ai_guard = AIGuardAsync(token="pangea_token")
     """
 
     service_name = "ai-guard"
@@ -53,11 +37,9 @@ class AIGuardAsync(ServiceBaseAsync):
             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)
+            ai_guard = AIGuardAsync(token="pangea_token")
         """
 
         super().__init__(token, config, logger_name, config_id)
@@ -67,29 +49,31 @@ class AIGuardAsync(ServiceBaseAsync):
         self,
         text: str,
         *,
-        recipe: str | None = None,
         debug: bool | None = None,
-        overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
-    ) -> PangeaResponse[TextGuardResult[None]]:
+        overrides: Overrides | None = None,
+        recipe: str | None = None,
+    ) -> PangeaResponse[TextGuardResult]:
         """
-        Text Guard for scanning LLM inputs and outputs
+        Guard LLM input and output text
 
-        Analyze and redact text to avoid manipulation of the model, addition of
-        malicious content, and other undesirable data transfers.
+        Detect, remove, or block malicious content and intent in LLM inputs and
+        outputs to prevent model manipulation and data leakage.
 
         OperationId: ai_guard_post_v1_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.
+                configuration. Supports processing up to 20 KiB of text.
             debug: Setting this value to true will provide a detailed analysis
                 of the text data
             log_field: Additional fields to include in activity log
+            overrides: Overrides flags. Note: This parameter has no effect when
+                the request is made by AIDR
+            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.
 
         Examples:
             response = await ai_guard.guard_text("text")
@@ -99,51 +83,53 @@ class AIGuardAsync(ServiceBaseAsync):
     async def guard_text(
         self,
         *,
-        messages: _T,
+        messages: Sequence[Message],
         recipe: str | None = None,
         debug: bool | None = None,
         overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
-    ) -> PangeaResponse[TextGuardResult[_T]]:
+    ) -> PangeaResponse[TextGuardResult]:
         """
-        Text Guard for scanning LLM inputs and outputs
+        Guard LLM input and output text
 
-        Analyze and redact text to avoid manipulation of the model, addition of
-        malicious content, and other undesirable data transfers.
+        Detect, remove, or block malicious content and intent in LLM inputs and
+        outputs to prevent model manipulation and data leakage.
 
         OperationId: ai_guard_post_v1_text_guard
 
         Args:
             messages: Structured messages 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.
+                defined by the configuration. Supports processing up to 20 KiB
+                of JSON text using Pangea message format.
             debug: Setting this value to true will provide a detailed analysis
                 of the text data
             log_field: Additional fields to include in activity log
+            overrides: Overrides flags. Note: This parameter has no effect when
+                the request is made by AIDR
+            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.
 
         Examples:
-            response = await ai_guard.guard_text(messages=[{"role": "user", "content": "hello world"}])
+            response = await ai_guard.guard_text(messages=[Message(role="user", content="hello world")])
         """
 
-    async def guard_text(  # type: ignore[misc]
+    async def guard_text(
         self,
         text: str | None = None,
         *,
-        messages: _T | None = None,
+        messages: Sequence[Message] | None = None,
         recipe: str | None = None,
         debug: bool | None = None,
         overrides: Overrides | None = None,
         log_fields: LogFields | None = None,
-    ) -> PangeaResponse[TextGuardResult[None]]:
+    ) -> PangeaResponse[TextGuardResult]:
         """
-        Text Guard for scanning LLM inputs and outputs
+        Guard LLM input and output text
 
-        Analyze and redact text to avoid manipulation of the model, addition of
-        malicious content, and other undesirable data transfers.
+        Detect, remove, or block malicious content and intent in LLM inputs and
+        outputs to prevent model manipulation and data leakage.
 
         OperationId: ai_guard_post_v1_text_guard
 
@@ -155,12 +141,14 @@ class AIGuardAsync(ServiceBaseAsync):
                 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
             log_field: Additional fields to include in activity log
+            overrides: Overrides flags. Note: This parameter has no effect when
+                the request is made by AIDR
+            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.
 
         Examples:
             response = await ai_guard.guard_text("text")
@@ -181,81 +169,3 @@ class AIGuardAsync(ServiceBaseAsync):
                 "log_fields": log_fields,
             },
         )
-
-    async def get_service_config(self, id: str) -> PangeaResponse[ServiceConfig]:
-        """
-        OperationId: ai_guard_post_v1beta_config
-        """
-        return await self.request.post("v1beta/config", data={"id": id}, result_class=ServiceConfig)
-
-    async def create_service_config(
-        self,
-        name: str,
-        *,
-        id: str | None = None,
-        audit_data_activity: AuditDataActivityConfig | None = None,
-        connections: ConnectionsConfig | None = None,
-        recipes: Mapping[str, RecipeConfig] | None = None,
-    ) -> PangeaResponse[ServiceConfig]:
-        """
-        OperationId: ai_guard_post_v1beta_config_create
-        """
-        return await self.request.post(
-            "v1beta/config/create",
-            data={
-                "name": name,
-                "id": id,
-                "audit_data_activity": audit_data_activity,
-                "connections": connections,
-                "recipes": recipes,
-            },
-            result_class=ServiceConfig,
-        )
-
-    async def update_service_config(
-        self,
-        id: str,
-        name: str,
-        *,
-        audit_data_activity: AuditDataActivityConfig | None = None,
-        connections: ConnectionsConfig | None = None,
-        recipes: Mapping[str, RecipeConfig] | None = None,
-    ) -> PangeaResponse[ServiceConfig]:
-        """
-        OperationId: ai_guard_post_v1beta_config_update
-        """
-        return await self.request.post(
-            "v1beta/config/update",
-            data={
-                "id": id,
-                "name": name,
-                "audit_data_activity": audit_data_activity,
-                "connections": connections,
-                "recipes": recipes,
-            },
-            result_class=ServiceConfig,
-        )
-
-    async def delete_service_config(self, id: str) -> PangeaResponse[ServiceConfig]:
-        """
-        OperationId: ai_guard_post_v1beta_config_delete
-        """
-        return await self.request.post("v1beta/config/delete", data={"id": id}, result_class=ServiceConfig)
-
-    async def list_service_configs(
-        self,
-        *,
-        filter: ServiceConfigFilter | None = None,
-        last: str | None = None,
-        order: Literal["asc", "desc"] | None = None,
-        order_by: Literal["id", "created_at", "updated_at"] | None = None,
-        size: int | None = None,
-    ) -> PangeaResponse[ServiceConfigsPage]:
-        """
-        OperationId: ai_guard_post_v1beta_config_list
-        """
-        return await self.request.post(
-            "v1beta/config/list",
-            data={"filter": filter, "last": last, "order": order, "order_by": order_by, "size": size},
-            result_class=ServiceConfigsPage,
-        )