OnReceive is only run if all relevant Middleware Complete

libraries/Microsoft.Bot.Builder.Ai/QnAMaker.cs

@@ -0,0 +1,131 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Newtonsoft.Json;
+using System;
+using System.Linq;
+using System.Net.Http;
+using System.Threading.Tasks;
+
+namespace Microsoft.Bot.Builder.Ai
+{
+    public class QnAMaker
+    {
+        public const string qnaMakerServiceEndpoint = "https://westus.api.cognitive.microsoft.com/qnamaker/v3.0/knowledgebases/";
+        public const string APIManagementHeader = "Ocp-Apim-Subscription-Key";
+        public const string JsonMimeType = "application/json";
+
+        private readonly HttpClient _httpClient;
+        private readonly QnAMakerOptions _options;
+        private readonly string _answerUrl;
+
+        public QnAMaker(QnAMakerOptions options, HttpClient httpClient)
+        {
+            _httpClient = httpClient ?? throw new ArgumentNullException(nameof(httpClient));
+            _options = options ?? throw new ArgumentNullException(nameof(options));
+            if (string.IsNullOrEmpty(options.KnowledgeBaseId))
+            {
+                throw new ArgumentException(nameof(options.KnowledgeBaseId));
+            }
+
+            _answerUrl = $"{qnaMakerServiceEndpoint}{options.KnowledgeBaseId}/generateanswer";
+
+            if (_options.ScoreThreshold == 0)
+            {
+                _options.ScoreThreshold = 0.3F;
+            }
+
+            if (_options.Top == 0)
+            {
+                _options.Top = 1;
+            }
+
+            if (_options.StrictFilters == null)
+            {
+                _options.StrictFilters = new Metadata[] {};
+            }
+
+            if (_options.MetadataBoost == null)
+            {
+                _options.MetadataBoost = new Metadata[] { };
+            }
+        }
+
+        public async Task<QueryResult[]> GetAnswers(string question)
+        {
+            var request = new HttpRequestMessage(HttpMethod.Post, _answerUrl);
+
+            string jsonRequest = JsonConvert.SerializeObject(new
+            {
+                question,
+                top = _options.Top,
+                strictFilters = _options.StrictFilters,
+                metadataBoost = _options.MetadataBoost
+            }, Formatting.None);
+
+            var content = new StringContent(jsonRequest, System.Text.Encoding.UTF8, JsonMimeType);
+            content.Headers.Add(APIManagementHeader, _options.SubscriptionKey);
+
+            var response = await _httpClient.PostAsync(_answerUrl, content).ConfigureAwait(false);
+            if (response.IsSuccessStatusCode)
+            {
+                var jsonResponse = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
+                var results = JsonConvert.DeserializeObject<QueryResults>(jsonResponse);
+                foreach (var answer in results.Answers)
+                {
+                    answer.Score = answer.Score / 100;
+                }
+
+                return results.Answers.Where(answer => answer.Score > _options.ScoreThreshold).ToArray();
+            }
+            return null;
+        }
+    }
+
+    public class QnAMakerOptions
+    {
+        public string SubscriptionKey { get; set; }
+        public string KnowledgeBaseId { get; set; }
+        public float ScoreThreshold { get; set; }
+        public int Top { get; set; }
+        public Metadata[] StrictFilters { get; set; }
+        public Metadata[] MetadataBoost { get; set; }
+    }
+
+    [Serializable]
+    public class Metadata
+    {
+        [JsonProperty(PropertyName = "name")]
+        public string Name { get; set; }
+
+        [JsonProperty(PropertyName = "value")]
+        public string Value { get; set; }
+    }
+
+    public class QueryResult
+    {
+        [JsonProperty("questions")]
+        public string[] Questions { get; set; }
+
+        [JsonProperty("answer")]
+        public string Answer { get; set; }
+
+        [JsonProperty("score")]
+        public float Score { get; set; }
+
+        [JsonProperty(PropertyName = "metadata")]
+        public Metadata[] Metadata { get; set; }
+
+        [JsonProperty(PropertyName = "source")]
+        public string Source { get; set; }
+
+        [JsonProperty(PropertyName = "qnaId")]
+        public int QnaId { get; set; }
+    }
+
+    public class QueryResults
+    {
+        [JsonProperty("answers")]
+        public QueryResult[] Answers { get; set; }
+    }
+}

libraries/Microsoft.Bot.Builder.Ai/QnAMakerMiddleware.cs

@@ -1,104 +1,21 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-using System;
 using System.Linq;
 using System.Net.Http;
 using System.Threading.Tasks;
 using Microsoft.Bot.Builder.Middleware;
 using Microsoft.Bot.Schema;
