Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 3.12 KB

README.md

File metadata and controls

46 lines (33 loc) · 3.12 KB

Agent Toolkit User Interface Integration

Complexity: 🛑 Advanced

This example demonstrates how to integrate and use the web-based user interface of NVIDIA NeMo Agent Toolkit for interactive workflow management. Learn to set up, configure, and customize the UI for seamless agent interaction through both HTTP and WebSocket connections.

Key Features

  • Web-Based Interactive Interface: Provides a complete web UI for interacting with NeMo Agent Toolkit workflows through an intuitive chat interface with conversation history and real-time responses.
  • Multi-Connection Support: Demonstrates both HTTP and WebSocket connection modes for different use cases, enabling both simple request-response patterns and real-time streaming interactions.
  • Real-Time Streaming: Shows how to enable intermediate step streaming for enhanced user experience, allowing users to see agent reasoning and tool execution in real-time.
  • UI Customization Options: Supports theme customization, endpoint configuration, and display options to match different deployment environments and user preferences.
  • Conversation Management: Includes conversation history, session management, and context preservation across multiple interactions within the same session.
  • Human-in-the-Loop Support: Interactive prompts and OAuth consent handling for workflows requiring user input or authentication.

What You'll Learn

  • UI setup and configuration: Launch and configure the Agent toolkit web interface
  • Interactive workflow management: Use the UI to interact with agents and view conversation history
  • Connection management: Configure HTTP and WebSocket connections for different use cases
  • Real-time streaming: Enable intermediate step streaming for enhanced user experience
  • UI customization: Customize themes, endpoints, and display options through environment variables

Quick Start

For complete setup and usage instructions, refer to the comprehensive guide: Launching the UI.

Important

Workflows requiring human input or interaction (such as human-in-the-loop workflows, OAuth authentication, or interactive prompts) must use WebSocket connections. HTTP requests are the default method of communication, but human-in-the-loop functionality is not supported through HTTP. Ensure that WebSocket mode is enabled in the UI by navigating to the top-right corner and selecting the WebSocket option in the arrow pop-out.