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

@@ -504,6 +504,11 @@ private async Task<DialogTurnResult> CallGenerateAnswerAsync(WaterfallStepContex
             var result = new List<QueryResult>();
             if (response.Answers.Any())
             {
+                if (response.Answers.First() != null && response.Answers.First().AnswerSpan != null && !string.IsNullOrEmpty(response.Answers.First().AnswerSpan.Text)) 
+                { 
+                    response.Answers.First().Answer = response.Answers.First().AnswerSpan.Text;
+                }
+
                 result.Add(response.Answers.First());
             }
 

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/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("mRCEnable")]
+        public bool MRCEnable { get; set; }
     }
 }

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

@@ -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.MRCEnable = queryOptions.MRCEnable;
             }
 
             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.MRCEnable;
             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.MRCEnable;
             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);

tests/Microsoft.Bot.Builder.AI.QnA.Tests/QnAMakerRecognizerTests.cs

@@ -59,16 +59,16 @@ public AdaptiveDialog QnAMakerRecognizer_DialogBase()
         {
             var mockHttp = new MockHttpMessageHandler();
             mockHttp.When(HttpMethod.Post, GetRequestUrl())
-                .WithContent("{\"question\":\"QnaMaker_ReturnsAnswer\",\"top\":3,\"strictFilters\":[{\"name\":\"dialogName\",\"value\":\"outer\"}],\"scoreThreshold\":0.3,\"context\":null,\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\"}")
+                .WithContent("{\"question\":\"QnaMaker_ReturnsAnswer\",\"top\":3,\"strictFilters\":[{\"name\":\"dialogName\",\"value\":\"outer\"}],\"scoreThreshold\":0.3,\"context\":null,\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\",\"answerSpanRequest\":{\"enable\":false}}")
                 .Respond("application/json", GetResponse("QnaMaker_ReturnsAnswer.json"));
             mockHttp.When(HttpMethod.Post, GetRequestUrl())
-                .WithContent("{\"question\":\"QnaMaker_ReturnsNoAnswer\",\"top\":3,\"strictFilters\":[{\"name\":\"dialogName\",\"value\":\"outer\"}],\"scoreThreshold\":0.3,\"context\":null,\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\"}")
+                .WithContent("{\"question\":\"QnaMaker_ReturnsNoAnswer\",\"top\":3,\"strictFilters\":[{\"name\":\"dialogName\",\"value\":\"outer\"}],\"scoreThreshold\":0.3,\"context\":null,\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\",\"answerSpanRequest\":{\"enable\":false}}")
                 .Respond("application/json", GetResponse("QnaMaker_ReturnsNoAnswer.json"));
             mockHttp.When(HttpMethod.Post, GetRequestUrl())
-                .WithContent("{\"question\":\"QnaMaker_TopNAnswer\",\"top\":3,\"strictFilters\":[{\"name\":\"dialogName\",\"value\":\"outer\"}],\"scoreThreshold\":0.3,\"context\":null,\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\"}")
+                .WithContent("{\"question\":\"QnaMaker_TopNAnswer\",\"top\":3,\"strictFilters\":[{\"name\":\"dialogName\",\"value\":\"outer\"}],\"scoreThreshold\":0.3,\"context\":null,\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\",\"answerSpanRequest\":{\"enable\":false}}")
                 .Respond("application/json", GetResponse("QnaMaker_TopNAnswer.json"));
             mockHttp.When(HttpMethod.Post, GetRequestUrl())
-                .WithContent("{\"question\":\"QnaMaker_ReturnsAnswerWithIntent\",\"top\":3,\"strictFilters\":[{\"name\":\"dialogName\",\"value\":\"outer\"}],\"scoreThreshold\":0.3,\"context\":null,\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\"}")
+                .WithContent("{\"question\":\"QnaMaker_ReturnsAnswerWithIntent\",\"top\":3,\"strictFilters\":[{\"name\":\"dialogName\",\"value\":\"outer\"}],\"scoreThreshold\":0.3,\"context\":null,\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\",\"answerSpanRequest\":{\"enable\":false}}")
                 .Respond("application/json", GetResponse("QnaMaker_ReturnsAnswerWithIntent.json"));
 
             return CreateQnAMakerActionDialog(mockHttp);

tests/Microsoft.Bot.Builder.AI.QnA.Tests/QnAMakerTests.cs

@@ -40,11 +40,11 @@ public class QnAMakerTests
         public AdaptiveDialog QnAMakerAction_ActiveLearningDialogBase()
         {
             var mockHttp = new MockHttpMessageHandler();
-            mockHttp.When(HttpMethod.Post, GetRequestUrl()).WithContent("{\"question\":\"Q11\",\"top\":3,\"strictFilters\":[],\"scoreThreshold\":0.3,\"context\":{\"previousQnAId\":0,\"previousUserQuery\":\"\"},\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\"}")
+            mockHttp.When(HttpMethod.Post, GetRequestUrl()).WithContent("{\"question\":\"Q11\",\"top\":3,\"strictFilters\":[],\"scoreThreshold\":0.3,\"context\":{\"previousQnAId\":0,\"previousUserQuery\":\"\"},\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\",\"answerSpanRequest\":{\"enable\":false}}")
                 .Respond("application/json", GetResponse("QnaMaker_TopNAnswer.json"));
             mockHttp.When(HttpMethod.Post, GetTrainRequestUrl())
                 .Respond(HttpStatusCode.NoContent, "application/json", "{ }");
-            mockHttp.When(HttpMethod.Post, GetRequestUrl()).WithContent("{\"question\":\"Q12\",\"top\":3,\"strictFilters\":[],\"scoreThreshold\":0.3,\"context\":{\"previousQnAId\":0,\"previousUserQuery\":\"\"},\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\"}")
+            mockHttp.When(HttpMethod.Post, GetRequestUrl()).WithContent("{\"question\":\"Q12\",\"top\":3,\"strictFilters\":[],\"scoreThreshold\":0.3,\"context\":{\"previousQnAId\":0,\"previousUserQuery\":\"\"},\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\",\"answerSpanRequest\":{\"enable\":false}}")
                .Respond("application/json", GetResponse("QnaMaker_ReturnsAnswer_WhenNoAnswerFoundInKb.json"));
 
             return CreateQnAMakerActionDialog(mockHttp);
@@ -106,9 +106,9 @@ await CreateFlow(rootDialog)
         public AdaptiveDialog QnAMakerAction_MultiTurnDialogBase()
         {
             var mockHttp = new MockHttpMessageHandler();
-            mockHttp.When(HttpMethod.Post, GetRequestUrl()).WithContent("{\"question\":\"I have issues related to KB\",\"top\":3,\"strictFilters\":[],\"scoreThreshold\":0.3,\"context\":{\"previousQnAId\":0,\"previousUserQuery\":\"\"},\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\"}")
+            mockHttp.When(HttpMethod.Post, GetRequestUrl()).WithContent("{\"question\":\"I have issues related to KB\",\"top\":3,\"strictFilters\":[],\"scoreThreshold\":0.3,\"context\":{\"previousQnAId\":0,\"previousUserQuery\":\"\"},\"qnaId\":0,\"isTest\":false,\"rankerType\":\"Default\",\"answerSpanRequest\":{\"enable\":false}}")
                 .Respond("application/json", GetResponse("QnaMaker_ReturnAnswer_withPrompts.json"));
-            mockHttp.When(HttpMethod.Post, GetRequestUrl()).WithContent("{\"question\":\"Accidently deleted KB\",\"top\":3,\"strictFilters\":[],\"scoreThreshold\":0.3,\"context\":{\"previousQnAId\":27,\"previousUserQuery\":\"\"},\"qnaId\":1,\"isTest\":false,\"rankerType\":\"Default\"}")
+            mockHttp.When(HttpMethod.Post, GetRequestUrl()).WithContent("{\"question\":\"Accidently deleted KB\",\"top\":3,\"strictFilters\":[],\"scoreThreshold\":0.3,\"context\":{\"previousQnAId\":27,\"previousUserQuery\":\"\"},\"qnaId\":1,\"isTest\":false,\"rankerType\":\"Default\",\"answerSpanRequest\":{\"enable\":false}}")
                 .Respond("application/json", GetResponse("QnaMaker_ReturnAnswer_MultiTurnLevel1.json"));
 
             return CreateQnAMakerActionDialog(mockHttp);