> 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.sensitive_data_detection.actions

## Module Contents

### Classes

| Name                                                                                                | Description                                                    |
| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| [`_DetectionExecutor`](#nemoguardrails-library-sensitive_data_detection-actions-_DetectionExecutor) | Keep Presidio work out of the event loop's shared thread pool. |

### Functions

| Name                                                                                                                              | Description                                                         |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| [`_create_analyzer`](#nemoguardrails-library-sensitive_data_detection-actions-_create_analyzer)                                   | Create an analyzer with the installed spaCy model.                  |
| [`_get_ad_hoc_recognizers`](#nemoguardrails-library-sensitive_data_detection-actions-_get_ad_hoc_recognizers)                     | Helper to compute the ad hoc recognizers for a config.              |
| [`_get_analyzer`](#nemoguardrails-library-sensitive_data_detection-actions-_get_analyzer)                                         | Reuse one analyzer per threshold, including concurrent cold starts. |
| [`_mask_sensitive_data_outcome`](#nemoguardrails-library-sensitive_data_detection-actions-_mask_sensitive_data_outcome)           | -                                                                   |
| [`_sensitive_data_detection_outcome`](#nemoguardrails-library-sensitive_data_detection-actions-_sensitive_data_detection_outcome) | -                                                                   |
| [`detect_sensitive_data`](#nemoguardrails-library-sensitive_data_detection-actions-detect_sensitive_data)                         | Checks whether the provided text contains any sensitive data.       |
| [`mask_sensitive_data`](#nemoguardrails-library-sensitive_data_detection-actions-mask_sensitive_data)                             | Checks whether the provided text contains any sensitive data.       |

### Data

[`_T`](#nemoguardrails-library-sensitive_data_detection-actions-_T)

[`_analyzer_init_lock`](#nemoguardrails-library-sensitive_data_detection-actions-_analyzer_init_lock)

[`_detection_executor`](#nemoguardrails-library-sensitive_data_detection-actions-_detection_executor)

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

### API

```python
class nemoguardrails.library.sensitive_data_detection.actions._DetectionExecutor()
```

**Bases:** `ThreadPoolExecutor`

Keep Presidio work out of the event loop's shared thread pool.

```python
nemoguardrails.library.sensitive_data_detection.actions._DetectionExecutor.run(
    func: collections.abc.Callable[[], nemoguardrails.library.sensitive_data_detection.actions._T]
) -> nemoguardrails.library.sensitive_data_detection.actions._T
```

async

Offload work with the caller's context and standard future cancellation.

```python
nemoguardrails.library.sensitive_data_detection.actions._create_analyzer(
    score_threshold: float = 0.4
)
```

Create an analyzer with the installed spaCy model.

```python
nemoguardrails.library.sensitive_data_detection.actions._get_ad_hoc_recognizers(
    sdd_config: nemoguardrails.rails.llm.config.SensitiveDataDetection
)
```

Helper to compute the ad hoc recognizers for a config.

```python
nemoguardrails.library.sensitive_data_detection.actions._get_analyzer(
    score_threshold: float = 0.4
)
```

Reuse one analyzer per threshold, including concurrent cold starts.

```python
nemoguardrails.library.sensitive_data_detection.actions._mask_sensitive_data_outcome(
    source: str,
    original_text: str,
    masked_text: str
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

```python
nemoguardrails.library.sensitive_data_detection.actions._sensitive_data_detection_outcome(
    has_sensitive_data: bool
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

```python
nemoguardrails.library.sensitive_data_detection.actions.detect_sensitive_data(
    source: str,
    text: str,
    config: nemoguardrails.RailsConfig,
    kwargs = {}
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

async

Checks whether the provided text contains any sensitive data.

Args
source: The source for the text, i.e. "input", "output", "retrieval".
text: The text to check.
config: The rails configuration object.

Returns
RailOutcome.block() if sensitive data has been detected, RailOutcome.allow() otherwise.

```python
nemoguardrails.library.sensitive_data_detection.actions.mask_sensitive_data(
    source: str,
    text: str,
    config: nemoguardrails.RailsConfig
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

async

Checks whether the provided text contains any sensitive data.

Args
source: The source for the text, i.e. "input", "output", "retrieval".
text: The text to check.
config: The rails configuration object.

Returns
RailOutcome.transform() with the altered text if it changed, RailOutcome.allow() otherwise.

```python
nemoguardrails.library.sensitive_data_detection.actions._T = TypeVar('_T')
```

```python
nemoguardrails.library.sensitive_data_detection.actions._analyzer_init_lock = Lock()
```

```python
nemoguardrails.library.sensitive_data_detection.actions._detection_executor = _DetectionExecutor(thread_name_prefix='presidio-detection')
```

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