Fixes issue #3960 [QnAMaker] [DotNet] Implementing QnAMaker's precise answering capability as an additional feature for BotFramework users

libraries/Microsoft.Bot.Builder.AI.QnA/AnswerSpanRequest.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Newtonsoft.Json;
+
+namespace Microsoft.Bot.Builder.AI.QnA
+{
+    public class AnswerSpanRequest
+    {
+        /// <summary>
+        /// Gets or sets a value indicating whether gets or sets the enablet.
+        /// </summary>
+        /// <value>
+        /// The answer text.
+        /// </value>
+        [JsonProperty("enable")]
+        public bool Enable { get; set; }
+    }
+}

libraries/Microsoft.Bot.Builder.AI.QnA/Dialogs/QnAMakerDialog.cs

@@ -508,6 +508,7 @@ private async Task<DialogTurnResult> CallGenerateAnswerAsync(WaterfallStepContex
             }
 
             stepContext.Values[ValueProperty.QnAData] = result;
+
             ObjectPath.SetPathValue(stepContext.ActiveDialog.State, Options, dialogOptions);
 
             // If card is not shown, move to next step with top QnA response.
@@ -625,8 +626,23 @@ private async Task<DialogTurnResult> CheckForMultiTurnPromptAsync(WaterfallStepC
                     ObjectPath.SetPathValue(stepContext.ActiveDialog.State, PreviousQnAId, answer.Id);
                     ObjectPath.SetPathValue(stepContext.ActiveDialog.State, Options, dialogOptions);
 
+                    int contentChoice = -1;
+
+                    if (answer.AnswerSpan != null && !string.IsNullOrEmpty(answer.AnswerSpan.Text)) 
+                    {
+                        if (dialogOptions.ResponseOptions.ContentChoice.Equals(QnADialogResponseOptions.PreciseAnswer))
+                        {
+                            contentChoice = 0;
+                        }
+
+                        if (dialogOptions.ResponseOptions.ContentChoice.Equals(QnADialogResponseOptions.Both))
+                        {
+                            contentChoice = 1;
+                        }
+                    }
+
                     // Get multi-turn prompts card activity.
-                    var message = QnACardBuilder.GetQnAPromptsCard(answer, dialogOptions.ResponseOptions.CardNoMatchText);
+                    var message = QnACardBuilder.GetQnAPromptsContentCard(answer, dialogOptions.ResponseOptions.CardNoMatchText, contentChoice);
                     await stepContext.Context.SendActivityAsync(message).ConfigureAwait(false);
 
                     return new DialogTurnResult(DialogTurnStatus.Waiting);
@@ -636,6 +652,13 @@ private async Task<DialogTurnResult> CheckForMultiTurnPromptAsync(WaterfallStepC
             return await stepContext.NextAsync(stepContext.Result, cancellationToken).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Gets the options the dialog will use to display query results to the user.
+        /// </summary>
+        /// <param name="stepContext">The <see cref="WaterfallStepContext"/> for the current turn of conversation.</param>
+        /// <param name="cancellationToken">The <see cref="CancellationToken"/> for the current turn of conversation.</param>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+        /// <remarks>If the task is successful, the result contains the response options to use.</remarks>
         private async Task<DialogTurnResult> DisplayQnAResultAsync(WaterfallStepContext stepContext, CancellationToken cancellationToken)
         {
             var dialogOptions = ObjectPath.GetPathValue<QnAMakerDialogOptions>(stepContext.ActiveDialog.State, Options);
@@ -667,7 +690,25 @@ private async Task<DialogTurnResult> DisplayQnAResultAsync(WaterfallStepContext
             // If response is present then show that response, else default answer.
             if (stepContext.Result is List<QueryResult> response && response.Count > 0)
             {
-                await stepContext.Context.SendActivityAsync(response.First().Answer, cancellationToken: cancellationToken).ConfigureAwait(false);
+                var firstAnswer = response.First();
+                var answer = firstAnswer.Answer;
+                int contentChoice = -1;
+
+                if (firstAnswer.AnswerSpan != null && !string.IsNullOrEmpty(firstAnswer.AnswerSpan.Text))
+                {
+                    if (dialogOptions.ResponseOptions.ContentChoice.Equals(QnADialogResponseOptions.PreciseAnswer))
+                    {
+                        contentChoice = 0;
+                    }
+
+                    if (dialogOptions.ResponseOptions.ContentChoice.Equals(QnADialogResponseOptions.Both))
+                    {
+                        contentChoice = 1;
+                    }
+                }
+
+                var message = QnACardBuilder.GetAnswerSpanCard(firstAnswer,  contentChoice);
+                await stepContext.Context.SendActivityAsync(message).ConfigureAwait(false);
             }
             else
             {

libraries/Microsoft.Bot.Builder.AI.QnA/Models/AnswerSpan.cs

@@ -0,0 +1,46 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Newtonsoft.Json;
+
+namespace Microsoft.Bot.Builder.AI.QnA
+{
+    public class AnswerSpan
+    {
+        /// <summary>
+        /// Gets or sets the answer text.
+        /// </summary>
+        /// <value>
+        /// The answer text.
+        /// </value>
+        [JsonProperty("text")]
+        public string Text { get; set; }
+
+        /// <summary>
+        /// Gets or sets the answer score.
+        /// </summary>
+        /// <value>
+        /// The answer score.
+        /// </value>
+        [JsonProperty("score")]
+        public float Score { get; set; }
+
+        /// <summary>
+        /// Gets or sets the answer startIndex.
+        /// </summary>
+        /// <value>
+        /// The answer startIndex.
+        /// </value>
+        [JsonProperty("startIndex")]
+        public int StartIndex { get; set; }
+
+        /// <summary>
+        /// Gets or sets the answer endIndex.
+        /// </summary>
+        /// <value>
+        /// The answer endIndex.
+        /// </value>
+        [JsonProperty("endIndex")]
+        public int EndIndex { get; set; }
+    }
+}

libraries/Microsoft.Bot.Builder.AI.QnA/Models/QnAMakerTraceInfo.cs

@@ -103,9 +103,18 @@ public class QnAMakerTraceInfo
         /// </value>
         [JsonProperty("rankerType")]
         public string RankerType { get; set; }
-        
+
         [Obsolete("This property is no longer used and will be ignored")]
         [JsonIgnore]
         public Metadata[] MetadataBoost { get; set; }
+
+        /// <summary>
+        /// Gets or sets AnswerSpanRequest of the previous turn.
+        /// </summary>
+        /// <value>
+        /// The AnswerSpanRequest.
+        /// </value>
+        [JsonProperty("answerSpanRequest")]
+        public AnswerSpanRequest AnswerSpanRequest { get; set; }
     }
 }

libraries/Microsoft.Bot.Builder.AI.QnA/Models/QueryResult.cs

@@ -76,5 +76,14 @@ public class QueryResult
         /// </value>
         [JsonProperty(PropertyName = "context")]
         public QnAResponseContext Context { get; set; }
+
+        /// <summary>
+        /// Gets or sets AnswerSpan of the previous turn.
+        /// </summary>
+        /// <value>
+        /// The answerspan value.
+        /// </value>
+        [JsonProperty("answerSpan")]
+        public AnswerSpan AnswerSpan { get; set; }
     }
 }

libraries/Microsoft.Bot.Builder.AI.QnA/QnADialogResponseOptions.cs

@@ -10,6 +10,10 @@ namespace Microsoft.Bot.Builder.AI.QnA
     /// </summary>
     public class QnADialogResponseOptions
     {
+        public const string PreciseAnswer = "PreciseAnswer";
+
+        public const string Both = "Both";
+
         /// <summary>
         /// Gets or sets get or set for Active learning card title.
         /// </summary>
@@ -41,5 +45,13 @@ public class QnADialogResponseOptions
         /// Get or set for Card no match response.
         /// </value>
         public Activity CardNoMatchResponse { get; set; }
+
+        /// <summary>
+        /// Gets or sets get or set for MRCAnswerSpanRenderingOption.
+        /// </summary>
+        /// <value>
+        /// Get or set for Card no match MRCAnswerSpanRenderingOption.
+        /// </value>
+        public string ContentChoice { get; set; } = PreciseAnswer;
     }
 }

