Merge pull request #195473 from eric-urban/eur/sdk-1-21

Eur/sdk-1-21

Author: hmacgregor1

articles/cognitive-services/Speech-Service/how-to-use-custom-entity-pattern-matching.md

@@ -29,17 +29,14 @@ In this guide, you use the Speech SDK to develop a console application that deri
 > - Add custom entities via the Speech SDK API
 > - Use asynchronous, event-driven continuous recognition
 
-## When should you use this?
+## When to use pattern matching
 
-Use this sample code if:
+Use this sample code if: 
+* You're only interested in matching strictly what the user said. These patterns match more aggressively than LUIS.
+* You don't have access to a [LUIS](../LUIS/index.yml) app, but still want intents. 
+* You can't or don't want to create a [LUIS](../LUIS/index.yml) app but you still want some voice-commanding capability.
 
-- You are only interested in matching very strictly what the user said. These patterns match more aggressively than LUIS.
-- You do not have access to a [LUIS](../LUIS/index.yml) app, but still want intents. This can be helpful since it is embedded within the SDK.
-- You cannot or do not want to create a LUIS app but you still want some voice-commanding capability.
-
-If you do not have access to a [LUIS](../LUIS/index.yml) app, but still want intents, this can be helpful since it is embedded within the SDK.
-
-For supported locales see [here](./language-support.md?tabs=IntentRecognitionPatternMatcher).
+For more information, see the [pattern matching overview](./pattern-matching-overview.md).
 
 ## Prerequisites
 
@@ -48,10 +45,6 @@ Be sure you have the following items before you begin this guide:
 - A [Cognitive Services Azure resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices) or a [Unified Speech resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesSpeechServices)
 - [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/) (any edition).
 
-## Pattern Matching Model overview
-
-[!INCLUDE [Pattern Matching Overview](includes/pattern-matching-overview.md)]
-
 ::: zone pivot="programming-language-csharp"
 [!INCLUDE [csharp](includes/how-to/intent-recognition/csharp/pattern-matching.md)]
 ::: zone-end

articles/cognitive-services/Speech-Service/how-to-use-simple-language-pattern-matching.md

@@ -8,7 +8,7 @@ manager: travisw
 ms.service: cognitive-services
 ms.subservice: speech-service
 ms.topic: how-to
-ms.date: 11/15/2021
+ms.date: 04/19/2022
 ms.author: chschrae
 zone_pivot_groups: programming-languages-set-nine
 ms.custom: devx-track-cpp, devx-track-csharp, mode-other
@@ -28,16 +28,14 @@ In this guide, you use the Speech SDK to develop a C++ console application that
 > - Recognize speech from a microphone
 > - Use asynchronous, event-driven continuous recognition
 
-## When should you use this?
+## When to use pattern matching
 
 Use this sample code if: 
-* You are only interested in matching very strictly what the user said. These patterns match more aggressively than LUIS.
-* You do not have access to a [LUIS](../LUIS/index.yml) app, but still want intents. This can be helpful since it is embedded within the SDK.
-* You cannot or do not want to create a [LUIS](../LUIS/index.yml) app but you still want some voice-commanding capability.
+* You're only interested in matching strictly what the user said. These patterns match more aggressively than LUIS.
+* You don't have access to a [LUIS](../LUIS/index.yml) app, but still want intents. 
+* You can't or don't want to create a [LUIS](../LUIS/index.yml) app but you still want some voice-commanding capability.
 
-If you do not have access to a [LUIS](../LUIS/index.yml) app, but still want intents, this can be helpful since it is embedded within the SDK.
-
-For supported locales see [here](./language-support.md?tabs=IntentRecognitionPatternMatcher).
+For more information, see the [pattern matching overview](./pattern-matching-overview.md).
 
 ## Prerequisites
 
@@ -50,14 +48,12 @@ Be sure you have the following items before you begin this guide:
 
 The simple patterns are a feature of the Speech SDK and need a Cognitive Services resource or a Unified Speech resource.
 
