Support initial silence timeout (#5400)

* Bump [email protected] * Support initialSilenceTimeout * Add sample for initialSilenceTimeout * Update to MSI token * Add sample * Update PR number * Update [email protected] bump
microsoft · Jan 7, 2025 · 5289ce3 · 5289ce3
1 parent c3857bf
commit 5289ce3
Show file tree

Hide file tree

Showing 14 changed files with 347 additions and 66 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -72,6 +72,7 @@ Notes: web developers are advised to use [`~` (tilde range)](https://github.com/
    -  Copy button is added to fenced code blocks (`<pre><code>`)
    -  Configure HTML sanitizer via `request.allowedTags`
 -  Added support for math blocks using `$$` delimiter alongside existing `\[...\]` and `\(...\)` notations, in PR [#5381](https://github.com/microsoft/BotFramework-WebChat/pull/5381), by [@OEvgeny](https://github.com/OEvgeny)
+-  Added support for speech recognition initial silence timeout when using Azure Speech, in PR [#5400](https://github.com/microsoft/BotFramework/WebChat/pull/5400), by [@compulim](https://github.com/compulim)
 
 ### Changed
 
@@ -93,9 +94,9 @@ Notes: web developers are advised to use [`~` (tilde range)](https://github.com/
 -  Switched math block syntax from `$$` to Tex-style `\[ \]` and `\( \)` delimiters with improved rendering and error handling, in PR [#5353](https://github.com/microsoft/BotFramework-WebChat/pull/5353), by [@OEvgeny](https://github.com/OEvgeny)
 -  Improved avatar display and grouping behavior by fixing rendering issues and activity sender identification, in PR [#5346](https://github.com/microsoft/BotFramework-WebChat/pull/5346), by [@OEvgeny](https://github.com/OEvgeny)
 -  Activity "copy" button will use `outerHTML` and `textContent` for clipboard content, in PR [#5378](https://github.com/microsoft/BotFramework-WebChat/pull/5378), by [@compulim](https://github.com/compulim)
--  Bumped dependencies to the latest versions, by [@compulim](https://github.com/compulim) in PR [#5385](https://github.com/microsoft/BotFramework-WebChat/pull/5385)
+-  Bumped dependencies to the latest versions, by [@compulim](https://github.com/compulim) in PR [#5385](https://github.com/microsoft/BotFramework-WebChat/pull/5385) and [#5400](https://github.com/microsoft/BotFramework-WebChat/pull/5400)
    -  Production dependencies
-      -  [`web-speech-cognitive-services@8.0.0`](https://npmjs.com/package/web-speech-cognitive-services)
+      -  [`web-speech-cognitive-services@8.1.0`](https://npmjs.com/package/web-speech-cognitive-services)
 
 ### Fixed
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/bundle/package.json b/packages/bundle/package.json
@@ -141,7 +141,7 @@
     "swiper": "8.4.7",
     "url-search-params-polyfill": "8.2.5",
     "uuid": "8.3.2",
-    "web-speech-cognitive-services": "^8.0.0",
+    "web-speech-cognitive-services": "^8.1.0",
     "whatwg-fetch": "3.6.20"
   },
   "devDependencies": {

diff --git a/packages/bundle/src/createCognitiveServicesSpeechServicesPonyfillFactory.ts b/packages/bundle/src/createCognitiveServicesSpeechServicesPonyfillFactory.ts
@@ -13,6 +13,7 @@ export default function createCognitiveServicesSpeechServicesPonyfillFactory({
   audioInputDeviceId,
   credentials,
   enableTelemetry,
+  initialSilenceTimeout,
   speechRecognitionEndpointId,
   speechSynthesisDeploymentId,
   speechSynthesisOutputFormat,
@@ -23,6 +24,7 @@ export default function createCognitiveServicesSpeechServicesPonyfillFactory({
   audioInputDeviceId?: string;
   credentials: CognitiveServicesCredentials;
   enableTelemetry?: true;
+  initialSilenceTimeout?: number | undefined;
   speechRecognitionEndpointId?: string;
   speechSynthesisDeploymentId?: string;
   speechSynthesisOutputFormat?: CognitiveServicesAudioOutputFormat;
@@ -61,6 +63,7 @@ export default function createCognitiveServicesSpeechServicesPonyfillFactory({
         audioContext,
         credentials,
         enableTelemetry,
+        initialSilenceTimeout,
         referenceGrammars: referenceGrammarID ? [`luis/${referenceGrammarID}-PRODUCTION`] : [],
         speechRecognitionEndpointId,
         speechSynthesisDeploymentId,

diff --git a/packages/directlinespeech/package.json b/packages/directlinespeech/package.json
@@ -120,7 +120,7 @@
     "event-target-shim": "6.0.2",
     "math-random": "2.0.1",
     "microsoft-cognitiveservices-speech-sdk": "1.17.0",
-    "web-speech-cognitive-services": "^8.0.0"
+    "web-speech-cognitive-services": "^8.1.0"
   },
   "engines": {
     "node": ">= 10.14.2"

diff --git a/samples/03.speech/b.cognitive-speech-services-js/index.html b/samples/03.speech/b.cognitive-speech-services-js/index.html
@@ -43,16 +43,19 @@
           // https://docs.microsoft.com/en-us/azure/cognitive-services/authentication#authenticate-with-an-authentication-token
           if (now > expireAfter) {
             expireAfter = now + 300000;
-            lastPromise = fetch('https://webchat-mockbot.azurewebsites.net/speechservices/token', {
-              method: 'POST'
-            }).then(
-              res => res.json(),
-              err => {
-                expireAfter = 0;
+            lastPromise = fetch(
+              'https://hawo-mockbot4-token-app.blueriver-ce85e8f0.westus.azurecontainerapps.io/api/token/speech/msi',
+              { method: 'POST' }
+            )
+              .then(
+                res => res.json(),
+                err => {
+                  expireAfter = 0;
 
-                return Promise.reject(err);
-              }
-            );
+                  return Promise.reject(err);
+                }
+              )
+              .then(({ region, token }) => ({ authorizationToken: `Bearer ${token}`, region }));
           }
 
           return lastPromise;

diff --git a/samples/03.speech/c.cognitive-speech-services-with-lexical-result/index.html b/samples/03.speech/c.cognitive-speech-services-with-lexical-result/index.html
@@ -43,16 +43,19 @@
           // https://docs.microsoft.com/en-us/azure/cognitive-services/authentication#authenticate-with-an-authentication-token
           if (now > expireAfter) {
             expireAfter = now + 300000;
-            lastPromise = fetch('https://webchat-mockbot.azurewebsites.net/speechservices/token', {
-              method: 'POST'
-            }).then(
-              res => res.json(),
-              err => {
-                expireAfter = 0;
+            lastPromise = fetch(
+              'https://hawo-mockbot4-token-app.blueriver-ce85e8f0.westus.azurecontainerapps.io/api/token/speech/msi',
+              { method: 'POST' }
+            )
+              .then(
+                res => res.json(),
+                err => {
+                  expireAfter = 0;
 
-                return Promise.reject(err);
-              }
-            );
+                  return Promise.reject(err);
+                }
+              )
+              .then(({ region, token }) => ({ authorizationToken: `Bearer ${token}`, region }));
           }
 
           return lastPromise;

diff --git a/samples/03.speech/d.cognitive-speech-services-speech-recognition-only/index.html b/samples/03.speech/d.cognitive-speech-services-speech-recognition-only/index.html
@@ -43,16 +43,19 @@
           // https://docs.microsoft.com/en-us/azure/cognitive-services/authentication#authenticate-with-an-authentication-token
           if (now > expireAfter) {
             expireAfter = now + 300000;
-            lastPromise = fetch('https://webchat-mockbot.azurewebsites.net/speechservices/token', {
-              method: 'POST'
-            }).then(
-              res => res.json(),
-              err => {
-                expireAfter = 0;
+            lastPromise = fetch(
+              'https://hawo-mockbot4-token-app.blueriver-ce85e8f0.westus.azurecontainerapps.io/api/token/speech/msi',
+              { method: 'POST' }
+            )
+              .then(
+                res => res.json(),
+                err => {
+                  expireAfter = 0;
 
-                return Promise.reject(err);
-              }
-            );
+                  return Promise.reject(err);
+                }
+              )
+              .then(({ region, token }) => ({ authorizationToken: `Bearer ${token}`, region }));
           }
 
           return lastPromise;

diff --git a/samples/03.speech/e.select-voice/index.html b/samples/03.speech/e.select-voice/index.html
@@ -43,16 +43,19 @@
           // https://docs.microsoft.com/en-us/azure/cognitive-services/authentication#authenticate-with-an-authentication-token
           if (now > expireAfter) {
             expireAfter = now + 300000;
-            lastPromise = fetch('https://webchat-mockbot.azurewebsites.net/speechservices/token', {
-              method: 'POST'
-            }).then(
-              res => res.json(),
-              err => {
-                expireAfter = 0;
+            lastPromise = fetch(
+              'https://hawo-mockbot4-token-app.blueriver-ce85e8f0.westus.azurecontainerapps.io/api/token/speech/msi',
+              { method: 'POST' }
+            )
+              .then(
+                res => res.json(),
+                err => {
+                  expireAfter = 0;
 
-                return Promise.reject(err);
-              }
-            );
+                  return Promise.reject(err);
+                }
+              )
+              .then(({ region, token }) => ({ authorizationToken: `Bearer ${token}`, region }));
           }
 
           return lastPromise;

diff --git a/samples/03.speech/g.hybrid-speech/index.html b/samples/03.speech/g.hybrid-speech/index.html
@@ -43,16 +43,19 @@
           // https://docs.microsoft.com/en-us/azure/cognitive-services/authentication#authenticate-with-an-authentication-token
           if (now > expireAfter) {
             expireAfter = now + 300000;
-            lastPromise = fetch('https://webchat-mockbot.azurewebsites.net/speechservices/token', {
-              method: 'POST'
-            }).then(
-              res => res.json(),
-              err => {
-                expireAfter = 0;
-
-                return Promise.reject(err);
-              }
-            );
+            lastPromise = fetch(
+              'https://hawo-mockbot4-token-app.blueriver-ce85e8f0.westus.azurecontainerapps.io/api/token/speech/msi',
+              { method: 'POST' }
+            )
+              .then(
+                res => res.json(),
+                err => {
+                  expireAfter = 0;
+
+                  return Promise.reject(err);
+                }
+              )
+              .then(({ region, token }) => ({ authorizationToken: `Bearer ${token}`, region }));
           }
 
           return lastPromise;

diff --git a/samples/03.speech/h.select-audio-input-device/index.html b/samples/03.speech/h.select-audio-input-device/index.html
@@ -39,16 +39,19 @@
           // https://docs.microsoft.com/en-us/azure/cognitive-services/authentication#authenticate-with-an-authentication-token
           if (now > expireAfter) {
             expireAfter = now + 300000;
-            lastPromise = fetch('https://webchat-mockbot.azurewebsites.net/speechservices/token', {
-              method: 'POST'
-            }).then(
-              res => res.json(),
-              err => {
-                expireAfter = 0;
+            lastPromise = fetch(
+              'https://hawo-mockbot4-token-app.blueriver-ce85e8f0.westus.azurecontainerapps.io/api/token/speech/msi',
+              { method: 'POST' }
+            )
+              .then(
+                res => res.json(),
+                err => {
+                  expireAfter = 0;
 
-                return Promise.reject(err);
-              }
-            );
+                  return Promise.reject(err);
+                }
+              )
+              .then(({ region, token }) => ({ authorizationToken: `Bearer ${token}`, region }));
           }
 
           return lastPromise;