Skip to content

latent.guardrails.base

Classes

GuardrailBlockContext

GuardrailBlockContext(rule_name: str, score: float, prompt: str, message: str, metadata: dict[str, Any] = dict(), agent: Any = None)

Context passed to on_block callbacks when an active guardrail fires.

GuardrailBlockedError

GuardrailBlockedError(rule_name: str, score: float, message: str = 'Request blocked by guardrail.', is_context_check: bool = False)

Raised when an active rule blocks a request.

InputScanner

InputScanner()

MessageInputScanner

MessageInputScanner()

Scanner that operates on the full message list instead of a single prompt string.

OutputScanner

OutputScanner()

ScanResult

ScanResult()

Functions

error_result

error_result(name: str, exc: Exception) -> ScanResult

ScanResult for a scanner that errored (passes to avoid false blocks).

pass_result

pass_result(name: str, passed: bool = True, score: float = 0.0, metadata: Any = {}) -> ScanResult

Convenience constructor for a passing (or simple failing) ScanResult.

Methods

InputScanner.scan

scan(prompt: str) -> ScanResult

MessageInputScanner.scan_messages

scan_messages(messages: list[Any], tools: list[dict[str, Any]] | None = None) -> ScanResult

OutputScanner.scan

scan(prompt: str, output: str) -> ScanResult

Attributes

Mode

OnError

Outcome

Timing