GenAI enablement handling and doc update (open-edge-platform#1501)

Co-authored-by: kumarsjr <shashank.kumar1@intel.com>
Co-authored-by: Yogesh Pandey <yogesh.pandey@intel.com>

Author: 3 people

metro-ai-suite/smart-nvr/docs/user-guide/get-started.md

@@ -118,36 +118,29 @@ source setup.sh stop
 
 To enable Smart NVR's GenAI capabilities for intelligent event descriptions:
 
-#### 1. Update Frigate Configuration
-
-Modify `resources/frigate-config/config.yml`:
-
-```yaml
-genai:
-  enabled: true
-```
-
-#### 2. Ensure VLM Service Availability
+#### 1. Ensure VLM Service Availability
 
 Verify the VLM microservice is running and accessible at the configured endpoint.
 
-#### 3. Set Environment Variable
-
+#### 2. Set Environment Variable
 ```bash
 export NVR_GENAI=true
 export VLM_SERVING_IP=<vlm-serving-device-ip>
 export VLM_SERVING_PORT=<vlm-serving-port>
 ```
 
-#### 4. Run the application
+#### 3. Run the application
 
 Re-run the application after [configuring](./get-started.md#step-2-configure-environment) the rest of environment variables. Ensure that the environment value `export NVR_GENAI=true` is set.
 
 > **⚠️ Important Notes**:
 >
-> - This feature is experimental and may be unstable due to underlying Frigate GenAI implementation
-> - Requires VLM microservice to be running
-> - Disabled by default for system stability
+> - This feature is experimental and may be unstable due to underlying Frigate GenAI implementation.
+> - Requires VLM microservice to be running.
+> - Disabled by default for system stability.
+> - SmartNVR uses either Frigate or Scenescape for GenAI capabilities. GenAI in both cannot be enabled at the same time. If Scenescape is enabled, its capabilities are prioritized over Frigate, with Frigate used in "dumb" mode.
+> - If NVR_SCENESCAPE=true. then NVR_GENAI must be set to false. Else, error is thrown.
+
 
 ## Running Tests and Generating Coverage Report
 

metro-ai-suite/smart-nvr/setup.sh

@@ -107,6 +107,26 @@ configure_scenescape_setup() {
     fi
 }
 
+configure_genai_setup() {
+    print_info "Configuring GenAI setup based on NVR_GENAI setting"
+    
+    if [ "${NVR_GENAI}" = "True" ] || [ "${NVR_GENAI}" = "true" ]; then
+        print_info "NVR_GENAI is enabled - configuring GenAI mode"
+        
+        if [ -f "./resources/frigate-config/config.yml" ]; then
+            sed -i '/^\s*genai:/!b;n;s/enabled: false/enabled: true/' "./resources/frigate-config/config.yml"
+            # Enable Detect - required for GenAI
+            sed -i '/^\s*detect:/!b;n;s/enabled: false/enabled: true/' "./resources/frigate-config/config.yml"
+            print_success "GenAI and Detection enabled in Frigate configuration"
+        else
+            print_error "Frigate config file not found at ./resources/frigate-config/config.yml"
+            return 1
+        fi
+    else
+        print_info "NVR_GENAI is disabled"
+    fi
+}
+
 # Function to validate required environment variables
 validate_environment() {    
     # Check for NVR_GENAI flag
@@ -119,7 +139,15 @@ validate_environment() {
         print_error "NVR_SCENESCAPE environment variable is required"
         print_info "Please set it to 'true' or 'false' to enable/disable NVR SceneScape features"
         return 1
-    fi    
+    fi
+
+    # Check for incompatible configuration
+    if ([ "${NVR_SCENESCAPE}" = "True" ] || [ "${NVR_SCENESCAPE}" = "true" ]) && ([ "${NVR_GENAI}" = "True" ] || [ "${NVR_GENAI}" = "true" ]); then
+        print_error "NVR_GENAI cannot be enabled when NVR_SCENESCAPE is enabled"
+        print_info "Please set NVR_GENAI to 'false' if using SceneScape, or disable NVR_SCENESCAPE"
+        return 1
+    fi
+    
     # Check for VSS IP and port
     if [ -z "${VSS_SUMMARY_IP}" ]; then
         print_error "VSS_SUMMARY_IP environment variable is required"
@@ -201,6 +229,11 @@ start_services() {
         return 1
     fi
 
+    # Configure GenAI setup
+    if ! configure_genai_setup; then
+        return 1
+    fi
+    
     print_info "Starting Docker Compose services..."
     # Run the Docker Compose stack with all services
     docker compose -f docker/compose.yaml up -d