ReferencePython SDK ReferenceNemoguardrailsLibrarySelf CheckInput Check

nemoguardrails.library.self_check.input_check.actions

View as Markdown

Module Contents

Functions

NameDescription
_self_check_outcome-
self_check_inputChecks the input from the user.

Data

DEFAULT_TASK

log

API

nemoguardrails.library.self_check.input_check.actions._self_check_outcome(
    allowed: bool
) -> nemoguardrails.actions.rail_outcome.RailOutcome
 
nemoguardrails.library.self_check.input_check.actions.self_check_input(
    llms: typing.Dict[str, nemoguardrails.types.LLMModel],
    llm_task_manager: nemoguardrails.llm.taskmanager.LLMTaskManager,
    context: typing.Optional[dict] = None,
    events: typing.Optional[typing.List[dict]] = None,
    llm: typing.Optional[nemoguardrails.types.LLMModel] = None,
    config: typing.Optional[nemoguardrails.RailsConfig] = None,
    variant: typing.Optional[str] = None,
    user_message: typing.Optional[str] = None,
    kwargs = {}
) -> nemoguardrails.actions.rail_outcome.RailOutcome
async

Checks the input from the user.

Prompt the LLM, using the check_input task prompt, to determine if the input from the user should be allowed or not.

Returns: RailOutcome

RailOutcome.allow() if the input should be allowed, RailOutcome.block() otherwise.

nemoguardrails.library.self_check.input_check.actions.DEFAULT_TASK = SELF_CHECK_INPUT_DEFAULT_TASK
 
nemoguardrails.library.self_check.input_check.actions.log = logging.getLogger(__name__)