> This page is for version v0.25.0.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo/guardrails/latest/llms.txt
> - v0.25.0: https://docs.nvidia.com/nemo/guardrails/v0.25.0/llms.txt
> - v0.24.1: https://docs.nvidia.com/nemo/guardrails/v0.24.1/llms.txt
> - v0.24.0: https://docs.nvidia.com/nemo/guardrails/v0.24.0/llms.txt
> - v0.23.0: https://docs.nvidia.com/nemo/guardrails/v0.23.0/llms.txt
> - v0.22.0: https://docs.nvidia.com/nemo/guardrails/v0.22.0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/guardrails/llms.txt.

# nemoguardrails.library.zscaler_aiguard.actions

Zscaler AI Guard integration for NeMo Guardrails.

Scans prompts and LLM responses using the Zscaler AI Guard DAS API
via the zscaler-sdk-python SDK.

By default, uses resolve-and-execute-policy (automatic policy selection).
Set AIGUARD_POLICY_ID to use execute-policy with a specific policy.

Required environment variables:
AIGUARD_API_KEY  - Zscaler AI Guard API key (Bearer token)
AIGUARD_CLOUD    - Cloud region, e.g. us1, us2, eu1 (default: us1)

Optional environment variables:
AIGUARD_POLICY_ID - Specific policy ID to use (default: auto-resolved)

## Module Contents

### Classes

| Name                                                                                         | Description |
| -------------------------------------------------------------------------------------------- | ----------- |
| [`_MissingApiKeyError`](#nemoguardrails-library-zscaler_aiguard-actions-_MissingApiKeyError) | -           |

### Functions

| Name                                                                                                   | Description                                                           |
| ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- |
| [`_build_block_message`](#nemoguardrails-library-zscaler_aiguard-actions-_build_block_message)         | Build a human-readable block message with full context.               |
| [`_get_attr`](#nemoguardrails-library-zscaler_aiguard-actions-_get_attr)                               | Access an attribute by name from either a dict or an object.          |
| [`_get_sdk_client`](#nemoguardrails-library-zscaler_aiguard-actions-_get_sdk_client)                   | Lazily initialise the Zscaler AI Guard SDK client.                    |
| [`_outcome_metadata`](#nemoguardrails-library-zscaler_aiguard-actions-_outcome_metadata)               | -                                                                     |
| [`_scan_sync`](#nemoguardrails-library-zscaler_aiguard-actions-_scan_sync)                             | Call the AI Guard API synchronously (wrapped with asyncio.to_thread). |
| [`call_zscaler_aiguard_api`](#nemoguardrails-library-zscaler_aiguard-actions-call_zscaler_aiguard_api) | Scan content using Zscaler AI Guard.                                  |

### Data

[`_sdk_client`](#nemoguardrails-library-zscaler_aiguard-actions-_sdk_client)

[`_sdk_client_cloud`](#nemoguardrails-library-zscaler_aiguard-actions-_sdk_client_cloud)

[`log`](#nemoguardrails-library-zscaler_aiguard-actions-log)

### API

```python
class nemoguardrails.library.zscaler_aiguard.actions._MissingApiKeyError()
```

**Bases:** `EnvironmentError`

```python
nemoguardrails.library.zscaler_aiguard.actions._build_block_message(
    direction: str,
    severity: str,
    policy_name: str,
    blocking_detectors: list,
    transaction_id: typing.Optional[str] = None
) -> str
```

Build a human-readable block message with full context.

```python
nemoguardrails.library.zscaler_aiguard.actions._get_attr(
    obj,
    name,
    default = None
)
```

Access an attribute by name from either a dict or an object.

```python
nemoguardrails.library.zscaler_aiguard.actions._get_sdk_client()
```

Lazily initialise the Zscaler AI Guard SDK client.

```python
nemoguardrails.library.zscaler_aiguard.actions._outcome_metadata(
    action_value: str,
    severity: str,
    policy_name: str,
    transaction_id: typing.Optional[str],
    detectors: dict[str, typing.Any],
    blocking_detectors: list[str],
    extra: typing.Any = {}
) -> dict[str, typing.Any]
```

```python
nemoguardrails.library.zscaler_aiguard.actions._scan_sync(
    content: str,
    direction: str,
    policy_id: typing.Optional[int] = None
)
```

Call the AI Guard API synchronously (wrapped with asyncio.to_thread).

```python
nemoguardrails.library.zscaler_aiguard.actions.call_zscaler_aiguard_api(
    text: typing.Optional[str] = None,
    direction: str = 'IN',
    policy_id: typing.Optional[int] = None,
    kwargs = {}
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

async

Scan content using Zscaler AI Guard.

**Parameters:**

**`text`** `Optional[str]` — default: None

Content to scan (user prompt or bot response).

---

**`direction`** `str` — default: 'IN'

"IN" for user prompts, "OUT" for bot responses.

---

**`policy_id`** `Optional[int]` — default: None

Optional policy ID. If provided, calls execute_policy
instead of resolve_and_execute_policy. Can also be set via
AIGUARD_POLICY_ID environment variable.

---

**Returns:** [`RailOutcome`](/nemo/guardrails/v0.25.0/guardrails-python-sdk/nemoguardrails/actions/rail_outcome#nemoguardrails-actions-rail_outcome-RailOutcome)

The rail decision with the parsed AI Guard response as metadata.

```python
nemoguardrails.library.zscaler_aiguard.actions._sdk_client = None
```

```python
nemoguardrails.library.zscaler_aiguard.actions._sdk_client_cloud = None
```

```python
nemoguardrails.library.zscaler_aiguard.actions.log = logging.getLogger(__name__)
```