Skip to main content
Ctrl+K
NVIDIA NeMo Guardrails Toolkit Developer Guide - Home NVIDIA NeMo Guardrails Toolkit Developer Guide - Home

NVIDIA NeMo Guardrails Toolkit Developer Guide

NVIDIA NeMo Guardrails Toolkit Developer Guide - Home NVIDIA NeMo Guardrails Toolkit Developer Guide - Home

NVIDIA NeMo Guardrails Toolkit Developer Guide

Table of Contents

About NeMo Guardrails Toolkit

  • Overview
  • How It Works
    • Rails Overview
    • Rails Sequence Diagrams
    • Detailed Architecture
  • Use Cases
  • Supported LLMs
  • Release Notes

Get Started

  • Installation Guide
  • Tutorials
    • Content Safety
    • Topic Control
    • Jailbreak Detection
    • Multimodal Data

Configure Rails

  • Before Configuring Rails
  • Configuration Overview
  • Core Configuration
    • Model Configuration
    • Guardrails Configuration
      • Built-in Guardrails
    • Prompt Configuration
    • Tracing Configuration
  • Custom Actions
    • Creating Custom Actions
    • Built-in Actions
    • Action Parameters
    • Registering Actions
  • Custom Initialization
    • The Init Function
    • Custom LLM Providers
    • Custom Embedding Providers
    • Custom Configuration Data
  • Colang
    • Colang 2.0 Guide
      • What’s Changed
      • Getting Started
        • Hello World
        • Dialog Rails
        • Multimodal Rails
        • Input Rails
        • Interaction Loop
        • LLM Flows
        • Recommended Next Steps
      • Language Reference
        • Introduction
        • Event Generation & Matching
        • Working with Actions
        • Defining Flows
        • Working with Variables & Expressions
        • Flow control
        • Colang Standard Library (CSL)
        • Make use of Large Language Models (LLM)
        • More on Flows
        • Python Actions
        • Development and Debugging
      • Migrating from Colang 1 to Colang 2
    • Colang 1.0 Guide
      • Colang 1.0 Guide
      • Colang 1.0 Tutorials
        • Hello World
        • Core Colang Concepts
        • Demo Use Case
        • Input Rails
        • Output Rails
        • Topical Rails
        • Retrieval-Augmented Generation
    • Colang Usage Examples
      • Bot Message Instructions
      • Extract User-provided Values
  • Other Configurations
    • Knowledge Base
    • Exceptions and Error Handling

Run Rails

  • Run Rails
  • Core Classes
  • Generation Options
  • Streaming
  • Event-based API
  • Tools Integration

Evaluation

  • Guardrails Evaluation
  • LLM Vulnerability Scanning

Observability

  • Logging
  • Tracing
    • Quick Start
    • Adapter Configurations
    • Advanced OpenTelemetry Integration
    • Troubleshooting

Deployment Guides

  • Deployment Options
  • Local Server Setup
    • Guardrails Server
    • Actions Server
  • Using Docker
  • Using NeMo Guardrails Microservice

Integration with Third-Party Libraries

  • LangChain
    • LangChain Integration
    • RunnableRails
    • LangGraph Integration
    • Chain with Guardrails
    • Runnable as Action
  • Vertex AI
  • AlignScore
  • Llama Guard

Security

  • Security Guidelines

Reference

  • Python API
  • CLI
  • Glossary
  • Frequently Asked Questions (FAQ)
  • Colang Guide
  • Colang 2.0 Guide
  • Getting Started
  • Recommended Next Steps

Recommended Next Steps#

The Colang 2.0 getting started guide introduced you to a basic Hello World example, and then goes into Dialog Rails, Input Rails, Multimodal Rails, and other Colang 2.0 concepts like Interaction Loop and LLM Flows.

This only scratches the surface of what can be achieved with Colang 2.0.

If you are an experienced developer and want to learn about the syntax and the various features in details, we recommend going through the Language Reference documentation.

Version 0.10.0 of NeMo Guardrails will add more examples including RAG and agents. Also it will bring support for the Guardrails Library, which will enable you to use any of the existing guardrails similar to Colang 1.0.

previous

LLM Flows

next

Language Reference

NVIDIA NVIDIA
Privacy Policy | Manage My Privacy | Do Not Sell or Share My Data | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2023-2025, NVIDIA Corporation.