[SDK] Add bot-ai-qna library

[Batta32]

Fixes #740

• Migration of source code
• Migration of tests
• Testing

Description

We are adding the SDK bot-ai-qna library in Java having into account the C# Microsoft.Bot.Builder.AI.QnA present in botbuilder-dotnet repository.

Specific Changes

• Generate main structure of the library
• Migrate dialogs folder
• Migrate models folder
• Add icon.png in resources folder
• Migrate utils folder
• Migrate root files
• Add testData folder
• Add QnAMakerRecognizerTests unit tests
• Add QnAMakerTests unit tests
• Add QnAMakerTraceInfoTests unit tests

Migrated structure

Migrated test structure

Testing

QnA tests passing correctly 48/48

mvn clean install passing correctly

Feature Plan

-

[tracyboehrer]

Parts of the QnAMakerDialog have been updated to be Adaptive friendly. This won't apply for this version on the Java SDK since Adaptive won't be part of the GA release.

For example, in QnAMakerDialog: StringExpression, IntegerExpression, etc...

Other:

1. QnAMakerComponentRegistration is not needed (can't actually be ported, so delete the file)
2. schemas folder can be deleted.

[Batta32]

Thanks @tracyboehrer for the feedback! We will be applying the changes as soon as we can 😊.

[Batta32]

Hi @tracyboehrer , we finished with the migration of the bot-ai-qna library having all the unit tests passing correctly so this is ready to be reviewed and merged 😊.

[tracyboehrer]

• Drop "I" for IQnAMakerClient and ITelemetryQnAMaker to be consistent with other Java SDK interfaces
• Drop QnAMaker.kind and associated getter. This is an Adaptive thing that isn't used yet.
• I believe we can drop QnAMaker constructor "sourceFilePath" and "sourceLineNumber". This is part of DotNets debugging that we don't currently have in Java.
• I believe we can delete resources/icon.png. I think this is just for NuGet packaging in DotNet.
• Is QnAMaker.httpClient (and accessors) used? DotNet support passing in a custom client that we haven't supported anywhere else.

Bug

QnAMaker.getAnswerRaw

if (messageActivity == null || messageActivity.getType() != ActivityTypes.MESSAGE) {

Activity.getType is a string so that comparison won't work. Use:

Activity.isType(ActivityTypes.MESSAGE)

Recommend searching for "getType()" and see if that happens elsewhere.

Bug

QnAMakerDialog.callTrain, line 934

QueryResult qnaResult = trainResponses
                .stream().filter(kvp -> kvp.getQuestions()[0] == reply).findFirst().orElse(null);

Performing string comparison with ==. We typically use StringUtils.equals.

Recommend maybe searching for "==", "!=", etc... and checking for other string comparisons. This would also help you find the previous bug.

Minor:

QnAMaker.fillQnAEvent:

return CompletableFuture.completedFuture(new Pair(telemetryPropertiesResult, telemetryMetricsResult));

Produces an unchecked assignment warning. Should be:

return CompletableFuture.completedFuture(new Pair<>(telemetryPropertiesResult, telemetryMetricsResult));

[tracyboehrer]

@Batta32 Lee said there is a CheckStyle rule you can add that will flag string comparisons. That might be the quickest way to find those. Check with him on that. We were going to add it as part of the work Lee is doing, but its just as well if you do.

[LeeParrishMSFT]

@Batta32 Lee said there is a CheckStyle rule you can add that will flag string comparisons. That might be the quickest way to find those. Check with him on that. We were going to add it as part of the work Lee is doing, but its just as well if you do.

This is what you can add as a child to the section:

    <!-- check for usage of literal equality "==" between string -->
   <module name="StringLiteralEquality"/>

[Batta32]

Thanks @tracyboehrer and @LeeParrishMSFT for your feedback! We will be implementing the requested changes in order to update the PR.

• httpClient is only used in HttpRequestUtils in C# and Java as well. We created the client where it's used instead of adding unused properties in QnAMaker, TrainUtils and GenerateAnswerUtils. We can add the property on these classes too if you want 😊.
• We will add the StringLiteralEquality rule in the bot-checkstyle.xml file and fix the issues that will appear in the entire repository.

[Batta32]

Hi @tracyboehrer & @LeeParrishMSFT, we already applied the requested changes 😊.

[tracyboehrer]

@Batta32 Awesome! Can you merge the latest from main?

[Batta32]

Done!