libraries/Microsoft.Bot.Builder.AI.QnA/QnAMakerOptions.cs

@@ -92,5 +92,14 @@ public QnAMakerOptions()
         /// <seealso cref="RankerTypes"/>
         [JsonProperty("rankerType")]
         public string RankerType { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether  MRCEnable of the previous turn.
+        /// </summary>
+        /// <value>
+        /// To enable MRC.
+        /// </value>
+        [JsonProperty("enableMRC")]
+        public bool EnablePreciseAnswer { get; set; }
     }
 }

libraries/Microsoft.Bot.Builder.AI.QnA/Utils/GenerateAnswerUtils.cs

@@ -153,7 +153,7 @@ private static void ValidateOptions(QnAMakerOptions options)
         private QnAMakerOptions HydrateOptions(QnAMakerOptions queryOptions)
         {
             var hydratedOptions = JsonConvert.DeserializeObject<QnAMakerOptions>(JsonConvert.SerializeObject(this.Options));
-
+            
             if (queryOptions != null)
             {
                 if (queryOptions.ScoreThreshold != hydratedOptions.ScoreThreshold && queryOptions.ScoreThreshold != 0)
@@ -169,12 +169,13 @@ private QnAMakerOptions HydrateOptions(QnAMakerOptions queryOptions)
                 if (queryOptions.StrictFilters?.Length > 0)
                 {
                     hydratedOptions.StrictFilters = queryOptions.StrictFilters;
-                }         
+                }
 
                 hydratedOptions.Context = queryOptions.Context;
                 hydratedOptions.QnAId = queryOptions.QnAId;
                 hydratedOptions.IsTest = queryOptions.IsTest;
                 hydratedOptions.RankerType = queryOptions.RankerType != null ? queryOptions.RankerType : RankerTypes.DefaultRankerType;
+                hydratedOptions.EnablePreciseAnswer = queryOptions.EnablePreciseAnswer;
             }
 
             return hydratedOptions;
