nemoguardrails.library.hf_classifier.actions

HuggingFace classifier-based detection actions.

Module Contents

Functions

Name	Description
`_classify_and_check`	Classify text and check against blocked labels.
`_extract_text`	-
`_hf_classifier_outcome`	-
`_hf_classifier_retrieval_outcome`	-
`hf_classifier_check_input`	-
`hf_classifier_check_output`	-
`hf_classifier_check_retrieval`	-

Data

log

API

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.

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

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

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

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

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

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

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