MCPcopy Create free account
hub / github.com/NVIDIA-AI-Blueprints/video-search-and-summarization

github.com/NVIDIA-AI-Blueprints/video-search-and-summarization @v3.2.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v3.2.0 ↗ · + Follow
58,945 symbols 155,773 edges 7,635 files 17,778 documented · 30% updated 1d agov3.2.0 · 2026-06-16★ 1,7307 open issues

Browse by type

Functions 39,884 Types & classes 18,454 Endpoints 607
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

NVIDIA AI Blueprint: Video Search and Summarization (VSS)

Table of Contents

Overview

The NVIDIA Blueprint for Video Search and Summarization (VSS) provides a suite of reference architectures for building vision agents and AI-powered video analytics applications. Those architectures bring together accelerated vision microservices, vision language models (VLMs), and large language models (LLMs) so you can use them in existing applications, as standalone microservices, or as part of a larger vision agent.

VSS is organized into three areas of processing and analysis: real-time video intelligence (feature extraction, embeddings, and stream understanding with results published to a message broker), downstream analytics (enrichment of metadata into trajectories, incidents, and verified alerts), and agentic and offline processing (orchestrated tools for search, Q&A, summarization, and clip retrieval, including via the Model Context Protocol).

This repository implements the blueprint and powers the NVIDIA build experience for natural-language video agents—search, summarization, visual Q&A, and related workflows—backed by generative AI, VLMs and LLMs, and NVIDIA NIM microservices as configured in the stacks below.

Use Case / Problem Description

The NVIDIA AI Blueprint for Video Search and Summarization addresses the challenge of deploying visual agents capable of interacting with large volumes of video data, both stored and streamed. This can be used to create vision AI agents, that can be applied to a multitude of use cases such as monitoring smart spaces, warehouse automation, and SOP validation. This is important where quick and accurate video analysis can lead to better decision-making and enhanced operational efficiency.

Agent Workflows

We provide multiple reference Agent Workflows which demonstrate how the individual components can be leveraged by an agent:

Workflow Description
Q&A and Report Generation (Quickstart) Video retrieval, VLM-based Q&A, and report generation on short video clips
Alert Verification Realtime processing of videos using perception (object detection, tracking) and behavior analytics to generate alerts, which are subsequently verified with VLM to reduce false positives
Real-Time Alerts Continuous processing of video streams through VLM for anomaly detection
Video Search Natural language search across video archives using video embeddings (alpha)
Long Video Summarization Analysis and summarization of extended video recordings through chunking and aggregation of dense captions

Software Components

  1. NIM microservices: Here are models used in this blueprint:

  2. Real-time video intelligence: The Real-Time Video Intelligence layer extracts rich visual features, semantic embeddings, and contextual understanding from video data in real-time, publishing results to a message broker for downstream analytics and agentic workflows. It provides three core microservices for processing video streams.

  3. Downstream analytics: The Downstream Analytics layer processes and enriches the metadata streams generated by real-time video intelligence microservices, transforming raw detections into actionable insights and verified alerts.

  4. Agent and offline processing: The top-level agent leverages the Model Context Protocol (MCP) to access video analytics data, incident records, and vision processing capabilities through a unified tool interface. It integrates multiple vision-based tools including video understanding with Vision Language Models (VLMs), semantic video search using embeddings, long video summarization for extended footage analysis, and video snapshot/clip retrieval.

Target Audience

This blueprint is designed for ease of setup with extensive configuration options, requiring technical expertise. It is intended for:

  1. Video Analysts and IT Engineers: Professionals focused on analyzing video data and ensuring efficient processing and summarization. The blueprint offers 1-click deployment steps, easy-to-manage configurations, and plug-and-play models, making it accessible for early developers.

  2. GenAI Developers / Machine Learning Engineers: Experts who need to customize the blueprint for specific use cases. This includes modifying the pipelines for unique datasets and fine-tuning LLMs as needed. For advanced users, the blueprint provides detailed configuration options and custom deployment possibilities, enabling extensive customization and optimization.

Repository Structure Overview

