Fixing SME comments

Author: munozemilio

packages/qnamaker/README.md

@@ -57,16 +57,16 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:create:kb command help
-  --in=in                            (required) The CreateKbDTO object to send in the body of the request.
+  --in=in                            File path to the CreateKbDTO object to send in the body of the request.
 
   --name=name                        Name of the kb you want to create. This will override the name of KB that might be
                                      present in the CreateKb DTO
 
+  --save                             Save the kbId in config.
+
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
-
-  --wait                             Wait for the operation to complete.
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/create/kb.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/create/kb.ts)_
@@ -82,11 +82,13 @@ USAGE
 OPTIONS
   -h, --help                         qnamaker:delete:kb command help
   --force                            Do not prompt for confirmation, force the operation
-  --kbId=kbId                        Knowledgebase id to be deleted
+
+  --kbId=kbId                        Knowledgebase id to be deleted. Overrides the knowledge base id present in the
+                                     config
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/delete/kb.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/delete/kb.ts)_
@@ -102,11 +104,13 @@ USAGE
 OPTIONS
   -h, --help                         qnamaker:export:kb command help
   --environment=environment          (required) Specifies whether environment is Test or Prod.
-  --kbId=kbId                        Knowledgebase id to be exported.
+
+  --kbId=kbId                        Knowledgebase id to be exported. Overrides the knowledge base id present in the
+                                     config
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/export/kb.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/export/kb.ts)_
@@ -139,7 +143,7 @@ OPTIONS
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/get/endpointsettings.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/get/endpointsettings.ts)_
@@ -154,11 +158,13 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:get:kb command help
-  --kbId=kbId                        (required) Knowledgebase id to get metadata.
+
+  --kbId=kbId                        Knowledgebase id to get metadata. Overrides the knowledge base id present in the
+                                     config
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/get/kb.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/get/kb.ts)_
@@ -177,14 +183,14 @@ OPTIONS
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/get/operationdetails.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/get/operationdetails.ts)_
 
 ## `bf qnamaker:init`
 
-Initializes the .qnamakerrc file with settings.
+Initializes the config file with settings.
 
 ```
 USAGE
@@ -223,7 +229,7 @@ OPTIONS
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/list/alterations.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/list/alterations.ts)_
@@ -241,7 +247,7 @@ OPTIONS
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/list/endpointkeys.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/list/endpointkeys.ts)_
@@ -259,7 +265,7 @@ OPTIONS
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/list/kbs.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/list/kbs.ts)_
@@ -274,46 +280,44 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:publish:kb command help
-  --kbId=kbId                        Knowledgebase id to pubish.
+  --kbId=kbId                        Knowledgebase id to pubish. Overrides the knowledge base id present in the config
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/publish/kb.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/publish/kb.ts)_
 
 ## `bf qnamaker:query`
 
-Query model for fetching the answer from Kb for a query
+Generate Answer for fetching the answer from Kb for a query
 
 ```
 USAGE
   $ bf qnamaker:query
 
 OPTIONS
-  -h, --help                         qnamaker:query command help
+  -h, --help                       qnamaker:query command help
 
-  --endpointKey=endpointKey          Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal
-                                     user settings page). Overrides the value present in config.
+  --endpointKey=endpointKey        Specifies the endpoint key for your private QnA service (From qnamaker.ai portal user
+                                   settings page). Overrides the value present in config.
 
-  --hostname=hostname                Specifies the url for your private QnA service. Overrides the value present in
-                                     config.
+  --hostname=hostname              Specifies the url for your private QnA service. Overrides the value present in
+                                   config.
 
-  --isTest                           Query against the test index.
+  --kbId=kbId                      Specifies the active qnamaker knowledgebase id. Overrides the value present in the
+                                   config
 
-  --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the value present in the
-                                     config
+  --question=question              (required) Query to get a prediction for.
 
-  --question=question                (required) Query to get a prediction for.
+  --scorethreshold=scorethreshold  Specifies the confidence score threshold for the returned answer.
 
-  --scoreThreshold=scoreThreshold    Query to get a prediction for.
+  --strictfilters=strictfilters    Path to json file {"strictfilters": MetadataDTO[]}
 
-  --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
-                                     Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+  --test                           Query against the test index.
 
-  --top=top                          Query to get a prediction for.
+  --top=top                        Specifies the number of matching results
 ```
 
 _See code: [src/commands/qnamaker/query.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/query.ts)_
@@ -328,11 +332,11 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:refresh:endpoints command help
-  --keyType=keyType                  (required) Type of Key.
+  --keyType=keyType                  (required) Type of Key. (PrimaryKey/SecondaryKey)
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/refresh/endpointkeys.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/refresh/endpointkeys.ts)_
@@ -361,11 +365,11 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:replace:alterations command help
-  --in=in                            (required) The WordAlterationsDTO object to send in the body of the request
+  --in=in                            File path to the WordAlterationsDTO object to send in the body of the request
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/replace/alterations.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/replace/alterations.ts)_
@@ -380,12 +384,12 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:replace:kb command help
-  --in=in                            (required) The ReplaceKbDTO object to send in the body of the request
-  --kbId=kbId                        Knowledgebase id.
+  --in=in                            File path to the ReplaceKbDTO object to send in the body of the request
+  --kbId=kbId                        Knowledgebase id. Overrides the knowledge base id present in the config
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/replace/kb.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/replace/kb.ts)_
@@ -407,7 +411,7 @@ OPTIONS
   --hostname=hostname                Specifies the url for your private QnA service. Overrides the value present in
                                      config.
 
-  --in=in                            (required) The FeedbackRecordDTO object to send in the body of the request.
+  --in=in                            File path to the FeedbackRecordDTO object to send in the body of the request.
 
   --kbId=kbId                        Specifies the active qnamaker knowledgebase id. Overrides the value present in the
                                      config
@@ -431,9 +435,9 @@ OPTIONS
   -h, --help                         qnamaker:update:endpointsettings command help
   --activelearning                   Enable active learning. Disables if flag not set
 
-  --subscriptionKey=subscriptionKey  Specifies the qnamaker subscription key/access keys (found on the Cognitive
-                                     Services Azure portal page under "access keys"). Overrides the .qnamakerrc value
-                                     and the QNAMAKER_SUBSCRIPTION_KEY environment variable.
+  --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
+                                     Management section for your Qna Maker cognitive service). Overrides the
+                                     subscriptionkey value present in the config
 ```
 
 _See code: [src/commands/qnamaker/update/endpointsettings.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/update/endpointsettings.ts)_
