Add userId property to Language Service QnA (#4493)

Co-authored-by: JhontSouth <[email protected]>
microsoft · Jul 14, 2023 · a44bfbc · a44bfbc
1 parent 6cae128
commit a44bfbc
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 2 deletions.
diff --git a/libraries/botbuilder-ai/etc/botbuilder-ai.api.md b/libraries/botbuilder-ai/etc/botbuilder-ai.api.md
@@ -589,6 +589,7 @@ export interface QnAMakerOptions {
     strictFiltersJoinOperator?: JoinOperator;
     timeout?: number;
     top?: number;
+    userId?: string;
 }
 
 // @public

diff --git a/libraries/botbuilder-ai/src/customQuestionAnswering.ts b/libraries/botbuilder-ai/src/customQuestionAnswering.ts
@@ -269,7 +269,8 @@ export class CustomQuestionAnswering implements QnAMakerClient, QnAMakerTelemetr
         telemetryMetrics: { [key: string]: number }
     ): Promise<QnAMakerResults> {
         const question: string = this.getTrimmedMessageText(context);
-        const queryOptions: QnAMakerOptions = { ...this._options, ...options } as QnAMakerOptions;
+        const userId = context?.activity?.from?.id;
+        const queryOptions: QnAMakerOptions = { ...this._options, ...options, userId } as QnAMakerOptions;
 
         let result: QnAMakerResults;
 

diff --git a/libraries/botbuilder-ai/src/qnamaker-interfaces/qnamakerOptions.ts b/libraries/botbuilder-ai/src/qnamaker-interfaces/qnamakerOptions.ts
@@ -83,4 +83,9 @@ export interface QnAMakerOptions {
      * includeUnstructuredSources - option to fetch answers from unsrtuctured sources
      */
     includeUnstructuredSources?: boolean;
+
+    /**
+     * Channel id for the user or bot on this channel
+     */
+    userId?: string;
 }
diff --git a/libraries/botbuilder-ai/src/qnamaker-utils/languageServiceUtils.ts b/libraries/botbuilder-ai/src/qnamaker-utils/languageServiceUtils.ts
@@ -99,6 +99,7 @@ export class LanguageServiceUtils {
             context: queryOptions.context,
             answerSpanRequest: { enable: queryOptions.enablePreciseAnswer },
             includeUnstructuredSources: queryOptions.includeUnstructuredSources,
+            userId: options.userId,
         });
 
         const qnaResults = await this.httpRequestUtils.executeHttpRequest(

diff --git a/libraries/botbuilder-ai/tests/languageService.test.js b/libraries/botbuilder-ai/tests/languageService.test.js
@@ -255,7 +255,7 @@ describe('LanguageService', function () {
 
         it('sorts the answers in the qna results from highest to lowest score', async function () {
             const qna = new CustomQuestionAnswering(endpoint);
-            const context = new TestContext({ text: "what's your favorite animal?" });
+            const context = new TestContext({ text: "what's your favorite animal?", from: { id: 'user' } });
             const options = { top: 5 };
 
             const results = await qna.getAnswers(context, options);