-using Newtonsoft.Json;
 
 namespace Microsoft.Bot.Builder.Ai
 {
-
-    public class QueryResult
-    {
-        [JsonProperty("questions")]
-        public string[] Questions { get; set; }
-
-        [JsonProperty("answer")]
-        public string Answer { get; set; }
-
-        [JsonProperty("score")]
-        public float Score { get; set; }
-    }
-
-    public class QueryResults
-    {
-        [JsonProperty("answers")]
-        public QueryResult[] Answers { get; set; }
-    }
-
-
-    public class QnAMakerOptions
-    {
-        public string SubscriptionKey { get; set; }
-        public string KnowledgeBaseId { get; set; }
-        public float ScoreThreshold { get; set; }
-        public int Top { get; set; }
-    }
-
     public class QnAMakerMiddleware : Middleware.IReceiveActivity
     {
-        public const string qnaMakerServiceEndpoint = "https://westus.api.cognitive.microsoft.com/qnamaker/v2.0/knowledgebases/";
-        private readonly string _answerUrl;
-        private readonly QnAMakerOptions _options;
-        private readonly HttpClient _httpClient;
-
-        public const string APIManagementHeader = "Ocp-Apim-Subscription-Key";
-        public const string JsonMimeType = "application/json"; 
+        private readonly QnAMaker _qnaMaker;
 
         public QnAMakerMiddleware(QnAMakerOptions options, HttpClient httpClient)
         {
-
-            _options = options ?? throw new ArgumentNullException(nameof(options));
-            this._httpClient = httpClient ?? throw new ArgumentNullException(nameof(httpClient));
-
-            if (string.IsNullOrEmpty(options.KnowledgeBaseId))
-            {
-                throw new ArgumentException(nameof(options.KnowledgeBaseId));
-            }
-
-            this._answerUrl = $"{qnaMakerServiceEndpoint}{options.KnowledgeBaseId}/generateanswer";
-
-            if (_options.ScoreThreshold == 0)
-            {
-                _options.ScoreThreshold = 0.3F;
-            }
-
-            if (_options.Top == 0)
-            {
-                _options.Top = 1;
-            }                        
-        }
-
-        public async Task<QueryResult[]> GetAnswers(string question)
-        {
-            var request = new HttpRequestMessage(HttpMethod.Post, this._answerUrl);
-
-            string jsonRequest = JsonConvert.SerializeObject(new
-            {
-                question,
-                top = this._options.Top
-            }, Formatting.None);
-
-            var content = new StringContent(jsonRequest, System.Text.Encoding.UTF8, JsonMimeType);
-            content.Headers.Add(APIManagementHeader, this._options.SubscriptionKey);
-
-            var response = await this._httpClient.PostAsync(this._answerUrl, content).ConfigureAwait(false);
-            if (response.IsSuccessStatusCode)
-            {
-                var jsonResponse = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
-                var results = JsonConvert.DeserializeObject<QueryResults>(jsonResponse);
-                foreach (var answer in results.Answers)
-                {
-                    answer.Score = answer.Score / 100;
-                }
-
-                return results.Answers.Where(answer => answer.Score > this._options.ScoreThreshold).ToArray();
-            }
-            return null;
+            _qnaMaker = new QnAMaker(options, httpClient);
         }
 
         public async Task ReceiveActivity(IBotContext context, MiddlewareSet.NextDelegate next)
@@ -108,15 +25,15 @@ public async Task ReceiveActivity(IBotContext context, MiddlewareSet.NextDelegat
                 var messageActivity = context.Request.AsMessageActivity();
                 if (!string.IsNullOrEmpty(messageActivity.Text))
                 {
-                    var results = await this.GetAnswers(messageActivity.Text.Trim()).ConfigureAwait(false);
+                    var results = await _qnaMaker.GetAnswers(messageActivity.Text.Trim()).ConfigureAwait(false);
                     if (results.Any())
                     {
                         context.Reply(results.First().Answer);
                     }
                 }
             }
 
-            await next().ConfigureAwait(false); 
+            await next().ConfigureAwait(false);
         }
     }
 }

libraries/Microsoft.Bot.Builder/Bot.cs

@@ -4,7 +4,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Net.Http;
 using System.Threading.Tasks;
 using Microsoft.Bot.Builder.Adapters;
 using Microsoft.Bot.Schema;
@@ -56,12 +55,21 @@ private async Task RunPipeline(IBotContext context, Func<IBotContext, Task> proa
             // Call any registered Middleware Components looking for ReceiveActivity()
             if (context.Request != null)
             {
-                await _middlewareSet.ReceiveActivity(context).ConfigureAwait(false);
-
-                // If the dev has registered a Receive Handler, call it. 
-                if (this._onReceive != null)
+                bool didAllMiddlewareRun = await _middlewareSet.ReceiveActivityWithStatus(context).ConfigureAwait(false);
+                if (didAllMiddlewareRun)
+                {
+                    // If the dev has registered a Receive Handler, call it. 
+                    if (_onReceive != null)
+                    {
+                        await _onReceive(context).ConfigureAwait(false);
+                    }
+                }
+                else
                 {
-                    await _onReceive(context).ConfigureAwait(false);
+                    // One of the middleware instances did not call Next(). When this happens,
+                    // by design, we do NOT call the OnReceive handler. This allows
+                    // Middleware interceptors to be written that activly prevent certain
+                    // Activites from being run. 
                 }
             }