Merge state changes into 4.future

.gitignore

@@ -3,6 +3,11 @@
 ##
 ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
 
+# Blanket ignore zip files
+# Related to Teams Scenarios work
+*.zip
+*.vscode
+
 # User-specific files
 *.suo
 *.user
@@ -287,12 +292,20 @@ __pycache__/
 *.odx.cs
 *.xsd.cs
 /**/node_modules
-/**/.vscode
+
+# Exception for including the ESLint extension in vscode
+!.vscode/
+.vscode/*
+!.vscode/extensions.json
+
 /**/*.VC.db
 #coverage
 /**/coverage
 /**/.nyc_output
 
 #derived
 /test-runner/out
+package-lock.json
 
+*.tsbuildinfo
+*.js.map

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "dbaeumer.vscode-eslint",
+    ]
+}

lerna.json

@@ -10,12 +10,13 @@
     "libraries/botbuilder-dialogs",
     "libraries/botbuilder-dialogs-adaptive",
     "libraries/botbuilder-dialogs-declarative",
-    "libraries/botframework-expressions",
     "libraries/botbuilder-lg",
     "libraries/botbuilder-testing",
     "libraries/botframework-config",
     "libraries/botframework-connector",
+    "libraries/botframework-expressions",
     "libraries/botframework-schema",
+    "libraries/botframework-streaming",
     "libraries/functional-tests",
     "libraries/testbot",
     "transcripts"

libraries/botbuilder-ai/src/luisRecognizer.ts