@@ -448,12 +452,15 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:update:kb command help
-  --in=in                            (required) The UpdateKbOperationDTO object to send in the body of the request.
-  --kbId=kbId                        Knowledgebase id.
+
+  --in=in                            The file path to the UpdateKbOperationDTO object to send in the body of the
+                                     request.
+
+  --kbId=kbId                        Knowledgebase id. Overrides the knowledge base id present in the config
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
-                                     subscriptionkey value present in config
+                                     subscriptionkey value present in the config
 
   --wait                             Wait for the operation to complete.
 ```

packages/qnamaker/src/commands/qnamaker/create/kb.ts

@@ -19,8 +19,7 @@ export default class QnamakerCreateKb extends Command {
     in: flags.string({description: 'File path to the CreateKbDTO object to send in the body of the request.'}),
     name: flags.string({description: 'Name of the kb you want to create. This will override the name of KB that might be present in the CreateKb DTO'}),
     save: flags.boolean({description: 'Save the kbId in config.'}),
-    quiet: flags.boolean({description: 'Save the kbId in config.'}),
-    subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in config'}),
+    subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in the config'}),
     help: flags.help({char: 'h', description: 'qnamaker:create:kb command help'}),
   }
 
@@ -37,12 +36,11 @@ export default class QnamakerCreateKb extends Command {
       input.requestBody.name = flags.name
     }
 
-    if (!input.requestBody.name && flags.quiet) {
+    if (!input.requestBody.name) {
       let answer = readlineSync.question('What would you like to name your new knowledgebase?')
       if (answer && answer.length > 0) {
         input.requestBody.name = answer.trim()
       }
-
     }
     // hack to map incorrect export property from expected import.  Export uses qnaDocuments, create/update/replace qnaList :(
     if (input.requestBody.qnaDocuments && !input.requestBody.qnaList) {
@@ -58,8 +56,8 @@ export default class QnamakerCreateKb extends Command {
 
     result = await qnaconfig.waitForOperationSucceeded(input.config, result)
 
+    let kbId = result.resourceLocation.split('/')[2]
     if (flags.save) {
-      let kbId = result.resourceLocation.split('/')[2]
       input.config.kbId = kbId
       await this.updateKbId(input.config)
       let userConfig: any = {}
@@ -73,7 +71,7 @@ export default class QnamakerCreateKb extends Command {
       userConfig.qnamaker = input.config
       await fs.writeJson(path.join(this.config.configDir, 'config.json'), userConfig, {spaces: 2})
     } else {
-      this.log(JSON.stringify(result, null, 2))
+      this.log('Knowledge Base id: ' + kbId)
     }
   }
 

packages/qnamaker/src/commands/qnamaker/delete/kb.ts

@@ -11,8 +11,8 @@ export default class QnamakerDeleteKb extends Command {
   static description = 'Delete a knowledgebase by id'
 
   static flags: flags.Input<any> = {
-    kbId: flags.string({description: 'Knowledgebase id to be deleted'}),
-    subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in config'}),
+    kbId: flags.string({description: 'Knowledgebase id to be deleted. Overrides the knowledge base id present in the config'}),
+    subscriptionKey: flags.string({description: 'Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource Management section for your Qna Maker cognitive service). Overrides the subscriptionkey value present in the config'}),
     force: flags.boolean({description: 'Do not prompt for confirmation, force the operation  '}),
     help: flags.help({char: 'h', description: 'qnamaker:delete:kb command help'}),
   }
@@ -24,8 +24,8 @@ export default class QnamakerDeleteKb extends Command {
     if (!flags.force) {
       let kbResult = await new Knowledgebase().getKnowledgebaseDetails(input.config)
       let kb = await JSON.parse(await kbResult.text())
-      let answer = await cli.prompt(`Are you sure you would like to delete ${kb.name} [${kb.id}]? [no] `, {default: 'no'})
-      if (answer.trim()[0] === 'n') {
+      let answer = await cli.confirm(`Are you sure you would like to delete ${kb.name} [${kb.id}]? (y/n)`)
+      if (!answer) {
         this.log('operation canceled')
         return
       }
@@ -36,5 +36,7 @@ export default class QnamakerDeleteKb extends Command {
     if (result.error) {
       throw new CLIError(JSON.stringify(result.error, null, 4))
     }
+
+    this.log('Success')
   }
 }