diff --git a/packages/cli/README.md b/packages/cli/README.md index 7f01c51b7..d5444c268 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -143,7 +143,9 @@ USAGE OPTIONS --kbid=kbid QnAMaker kbid to be set - --subscriptionkey=subscriptionkey QnAMaker subscriptionkey to be set + --subscriptionkey=subscriptionkey QnAMaker Ocp Apim subscription key to be set. You can find it in Keys under Resource Management section for your QnA Maker service + --hostname=hostname Specific the URL for your private QnA Service + --endpointkey=endpointkey Specifies the endpoint key to call Generate ANswer ``` _See code: [@microsoft/bf-cli-config](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/config/qnamaker/set.ts)_ @@ -209,14 +211,14 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.1.6 ## `bf qnamaker` -QnA Maker CLI (Preview version) +Provides access to QnA Maker commands ``` USAGE $ bf qnamaker OPTIONS - -h, --help Display QnA Maker CLI available commnads + -h, --help Displays commands available for QnA Maker ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/index.ts)_ @@ -232,26 +234,16 @@ USAGE OPTIONS -h, --help qnamaker:create:kb command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config. --in=in (required) The CreateKbDTO object to send in the body of the request. - --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and - the QNAMAKER_KBID environment variable. - - --name=name Name of the kb you want to create. + --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 --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + config value. - --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 --wait Wait for the operation to complete. ``` @@ -269,23 +261,16 @@ USAGE OPTIONS -h, --help qnamaker:delete:kb command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - --force Do not prompt for confirmation, force the operation - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value in config. --kbId=kbId (required) Knowledgebase id to be deleted --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + config value. - --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 config value. ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/delete/kb.ts)_ @@ -301,25 +286,16 @@ USAGE OPTIONS -h, --help qnamaker:export:kb command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - --environment=environment (required) Specifies whether environment is Test or Prod. - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config --kbId=kbId (required) Knowledgebase id to be exported. - --legacy Specifies if is a legacy knowlegebase. - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + config values. - --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 config value. ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/export/kb.ts)_ @@ -349,23 +325,14 @@ USAGE OPTIONS -h, --help qnamaker:get:kb command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --environment=environment Specifies whether environment is Test or Prod. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config. --kbId=kbId (required) Knowledgebase id to get metadata. - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. overrides the value present in config --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. + Services Azure portal page under "access keys"). Overrides the value present in config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/get/kb.ts)_ @@ -381,41 +348,18 @@ USAGE OPTIONS -h, --help qnamaker:get:operationdetails command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. - - --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and - the QNAMAKER_KBID environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config --operationId=operationId (required) Operation id. - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the value present in the config --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. + Services Azure portal page under "access keys"). Overrides the value present in the config ``` _See code: [@microsoft/bf-qnamaker](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. - -``` -USAGE - $ bf qnamaker:init - -OPTIONS - -h, --help qnamaker:init command help -``` - -_See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/init.ts)_ ## `bf qnamaker:list` @@ -433,7 +377,7 @@ _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cl ## `bf qnamaker:list:alterations` -Downloads all word alterations (synonyms) that have been automatically mined or added by the user. +Downloads all word alterations (synonyms) that have been added by the user. ``` USAGE @@ -442,22 +386,12 @@ USAGE OPTIONS -h, --help qnamaker:list:alterations command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config. - --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and - the QNAMAKER_KBID environment variable. - - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the values present in the config --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. + Services Azure portal page under "access keys"). Overrides the value present in the config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/list/alterations.ts)_ @@ -473,22 +407,13 @@ USAGE OPTIONS -h, --help qnamaker:list:endpointkeys command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. - - --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and - the QNAMAKER_KBID environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in the config. - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the value present in the config + --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. + Services Azure portal page under "access keys"). Overrides the value present in the config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/list/endpointkeys.ts)_ @@ -504,22 +429,12 @@ USAGE OPTIONS -h, --help qnamaker:list:kbs command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config. - --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and - the QNAMAKER_KBID environment variable. - - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the value present in the config --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. + Services Azure portal page under "access keys"). Overrides the values present in the config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/list/kbs.ts)_ @@ -535,28 +450,21 @@ USAGE OPTIONS -h, --help qnamaker:publish:kb command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config - --kbId=kbId (required) Knowledgebase id to pubish. + --kbId=kbId (required) Knowledgebase id to pubish. - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the value present in config --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. + Services Azure portal page under "access keys"). Overrides the value present in config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/publish/kb.ts)_ ## `bf qnamaker:query` -Query model for prediction +Query model for fetching the answer from Kb for a query ``` USAGE @@ -566,23 +474,15 @@ OPTIONS -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 .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. + KB settings page). Overrides the value present in config. - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config. + + --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the value present in the config + + --question=question (required) Query to get a answer for. - --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and - the QNAMAKER_KBID environment variable. - - --question=question (required) Query to get a prediction for. - - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. - - --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. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the value present in th config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/query.ts)_ @@ -598,24 +498,16 @@ USAGE OPTIONS -h, --help qnamaker:refresh:endpoints command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. - --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and - the QNAMAKER_KBID environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config --keyType=keyType (required) Type of Key. - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the valure present in config + --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. + Services Azure portal page under "access keys"). Overrides the value present in config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/refresh/endpointkeys.ts)_ @@ -636,7 +528,7 @@ _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cl ## `bf qnamaker:replace:alterations` -Replaces word alterations (synonyms) for the KB with the give records. +Replaces word alterations (synonyms) for the KB with the given records. ``` USAGE @@ -645,24 +537,15 @@ USAGE OPTIONS -h, --help qnamaker:replace:alterations command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config --in=in (required) The WordAlterationsDTO object to send in the body of the request - --kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the .qnamakerrc value and - the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the value in the config - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. --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. + Services Azure portal page under "access keys"). Overrides the value in the config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/replace/alterations.ts)_ @@ -678,23 +561,16 @@ USAGE OPTIONS -h, --help qnamaker:replace:kb command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config - --in=in (required) The ReplaceKbDTO object to send in the body of the request + --in=in (required) The QnADTO object to send in the body of the request --kbId=kbId (required) Knowledgebase id. - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the value present in the config --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. + Services Azure portal page under "access keys"). Overrides the value present in the config ``` _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/replace/kb.ts)_ @@ -710,23 +586,16 @@ USAGE OPTIONS -h, --help qnamaker:update:kb command help - --endpointKey=endpointKey Specifies the endpoint key for your private QnA service.(from qnamaker.ai portal - user settings page). Overrides the .qnamakerrc value and the QNAMAKER_ENDPOINTKEY - environment variable. - - --hostname=hostname Specifies the url for your private QnA service. Overrides the .qnamakerrc value and - the QNAMAKER_HOSTNAME environment variable. + --hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config. --in=in (required) The UpdateKbOperationDTO object to send in the body of the request. --kbId=kbId (required) Knowledgebase id. - --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the - .qnamakerrc value and the QNAMAKER_KBID environment variable. + --stdin Specifies qnamaker configuration is being passed via stdin. Overrides the value present in config. --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. + Services Azure portal page under "access keys"). Overrides the value present in the config --wait Wait for the operation to complete. ```