Better Culture Recognition in Choice/Confirm Prompts

libraries/Microsoft.Bot.Builder.Dialogs/Prompts/ConfirmPrompt.cs

@@ -3,12 +3,13 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.Bot.Builder.Dialogs.Choices;
 using Microsoft.Bot.Schema;
 using Microsoft.Recognizers.Text.Choice;
-using static Microsoft.Recognizers.Text.Culture;
+using static Microsoft.Bot.Builder.Dialogs.Prompts.PromptCultureModels;
 
 namespace Microsoft.Bot.Builder.Dialogs
 {
@@ -17,17 +18,17 @@ namespace Microsoft.Bot.Builder.Dialogs
     /// </summary>
     public class ConfirmPrompt : Prompt<bool>
     {
-        private static readonly Dictionary<string, (Choice, Choice, ChoiceFactoryOptions)> ChoiceDefaults = new Dictionary<string, (Choice, Choice, ChoiceFactoryOptions)>()
-        {
-            { Spanish, (new Choice("Sí"), new Choice("No"), new ChoiceFactoryOptions(", ", " o ", ", o ", true)) },
-            { Dutch, (new Choice("Ja"), new Choice("Nee"), new ChoiceFactoryOptions(", ", " of ", ", of ", true)) },
-            { English, (new Choice("Yes"), new Choice("No"), new ChoiceFactoryOptions(", ", " or ", ", or ", true)) },
-            { French, (new Choice("Oui"), new Choice("Non"), new ChoiceFactoryOptions(", ", " ou ", ", ou ", true)) },
-            { German, (new Choice("Ja"), new Choice("Nein"), new ChoiceFactoryOptions(", ", " oder ", ", oder ", true)) },
-            { Japanese, (new Choice("はい"), new Choice("いいえ"), new ChoiceFactoryOptions("、 ", " または ", "、 または ", true)) },
-            { Portuguese, (new Choice("Sim"), new Choice("Não"), new ChoiceFactoryOptions(", ", " ou ", ", ou ", true)) },
-            { Chinese, (new Choice("是的"), new Choice("不"), new ChoiceFactoryOptions("， ", " 要么 ",  "， 要么 ", true)) },
-        };
+        /// <summary>
+        /// A dictionary of Default Choices based on <seealso cref="GetSupportedCultures"/>.
+        /// Can be replaced by user using the constructor that contains choiceDefaults.
+        /// </summary>
+        private readonly Dictionary<string, (Choice, Choice, ChoiceFactoryOptions)> _choiceDefaults =
+            new Dictionary<string, (Choice, Choice, ChoiceFactoryOptions)>(
+            GetSupportedCultures().ToDictionary(
+                culture => culture.Locale, culture =>
+                (new Choice(culture.YesInLanguage),
+                    new Choice(culture.NoInLanguage),
+                    new ChoiceFactoryOptions(culture.Separator, culture.InlineOr, culture.InlineOrMore, true))));
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ConfirmPrompt"/> class.
@@ -51,6 +52,29 @@ public ConfirmPrompt(string dialogId, PromptValidator<bool> validator = null, st
             DefaultLocale = defaultLocale;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConfirmPrompt"/> class.
+        /// </summary>
+        /// <param name="dialogId">The ID to assign to this prompt.</param>
+        /// <param name="validator">Optional, a <see cref="PromptValidator{FoundChoice}"/> that contains additional,
+        /// custom validation for this prompt.</param>
+        /// <param name="defaultLocale">Optional, the default locale used to determine language-specific behavior of the prompt.
+        /// The locale is a 2, 3, or 4 character ISO 639 code that represents a language or language family.</param>
+        /// <param name="choiceDefaults">Overrides the dictionary of Bot Framework SDK-supported _choiceDefaults (for prompt localization).
+        /// Must be passed in to each ConfirmPrompt that needs the custom choice defaults.</param>
+        /// <remarks>The value of <paramref name="dialogId"/> must be unique within the
+        /// <see cref="DialogSet"/> or <see cref="ComponentDialog"/> to which the prompt is added.
+        /// <para>If the <see cref="Activity.Locale"/>
+        /// of the <see cref="DialogContext"/>.<see cref="DialogContext.Context"/>.<see cref="ITurnContext.Activity"/>
+        /// is specified, then that local is used to determine language specific behavior; otherwise
+        /// the <paramref name="defaultLocale"/> is used. US-English is the used if no language or
+        /// default locale is available, or if the language or locale is not otherwise supported.</para></remarks>
+        public ConfirmPrompt(string dialogId, Dictionary<string, (Choice, Choice, ChoiceFactoryOptions)> choiceDefaults, PromptValidator<bool> validator = null, string defaultLocale = null)
+            : this(dialogId, validator, defaultLocale)
+        {
+            _choiceDefaults = choiceDefaults;
+        }
+
         /// <summary>
         /// Gets or sets the style of the yes/no choices rendered to the user when prompting.
         /// </summary>
@@ -106,7 +130,7 @@ protected override async Task OnPromptAsync(ITurnContext turnContext, IDictionar
             IMessageActivity prompt;
             var channelId = turnContext.Activity.ChannelId;
             var culture = DetermineCulture(turnContext.Activity);
-            var defaults = ChoiceDefaults[culture];
+            var defaults = _choiceDefaults[culture];
             var choiceOptions = ChoiceOptions ?? defaults.Item3;
             var confirmChoices = ConfirmChoices ?? Tuple.Create(defaults.Item1, defaults.Item2);
             var choices = new List<Choice> { confirmChoices.Item1, confirmChoices.Item2 };
@@ -160,7 +184,7 @@ protected override Task<PromptRecognizerResult<bool>> OnRecognizeAsync(ITurnCont
                 else
                 {
                     // First check whether the prompt was sent to the user with numbers - if it was we should recognize numbers
-                    var defaults = ChoiceDefaults[culture];
+                    var defaults = _choiceDefaults[culture];
                     var choiceOptions = ChoiceOptions ?? defaults.Item3;
 
                     // This logic reflects the fact that IncludeNumbers is nullable and True is the default set in Inline style
@@ -184,10 +208,10 @@ protected override Task<PromptRecognizerResult<bool>> OnRecognizeAsync(ITurnCont
 
         private string DetermineCulture(Activity activity)
         {
-            var culture = activity.Locale ?? DefaultLocale;
-            if (string.IsNullOrEmpty(culture) || !ChoiceDefaults.ContainsKey(culture))
+            var culture = MapToNearestLanguage(activity.Locale ?? DefaultLocale ?? English.Locale);
+            if (string.IsNullOrEmpty(culture) || !_choiceDefaults.ContainsKey(culture))
             {
-                culture = English;
+                culture = English.Locale;
             }
 
             return culture;

libraries/Microsoft.Bot.Builder.Dialogs/Prompts/PromptCultureModel.cs

@@ -0,0 +1,59 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Microsoft.Bot.Builder.Dialogs.Prompts
+{
+    /// <summary>
+    /// Culture model used in Choice and Confirm Prompts.
+    /// </summary>
+    public class PromptCultureModel
+    {
+        /// <summary>
+        /// Gets or Sets Culture Model's Locale.
+        /// </summary>
+        /// <value>
+        /// Ex: Locale. Example: "en-US".
+        /// </value>
+        public string Locale { get; set; }
+
+        /// <summary>
+        /// Gets or Sets Culture Model's InlineSeparator.
+        /// </summary>
+        /// <value>
+        /// Ex: Locale. Example: ", ".
+        /// </value>
+        public string Separator { get; set; }
+
+        /// <summary>
+        /// Gets or Sets Culture Model's InlineOr.
+        /// </summary>
+        /// <value>
+        /// Ex: Locale. Example: " or ".
+        /// </value>
+        public string InlineOr { get; set; }
+
+        /// <summary>
+        /// Gets or Sets Culture Model's InlineOrMore.
+        /// </summary>
+        /// <value>
+        /// Ex: Locale. Example: ", or ".
+        /// </value>
+        public string InlineOrMore { get; set; }
+
+        /// <summary>
+        /// Gets or Sets Equivalent of "Yes" in Culture Model's Language.
+        /// </summary>
+        /// <value>
+        /// Ex: Locale. Example: "Yes".
+        /// </value>
+        public string YesInLanguage { get; set; }
+
+        /// <summary>
+        /// Gets or Sets Equivalent of "No" in Culture Model's Language.
+        /// </summary>
+        /// <value>
+        /// Ex: Locale. Example: "No".
+        /// </value>
+        public string NoInLanguage { get; set; }
+    }
+}

libraries/Microsoft.Bot.Builder.Dialogs/Prompts/PromptCultureModels.cs

@@ -0,0 +1,119 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.Recognizers.Text;
+
+namespace Microsoft.Bot.Builder.Dialogs.Prompts
+{
+    /// <summary>
+    /// Class container for currently-supported Culture Models in Confirm and Choice Prompt.
+    /// </summary>
+    public static class PromptCultureModels
+    {
+        public static PromptCultureModel Chinese =>
+            new PromptCultureModel
+            {
+                InlineOr = " 要么 ",
+                InlineOrMore = "， 要么 ",
+                Locale = Culture.Chinese,
+                NoInLanguage = "不",
+                Separator = "， ",
+                YesInLanguage = "是的",
+            };
+
+        public static PromptCultureModel Dutch =>
+            new PromptCultureModel
+            {
+                InlineOr = " of ",
+                InlineOrMore = ", of ",
+                Locale = Culture.Dutch,
+                NoInLanguage = "Nee",
+                Separator = ", ",
+                YesInLanguage = "Ja",
+            };
+
+        public static PromptCultureModel English =>
+            new PromptCultureModel
+            {
+                InlineOr = " or ",
+                InlineOrMore = ", or ",
+                Locale = Culture.English,
+                NoInLanguage = "No",
+                Separator = ", ",
+                YesInLanguage = "Yes",
+            };
+
+        public static PromptCultureModel French =>
+            new PromptCultureModel
+            {
+                InlineOr = " ou ",
+                InlineOrMore = ", ou ",
+                Locale = Culture.French,
+                NoInLanguage = "Non",
+                Separator = ", ",
+                YesInLanguage = "Oui",
+            };
+
+        public static PromptCultureModel German =>
+            new PromptCultureModel
+            {
+                InlineOr = " oder ",
+                InlineOrMore = ", oder ",
+                Locale = Culture.German,
+                NoInLanguage = "Nein",
+                Separator = ", ",
+                YesInLanguage = "Ja",
+            };
+
+        public static PromptCultureModel Japanese =>
+            new PromptCultureModel
+            {
+                InlineOr = " または ",
+                InlineOrMore = "、 または ",
+                Locale = Culture.Japanese,
+                NoInLanguage = "いいえ",
+                Separator = "、 ",
+                YesInLanguage = "はい",
+            };
+
+        public static PromptCultureModel Portuguese =>
+            new PromptCultureModel
+            {
+                InlineOr = " ou ",
+                InlineOrMore = ", ou ",
+                Locale = Culture.Portuguese,
+                NoInLanguage = "Não",
+                Separator = ", ",
+                YesInLanguage = "Sim",
+            };
+
+        public static PromptCultureModel Spanish =>
+            new PromptCultureModel
+            {
+                InlineOr = " o ",
+                InlineOrMore = ", o ",
+                Locale = Culture.Spanish,
+                NoInLanguage = "No",
+                Separator = ", ",
+                YesInLanguage = "Sí",
+            };
+
+        /// <summary>
+        /// Use Recognizers-Text to normalize various potential Locale strings to a standard.
+        /// <param name="cultureCode">Represents locale. Examples: "en-US, en-us, EN".</param>
+        /// <returns>Normalized locale.</returns>
+        public static string MapToNearestLanguage(string cultureCode) => Culture.MapToNearestLanguage(cultureCode);
+
+        public static PromptCultureModel[] GetSupportedCultures() => new PromptCultureModel[]
+        {
+            Chinese,
+            Dutch,
+            English,
+            French,
+            German,
+            Japanese,
+            Portuguese,
+            Spanish,
+        };
+    }
+}