ACE Agent

Getting Started

• Overview
  • Structure of this Document
• Quick Start Guide
• Release Notes
  • ACE Agent Release 4.0.0
    • Key Features and Enhancements
    • Compatibility
    • Breaking Changes
    • Limitations
    • Known Issues
  • ACE Agent Release 3.0.1 EA
    • Fixed Bugs
    • Known Issues
  • ACE Agent Release 3.0.0 EA
    • Key Features and Enhancements
    • Announcements
    • Limitations
    • Known Issues

Architecture

• Architecture Introduction
  • Chat Engine Server Architecture
  • Plugin Server Architecture
  • ACE Agent Event Architecture

Deployment

• Interface Introduction
  • CLI Interface
  • HTTP Server Interface
  • Event Interface
  • gRPC Interface
• Docker Environment
  • CLI Interface
  • HTTP Server Interface
  • Event Interface
  • gRPC Interface
  • Event Interface with Speech
  • Model Deployment
• Kubernetes Environment
  • Deploying a Bot via UCS Application
  • Building a Custom Helm Chart using ACE Agent Microservices
    • Building a Chatbot UCS Application
    • Building Speech Bot UCS Application
    • Building LangChain Bot UCS Application
    • Building Event Interface-Based Bot UCS Application
• Python Environment
  • Chat Engine
    • CLI Interface
    • HTTP Server Interface
    • Event Interface
  • Plugin Server
  • Model Deployment
  • NLP Server
  • Clean Up
  • Python Native Application
• Sample Clients
  • Web Sample Application
    • Text-Based Web Sample Application
    • Speech-based Web Sample Application
    • Launching the Web Sample Application with Certificates
  • gRPC Server Sample Client
  • Chat Python Sample Client
  • Event Sample Client

Tutorials

• Building a Bot using Colang 1.0
  • Stock Bot
    • Creating a Bot
    • Specifying Bot Configurations
    • Specifying Colang Dialog Modeling
    • Testing the Bot
  • Adding a Plugin Service
  • Adding Speech to a Bot
• Building LangChain-Based Bots
  • Creating the LangChain Plugin
  • Connecting the Plugin to the Chat Controller
  • Connecting the Plugin to the Chat Engine
    • Creating the Bot and Colang Configurations
    • Testing the Bot
• Building a Bot using NVIDIA RAG Examples
  • Connecting Chat Controller to the RAG Plugin
  • Connecting the Plugin to the Chat Engine
    • Creating the Bot and Colang Configurations
    • Testing the Bot
• Building a Bot using Colang 2.0 and Event Interface
  • Prerequisites
  • Step 1: Making the Greeting Multimodal
  • Step 2: Leveraging LLMs to Answer User Questions
  • Step 3: Making the Bot Proactive
  • Step 4: Interrupting the Bot
  • Step 5: Back-Channeling
• Customizing a Bot
  • Selecting an LLM Model
  • Using an On-Premise LLM Model Deployed via NIM
  • Custom Actions
    • Creating a New Custom Action
    • Overriding a System Action
  • Using a Custom NLP Model
    • Deploying a Custom NLP Model with the NLP Server
      • Custom Model Integration using the @model_api Decorator
      • Custom Model Integration using the @pytriton Decorator
  • Customizing ASR Recognition with Word Boosting
  • Customizing TTS Pronunciation using IPA
  • Using 3rd Party Text-to-Speech (TTS) Solutions
• Deploying Multiple Bots

Sample Bots

• Sample Bots Introduction
• Food Ordering Bot
• Stock Market Bot
• Gaming Non-Playing Character (NPC) Bot
• Spanish Weather Bot
• RAG Bot
• RAG LangChain Bot
• DuckDuckGo LangChain Bot
• Colang 2.0 Bot
• Plan and Execute (LangGraph) Bot

Configuration Guide

• Bot Configurations Introduction
• General Configurations
  • Bot Name and Version
  • Configuring the NLP and Plugin Server Endpoints
  • Configuring the NLP Server Model Parameters
    • Intent Slot Models
    • Named Entity Recognizer Models
    • Text Classifier Models
  • Configuring Bot Voices
  • Multilingual Configurations
  • LLM Model Configurations
    • LangChain Models
    • NVIDIA AI Endpoints
    • Custom LLM Models using the LangChain Wrapper
    • LLM Prompts
• Slots Configurations
  • Defining Slots
  • Adding Lookup and Regex Rules
  • Adding Synonyms to Slots
  • Defining Slot Memory
  • Grouping Slots using Composite Slots
  • Correcting Slots using Slot Resolution
  • Linking Slots to Similar Slot Values
• Plugin Configurations
  • Defining Plugin
  • Adding Custom Plugin
  • Importing Parameters into Plugins
• Model Configurations
  • Triton Inference Server
  • Riva Skills Server
  • Custom Models
• Chat Engine Configurations
• Speech Configurations
  • BotRuntimeGrpc
  • SpeechPipelineManager
  • Riva ASR
  • Word Boosting
  • Chat Engine
  • Riva TTS
  • IPA Dictionary
  • Riva Logger
  • NvMsgBrokerC2DReceiver
  • NvMsgBrokerD2CTransmitter
  • Audio2FaceGrpc
  • HttpClient
  • BotControllerUMIM

User Guide

• Using Colang
• Integration with LangChain and LlamaIndex
• NLP Server
  • API Server
  • Model Registry
  • Model Servers
  • Config Manager
  • Model Manager
  • Custom Model Client
    • @model_api Decorator
    • @pytriton Decorator
• Speech AI
  • ASR Module
  • TTS Module
• Training Models
• Plugin Server
  • Using Plugin with Colang
  • Passing URL Parameters
  • Passing Context Information and Conversation History
  • Maintaining Plugin Memory
  • Accessing Custom Metadata
  • Parameter List
  • Logging and Monitoring
  • Adding Plugin Requirements
  • Interacting with the Plugin Server
• Streaming in ACE Agent
  • Streaming Overview
  • Streaming Exceptions
  • TTS Streaming

API Guide

• API Introduction
• HTTP Interface
• gRPC Interface
• Plugin Server
• NLP Server

Best Practices

• Best Practices Introduction
• Planning your Bot
  • Step 1: Choose your Bot’s Domain of Expertise
  • Step 2: Determine the Conversation Flow and Knowledge Bases
  • Step 3: Determine the Language Model
  • Step 4: Determine the Dialog Modeling Language
  • Step 5: Plan More Modalities
  • Step 6: Determine the Frontend Channel
  • Step 7: Determine the Deployment Infrastructure
• Managing Conversation Context
  • Setting Conversation Context
  • Deleting Conversation Context
  • Saving Conversation Context
• Logging and Debugging Issues
  • Log Location
  • Log Naming Convention
    • Exposing Chat Engine Logs to the Console
  • Audio and Metadata Logger
• Security Considerations

Reference

• Basic Concepts
  • Bot
  • Chat Controller
  • Chat Engine
  • Colang
  • Context
  • Entity
  • Intent
  • Knowledge Base
  • NeMo Guardrails
  • NLP Server
  • Plugin Server
  • Prompt
  • RAG (Retrieval-Augmented Generation)
  • Slot
• Support Matrix
  • Hardware
  • Software
• Migrating from Bot Maker 3.0.0 to ACE Agent 4.0.0
• Troubleshooting
• End User License Agreement
• Notices
  • Notice
  • Google
  • Trademarks
  • Copyright