[voice] Allow speech-to-text services to emit empty error events (openhab#16922)

GiviMAD · web-flow · commit 9512f8f8944a · 2024-06-23T23:21:55.000+02:00
* [voice] Align speech-to-text services error events to core

Signed-off-by: Miguel Álvarez &lt;miguelwork92@gmail.com&gt;
diff --git a/bundles/org.openhab.voice.googlestt/src/main/java/org/openhab/voice/googlestt/internal/GoogleSTTService.java b/bundles/org.openhab.voice.googlestt/src/main/java/org/openhab/voice/googlestt/internal/GoogleSTTService.java
@@ -405,10 +405,8 @@ public void onComplete() {
                 String transcript = transcriptBuilder.toString();
                 if (!transcript.isBlank()) {
                     sttListener.sttEventReceived(new SpeechRecognitionEvent(transcript, averageConfidence));
-                } else if (!config.noResultsMessage.isBlank()) {
-                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));
                 } else {
-                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent("No results"));
+                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));
                 }
             }
         }
@@ -418,13 +416,7 @@ public void onError(@Nullable Throwable t) {
             logger.warn("Recognition error: ", t);
             if (!aborted.getAndSet(true)) {
                 sttListener.sttEventReceived(new RecognitionStopEvent());
-                if (!config.errorMessage.isBlank()) {
-                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));
-                } else {
-                    String errorMessage = t.getMessage();
-                    sttListener.sttEventReceived(
-                            new SpeechRecognitionErrorEvent(errorMessage != null ? errorMessage : "Unknown error"));
-                }
+                sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));
             }
         }
 
