Botframework-solutions: QnAMakerDialog is not created for different languages
What project is affected?
Virtual Assistant and Skills
What language is this in?
Typescript
What happens?
When a QnAMakerDialog is created with a specific language (ex. DE) will be resolving always that language even though you change the language or another user uses a different language (ex EN).
What are the steps to reproduce this issue?
User 1: Sends utterance to the bot ( DE );
Bot: The Bot resolves the utterance as QnA intent, and create the new QnADialog, with the knowledgebaseId as Id of the Dialog:
``
private registerQnADialog(knowledgebaseId: string, cognitiveModels: ICognitiveModelSet, locale: string): void {
const qnaEndpoint: QnAMakerEndpoint | undefined = cognitiveModels.qnaConfiguration.get(knowledgebaseId);
if (qnaEndpoint == undefined){
throw new Error(Could not find QnA Maker knowledge base configuration with id: ${ knowledgebaseId }.`);
}
if (this.dialogs.find(knowledgebaseId) == undefined) {
const qnaDialog: QnAMakerDialog = new QnAMakerDialog(
qnaEndpoint.knowledgeBaseId,
qnaEndpoint.endpointKey,
// The following line is a workaround until the method getQnAClient of QnAMakerDialog is fixed
// as per issue https://github.com/microsoft/botbuilder-js/issues/1885
new URL(qnaEndpoint.host).hostname.split('.')[0],
this.templateEngine.generateActivityForLocale('UnsupportedMessage', locale) as Activity,
// Before, instead of 'undefined' a '0.3' value was used in the following line
undefined,
this.templateEngine.generateActivityForLocale('QnaMakerAdaptiveLearningCardTitle', locale).text,
this.templateEngine.generateActivityForLocale('QnaMakerNoMatchText', locale).text
);
qnaDialog.id = knowledgebaseId;
this.addDialog(qnaDialog);
}
}
```
Bot: Sends QnA Answer to User 1 in User 1's locale ( DE )
User 2: Sends utterance to bot ( EN );
Bot: The Bot resolves the utterance as QnA intent ( same the user 1 sent ), no new QnaMakerDialog is created because one Dialog with the same knowledgebaseId already exists.
Bot: The Bot start again the QnA Dialog (added from user 1 iteration) and get the answer from the Knowledge Base (DE) of the first user;
Bot: Sends Message to User 2 in User 1's locale.
What were you expecting to happen?
Another QnAMakerDialog will be created with the right language and right knowledge base ID.
tommyJimmy87
All 22 comments
Thanks @tommyJimmy87. As soon as we have any update related to the Dependency Injection's implementation, we will back to you!
Batta32
on 29 Jun 2020
Hi @tommyJimmy87, we created the PR #3559 which solves this problem incorporating Dependency Injection in the bots.
If you are so kind, can you validate the changes following these repro steps and using this branch:
- Go to bot-solutions library
- Execute
npm installto install the dependencies - Execute
npm run buildto compile the solution - Execute
npm packto create the tgz - Go to the Virtual Assistant Sample
Use the created tgz in the Virtual Assistant package.json as follows:
"bot-solutions": "PATH TO BOT-SOLUTIONS TGZ"
Deploy the Virtual Assistant in multi languages
- Follow the steps to reproduce the
QnAMakerDialogscenario you mentioned
Last but not least, as it was mentioned, the PR contains the following changes:
- Implementation of Dependency Injection (
inversifyjslibrary) in Virtual Assistant and Skill of TypeScript - Update templates
We will be attentive to your answer 😊.
Batta32
on 15 Jul 2020
Hi @Batta32,
thanks for your support, looks like the issue has been solved with the new bot-solutions library that I integrated from your branch :) Do you have a rough estimation to when you're going to release it?
tommyJimmy87
on 29 Jul 2020
HI @Batta32, I was noticing that when I try to run the unit tests I get an error : TypeError: Reflect.hasOwnMetadata is not a function.
Is this because you didn't migrate the tests to use inversify?
tommyJimmy87
on 5 Aug 2020
Thanks @tommyJimmy87! We will be reviewing this and we will back to you as soon as we have any update of this 😊.
Batta32
on 5 Aug 2020
Hi @Batta32, we solved this problem adding this import to the test base js file : require('reflect-metadata');
tommyJimmy87
on 7 Aug 2020
Hi @tommyJimmy87 - we couldn't reproduce the issue that you mentioned related to the unit tests.
We came up with questions:
- Are you using our branch to validate those changes?
- Which component do you have the issue?
- Can you share the repro steps that you followed?
This is our environment:
- We are using this branch:
feature/southworks/dependency-injection-implementation - TypeScript Virtual Assistant Sample
- TypeScript Skill Sample
We took the following steps to reproduce the issue for the Virtual Assistant and the Skill:
- Go to bot-solutions library
- Execute
npm installto install the dependencies - Execute
npm run buildto compile the solution - Execute
npm packto create the.tgz - Go to the Virtual Assistant Sample
- Use the created
.tgzin the Virtual Assistant package.json as follows: - "bot-solutions": "
" - Execute
npm installto install the dependencies - Execute
npm run buildto compile the solution - Execute
npm run testto compile the solution - Verify the test execution
DiegoCardozo94
on 10 Aug 2020
Hi @tommyJimmy87 - we added the suggested changes in the PR #3559.
We updated the Virtual Assistant & Skill bots adding the following import tests files: require('reflect-metadata'); specifically in the BotTestBase and SkillTestBase, in order to avoid the issue that you mentioned related to the unit tests.
You can follow up these steps to test the changes in the Virtual Assistant and Skill.
Thanks,
Diego.
DiegoCardozo94
on 11 Aug 2020
Hi @Batta32 and @DiegoCardozo94,
I have one a generic question but since I'm using this Branch in our project already even though has not been released I would ask it here.
In our scenario, we have MS Teams as the only channel, I see that the TeamsActivityHandler is used only in the VA and not in the skill's sample, is that right? Because maybe wrongly I was extending also in the skill the TeamsActivityHandler and that drove me to one issue specifically: basically the endOfConversation method is never called after a cancel in the skill's DefaultActivityHandler. But maybe I should just switch to the "normal" ActivityHandler extension within the skills. Could you help me or rather give me feedback on this?
Thanks
tommyJimmy87
on 11 Sep 2020
Hi @tommyJimmy87, the TeamsActivityHandler is derived from ActivityHandler which adds support for the Microsoft Teams specific events and interactions.
The Virtual Assistant is the one which interacts to the Microsoft Teams Channel in the schema of Virtual Assistant connected to Skills, so the DefaultActivityHandler of the Virtual Assistant needs to extend from the TeamsActivityHandler, not the Skill in that mentioned schema, as you can see in the samples.
The DefaultActivityHandler of the Virtual Assistant in the templates/samples implements the TeamsActivityHandler which enables Teams scenarios out of the box.
We researched the following documentation that you can also review:
- Virtual Assistant Activity Flow
- Migration to GA for Virtual Assistant
- TeamsActivityHandler implemented in BotBuilder-JS
- TeamsActivityHandler implemented in BotBuilder-Dotnet
- PR #2619 which introduces the TeamsActivityHandler in the DefaultActivityHandler of the C# Virtual Assistant
- Issue #3107 which discuss to implement the TeamsActivitytHandler in the Skills (see the comment of @darrenj)
Let us know if this helps to you 😊.
Batta32
on 11 Sep 2020
This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days
![github-actions[bot] picture](https://avatars.githubusercontent.com/in/15368?v=4&s=40)
github-actions[bot]
on 12 Oct 2020
@Batta32 this is not yet released right?
tommyJimmy87
on 12 Oct 2020
Hi @tommyJimmy87 - we are finalizing a plan to release new packages. As soon as we have any update we will back to you here 😊.
Batta32
on 13 Oct 2020
@Batta32 any updates?
cwhitten
on 9 Nov 2020
Hi @cwhitten, this issue is already fixed with the PR #3559 which is updated with the requested changes of @peterinnesmsft .
As soon as the PR is merged, the changes will be present in the next branch.
Batta32
on 9 Nov 2020
What is the status of #3559? @Batta32
The last update on it was on September 11
Thanks
tonyanziano
on 11 Dec 2020
Hi @tonyanziano, the PR #3559 is ready to be reviewed and merged containing the requested changes of @peterinnesmsft.
As soon as the PR is merged, the changes will be present in the next branch.
Batta32
on 11 Dec 2020
This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days
github-actions[bot]
on 11 Jan 2021
@joshgummersall what is the status of #3752? When do you expect to merge that in?
a-b-r-o-w-n
on 25 Jan 2021
Just as soon as someone else can review it and approve!
joshgummersall
on 25 Jan 2021
@joshgummersall,
Can you work to get the PR merged so this ticket can be closed?
Virtual-Josh
on 8 Feb 2021
@virtual-josh, it's just waiting on one more PR review; it's been approved by one reviewer already. Not sure who to ping for a second review.
joshgummersall
on 8 Feb 2021
Related issues
lauren-mills
·
3Comments
tommyJimmy87
·
4Comments
VladPapacostea-SM
·
3Comments
BillStrait
·
3Comments
elaine-chang
·
4Comments
Most helpful comment
Hi @Batta32,
thanks for your support, looks like the issue has been solved with the new bot-solutions library that I integrated from your branch :) Do you have a rough estimation to when you're going to release it?