Skip to contents

Policies and Rules

Scanners

scan_prompt()
Scan a prompt
preflight_check()
Preflight-check a prompt
scan_context()
Scan retrieved context rows
scan_output()
Scan model output
scan_conversation()
Scan a conversation while preserving message roles
scan_stream()
Scan streamed output chunks with rolling context
scan_tool_call()
Scan a tool call before execution
scan_tool_output()
Scan tool output before it re-enters model context
scanner_options()
Configure optional text scanners
redaction_strategy()
Configure redaction behavior

Orchestration

secure_chat()
Run a guarded chat call
shield_ollama()
Guard an Ollama chat workflow
ollama_reviewer()
Create a local Ollama reviewer
remote_reviewer()
Create a remote semantic reviewer
trust_boundary()
Wrap a chat object in a trust boundary
rate_guard()
Create or check a rate guard

Audit and Explanation

write_audit_log()
Write an audit log
explain_findings()
Explain findings
example_prompts()
Example prompts
evaluate_security_cases()
Evaluate scanner behavior on a labeled corpus
reviewer_prompt()
Return the default semantic reviewer prompt

Constructors

shieldr_rule()
Construct a shieldr_rule
shieldr_policy()
Construct a shieldr_policy
shieldr_report()
Construct a shieldr_report
shieldr_audit()
Construct a shieldr_audit
shieldr_result()
Construct a shieldr_result
print(<shieldr_policy>)
Print a shieldr_policy
print(<shieldr_report>)
Print a shieldr_report