> This page is for version v0.24.1.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo/guardrails/latest/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.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/guardrails/_mcp/server.

# nemoguardrails.library.hf_classifier.actions

HuggingFace classifier-based detection actions.

## Module Contents

### Functions

| Name                                                                                                                 | Description                                       |
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- |
| [`_classify_and_check`](#nemoguardrails-library-hf_classifier-actions-_classify_and_check)                           | Classify *text* and check against blocked labels. |
| [`_extract_text`](#nemoguardrails-library-hf_classifier-actions-_extract_text)                                       | -                                                 |
| [`_hf_classifier_outcome`](#nemoguardrails-library-hf_classifier-actions-_hf_classifier_outcome)                     | -                                                 |
| [`_hf_classifier_retrieval_outcome`](#nemoguardrails-library-hf_classifier-actions-_hf_classifier_retrieval_outcome) | -                                                 |
| [`hf_classifier_check_input`](#nemoguardrails-library-hf_classifier-actions-hf_classifier_check_input)               | -                                                 |
| [`hf_classifier_check_output`](#nemoguardrails-library-hf_classifier-actions-hf_classifier_check_output)             | -                                                 |
| [`hf_classifier_check_retrieval`](#nemoguardrails-library-hf_classifier-actions-hf_classifier_check_retrieval)       | -                                                 |

### Data

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

### API

```python
nemoguardrails.library.hf_classifier.actions._classify_and_check(
    classifier_name: str,
    text: str,
    config: typing.Any | None,
    http_client: nemoguardrails.http.HTTPClient | None = None
) -> bool
```

async

Classify *text* and check against blocked labels.

Returns `True` if allowed, `False` if blocked.

```python
nemoguardrails.library.hf_classifier.actions._extract_text(
    context: typing.Optional[dict],
    key: str
) -> str
```

```python
nemoguardrails.library.hf_classifier.actions._hf_classifier_outcome(
    allowed: bool
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

```python
nemoguardrails.library.hf_classifier.actions._hf_classifier_retrieval_outcome(
    allowed: bool
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

```python
nemoguardrails.library.hf_classifier.actions.hf_classifier_check_input(
    classifier: str,
    config: typing.Any | None = None,
    context: typing.Optional[dict] = None,
    text: typing.Optional[str] = None,
    http_client: nemoguardrails.http.HTTPClient | None = None,
    kwargs = {}
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

async

```python
nemoguardrails.library.hf_classifier.actions.hf_classifier_check_output(
    classifier: str,
    config: typing.Any | None = None,
    context: typing.Optional[dict] = None,
    model_name: typing.Optional[str] = None,
    text: typing.Optional[str] = None,
    http_client: nemoguardrails.http.HTTPClient | None = None,
    kwargs = {}
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

async

```python
nemoguardrails.library.hf_classifier.actions.hf_classifier_check_retrieval(
    classifier: str,
    config: typing.Any | None = None,
    context: typing.Optional[dict] = None,
    text: typing.Optional[str] = None,
    http_client: nemoguardrails.http.HTTPClient | None = None,
    kwargs = {}
) -> nemoguardrails.actions.rail_outcome.RailOutcome
```

async

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