-A pattern is a phrase that includes an Entity somewhere within it. An Entity is defined by wrapping a word in curly brackets. For example:
+A pattern is a phrase that includes an Entity somewhere within it. An Entity is defined by wrapping a word in curly brackets. This example defines an Entity with the ID "floorName", which is case-sensitive:
 
 ```
     Take me to the {floorName}
 ```
 
-This defines an Entity with the ID "floorName" which is case-sensitive.
-
 All other special characters and punctuation will be ignored.
 
 Intents will be added using calls to the IntentRecognizer->AddIntent() API.
@@ -68,4 +64,9 @@ Intents will be added using calls to the IntentRecognizer->AddIntent() API.
 
 ::: zone pivot="programming-language-cpp"
 [!INCLUDE [cpp](includes/how-to/intent-recognition/cpp/simple-pattern-matching.md)]
-::: zone-end
+::: zone-end
+
+## Next steps
+
+* Improve your pattern matching by using [custom entities](how-to-use-custom-entity-pattern-matching.md).
+* Look through our [GitHub samples](https://github.com/Azure-Samples/cognitive-services-speech-sdk).

articles/cognitive-services/Speech-Service/includes/get-speech-sdk-java.md

@@ -8,7 +8,7 @@ ms.author: eur
 
 :::row:::
     :::column span="3":::
-        The Java SDK for Android is packaged as an <a href="https://developer.android.com/studio/projects/android-library" target="_blank">AAR (Android Library)</a>, which includes the necessary libraries and required Android permissions. It's hosted in a Maven repository at `https://csspeechstorage.blob.core.windows.net/maven/` as package `com.microsoft.cognitiveservices.speech:client-sdk:1.19.0`. Make sure 1.19.0 is the latest version by [searching our GitHub repo](https://github.com/Azure-Samples/cognitive-services-speech-sdk/search?q=com.microsoft.cognitiveservices.speech%3Aclient-sdk).
+        The Java SDK for Android is packaged as an <a href="https://developer.android.com/studio/projects/android-library" target="_blank">AAR (Android Library)</a>, which includes the necessary libraries and required Android permissions. It's hosted in a Maven repository at `https://azureai.azureedge.net/maven/` as package `com.microsoft.cognitiveservices.speech:client-sdk:1.19.0`. Make sure 1.19.0 is the latest version by [searching our GitHub repo](https://github.com/Azure-Samples/cognitive-services-speech-sdk/search?q=com.microsoft.cognitiveservices.speech%3Aclient-sdk).
     :::column-end:::
     :::column:::
         <br>
@@ -22,12 +22,12 @@ To consume the package from your Android Studio project, make the following chan
 
 1. In the project-level *build.gradle* file, add the following to the `repositories` section:
       ```gradle
-      maven { url 'https://csspeechstorage.blob.core.windows.net/maven/' }
+      maven { url 'https://azureai.azureedge.net/maven/' }
       ```
 
 1. In the module-level *build.gradle* file, add the following to the `dependencies` section:
       ```gradle
-      implementation 'com.microsoft.cognitiveservices.speech:client-sdk:1.19.0'
+      implementation 'com.microsoft.cognitiveservices.speech:client-sdk:1.21.0'
       ```
 
 #### Additional resources

articles/cognitive-services/Speech-Service/includes/get-speech-sdk-macos.md

@@ -36,7 +36,7 @@ platform :osx, 10.14
 use_frameworks!
 
 target 'MyApp' do
-  pod 'MicrosoftCognitiveServicesSpeech', '~> 1.20.0'
+  pod 'MicrosoftCognitiveServicesSpeech', '~> 1.21.0'
 end
 ```
 

articles/cognitive-services/Speech-Service/includes/how-to/intent-recognition/cpp/simple-pattern-matching.md

@@ -239,9 +239,4 @@ Say something ...
 RECOGNIZED: Text = Take me to floor 7.
   Intent Id = ChangeFloors
   Floor name: = 7
-```
-
-## Next steps
-
-> Improve your pattern matching by using [custom entities](../../../../how-to-use-custom-entity-pattern-matching.md).
-
+```

articles/cognitive-services/Speech-Service/includes/how-to/intent-recognition/csharp/simple-pattern-matching.md

@@ -269,9 +269,4 @@ Say something ...
 RECOGNIZED: Text= Take me to floor 7.
   Intent Id= ChangeFloors
   FloorName= 7
-```
-
-## Next steps
-
-> Improve your pattern matching by using [custom entities](../../../../how-to-use-custom-entity-pattern-matching.md).
-
+```

articles/cognitive-services/Speech-Service/includes/how-to/remote-conversation/java/examples.md

@@ -103,7 +103,7 @@ You can obtain **remote-conversation** by editing your pom.xml file as follows.
      <repository>
        <id>maven-cognitiveservices-speech</id>
        <name>Microsoft Cognitive Services Speech Maven Repository</name>
-       <url>https://csspeechstorage.blob.core.windows.net/maven/</url>
+       <url>https://azureai.azureedge.net/maven/</url>
      </repository>
    </repositories>
    ```

articles/cognitive-services/Speech-Service/includes/pattern-matching-overview.md

@@ -14,7 +14,7 @@ Pattern matching can be customized to group together pattern intents and entitie
 
 For supported locales see [here](../language-support.md?tabs=IntentRecognitionPatternMatcher).
 
-### Patterns vs. Exact Phrases
+## Patterns vs. Exact Phrases
 
 There are two types of strings used in the pattern matcher: "exact phrases" and "patterns". It's important to understand the differences.
 
@@ -26,25 +26,25 @@ A pattern is a phrase that contains a marked entity. Entities are marked with "{
 
 > "Take me to floor {floorName}"
 
-### Outline of a PatternMatchingModel
+## Outline of a PatternMatchingModel
 
 The ``PatternMatchingModel`` contains an ID to reference that model by, a list of ``PatternMatchingIntent`` objects, and a list of ``PatternMatchingEntity`` objects.
 
-#### Pattern Matching Intents
+### Pattern Matching Intents
 
 ``PatternMatchingIntent`` objects represent a collection of phrases that will be used to evaluate speech or text in the ``IntentRecognizer``. If the phrases are matched, the ``IntentRecognitionResult`` returned will have the ID of the ``PatternMatchingIntent`` that was matched.
 
-#### Pattern Matching Entities
+### Pattern Matching Entities
 
 ``PatternMatchingEntity`` objects represent an individual entity reference and its corresponding properties that tell the ``IntentRecognizer`` how to treat it. All ``PatternMatchingEntity`` objects must have an ID that is present in a phrase or else it will never be matched.
 
-##### Entity Naming restrictions
+#### Entity Naming restrictions
 
 Entity names containing ':' characters will assign a role to an entity. (See below)
 
-### Types of Entities
+## Types of Entities
 
-#### Any Entity
+### Any Entity
 
 The "Any" entity will match any text that appears in that slot regardless of the text it contains. If we consider our previous example using the pattern "Take me to floor {floorName}", the user might say something like:
 
@@ -60,7 +60,7 @@ In this case, the utterance "Take me to the floor parking 2" would match and ret
 
 It may be tricky to handle extra text if it's captured. Perhaps the user kept talking and the utterance captured more than their command. "Take me to floor parking 2 yes Janice I heard about that let's". In this case the floorName1 would be correct, but floorName2 would = "2 yes Janice I heard about that let's". It's important to be aware of the way the Entities will match and adjust to your scenario appropriately. The Any entity type is the most basic and least precise.
 
-#### List Entity
+### List Entity
 
 The "List" entity is made up of a list of phrases that will guide the engine on how to match it. The "List" entity has two modes. "Strict" and "Fuzzy".
 
@@ -79,13 +79,13 @@ It's important to note that the Intent will not match, not just the entity.
 When an entity is of type "List" and is in "Fuzzy" mode, the engine will still match the Intent, and will return the text that appeared in the slot in the utterance even if it's not in the list. This is useful behind the scenes to help make the speech recognition better.
 
 > [!WARNING]
-> Fuzzy list entities are not currently implemented.
+> Fuzzy list entities are implemented, but not integrated into the speech recognition part. Therefore, they will match entities, but not improve speech recognition.
 
-#### Prebuilt Integer Entity
+### Prebuilt Integer Entity
 
 The "PrebuiltInteger" entity is used when you expect to get an integer in that slot. It won't match the intent if an integer cannot be found. The return value is a string representation of the number.
 
-#### Examples of a valid match and return values
+### Examples of a valid match and return values
 
 > "Two thousand one hundred and fifty-five" -> "2155"
 
@@ -97,7 +97,7 @@ The "PrebuiltInteger" entity is used when you expect to get an integer in that s
 
 If there's text that is not recognizable as a number, the entity and intent will not match.
 
-#### Examples of an invalid match
+### Examples of an invalid match
 
 > "the third"
 
@@ -113,48 +113,52 @@ Consider our elevator example.
 
 If "floorName" is a prebuilt integer entity, the expectation is that whatever text is inside the slot will represent an integer. Here a floor number would match well, but a floor with a name such as "lobby" would not.
 
-### Optional items and grouping
+## Grouping required and optional items
 
-In the pattern it's allowed to include words or entities that may be present in the utterance or not. This is especially useful for determiners like  "the", "a", or "an". This doesn't have any functional difference from hard coding out the many combinations, but can help reduce the number of patterns needed. Indicate optional items with "[" and "]". You may include multiple items in the same group by separating them with a '|' character.
+In the pattern it's allowed to include words or entities that may be present in the utterance or not. This is especially useful for determiners like  "the", "a", or "an". This doesn't have any functional difference from hard coding out the many combinations, but can help reduce the number of patterns needed. Indicate optional items with "[" and "]". Indicate required items with "(" and ")". You may include multiple items in the same group by separating them with a '|' character.
 
 To see how this would reduce the number of patterns needed consider the following set.
 
-> "Take me to the {floorName}"
+> "Take me to {floorName}"
 
 > "Take me the {floorName}"
 
-> "Take me to {floorName}"
+> "Take me {floorName}"
 
-> "take me {floorName}"
+> "Take me to {floorName} please"
 
-> "Take me to the {floorName}" please
+> "Take me the {floorName} please"
 
-> "Take me the {floorName}" please
+> "Take me {floorName} please"
 
-> "Take me to {floorName}" please
+> "Bring me {floorName} please"
 
-> "take me {floorName}" please
+> "Bring me to {floorName} please"
 
-These can all be reduced to a single pattern with optional items.
+These can all be reduced to a single pattern with grouping and optional items. First, it is possible to group "to" and "the" together as optional words like so: "[to | the]", and second we can make the "please" optional as well. Last, we can group the "bring" and "take" as required.
 
->"Take me [to | the] {floorName} [please]"
+>"(Bring | Take) me [to | the] {floorName} [please]"
 
 It's also possible to include optional entities. Imagine there are multiple parking levels and you want to match the word before the {floorName}. You could do so with a pattern like this:
 
 >"Take me to [{floorType}] {floorName}"
 
+Optionals are also very useful if you might be using keyword recognition and a push-to-talk function. This means sometimes the keyword will be present, and sometimes it won't. Assuming your keyword was "computer" your pattern would look something like this.
+
+>"[Computer] Take me to {floorName}"
+
 > [!NOTE]
 > While it's helpful to use optional items, it increases the chances of pattern collisions. This is where two patterns can match the same-spoken phrase. If this occurs, it can sometimes be solved by separating out the optional items into separate patterns.
 
-### Entity roles
+## Entity roles
 
 Inside the pattern, there may be a scenario where you want to use the same entity multiple times. Consider the scenario of booking a flight from one city to another. In this case the list of cities is the same, but it's necessary to know which city is the user coming from and which city is the destination. To accomplish this, you can use a role assigned to an entity using a ':'.
 
 > "Book a flight from {city:from} to {city:destination}"
 
 Given a pattern like this, there will be two entities in the result labeled "city:from" and "city:destination" but they'll both be referencing the "city" entity for matching purposes.
 
-### Intent Matching Priority
+## Intent Matching Priority
 
 Sometimes multiple patterns may match the same utterance. In this case, the engine will give priority to patterns as follows.
 
@@ -163,3 +167,9 @@ Sometimes multiple patterns may match the same utterance. In this case, the engi
 3. Patterns with Integer Entities.
 4. Patterns with List Entities.
 5. Patterns with Any Entities.
+
+## Next steps
+
+* Start with [simple pattern matching](../how-to-use-simple-language-pattern-matching.md).
+* Improve your pattern matching by using [custom entities](../how-to-use-custom-entity-pattern-matching.md).
+* Look through our [GitHub samples](https://github.com/Azure-Samples/cognitive-services-speech-sdk).

articles/cognitive-services/Speech-Service/includes/quickstarts/platform/java-jre.md

@@ -13,7 +13,7 @@ ms.custom: devx-track-java
 ms.author: eur
 ---
 
-This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for Java. If you just want the package name to get started on your own, the Java SDK is not available in the Maven central repository. Whether you're using Gradle or a *pom.xml* dependency file, you need to add a custom repository that points to `https://csspeechstorage.blob.core.windows.net/maven/`. (See below for the package name.)
+This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for Java. If you just want the package name to get started on your own, the Java SDK is not available in the Maven central repository. Whether you're using Gradle or a *pom.xml* dependency file, you need to add a custom repository that points to `https://azureai.azureedge.net/maven/`. (See below for the package name.)
 
 [!INCLUDE [License Notice](~/includes/cognitive-services-speech-service-license-notice.md)]
 
@@ -44,12 +44,12 @@ Gradle configurations require both a custom repository and an explicit reference
 
 repositories {
     maven {
-        url "https://csspeechstorage.blob.core.windows.net/maven/"
+        url "https://azureai.azureedge.net/maven/"
     }
 }
 
 dependencies {
-    implementation group: 'com.microsoft.cognitiveservices.speech', name: 'client-sdk', version: "1.19.0", ext: "jar"
+    implementation group: 'com.microsoft.cognitiveservices.speech', name: 'client-sdk', version: "1.21.0", ext: "jar"
 }
 ```
 

articles/cognitive-services/Speech-Service/includes/release-notes/release-notes-cli.md

@@ -6,6 +6,26 @@ ms.date: 01/08/2022
 ms.author: eur
 ---
 
+### Speech CLI 1.21.0: April 2022 release
+
+Uses Speech SDK 1.21.0.
+
+#### New features
+- WEBVTT Caption generation
+    - Added `--output vtt` support to `spx translate`
+    - Supports `--output vtt file FILENAME` to override default VTT FILENAME
+    - Supports `--output vtt file -` to write to standard output
+    - Individual VTT files are created for each target language (e.g. `--target en;de;fr`)
+- SRT Caption generation
+    - Added `--output srt` support to `spx recognize`, `spx intent`, and `spx translate`
+    - Supports `--output srt file FILENAME` to override default SRT FILENAME
+    - Supports `--output srt file -` to write to standard output
+    - For `spx translate` individual SRT files are created for each target language (e.g. `--target en;de;fr`)
+
+#### Bug fixes
+- Corrected WEBVTT timespan output to properly use `hh:mm:ss.fff` format
+
+
 ### Speech CLI 1.20.0: January 2022 release
 
 #### New features