Directory Description
services/agent/ Video search and summarization agent (Python). Contains src/vss_agents/ (tools, agents, APIs, embeddings, evaluators, video analytics), tests/, stubs/, docker/, and 3rdparty/. See services/agent/README.md.
services/ui/ Frontend monorepo (Next.js, Turbo): apps/ (nemo-agent-toolkit-ui, nv-metropolis-bp-vss-ui) and shared packages/. See services/ui/README.md.
services/analytics/ Downstream analytics services for processing real-time video intelligence metadata. Contains behavior analytics stream processing and REST APIs for querying analytics results.
services/analytics/behavior-analytics/ Python streaming pipeline for spatial AI analytics, incident detection, Smart City, warehouse, playback, and other behavior analytics applications. Includes app entry points, configs, Docker support, tests, and detailed guides. See services/analytics/behavior-analytics/README.md.
services/analytics/video-analytics-api/ Node.js and Express REST API service for VSS Video Analytics data. Exposes metrics, tracker, frames, behavior, clustering, events, sensor, config, alerts, and incidents endpoints backed by Elasticsearch. See services/analytics/video-analytics-api/README.md.
deploy/ Deployment configs, Docker Compose, and Helm charts: NIM model configs, developer profiles (dev-profile-base, dev-profile-search, dev-profile-alerts, dev-profile-lvs), foundational services, LVS, RTVI, VLM-as-verifier, VST, and root compose.yml. Also contains deploy/docker/scripts/ — the Brev launchable notebook and dev-profile / patch scripts.
tools/message-broker-consumers/ Multiprocessing Redis and Kafka consumers that decode VSS protobuf messages from streams/topics and export them as JSON Lines files for inspection, debugging, or offline processing. See tools/message-broker-consumers/README.md.
tools/sdg-postprocessing/ Dataset post-processing utilities for synthetic data generation workflows: semantic labeling helpers, raw data sanity checks, RGB/depth/video conversion, and ground-truth conversion for MTMC-compatible datasets. See tools/sdg-postprocessing/README.md.
tools/rtvi-cv-mv3dt-utils/ Offline utilities for generating MV3DT RTVI-CV configuration artifacts, including per-camera camInfo projection configs and MQTT publish/subscribe topology files for warehouse MV3DT deployments. See tools/rtvi-cv-mv3dt-utils/README.md.
skills/ agentskills.io-compatible agent skills for VSS: one self-contained subdirectory per skill with SKILL.md frontmatter. Covers deploy and usage of search, summarization, alerts, VIOS, RT-VLM, LVS, and other related workflows—see the catalog and install notes in skills/README.md.
libs/analytics/spatialai-data-utils/ Spatial AI Data Utils (SDU): NVSchema / ground-truth / calibration / Sparse4D loaders, camera calibration + grouping (BEV group-origin / per-group fan-out), 3D↔2D geometry, multi-cam 3D-bbox visualization, detection (mAP) + tracking (HOTA, CLEAR, identity, count) evaluators, NVSchema result converters, and video↔frame utilities. See libs/analytics/spatialai-data-utils/README.md.

Documentation

For detailed instructions and additional information about this blueprint, please refer to the official documentation.

Prerequisites

Obtain API Key

Hardware Requirements

The platform requirement can vary depending on the configuration and deployment topology used for VSS and dependencies like VLM, LLM, etc. For a list of validated GPU topologies and what configuration to use, see the GPU requirements.

Quickstart Guide

Launchable Deployment

Ideal for: Quickly getting started with your own videos without worrying about hardware and software requirements.

Follow the steps from the documentation and notebook in deploy/docker/scripts directory to complete all pre-requisites and deploy the blueprint using Brev Launchable in a 2xRTX PRO 6000 SE AWS instance. - deploy/docker/scripts/deploy_vss_launchable.ipynb: This notebook is tailored specifically for the AWS CSP which uses Ephemeral storage.

Docker Compose Deployment

Ideal for: Deploying a VSS agent on your own hardware or bare metal cloud instance.

System Requirements

  • OS:
    • x86 hosts: Ubuntu 22.04 or Ubuntu 24.04
    • DGX-SPARK: DGX OS 7.4.0
    • IGX-THOR: Jetson Linux BSP (Rel 38.5)
    • AGX-THOR: Jetson Linux BSP (Rel 38.4)
  • NVIDIA Driver:
    • 580.105.08 (x86 hosts with Ubuntu 24.04)
    • 580.65.06 (x86 hosts with Ubuntu 22.04)
    • 580.95.05 (DGX-SPARK)
    • 580.00 (IGX-THOR and AGX-THOR)
  • NVIDIA Container Toolkit: 1.17.8+
  • Docker Engine: 28.3.3 <= Docker Engine < 29.5.0
  • Docker Compose: v2.39.1+
  • NGC CLI: 4.10.0+

Docker upper bound: Docker Engine 29.5.0+ may fail pulling NGC-hosted images. Use Docker Engine 28.3.3 or another supported version below 29.5.0.

Please refer to Prerequisites section here for installation details.

Contributing

See CONTRIBUTING.md for the development workflow, branch naming convention, and PR guidelines.

License

Refer to LICENSE

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Method 28,451
Class 16,513
Function 11,433
Enum 1,427
Route 607
Interface 514

Languages

C++64%
Python31%
TypeScript5%
C1%
Ruby1%

Modules by API surface

services/vios/include/opentelemetry/proto/metrics/v1/metrics.pb.h368 symbols
libs/analytics/spatialai-data-utils/tests/visualization/test_visualization.py321 symbols
services/vios/include/opentelemetry/proto/trace/v1/trace.pb.h209 symbols
services/vios/src/framework/webrtc_streamer/inc/webrtc_headers/src/base/threading/thread_restrictions.h190 symbols
services/vios/include/opentelemetry/nostd/internal/absl/types/internal/variant.h173 symbols
services/alert/test/api/test_realtime_service.py168 symbols
services/vios/src/framework/webrtc_streamer/inc/webrtc_headers/src/pc/test/integration_test_helpers.h164 symbols
services/vios/src/framework/webrtc_streamer/inc/webrtc_headers/src/base/functional/bind_internal.h162 symbols
services/vios/src/framework/webrtc_streamer/inc/webrtc_headers/src/logging/rtc_event_log/logged_events.h159 symbols
services/vios/src/framework/utilities/utils.cpp153 symbols
services/alert/test/api/test_realtime_routes.py152 symbols
services/analytics/behavior-analytics/src/mdx/analytics/core/schema/config.py146 symbols

For agents

$ claude mcp add video-search-and-summarization \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page