@@ -142,7 +142,7 @@ export interface LuisRecognizerTelemetryClient {
  *
  * @remarks
  * This class is used to recognize intents and extract entities from incoming messages.
- * See this class in action [in this sample application](https://github.com/Microsoft/BotBuilder-Samples/tree/master/samples/javascript_nodejs/12.nlp-with-luis).
+ * See this class in action [in this sample application](https://github.com/microsoft/BotBuilder-Samples/tree/master/samples/javascript_nodejs/14.nlp-with-dispatch).
  *
  * This component can be used within your bots logic by calling [recognize()](#recognize).
  */

libraries/botbuilder-ai/src/qnaMaker.ts

@@ -5,9 +5,8 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
-import { Activity, TurnContext, BotTelemetryClient, NullTelemetryClient } from 'botbuilder-core';
+import { TurnContext, BotTelemetryClient, NullTelemetryClient } from 'botbuilder-core';
 
-import { constants } from 'http2';
 import { QnATelemetryConstants } from './qnaTelemetryConstants';
 import { QnAMakerEndpoint } from './qnamaker-interfaces/qnamakerEndpoint';
 import { QnAMakerMetadata } from './qnamaker-interfaces/qnamakerMetadata';
@@ -18,6 +17,7 @@ import { FeedbackRecords } from './qnamaker-interfaces/feedbackRecords';
 import { GenerateAnswerUtils } from './qnamaker-utils/generateAnswerUtils';
 import { ActiveLearningUtils } from './qnamaker-utils/activeLearningUtils';
 import { TrainUtils } from './qnamaker-utils/trainUtils';
+import { QnAMakerResults } from './qnamaker-interfaces/qnamakerResults';
 
 export const QNAMAKER_TRACE_TYPE = 'https://www.qnamaker.ai/schemas/trace';
 export const QNAMAKER_TRACE_NAME = 'QnAMaker';
@@ -132,25 +132,50 @@ export class QnAMaker implements QnAMakerTelemetryClient {
             throw new TypeError('QnAMaker.getAnswers() requires a TurnContext.');
         }
 
+        var response = await this.getAnswersRaw(context, options, telemetryProperties, telemetryMetrics);
+
+        if (!response) {
+            return [];
+        }
+
+        return response.answers;
+    }
+
+    public async getAnswersRaw(context: TurnContext, options?: QnAMakerOptions, telemetryProperties?: {[key: string]:string}, telemetryMetrics?: {[key: string]:number} ): Promise<QnAMakerResults> {
+        if (!context) {
+            throw new TypeError('QnAMaker.getAnswers() requires a TurnContext.');
+        }
+
         const queryResult: QnAMakerResult[] = [] as QnAMakerResult[];
         const question: string = this.getTrimmedMessageText(context);
         const queryOptions: QnAMakerOptions = { ...this._options, ...options } as QnAMakerOptions;
 
         this.generateAnswerUtils.validateOptions(queryOptions);
 
-        if (question.length > 0) {
-            const answers: QnAMakerResult[] = await this.generateAnswerUtils.queryQnaService(this.endpoint, question, queryOptions);
-            const sortedQnaAnswers: QnAMakerResult[] = GenerateAnswerUtils.sortAnswersWithinThreshold(answers, queryOptions);
+        var result: QnAMakerResults;
 
+        if (question.length > 0) {
+            result = await this.generateAnswerUtils.queryQnaServiceRaw(this.endpoint, question, queryOptions);
+
+            const sortedQnaAnswers: QnAMakerResult[] = GenerateAnswerUtils.sortAnswersWithinThreshold(result.answers, queryOptions);
             queryResult.push(...sortedQnaAnswers);
         }
 
+        if (!result) {
+            return result;
+        }
+
         // Log telemetry
         this.onQnaResults(queryResult, context, telemetryProperties, telemetryMetrics);
 
         await this.generateAnswerUtils.emitTraceInfo(context, queryResult, queryOptions);
 
-        return queryResult;
+        const qnaResponse: QnAMakerResults = {
+            activeLearningEnabled: result.activeLearningEnabled,
+            answers: queryResult
+        }
+
+        return qnaResponse;
     }
 
     /**
@@ -198,10 +223,10 @@ export class QnAMaker implements QnAMakerTelemetryClient {
         const trimmedAnswer: string = question ? question.trim() : '';
 
         if (trimmedAnswer.length > 0) {
-            const answers: QnAMakerResult[] = await this.callService(this.endpoint, question, typeof top === 'number' ? top : 1);
+            const result: QnAMakerResults = await this.callService(this.endpoint, question, typeof top === 'number' ? top : 1);
             const minScore: number = typeof scoreThreshold === 'number' ? scoreThreshold : 0.001;
 
-            return answers.filter(
+            return result.answers.filter(
                 (ans: QnAMakerResult) => ans.score >= minScore)
                 .sort((a: QnAMakerResult, b: QnAMakerResult) => b.score - a.score);
         }
@@ -236,8 +261,8 @@ export class QnAMaker implements QnAMakerTelemetryClient {
      * @remarks
      * This is exposed to enable better unit testing of the service.
      */
-    protected async callService(endpoint: QnAMakerEndpoint, question: string, top: number): Promise<QnAMakerResult[]> {
-        return this.generateAnswerUtils.queryQnaService(endpoint, question, { top } as QnAMakerOptions);
+    protected async callService(endpoint: QnAMakerEndpoint, question: string, top: number): Promise<QnAMakerResults> {
+        return this.generateAnswerUtils.queryQnaServiceRaw(endpoint, question, { top } as QnAMakerOptions);
     }
 
     /**

libraries/botbuilder-ai/src/qnamaker-interfaces/index.ts

@@ -10,6 +10,6 @@ export * from './qnamakerEndpoint';
 export * from './qnamakerMetadata';
 export * from './qnamakerOptions';
 export * from './qnamakerResult';
-export * from './qnamakerTraceinfo';
+export * from './qnamakerTraceInfo';
 export * from './feedbackRecord';
 export * from './feedbackRecords';

libraries/botbuilder-ai/src/qnamaker-interfaces/qnaRequestContext.ts

@@ -0,0 +1,22 @@
+/**
+ * @module botbuilder-ai
+ */
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+ /**
+ * The context associated with QnA.  Used to mark if the current prompt is relevant with a previous question or not.
+ */
+export interface QnARequestContext {
+
+    /**
+     * The previous QnA Id that was returned.
+     */
+    previousQnAId: number;
+
+    /**
+     * The previous user query/question.
+     */
+    previousUserQuery: string;
+}

libraries/botbuilder-ai/src/qnamaker-interfaces/qnaResponseContext.ts

@@ -0,0 +1,20 @@
+/**
+ * @module botbuilder-ai
+ */
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { QnAMakerPrompt } from './qnamakerPrompt';
+
+ /**
+ * The context associated with QnA.  Used to mark if the qna response has related prompts.
+ */
+export interface QnAResponseContext {
+
+    /**
+     * The prompts collection of related prompts.
+     */
+    prompts: QnAMakerPrompt[];
+}

libraries/botbuilder-ai/src/qnamaker-interfaces/qnamakerOptions.ts

@@ -7,6 +7,7 @@
  */
 
 import { QnAMakerMetadata } from './qnamakerMetadata';
+import { QnARequestContext } from './qnaRequestContext';
 
 /**
  * Additional settings used to configure a `QnAMaker` instance.
@@ -42,5 +43,15 @@ export interface QnAMakerOptions {
      * 
      * @remarks Defaults to "100000" milliseconds.
     */
-   timeout?: number;
+    timeout?: number;
+
+    /**
+     * The context of the previous turn.
+     */
+    context?: QnARequestContext;
+
+    /**
+     * Id of the current question asked.
+     */
+    qnaId?: number;
 }

libraries/botbuilder-ai/src/qnamaker-interfaces/qnamakerPrompt.ts

@@ -0,0 +1,32 @@
+/**
+ * @module botbuilder-ai
+ */
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+ /**
+ * QnAMaker Prompt Object.
+ */
+export interface QnAMakerPrompt {
+
+    /**
+     * Display Order - index of the prompt - used in ordering of the prompts.
+     */
+    displayOrder: number;
+
+    /**
+     * Qna id corresponding to the prompt - if QnaId is present, QnADTO object is ignored.
+     */
+    qnaId: number;
+
+    /**
+     * The QnA object returned from the API (Optional parameter).
+     */
+    qna?: object;
+
+    /**
+     * Display Text - Text displayed to represent a follow up question prompt.
+     */
+    displayText: string;
+}

libraries/botbuilder-ai/src/qnamaker-interfaces/qnamakerResult.ts

@@ -6,6 +6,8 @@
  * Licensed under the MIT License.
  */
 
+import { QnAResponseContext } from './qnaResponseContext';
+
  /**
  * An individual answer returned by a call to the QnA Maker Service.
  */
@@ -39,4 +41,9 @@ export interface QnAMakerResult {
      * The index of the answer in the knowledge base. V3 uses 'qnaId', V4 uses 'id'. (If any)
      */
     id?: number;
+
+    /**
+     * Context for multi-turn responses.
+     */
+    context?: QnAResponseContext; 
 }

libraries/botbuilder-ai/src/qnamaker-interfaces/qnamakerResults.ts

@@ -0,0 +1,24 @@
+/**
+ * @module botbuilder-ai
+ */
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { QnAMakerResult } from './qnamakerResult';
+
+ /**
+ * An object returned by a call to the QnA Maker Service.
+ */
+export interface QnAMakerResults {
+    /**
+     * The answers for a user query, sorted in decreasing order of ranking score.
+     */
+    answers?: QnAMakerResult[];
+
+    /**
+     * The active learning enable flag.
+     */
+    activeLearningEnabled?: boolean;
+}

libraries/botbuilder-ai/src/qnamaker-interfaces/qnamakerTraceInfo.ts

@@ -8,6 +8,7 @@
 
 import { Activity } from 'botbuilder-core';
 import { QnAMakerResult } from './qnamakerResult';
+import { QnARequestContext } from './qnaRequestContext';
 
 /**
  * Trace info that we collect and emit from a QnA Maker query
@@ -47,4 +48,14 @@ export interface QnAMakerTraceInfo {
      * Metadata related to query. Not used in JavaScript SDK v4 yet.
      */
     metadataBoost: any[];
+
+    /**
+     * The context for multi-turn responses.
+     */
+    context?: QnARequestContext;
+
+    /**
+     * Id of the current question asked.
+     */
+    qnaId?: number;
 }

libraries/botbuilder-ai/src/qnamaker-utils/activeLearningUtils.ts

@@ -12,10 +12,10 @@ import { QnAMakerResult } from '../qnamaker-interfaces/qnamakerResult';
 const MinimumScoreForLowScoreVariation = 20;
 
 // Previous Low Score Variation Multiplier
-const PreviousLowScoreVariationMultiplier = 1.4;
+const PreviousLowScoreVariationMultiplier = 0.7;
 
 // Max Low Score Variation Multiplier
-const MaxLowScoreVariationMultiplier = 2.0;
+const MaxLowScoreVariationMultiplier = 1.0;
 
 // Maximum Score For Low Score Variation
 const MaximumScoreForLowScoreVariation = 95.0;