For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

NeMo Guardrails

Overview
How It Works
Guardrail Types
Supported LLMs
Release Notes
Installation
Tutorials
Check Harmful Content
Content Safety Reasoning
Restrict Topics
Detect Jailbreak Attempts
Jailbreak Heuristics
Add Multimodal Content Safety
Integrate Guardrails
About Configuring Guardrails
Configuration Overview
Pre-Configuration Checklist
Configuring YAML File
Models
Guardrails
Prompts
Tracing
Streaming
Streaming LLM Responses
Output Rail Streaming
YAML Schema Reference
Guardrail Catalog
Content Safety
Jailbreak Protection
Topic Control
PII Detection
Agentic Security
Hallucinations & Fact-Checking
LLM Self-Check
Third-Party APIs
ActiveFence
AlignScore
AutoAlign
Cisco AI Defense
Clavata
Cleanlab
CrowdStrike AIDR
Fiddler
GCP Text Moderation
GLiNER PII
GuardrailsAI
Llama Guard
Pangea AI Guard
Patronus Evaluate API
Patronus Lynx
PolicyAI
Presidio
Private AI
Prompt Security
Regex
Trend Micro
Custom Actions
Creating Actions
Built-in Actions
Action Parameters
Registering Actions
Custom Initialization
Init Function
LLM Providers
Custom LLM Model
Testing
Custom LLM Framework
Embedding Providers
Custom Data
Colang
Colang 2.0 Guide
What's Changed
Migration Guide
Getting Started
Hello World
Interaction Loop
Input Rails
Dialog Rails
LLM Flows
Multimodal Rails
Recommended Next Steps
Language Reference
Introduction
Event Generation and Matching
Working with Actions
Defining Flows
Working with Variables and Expressions
Flow Control
Colang Standard Library
Core Flows
Timing Flows
LLM Flows
Avatar Flows
Guardrail Flows
Attention Flows
Make Use of LLMs
More on Flows
Python Actions
Development and Debugging
Colang 1.0 Guide
Colang 1.0 Language Syntax
Colang 1.0 Tutorials
Hello World
Core Colang Concepts
Demo Use Case
Input Rails
Output Rails
Topical Rails
Retrieval-Augmented Generation
Guardrailing Bot Reasoning Content
Colang Usage Examples
Bot Message Instructions
Extract User-provided Values
Other Configurations
Knowledge Base
Embedding Search Providers
Caching
Memory Model Cache
KV Cache Reuse
Exceptions
About Running Guardrailed Inference
Python APIs
Python APIs Overview
Core Classes
Generation Options
Streaming
Check Messages
Event-Based API
Guardrails API Server
Overview
Run the Server
Chat Completions
List Configurations
List Models
Actions Server
Evaluate Configuration
Evaluation Methodology
Evaluate Guardrails
Vulnerability Scanning
Overview
Logging
Tracing
Quick Start
Adapters
OpenTelemetry
OpenTelemetry Logs
Troubleshooting
Metrics
Enable Guardrails Metrics
OpenTelemetry Metrics Integration
Metric Reference
Deployment Options
Docker
NeMo Microservice
LangChain Frameworks
LangChain Integration
Agent Middleware
RunnableRails
Chain with Guardrails
Runnable as Action
LangGraph
Tools Integration
Architecture
Sequence Diagrams
Use Case Diagrams
Python SDK Reference
_compat
langchain_kwargs
actions
action_dispatcher
actions
core
llm
generation
utils
math
output_mapping
retrieve_relevant_chunks
v2_x
generation
validation
base
filter_secrets
actions_server
actions_server
cli
chat
debugger
migration
providers
colang
runtime
v1_0
lang
colang_parser
comd_parser
coyml_parser
parser
utils
runtime
eval
flows
runtime
sliding
utils
v2_x
lang
colang_ast
expansion
grammar
load
parser
transformer
utils
runtime
errors
eval
flows
runtime
serialization
statemachine
system_functions
utils
context
embeddings
basic
cache
index
providers
azureopenai
base
cohere
fastembed
google
nim
openai
registry
sentence_transformers
eval
check
cli
eval
models
ui
README
chart_utils
common
streamlit_utils
utils
utils
evaluate
cli
evaluate
simplify_formatter
evaluate_factcheck
evaluate_hallucination
evaluate_moderation
evaluate_topical
utils
exceptions
guardrails
_http
api_engine
async_work_queue
base_engine
engine_registry
guardrails
guardrails_types
iorails
model_engine
rail_action
rails_manager
telemetry
imports
integrations
langchain
actions
actions
safetools
exceptions
helpers
langchain_initializer
llm_adapter
message_utils
middleware
providers
huggingface
pipeline
streamers
providers
trtllm
client
llm
runnable_rails
utils
kb
kb
utils
library
activefence
actions
ai_defense
actions
autoalign
actions
clavata
actions
errs
request
utils
cleanlab
actions
content_safety
actions
crowdstrike_aidr
actions
factchecking
align_score
actions
request
server
fiddler
actions
gcp_moderate_text
actions
gliner
actions
models
request
guardrails_ai
actions
errors
registry
hallucination
actions
injection_detection
actions
yara_config
jailbreak_detection
actions
heuristics
checks
model_based
checks
models
request
server
llama_guard
actions
pangea
actions
patronusai
actions
policyai
actions
privateai
actions
request
prompt_security
actions
regex
actions
self_check
facts
actions
input_check
actions
output_check
actions
sensitive_data_detection
actions
topic_safety
actions
trend_micro
actions
llm
cache
interface
lfu
utils
clients
_errors
_sse
base
constants
openai_compatible
constants
filters
frameworks
default
registry
openai_reasoning
output_parsers
prompts
taskmanager
types
logging
explain
llm_tracker
processing_log
simplify_formatter
stats
verbose
patch_asyncio
rails
llm
buffer
config
llmrails
options
utils
registry
server
api
app
datastore
datastore
memory_store
redis_store
singleton
streaming
telemetry
testing
chat_harness
fake_model
fixtures
tracing
adapters
base
filesystem
opentelemetry
registry
constants
interaction_types
span_extractors
span_format
span_formatting
spans
tracer
types
utils
CLI
Create Chat Completion
List Models
List Guardrails Configurations
List Challenges
Get Server Health or Chat UI
Migrating to 0.22
Troubleshooting
Security
Telemetry and Privacy
Research

On this page

Submodules

Reference Python SDK Reference actions

nemoguardrails.actions.v2_x

||View as Markdown|

Submodules

nemoguardrails.actions.v2_x.generation

Developer-friendly docs for your API