widget interim results now are configurable for performance reasons

Author: Hectruendo

admin/components/widget_config/WidgetConfig.vue

@@ -48,6 +48,7 @@
                         'speech_recognition_always_on',
                         'speech_recognition_phrase_activation',
                         'speech_recognition_beep',
+                        'speech_recognition_interim_results',
                         'speech_synthesis',
                         'speech_synthesis_pitch',
                         'speech_synthesis_rate',

back/back/apps/widget/migrations/0037_historicalwidget_speech_recognition_interim_results_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.2.19 on 2025-03-25 15:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("widget", "0036_alter_historicalwidget_domain_alter_widget_domain"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="historicalwidget",
+            name="speech_recognition_interim_results",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="widget",
+            name="speech_recognition_interim_results",
+            field=models.BooleanField(default=False),
+        ),
+    ]

back/back/apps/widget/models.py

@@ -65,6 +65,8 @@ class Widget(models.Model):
     speech_recognition_auto_send = models.BooleanField(default=False)
     speech_recognition_phrase_activation = models.CharField(max_length=255, null=True, blank=True)
     speech_recognition_beep = models.BooleanField(default=False)
+    speech_recognition_interim_results = models.BooleanField(default=False)
+
     # # out
     speech_synthesis = models.BooleanField(default=False)
     speech_synthesis_pitch = models.FloatField(default=1.0, validators=[MinValueValidator(0.0), MaxValueValidator(2.0)])

widget/components/Widget.vue

@@ -82,6 +82,7 @@ const props = defineProps({
     speechRecognitionAlwaysOn: Boolean,
     speechRecognitionBeep: Boolean,
     speechRecognitionPhraseActivation: String,
+    speechRecognitionInterimResults: Boolean,
     allowAttachments: Boolean,
     authToken: String,
     disableDayNightMode: Boolean,
@@ -170,6 +171,7 @@ function initStore() {
     store.speechRecognitionAlwaysOn = data.speechRecognitionAlwaysOn && !data.speechRecognitionPhraseActivation
     store.speechRecognitionAutoSend = data.speechRecognitionAutoSend || data.speechRecognitionAlwaysOn
     store.speechRecognitionPhraseActivation = !data.speechRecognitionAlwaysOn ? data.speechRecognitionPhraseActivation : undefined
+    store.speechRecognitionInterimResults = data.speechRecognitionInterimResults
     store.speechRecognitionBeep = data.speechRecognitionBeep
     store.allowAttachments = data.allowAttachments
     store.authToken = data.authToken

widget/components/chat/PromptControls.vue

@@ -70,12 +70,12 @@ onMounted(async () => {
 
 })
 
-function _initSTT(continuous = false, phrase = false) {
+function _initSTT(phrase = false) {
     const sr = new (window.SpeechRecognition || window.webkitSpeechRecognition)();
     const _type =  phrase ? 'Phrase activation' : 'Transcriber'
     sr.lang = store.speechRecognitionLang;
-    sr.continuous = continuous;
-    sr.interimResults = true;
+    sr.continuous = false;
+    sr.interimResults = store.speechRecognitionInterimResults;
     sr.maxAlternatives = 1;
     sr.started = false;
 
@@ -85,16 +85,16 @@ function _initSTT(continuous = false, phrase = false) {
     sr.addEventListener("start", () => {
         sr.started = true;
         if (window.speechDebug)
-            console.log(`STT ${ _type } started`, 'color: #ffcc00');
+            console.log(`%c STT ${ _type } started`, 'color: #ffcc00');
     })
     sr.addEventListener("end", () => {
         sr.started = false;
         if (window.speechDebug)
-            console.log(`STT ${ _type } finished`, 'color: #ffcc00');
+            console.log(`%c STT ${ _type } finished`, 'color: #ffcc00');
     })
 
     sr.onerror = (event) => {
-        console.log(`Error occurred in the speech recognition: ${ _type } `, event)
+        console.log(`%c Error occurred in the speech recognition: ${ _type } `, 'color: #ff0000', event)
         // Don't restart if we got a not-allowed error, usually because the user has not granted permission
         if (event.error === 'not-allowed') {
             store.speechRecognition = false;  // Disable speech recognition entirely
@@ -151,7 +151,7 @@ function initSTT() {
 }
 
 function initSTTPhrase() {
-    sttPhrase.value = _initSTT(true, true);
+    sttPhrase.value = _initSTT(true);
 
     sttPhrase.value.onresult = (event) => {
         const text = sttPhrase.value.gatherText(event)
@@ -177,7 +177,7 @@ function initSTTPhrase() {
         }
     })
     if (window.speechDebug)
-        console.log(`starting phrase activation SR... `, 'color: #ffcc00');
+        console.log(`%c starting phrase activation SR... `, 'color: #ffcc00');
     sttPhrase.value.start();
 }
 

widget/package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "chatfaq-widget",
-    "version": "0.2.4",
+    "version": "0.2.6",
     "private": false,
     "main": "./dist/chatfaq-widget.umd.cjs",
     "module": "./dist/chatfaq-widget.mjs",

widget/package.json

@@ -47,6 +47,7 @@ export const useGlobalStore = defineStore('globalStore', {
             speechRecognitionAlwaysOn: false,
             speechRecognitionLang: 'en-US',
             speechRecognitionPhraseActivation: undefined,
+            speechRecognitionInterimResults: false,
             speechRecognitionBeep: false,
             allowAttachments: false,
             authToken: undefined,