Merge pull request #202 from microsoft/emimunoz/qnamaker

Gov support to QnAMaker

Author: munozemilio

packages/cli/README.md

@@ -30,12 +30,13 @@
 * [`bf qnamaker:replace:alterations`](#bf-qnamakerreplacealterations)
 * [`bf qnamaker:replace:kb`](#bf-qnamakerreplacekb)
 * [`bf qnamaker:train`](#bf-qnamakertrain)
+* [`bf qnamaker:update`](#bf-qnamakerupdate)
 * [`bf qnamaker:update:endpointsettings`](#bf-qnamakerupdateendpointsettings)
 * [`bf qnamaker:update:kb`](#bf-qnamakerupdatekb)
 
 ## `bf qnamaker`
 
-QnA Maker CLI (Preview version)
+QnA Maker
 
 ```
 USAGE
@@ -57,6 +58,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:create:kb command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --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
@@ -81,6 +83,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:delete:kb command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --force                            Do not prompt for confirmation, force the operation
 
   --kbId=kbId                        Knowledgebase id to be deleted. Overrides the knowledge base id present in the
@@ -103,6 +106,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:export:kb command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --environment=environment          (required) Specifies whether environment is Test or Prod.
 
   --kbId=kbId                        Knowledgebase id to be exported. Overrides the knowledge base id present in the
@@ -139,6 +143,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:get:endpointsettings command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --kbId=kbId                        Knowledgebase id to get metadata.
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
@@ -158,6 +163,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:get:kb command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
 
   --kbId=kbId                        Knowledgebase id to get metadata. Overrides the knowledge base id present in the
                                      config
@@ -179,6 +185,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:get:operationdetails command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --operationId=operationId          (required) Operation id.
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
@@ -197,7 +204,8 @@ USAGE
   $ bf qnamaker:init
 
 OPTIONS
-  -h, --help  qnamaker:init command help
+  -h, --help           qnamaker:init command help
+  --endpoint=endpoint  Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
 ```
 
 _See code: [src/commands/qnamaker/init.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/init.ts)_
@@ -226,6 +234,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:list:alterations command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
@@ -244,6 +253,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:list:endpointkeys command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
@@ -262,6 +272,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:list:kbs command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
@@ -280,6 +291,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:publish:kb command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --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
@@ -332,6 +344,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:refresh:endpoints command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --keyType=keyType                  (required) Type of Key. (PrimaryKey/SecondaryKey)
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
@@ -365,6 +378,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:replace:alterations command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --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
@@ -384,6 +398,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:replace:kb command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
   --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
 
@@ -423,6 +438,20 @@ OPTIONS
 
 _See code: [src/commands/qnamaker/train.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/train.ts)_
 
+## `bf qnamaker:update`
+
+Updates KB or Endpoint settings
+
+```
+USAGE
+  $ bf qnamaker:update
+
+OPTIONS
+  -h, --help  display qnamaker:update available commands
+```
+
+_See code: [src/commands/qnamaker/update/index.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/update/index.ts)_
+
 ## `bf qnamaker:update:endpointsettings`
 
 Updates endpoint settings for an endpoint.
@@ -434,6 +463,7 @@ USAGE
 OPTIONS
   -h, --help                         qnamaker:update:endpointsettings command help
   --activelearning                   Enable active learning. Disables if flag not set
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
 
   --subscriptionKey=subscriptionKey  Specifies the qnamaker Ocp-Apim-Subscription Key (found in Keys under Resource
                                      Management section for your Qna Maker cognitive service). Overrides the
@@ -452,6 +482,7 @@ USAGE
 
 OPTIONS
   -h, --help                         qnamaker:update:kb command help
+  --endpoint=endpoint                Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
 
   --in=in                            The file path to the UpdateKbOperationDTO object to send in the body of the
                                      request.

packages/qnamaker/README.md

@@ -20,6 +20,7 @@ export default class QnamakerCreateKb extends Command {
     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.'}),
     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'}),
+    endpoint: flags.string({description: 'Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/'}),
     help: flags.help({char: 'h', description: 'qnamaker:create:kb command help'}),
   }
 
@@ -68,6 +69,8 @@ export default class QnamakerCreateKb extends Command {
         await fs.mkdirp(this.config.configDir)
       }
 
+      delete input.config.endpoint
+
       userConfig.qnamaker = input.config
       await fs.writeJson(path.join(this.config.configDir, 'config.json'), userConfig, {spaces: 2})
     } else {

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

@@ -13,7 +13,8 @@ export default class QnamakerDeleteKb extends Command {
   static flags: flags.Input<any> = {
     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  '}),
+    force: flags.boolean({description: 'Do not prompt for confirmation, force the operation'}),
+    endpoint: flags.string({description: 'Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/'}),
     help: flags.help({char: 'h', description: 'qnamaker:delete:kb command help'}),
   }
 

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

@@ -10,6 +10,7 @@ export default class QnamakerExportKb extends Command {
     kbId: flags.string({description: 'Knowledgebase id to be exported. Overrides the knowledge base id present in the config'}),
     environment: flags.string({description: 'Specifies whether environment is Test or Prod.', required: true}),
     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'}),
+    endpoint: flags.string({description: 'Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/'}),
     help: flags.help({char: 'h', description: 'qnamaker:export:kb command help'}),
   }
 

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

@@ -9,6 +9,7 @@ export default class QnamakerGetEndpointsettings extends Command {
   static flags: flags.Input<any> = {
     kbId: flags.string({description: 'Knowledgebase id to get metadata.'}),
     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'}),
+    endpoint: flags.string({description: 'Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/'}),
     help: flags.help({char: 'h', description: 'qnamaker:get:endpointsettings command help'}),
   }
 

packages/qnamaker/src/commands/qnamaker/get/endpointsettings.ts

@@ -10,6 +10,7 @@ export default class QnamakerGetKb extends Command {
   static flags: flags.Input<any> = {
     kbId: flags.string({description: 'Knowledgebase id to get metadata. 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'}),
+    endpoint: flags.string({description: 'Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/'}),
     help: flags.help({char: 'h', description: 'qnamaker:get:kb command help'}),
   }
 

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

@@ -10,6 +10,7 @@ export default class QnamakerGetOperationdetails extends Command {
   static flags: flags.Input<any> = {
     operationId: flags.string({description: 'Operation id.', required: true}),
     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'}),
+    endpoint: flags.string({description: 'Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/'}),
     help: flags.help({char: 'h', description: 'qnamaker:get:operationdetails command help'}),
   }
 

packages/qnamaker/src/commands/qnamaker/get/operationdetails.ts

@@ -1,7 +1,7 @@
 import {Command, flags} from '@microsoft/bf-cli-command'
 
 export default class QnamakerIndex extends Command {
-  static description = 'QnA Maker CLI (Preview version)'
+  static description = 'QnA Maker'
 
   static flags: flags.Input<any> = {
     help: flags.help({char: 'h', description: 'Display QnA Maker CLI available commnads'}),

packages/qnamaker/src/commands/qnamaker/index.ts

@@ -11,17 +11,19 @@ export default class QnamakerInit extends Command {
   static description = 'Initializes the config file with settings.'
 
   static flags: flags.Input<any> = {
+    endpoint: flags.string({description: 'Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/'}),
     help: flags.help({char: 'h', description: 'qnamaker:init command help'}),
   }
 
   async run() {
-    const result = await this.initializeConfig()
+    const {flags} = this.parse(QnamakerInit)
+    const result = await this.initializeConfig(flags.endpoint)
     if (result) {
       this.log(`Successfully wrote ${this.config.configDir}/config.json`)
     }
   }
 
-  async initializeConfig(): Promise<boolean> {
+  async initializeConfig(endpoint: string | undefined): Promise<boolean> {
     this.log(chalk.cyan.bold('\nThis util will walk you through the QnA Maker config settings\n\nPress ^C at any time to quit.\n\n'))
     const questions = [
       'What is your QnAMaker access/subscription key? (found on the Cognitive Services Azure portal page under "access keys") ',
@@ -38,15 +40,16 @@ export default class QnamakerInit extends Command {
 
     let [subscriptionKey, kbId] = answers
     /* tslint:disable: prefer-object-spread */
-    const config = Object.assign({}, {subscriptionKey, kbId})
+    const config = Object.assign({}, {subscriptionKey, kbId, endpoint})
 
     if (subscriptionKey && kbId) {
-      cli.action.start('Updating hostname')
+      cli.action.start('Updating config file hostname and endpoint key')
       await this.updateKbId(config)
       cli.action.stop()
     }
 
     let confirmation: boolean
+    delete config.endpoint
     try {
       confirmation = await cli.confirm(`Does this look ok?\n${JSON.stringify(config, null, 2)}\n[Yes]/No:`)
       /* tslint:disable: no-unused */