@microsoft/bf-qnamaker
Advanced tools
This package is intended for Microsoft use only and should be consumed through @microsoft/botframework-cli. It is not designed to be consumed as an independent package.
bf qnamakerbf qnamaker:alterationsbf qnamaker:alterations:listbf qnamaker:alterations:replacebf qnamaker:buildbf qnamaker:convertbf qnamaker:cross-trainbf qnamaker:endpointkeysbf qnamaker:endpointkeys:listbf qnamaker:endpointkeys:refreshbf qnamaker:endpointsettingsbf qnamaker:endpointsettings:getbf qnamaker:endpointsettings:updatebf qnamaker:initbf qnamaker:kbbf qnamaker:kb:createbf qnamaker:kb:deletebf qnamaker:kb:exportbf qnamaker:kb:getbf qnamaker:kb:listbf qnamaker:kb:publishbf qnamaker:kb:replacebf qnamaker:kb:updatebf qnamaker:operationdetailsbf qnamaker:operationdetails:getbf qnamaker:querybf qnamaker:trainbf qnamaker:translatebf qnamakerQnA Maker
USAGE
$ bf qnamaker
OPTIONS
-h, --help Display QnA Maker CLI available commands
See code: src\commands\qnamaker\index.ts
bf qnamaker:alterationsCommands for replacing and listing your alterations
USAGE
$ bf qnamaker:alterations
OPTIONS
-h, --help display qnamaker:alterations available commands
See code: src\commands\qnamaker\alterations\index.ts
bf qnamaker:alterations:listDownloads all word alterations (synonyms) that have been added by the user.
USAGE
$ bf qnamaker:alterations:list
OPTIONS
-h, --help qnamaker:alterations:list 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
subscriptionkey value present in the config
See code: src\commands\qnamaker\alterations\list.ts
bf qnamaker:alterations:replaceReplaces word alterations (synonyms) for the KB with the give records.
USAGE
$ bf qnamaker:alterations:replace
OPTIONS
-h, --help qnamaker:alterations:replace command help
-i, --in=in File path to the WordAlterationsDTO object to send in the body of the request
--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
subscriptionkey value present in the config
See code: src\commands\qnamaker\alterations\replace.ts
bf qnamaker:buildBuild .qna files to create or update qnamaker knowledge bases and qnamaker alterations
USAGE
$ bf qnamaker:build
OPTIONS
-b, --botName=botName Bot name
-f, --force If --out flag is provided with the path to an existing file, overwrites that
file
-h, --help qnamaker:build command help
-i, --in=in Source .qna file or folder
-o, --out=out Output folder name to write out .dialog and settings files. If not specified,
knowledge base setting will be output to console
-s, --subscriptionKey=subscriptionKey QnA maker subscription key
--defaultCulture=defaultCulture Culture code for the content. Infer from .qna if available. Defaults to en-us
if not set
--dialog=dialog Dialog recognizer type [multiLanguage|crosstrained]. No dialog recognizers will
be generated if not specified. Only valid if --out is set
--endpoint=endpoint Qnamaker authoring endpoint for publishing
--fallbackLocale=fallbackLocale Locale to be used at the fallback if no locale specific recognizer is found.
Only valid if --out is set
--log Writes out log messages to console
--qnaConfig=qnaConfig Path to config for qna build which can contain switches for arguments
--region=region [default: westus] Overrides public endpoint
https://<region>.api.cognitive.microsoft.com/qnamaker/v4.0/
--schema=schema Defines $schema for generated .dialog files
--suffix=suffix Environment name as a suffix identifier to include in qnamaker kb name.
Defaults to current logged in user alias
EXAMPLE
$ bf qnamaker:build --in {INPUT_FILE_OR_FOLDER} --subscriptionKey {SUBSCRIPTION_KEY} --botName {BOT_NAME}
See code: src\commands\qnamaker\build.ts
bf qnamaker:convertConverts .qna file(s) to QnA application JSON models or vice versa.
USAGE
$ bf qnamaker:convert
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help qnamaker:convert help
-i, --in=in Source .qna file(s) or QnA KB JSON file
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-r, --recurse Indicates if sub-folders need to be considered to file .qna file(s)
--alterations Indicates if files is QnA Alterations
--log Enables log messages
--name=name Name of the QnA KB
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files
See code: src\commands\qnamaker\convert.ts
bf qnamaker:cross-trainLu and Qna cross train tool
USAGE
$ bf qnamaker:cross-train
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:cross-train command help
-i, --in=in Source lu and qna files folder
-o, --out=out Output folder name. If not specified, the cross trained files will be written to
cross-trained folder under folder of current command
--config=config Path to config file of mapping rules
--intentName=intentName [default: _Interruption] Interruption intent name
--log Writes out log messages to console
See code: src\commands\qnamaker\cross-train.ts
bf qnamaker:endpointkeysCommands to refresh and list keys
USAGE
$ bf qnamaker:endpointkeys
OPTIONS
-h, --help display qnamaker:endpointkeys available commands
See code: src\commands\qnamaker\endpointkeys\index.ts
bf qnamaker:endpointkeys:listList all the currently valid endpointKeys for querying your private endpoint
USAGE
$ bf qnamaker:endpointkeys:list
OPTIONS
-h, --help qnamaker:endpointkeys:list 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
subscriptionkey value present in the config
See code: src\commands\qnamaker\endpointkeys\list.ts
bf qnamaker:endpointkeys:refreshRe-generates an endpoint key, in case you suspect your keys have been compromised
USAGE
$ bf qnamaker:endpointkeys:refresh
OPTIONS
-h, --help qnamaker:endpoints:refresh 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
Management section for your Qna Maker cognitive service). Overrides the
subscriptionkey value present in the config
See code: src\commands\qnamaker\endpointkeys\refresh.ts
bf qnamaker:endpointsettingsCommands to get and update endpoint settings
USAGE
$ bf qnamaker:endpointsettings
OPTIONS
-h, --help display qnamaker:update available commands
See code: src\commands\qnamaker\endpointsettings\index.ts
bf qnamaker:endpointsettings:getGets endpoint settings for an endpoint.
USAGE
$ bf qnamaker:endpointsettings:get
OPTIONS
-h, --help qnamaker:endpointsettings:get 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
Management section for your Qna Maker cognitive service). Overrides the
subscriptionkey value present in the config
See code: src\commands\qnamaker\endpointsettings\get.ts
bf qnamaker:endpointsettings:updateUpdates endpoint settings for an endpoint.
USAGE
$ bf qnamaker:endpointsettings:update
OPTIONS
-h, --help qnamaker:endpointsettings:update 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
subscriptionkey value present in the config
See code: src\commands\qnamaker\endpointsettings\update.ts
bf qnamaker:initInitializes the config file with settings.
USAGE
$ bf qnamaker:init
OPTIONS
-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
bf qnamaker:kbCommands for manipulating your knowledge base
USAGE
$ bf qnamaker:kb
OPTIONS
-h, --help display qnamaker:kb available commands
See code: src\commands\qnamaker\kb\index.ts
bf qnamaker:kb:createCreates a new knowledgebase
USAGE
$ bf qnamaker:kb:create
OPTIONS
-h, --help qnamaker:kb:create command help
-i, --in=in File path to the CreateKbDTO object to send in the body of the request.
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--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 the config
See code: src\commands\qnamaker\kb\create.ts
bf qnamaker:kb:deleteDelete a knowledgebase by id
USAGE
$ bf qnamaker:kb:delete
OPTIONS
-h, --help qnamaker:kb:delete 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
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 the config
See code: src\commands\qnamaker\kb\delete.ts
bf qnamaker:kb:exportEchos a knowledgebase in json or qna format to stdout
USAGE
$ bf qnamaker:kb:export
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file.
-h, --help qnamaker:kb:export command help
-o, --out=out Output file path. If not specified stdout will be used as output.
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--environment=environment [default: Prod] Specifies whether environment is Test or Prod.
--kbId=kbId Knowledgebase id to be exported. Overrides the knowledge base id present in the
config
--qnaFormat Specifies if the content should be exported to .qna format.
--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\kb\export.ts
bf qnamaker:kb:getGet metadata about a knowledgebase
USAGE
$ bf qnamaker:kb:get
OPTIONS
-h, --help qnamaker:kb:get 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
--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\kb\get.ts
bf qnamaker:kb:listList all of your knowledgebases
USAGE
$ bf qnamaker:kb:list
OPTIONS
-h, --help qnamaker:kb:list 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
subscriptionkey value present in the config
See code: src\commands\qnamaker\kb\list.ts
bf qnamaker:kb:publishPublish all unpublished in the knowledgebase to the prod endpoint.
USAGE
$ bf qnamaker:kb:publish
OPTIONS
-h, --help qnamaker:kb:publish 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
Management section for your Qna Maker cognitive service). Overrides the
subscriptionkey value present in the config
See code: src\commands\qnamaker\kb\publish.ts
bf qnamaker:kb:replaceReplace a knowledgebase contents with new contents
USAGE
$ bf qnamaker:kb:replace
OPTIONS
-h, --help qnamaker:kb:replace command help
-i, --in=in File path to the ReplaceKbDTO object to send in the body of the request.
Alternately this can be path to a .qna file
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--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 the config
See code: src\commands\qnamaker\kb\replace.ts
bf qnamaker:kb:updateAdd or delete QnA Pairs and / or URLs to an existing knowledge base
USAGE
$ bf qnamaker:kb:update
OPTIONS
-h, --help qnamaker:kb:update command help
-i, --in=in The file path to the UpdateKbOperationDTO object to send in the body of the
request.
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--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 the config
--wait Wait for the operation to complete.
See code: src\commands\qnamaker\kb\update.ts
bf qnamaker:operationdetailsCommand to get operation details
USAGE
$ bf qnamaker:operationdetails
OPTIONS
-h, --help display qnamaker:operationdetails available commands
See code: src\commands\qnamaker\operationdetails\index.ts
bf qnamaker:operationdetails:getGets details of a specific long running operation.
USAGE
$ bf qnamaker:operationdetails:get
OPTIONS
-h, --help qnamaker:operationdetails:get 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
Management section for your Qna Maker cognitive service). Overrides the
subscriptionkey value present in the config
See code: src\commands\qnamaker\operationdetails\get.ts
bf qnamaker:queryGenerate Answer for fetching the answer from Kb for a query
USAGE
$ bf qnamaker:query
OPTIONS
-h, --help qnamaker:query command help
--context=context Path to Context object json file with previous QnA
--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
--kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the value present in the
config
--qnaId=qnaId Exact qnaId to fetch from the knowledgebase, this field takes priority over question
--question=question (required) Query to get a prediction for
--scorethreshold=scorethreshold Specifies the confidence score threshold for the returned answer.
--strictfilters=strictfilters Path to json file with MetadataDTO[] e.g {"strictfilters": MetadataDTO[]}
--test Query against the test index
--top=top Specifies the number of matching results
See code: src\commands\qnamaker\query.ts
bf qnamaker:trainTrain call to add suggestions to the knowledgebase.
USAGE
$ bf qnamaker:train
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 value present in config.
--hostname=hostname Specifies the url for your private QnA service. Overrides the value present in
config.
--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
--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
See code: src\commands\qnamaker\train.ts
bf qnamaker:translateTranslate given QnA maker application JSON model or qna file(s)
USAGE
$ bf qnamaker:translate
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites
that file
-h, --help qnamaker:translate help
-i, --in=in Source .qna file(s) or QnA maker application JSON model
-o, --out=out Output folder name. If not specified stdout will be used as output
-r, --recurse Indicates if sub-folders need to be considered to find .qna file(s)
--srclang=srclang Source lang code. Auto detect if missing.
--subscription_region=subscription_region Required request header if using a Cognitive Services Resource. Optional if
using a Translator Resource.
--tgtlang=tgtlang (required) Comma separated list of target languages.
--translate_comments When set, machine translate comments found in .qna file
--translate_link_text When set, machine translate link description in .qna file
--translatekey=translatekey (required) Machine translation endpoint key.
See code: src\commands\qnamaker\translate.ts
bf qnamakerbf qnamaker:alterationsbf qnamaker:alterations:listbf qnamaker:alterations:replacebf qnamaker:buildbf qnamaker:convertbf qnamaker:cross-trainbf qnamaker:endpointkeysbf qnamaker:endpointkeys:listbf qnamaker:endpointkeys:refreshbf qnamaker:endpointsettingsbf qnamaker:endpointsettings:getbf qnamaker:endpointsettings:updatebf qnamaker:initbf qnamaker:kbbf qnamaker:kb:createbf qnamaker:kb:deletebf qnamaker:kb:exportbf qnamaker:kb:getbf qnamaker:kb:listbf qnamaker:kb:publishbf qnamaker:kb:replacebf qnamaker:kb:updatebf qnamaker:operationdetailsbf qnamaker:operationdetails:getbf qnamaker:querybf qnamaker:trainbf qnamaker:translatebf qnamakerQnA Maker
USAGE
$ bf qnamaker
OPTIONS
-h, --help Display QnA Maker CLI available commands
See code: src/commands/qnamaker/index.ts
bf qnamaker:alterationsCommands for replacing and listing your alterations
USAGE
$ bf qnamaker:alterations
OPTIONS
-h, --help display qnamaker:alterations available commands
See code: src/commands/qnamaker/alterations/index.ts
bf qnamaker:alterations:listDownloads all word alterations (synonyms) that have been added by the user.
USAGE
$ bf qnamaker:alterations:list
OPTIONS
-h, --help qnamaker:alterations:list 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
subscriptionkey value present in the config
See code: src/commands/qnamaker/alterations/list.ts
bf qnamaker:alterations:replaceReplaces word alterations (synonyms) for the KB with the give records.
USAGE
$ bf qnamaker:alterations:replace
OPTIONS
-h, --help qnamaker:alterations:replace command help
-i, --in=in File path to the WordAlterationsDTO object to send in the body of the request
--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
subscriptionkey value present in the config
See code: src/commands/qnamaker/alterations/replace.ts
bf qnamaker:buildBuild .qna files to create or update qnamaker knowledge bases and qnamaker alterations
USAGE
$ bf qnamaker:build
OPTIONS
-b, --botName=botName Bot name
-f, --force If --out flag is provided with the path to an existing file, overwrites that
file
-h, --help qnamaker:build command help
-i, --in=in Source .qna file or folder
-o, --out=out Output folder name to write out .dialog and settings files. If not specified,
knowledge base setting will be output to console
-s, --subscriptionKey=subscriptionKey QnA maker subscription key
--defaultCulture=defaultCulture Culture code for the content. Infer from .qna if available. Defaults to en-us
if not set
--dialog=dialog Dialog recognizer type [multiLanguage|crosstrained]. No dialog recognizers will
be generated if not specified. Only valid if --out is set
--endpoint=endpoint Qnamaker authoring endpoint for publishing
--fallbackLocale=fallbackLocale Locale to be used at the fallback if no locale specific recognizer is found.
Only valid if --out is set
--log Writes out log messages to console
--qnaConfig=qnaConfig Path to config for qna build which can contain switches for arguments
--region=region [default: westus] Overrides public endpoint
https://<region>.api.cognitive.microsoft.com/qnamaker/v4.0/
--schema=schema Defines $schema for generated .dialog files
--suffix=suffix Environment name as a suffix identifier to include in qnamaker kb name.
Defaults to current logged in user alias
EXAMPLE
$ bf qnamaker:build --in {INPUT_FILE_OR_FOLDER} --subscriptionKey {SUBSCRIPTION_KEY} --botName {BOT_NAME}
See code: src/commands/qnamaker/build.ts
bf qnamaker:convertConverts .qna file(s) to QnA application JSON models or vice versa.
USAGE
$ bf qnamaker:convert
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help qnamaker:convert help
-i, --in=in Source .qna file(s) or QnA KB JSON file
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-r, --recurse Indicates if sub-folders need to be considered to file .qna file(s)
--alterations Indicates if files is QnA Alterations
--log Enables log messages
--name=name Name of the QnA KB
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files
See code: src/commands/qnamaker/convert.ts
bf qnamaker:cross-trainLu and Qna cross train tool
USAGE
$ bf qnamaker:cross-train
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:cross-train command help
-i, --in=in Source lu and qna files folder
-o, --out=out Output folder name. If not specified, the cross trained files will be written to
cross-trained folder under folder of current command
--config=config Path to config file of mapping rules
--intentName=intentName [default: _Interruption] Interruption intent name
--log Writes out log messages to console
See code: src/commands/qnamaker/cross-train.ts
bf qnamaker:endpointkeysCommands to refresh and list keys
USAGE
$ bf qnamaker:endpointkeys
OPTIONS
-h, --help display qnamaker:endpointkeys available commands
See code: src/commands/qnamaker/endpointkeys/index.ts
bf qnamaker:endpointkeys:listList all the currently valid endpointKeys for querying your private endpoint
USAGE
$ bf qnamaker:endpointkeys:list
OPTIONS
-h, --help qnamaker:endpointkeys:list 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
subscriptionkey value present in the config
See code: src/commands/qnamaker/endpointkeys/list.ts
bf qnamaker:endpointkeys:refreshRe-generates an endpoint key, in case you suspect your keys have been compromised
USAGE
$ bf qnamaker:endpointkeys:refresh
OPTIONS
-h, --help qnamaker:endpoints:refresh 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
Management section for your Qna Maker cognitive service). Overrides the
subscriptionkey value present in the config
See code: src/commands/qnamaker/endpointkeys/refresh.ts
bf qnamaker:endpointsettingsCommands to get and update endpoint settings
USAGE
$ bf qnamaker:endpointsettings
OPTIONS
-h, --help display qnamaker:update available commands
See code: src/commands/qnamaker/endpointsettings/index.ts
bf qnamaker:endpointsettings:getGets endpoint settings for an endpoint.
USAGE
$ bf qnamaker:endpointsettings:get
OPTIONS
-h, --help qnamaker:endpointsettings:get 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
Management section for your Qna Maker cognitive service). Overrides the
subscriptionkey value present in the config
See code: src/commands/qnamaker/endpointsettings/get.ts
bf qnamaker:endpointsettings:updateUpdates endpoint settings for an endpoint.
USAGE
$ bf qnamaker:endpointsettings:update
OPTIONS
-h, --help qnamaker:endpointsettings:update 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
subscriptionkey value present in the config
See code: src/commands/qnamaker/endpointsettings/update.ts
bf qnamaker:initInitializes the config file with settings.
USAGE
$ bf qnamaker:init
OPTIONS
-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
bf qnamaker:kbCommands for manipulating your knowledge base
USAGE
$ bf qnamaker:kb
OPTIONS
-h, --help display qnamaker:kb available commands
See code: src/commands/qnamaker/kb/index.ts
bf qnamaker:kb:createCreates a new knowledgebase
USAGE
$ bf qnamaker:kb:create
OPTIONS
-h, --help qnamaker:kb:create command help
-i, --in=in File path to the CreateKbDTO object to send in the body of the request.
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--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 the config
See code: src/commands/qnamaker/kb/create.ts
bf qnamaker:kb:deleteDelete a knowledgebase by id
USAGE
$ bf qnamaker:kb:delete
OPTIONS
-h, --help qnamaker:kb:delete 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
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 the config
See code: src/commands/qnamaker/kb/delete.ts
bf qnamaker:kb:exportEchos a knowledgebase in json or qna format to stdout
USAGE
$ bf qnamaker:kb:export
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file.
-h, --help qnamaker:kb:export command help
-o, --out=out Output file path. If not specified stdout will be used as output.
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--environment=environment [default: Prod] Specifies whether environment is Test or Prod.
--kbId=kbId Knowledgebase id to be exported. Overrides the knowledge base id present in the
config
--qnaFormat Specifies if the content should be exported to .qna format.
--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/kb/export.ts
bf qnamaker:kb:getGet metadata about a knowledgebase
USAGE
$ bf qnamaker:kb:get
OPTIONS
-h, --help qnamaker:kb:get 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
--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/kb/get.ts
bf qnamaker:kb:listList all of your knowledgebases
USAGE
$ bf qnamaker:kb:list
OPTIONS
-h, --help qnamaker:kb:list 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
subscriptionkey value present in the config
See code: src/commands/qnamaker/kb/list.ts
bf qnamaker:kb:publishPublish all unpublished in the knowledgebase to the prod endpoint.
USAGE
$ bf qnamaker:kb:publish
OPTIONS
-h, --help qnamaker:kb:publish 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
Management section for your Qna Maker cognitive service). Overrides the
subscriptionkey value present in the config
See code: src/commands/qnamaker/kb/publish.ts
bf qnamaker:kb:replaceReplace a knowledgebase contents with new contents
USAGE
$ bf qnamaker:kb:replace
OPTIONS
-h, --help qnamaker:kb:replace command help
-i, --in=in File path to the ReplaceKbDTO object to send in the body of the request.
Alternately this can be path to a .qna file
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--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 the config
See code: src/commands/qnamaker/kb/replace.ts
bf qnamaker:kb:updateAdd or delete QnA Pairs and / or URLs to an existing knowledge base
USAGE
$ bf qnamaker:kb:update
OPTIONS
-h, --help qnamaker:kb:update command help
-i, --in=in The file path to the UpdateKbOperationDTO object to send in the body of the
request.
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
--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 the config
--wait Wait for the operation to complete.
See code: src/commands/qnamaker/kb/update.ts
bf qnamaker:operationdetailsCommand to get operation details
USAGE
$ bf qnamaker:operationdetails
OPTIONS
-h, --help display qnamaker:operationdetails available commands
See code: src/commands/qnamaker/operationdetails/index.ts
bf qnamaker:operationdetails:getGets details of a specific long running operation.
USAGE
$ bf qnamaker:operationdetails:get
OPTIONS
-h, --help qnamaker:operationdetails:get 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
Management section for your Qna Maker cognitive service). Overrides the
subscriptionkey value present in the config
See code: src/commands/qnamaker/operationdetails/get.ts
bf qnamaker:queryGenerate Answer for fetching the answer from Kb for a query
USAGE
$ bf qnamaker:query
OPTIONS
-h, --help qnamaker:query command help
--context=context Path to Context object json file with previous QnA
--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
--kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the value present in the
config
--qnaId=qnaId Exact qnaId to fetch from the knowledgebase, this field takes priority over question
--question=question (required) Query to get a prediction for
--scorethreshold=scorethreshold Specifies the confidence score threshold for the returned answer.
--strictfilters=strictfilters Path to json file with MetadataDTO[] e.g {"strictfilters": MetadataDTO[]}
--test Query against the test index
--top=top Specifies the number of matching results
See code: src/commands/qnamaker/query.ts
bf qnamaker:trainTrain call to add suggestions to the knowledgebase.
USAGE
$ bf qnamaker:train
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 value present in config.
--hostname=hostname Specifies the url for your private QnA service. Overrides the value present in
config.
--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
--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
See code: src/commands/qnamaker/train.ts
bf qnamaker:translateTranslate given QnA maker application JSON model or qna file(s)
USAGE
$ bf qnamaker:translate
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites
that file
-h, --help qnamaker:translate help
-i, --in=in Source .qna file(s) or QnA maker application JSON model
-o, --out=out Output folder name. If not specified stdout will be used as output
-r, --recurse Indicates if sub-folders need to be considered to find .qna file(s)
--srclang=srclang Source lang code. Auto detect if missing.
--subscription_region=subscription_region Required request header if using a Cognitive Services Resource. Optional if
using a Translator Resource.
--tgtlang=tgtlang (required) Comma separated list of target languages.
--translate_comments When set, machine translate comments found in .qna file
--translate_link_text When set, machine translate link description in .qna file
--translatekey=translatekey (required) Machine translation endpoint key.
See code: src/commands/qnamaker/translate.ts
FAQs
@microsoft/bf-qnamaker ======================
The npm package @microsoft/bf-qnamaker receives a total of 2,643 weekly downloads. As such, @microsoft/bf-qnamaker popularity was classified as popular.
We found that @microsoft/bf-qnamaker demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket Firewall Enterprise is now available with flexible deployment, configurable policies, and expanded language support.
Security News
Open source dashboard CNAPulse tracks CVE Numbering Authorities’ publishing activity, highlighting trends and transparency across the CVE ecosystem.
Product
Detect malware, unsafe data flows, and license issues in GitHub Actions with Socket’s new workflow scanning support.