diff --git a/bundles/org.openhab.voice.voskstt/src/main/java/org/openhab/voice/voskstt/internal/VoskSTTService.java b/bundles/org.openhab.voice.voskstt/src/main/java/org/openhab/voice/voskstt/internal/VoskSTTService.java
@@ -271,27 +271,15 @@ private Future<?> backgroundRecognize(STTListener sttListener, InputStream audio
                     if (!transcript.isBlank()) {
                         sttListener.sttEventReceived(new SpeechRecognitionEvent(transcript, 1F));
                     } else {
-                        if (!config.noResultsMessage.isBlank()) {
-                            sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));
-                        } else {
-                            sttListener.sttEventReceived(new SpeechRecognitionErrorEvent("No results"));
-                        }
+                        sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));
                     }
                 }
             } catch (IOException e) {
                 logger.warn("Error running speech to text: {}", e.getMessage());
-                if (config.errorMessage.isBlank()) {
-                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent("Error"));
-                } else {
-                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));
-                }
+                sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));
             } catch (UnsatisfiedLinkError e) {
                 logger.warn("Missing native dependency: {}", e.getMessage());
-                if (config.errorMessage.isBlank()) {
-                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent("Error"));
-                } else {
-                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));
-                }
+                sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));
             } finally {
                 if (recognizer != null) {
                     recognizer.close();
diff --git a/bundles/org.openhab.voice.watsonstt/README.md b/bundles/org.openhab.voice.watsonstt/README.md
@@ -51,6 +51,7 @@ org.openhab.voice.watsonstt:optOutLogging=false
 org.openhab.voice.watsonstt:smartFormatting=false
 org.openhab.voice.watsonstt:redaction=false
 org.openhab.voice.watsonstt:noResultsMessage="Sorry, I didn't understand you"
+org.openhab.voice.watsonstt:errorMessage="Sorry, something went wrong"
 ```
 
 ### Default Speech-to-Text Configuration
diff --git a/bundles/org.openhab.voice.watsonstt/src/main/java/org/openhab/voice/watsonstt/internal/WatsonSTTConfiguration.java b/bundles/org.openhab.voice.watsonstt/src/main/java/org/openhab/voice/watsonstt/internal/WatsonSTTConfiguration.java
@@ -63,7 +63,13 @@ public class WatsonSTTConfiguration {
     /**
      * Message to be told when no results
      */
-    public String noResultsMessage = "No results";
+    public String noResultsMessage = "Sorry, I didn't understand you";
+
+    /**
+     * Message to be told when an error has happened
+     */
+    public String errorMessage = "Sorry, something went wrong";
+
     /**
      * By default, all IBM Watson™ services log requests and their results. Logging is done only to improve the services
      * for future users. The logged data is not shared or made public.
diff --git a/bundles/org.openhab.voice.watsonstt/src/main/java/org/openhab/voice/watsonstt/internal/WatsonSTTService.java b/bundles/org.openhab.voice.watsonstt/src/main/java/org/openhab/voice/watsonstt/internal/WatsonSTTService.java
@@ -311,8 +311,7 @@ public void onError(@Nullable Exception e) {
             }
             logger.warn("TranscriptionError: {}", errorMessage);
             if (!aborted.getAndSet(true)) {
-                sttListener.sttEventReceived(
-                        new SpeechRecognitionErrorEvent(errorMessage != null ? errorMessage : "Unknown error"));
+                sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));
             }
         }
 
@@ -327,11 +326,7 @@ public void onDisconnected() {
                 if (!transcript.isBlank()) {
                     sttListener.sttEventReceived(new SpeechRecognitionEvent(transcript, averageConfidence));
                 } else {
-                    if (!config.noResultsMessage.isBlank()) {
-                        sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));
-                    } else {
-                        sttListener.sttEventReceived(new SpeechRecognitionErrorEvent("No results"));
-                    }
+                    sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));
                 }
             }
         }
diff --git a/bundles/org.openhab.voice.watsonstt/src/main/resources/OH-INF/config/config.xml b/bundles/org.openhab.voice.watsonstt/src/main/resources/OH-INF/config/config.xml
@@ -47,7 +47,12 @@
 		<parameter name="noResultsMessage" type="text" groupName="stt">
 			<label>No Results Message</label>
 			<description>Message to be told when no transcription is done.</description>
-			<default>No results</default>
+			<default>Sorry, I didn't understand you</default>
+		</parameter>
+		<parameter name="errorMessage" type="text" groupName="stt">
+			<label>Error Message</label>
+			<description>Message to be told when an error has happened.</description>
+			<default>Sorry, something went wrong</default>
 		</parameter>
 		<parameter name="singleUtteranceMode" type="boolean" groupName="stt">
 			<label>Single Utterance Mode</label>
diff --git a/bundles/org.openhab.voice.watsonstt/src/main/resources/OH-INF/i18n/watsonstt.properties b/bundles/org.openhab.voice.watsonstt/src/main/resources/OH-INF/i18n/watsonstt.properties
@@ -12,6 +12,8 @@ voice.config.watsonstt.maxSilenceSeconds.label = Max Silence Seconds
 voice.config.watsonstt.maxSilenceSeconds.description = The time in seconds after which, if only silence (no speech) is detected in the audio, the connection is closed.
 voice.config.watsonstt.noResultsMessage.label = No Results Message
 voice.config.watsonstt.noResultsMessage.description = Message to be told when no transcription is done.
+voice.config.watsonstt.errorMessage.label = Error Message
+voice.config.watsonstt.errorMessage.description = Message to be told when an error has happened.
 voice.config.watsonstt.optOutLogging.label = Opt Out Logging
 voice.config.watsonstt.optOutLogging.description = By default, all IBM Watson™ services log requests and their results. Logging is done only to improve the services for future users. The logged data is not shared or made public.
 voice.config.watsonstt.preferMultimediaModel.label = Prefer Multimedia Model

Original file line number	Diff line number	Diff line change
`@@ -405,10 +405,8 @@ public void onComplete() {`
`405`	`405`	`String transcript = transcriptBuilder.toString();`
`406`	`406`	`if (!transcript.isBlank()) {`
`407`	`407`	`sttListener.sttEventReceived(new SpeechRecognitionEvent(transcript, averageConfidence));`
`408`		`- } else if (!config.noResultsMessage.isBlank()) {`
`409`		`- sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));`
`410`	`408`	`} else {`
`411`		`- sttListener.sttEventReceived(new SpeechRecognitionErrorEvent("No results"));`
	`409`	`+ sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));`
`412`	`410`	`}`
`413`	`411`	`}`
`414`	`412`	`}`
`@@ -418,13 +416,7 @@ public void onError(@Nullable Throwable t) {`
`418`	`416`	`logger.warn("Recognition error: ", t);`
`419`	`417`	`if (!aborted.getAndSet(true)) {`
`420`	`418`	`sttListener.sttEventReceived(new RecognitionStopEvent());`
`421`		`- if (!config.errorMessage.isBlank()) {`
`422`		`- sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));`
`423`		`- } else {`
`424`		`- String errorMessage = t.getMessage();`
`425`		`- sttListener.sttEventReceived(`
`426`		`- new SpeechRecognitionErrorEvent(errorMessage != null ? errorMessage : "Unknown error"));`
`427`		`- }`
	`419`	`+ sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));`
`428`	`420`	`}`
`429`	`421`	`}`
`430`	`422`
Original file line number	Diff line number	Diff line change
`@@ -311,8 +311,7 @@ public void onError(@Nullable Exception e) {`
`311`	`311`	`}`
`312`	`312`	`logger.warn("TranscriptionError: {}", errorMessage);`
`313`	`313`	`if (!aborted.getAndSet(true)) {`
`314`		`- sttListener.sttEventReceived(`
`315`		`- new SpeechRecognitionErrorEvent(errorMessage != null ? errorMessage : "Unknown error"));`
	`314`	`+ sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.errorMessage));`
`316`	`315`	`}`
`317`	`316`	`}`
`318`	`317`
`@@ -327,11 +326,7 @@ public void onDisconnected() {`
`327`	`326`	`if (!transcript.isBlank()) {`
`328`	`327`	`sttListener.sttEventReceived(new SpeechRecognitionEvent(transcript, averageConfidence));`
`329`	`328`	`} else {`
`330`		`- if (!config.noResultsMessage.isBlank()) {`
`331`		`- sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));`
`332`		`- } else {`
`333`		`- sttListener.sttEventReceived(new SpeechRecognitionErrorEvent("No results"));`
`334`		`- }`
	`329`	`+ sttListener.sttEventReceived(new SpeechRecognitionErrorEvent(config.noResultsMessage));`
`335`	`330`	`}`
`336`	`331`	`}`
`337`	`332`	`}`