@@ -183,17 +184,20 @@ private QnAMakerOptions HydrateOptions(QnAMakerOptions queryOptions)
         private async Task<QueryResults> QueryQnaServiceAsync(Activity messageActivity, QnAMakerOptions options)
         {
             var requestUrl = $"{_endpoint.Host}/knowledgebases/{_endpoint.KnowledgeBaseId}/generateanswer";
+            var answerSpanRequest = new AnswerSpanRequest();
+            answerSpanRequest.Enable = options.EnablePreciseAnswer;
             var jsonRequest = JsonConvert.SerializeObject(
                 new
                 {
                     question = messageActivity.Text,
                     top = options.Top,
-                    strictFilters = options.StrictFilters,                  
+                    strictFilters = options.StrictFilters,
                     scoreThreshold = options.ScoreThreshold,
                     context = options.Context,
                     qnaId = options.QnAId,
                     isTest = options.IsTest,
-                    rankerType = options.RankerType
+                    rankerType = options.RankerType,
+                    answerSpanRequest = answerSpanRequest
                 }, Formatting.None);
 
             var httpRequestHelper = new HttpRequestUtils(httpClient);
@@ -206,18 +210,21 @@ private async Task<QueryResults> QueryQnaServiceAsync(Activity messageActivity,
 
         private async Task EmitTraceInfoAsync(ITurnContext turnContext, Activity messageActivity, QueryResult[] result, QnAMakerOptions options)
         {
+            var answerSpanRequest = new AnswerSpanRequest();
+            answerSpanRequest.Enable = options.EnablePreciseAnswer;
             var traceInfo = new QnAMakerTraceInfo
             {
                 Message = (Activity)messageActivity,
                 QueryResults = result,
                 KnowledgeBaseId = _endpoint.KnowledgeBaseId,
                 ScoreThreshold = options.ScoreThreshold,
                 Top = options.Top,
-                StrictFilters = options.StrictFilters,               
+                StrictFilters = options.StrictFilters,
                 Context = options.Context,
                 QnAId = options.QnAId,
                 IsTest = options.IsTest,
-                RankerType = options.RankerType
+                RankerType = options.RankerType,
+                AnswerSpanRequest = answerSpanRequest
             };
             var traceActivity = Activity.CreateTraceActivity(QnAMaker.QnAMakerName, QnAMaker.QnAMakerTraceType, traceInfo, QnAMaker.QnAMakerTraceLabel);
             await turnContext.SendActivityAsync(traceActivity).ConfigureAwait(false);

libraries/Microsoft.Bot.Builder.AI.QnA/Utils/QnACardBuilder.cs

@@ -28,7 +28,7 @@ public static IMessageActivity GetSuggestionsCard(List<string> suggestionsList,
                 throw new ArgumentNullException(nameof(suggestionsList));
             }
 
-            if (cardTitle == null) 
+            if (cardTitle == null)
             {
                 throw new ArgumentNullException(nameof(cardTitle));
             }
@@ -80,9 +80,21 @@ public static IMessageActivity GetSuggestionsCard(List<string> suggestionsList,
         /// Get active learning suggestions card.
         /// </summary>
         /// <param name="result">Result to be dispalyed as prompts.</param>
-        /// <param name="cardNoMatchText">No match text.</param>
+        /// <param name="cardNoMatchText">No match text.</param>       
         /// <returns>IMessageActivity.</returns>
         public static IMessageActivity GetQnAPromptsCard(QueryResult result, string cardNoMatchText)
+        {
+           return GetQnAPromptsContentCard(result, cardNoMatchText, 0);
+        }
+
+        /// <summary>
+        /// Get active learning suggestions content card.
+        /// </summary>
+        /// <param name="result">Result to be dispalyed as prompts.</param>
+        /// <param name="cardNoMatchText">No match text.</param>
+        /// <param name="renderingOption">renderingchoice.</param>
+        /// <returns>IMessageActivity.</returns>
+        public static IMessageActivity GetQnAPromptsContentCard(QueryResult result, string cardNoMatchText, int renderingOption)
         {
             if (result == null)
             {
@@ -115,11 +127,64 @@ public static IMessageActivity GetQnAPromptsCard(QueryResult result, string card
                 Buttons = buttonList
             };
 
+            // For content choice Both Precise and Content
+            if (renderingOption == 1 && result.AnswerSpan != null)
+            {
+                plCard.Text = result.Answer;
+                chatActivity.Text = result.AnswerSpan.Text;
+            }
+
+            // For content choice Precise only
+            if (renderingOption == 0 && result.AnswerSpan != null)
+            {
+                chatActivity.Text = result.AnswerSpan.Text;
+            }
+
             // Create the attachment.
             var attachment = plCard.ToAttachment();
 
             chatActivity.Attachments.Add(attachment);
 
+            return chatActivity;
+       }
+
+        /// <summary>
+        /// Get active learning suggestions card.
+        /// </summary>
+        /// <param name="result">Result to be dispalyed as prompts.</param>
+        /// <param name="renderingOption">renderingchoice.</param>
+        /// <returns>IMessageActivity.</returns>
+        public static IMessageActivity GetAnswerSpanCard(QueryResult result, int renderingOption)
+        {
+            if (result == null)
+            {
+                throw new ArgumentNullException(nameof(result));
+            }
+
+            var chatActivity = Activity.CreateMessageActivity();
+            chatActivity.Text = result.Answer;
+
+            // For content choice Precise only
+            if (renderingOption == 0 && result.AnswerSpan != null)
+            {
+                chatActivity.Text = result.AnswerSpan.Text;
+            }
+
+            var plCard = new HeroCard()
+            {
+            };
+
+            // For content choice Both Precise and Content
+            if (renderingOption == 1 && result.AnswerSpan != null)
+            {
+                plCard.Text = result.Answer;
+                chatActivity.Text = result.AnswerSpan.Text;
+                var attachment = plCard.ToAttachment();
+
+                // Create the attachment.
+                chatActivity.Attachments.Add(attachment);
+            }
+
             return chatActivity;
         }
     }