@microsoft/bf-luis-cli
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 luisbf luis:application:assignazureaccountbf luis:application:createbf luis:application:deletebf luis:application:importbf luis:application:listbf luis:application:publishbf luis:application:querybf luis:application:renamebf luis:application:showbf luis:buildbf luis:convertbf luis:cross-trainbf luis:endpoints:listbf luis:generate:csbf luis:generate:tsbf luis:testbf luis:train:runbf luis:train:showbf luis:translatebf luis:version:clonebf luis:version:deletebf luis:version:exportbf luis:version:importbf luis:version:listbf luis:version:renamebf luisManages LUIS assets on service and/or locally.
USAGE
$ bf luis
OPTIONS
-h, --help LUIS command help
See code: src\commands\luis\index.ts
bf luis:application:assignazureaccountAssign a LUIS azure accounts to an application
USAGE
$ bf luis:application:assignazureaccount
OPTIONS
-h, --help show CLI help
--accountName=accountName (required) Account name
--appId=appId (required) LUIS application Id (defaults to config:set:luis --appId
{APPLICATION_ID})
--armToken=armToken (required) User`s ARM token used to validate azure accounts information
(default: config:set:luis --armToken {ARM_TOKEN})
--azureSubscriptionId=azureSubscriptionId (required) Azure Subscription Id
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--resourceGroup=resourceGroup (required) Resource Group
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:set:luis --subscriptionKey {SUBSCRIPTION_KEY})
See code: src\commands\luis\application\assignazureaccount.ts
bf luis:application:createCreates a new LUIS application
USAGE
$ bf luis:application:create
OPTIONS
-h, --help show CLI help
--culture=culture Specify culture language (default: en-us)
--description=description Description of LUIS application
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--name=name (required) Name of LUIS application
--save Save configuration settings from imported app (appId & endpoint)
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--tokenizerVersion=tokenizerVersion Version specifies how sentences are tokenized (optional). See also:
https://aka.ms/luistokens
--versionId=versionId (required) LUIS version Id. (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:application:create --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME} --culture
{CULTURE}
--domain {DOMAIN} --description {DESCRIPTION} --versionId {INITIAL_VERSION_ID}
See code: src\commands\luis\application\create.ts
bf luis:application:deleteDeletes a LUIS application
USAGE
$ bf luis:application:delete
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--force Force delete with no confirmation
--json Display output as JSON
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
EXAMPLE
$ bf luis:application:delete --appId {APP_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
See code: src\commands\luis\application\delete.ts
bf luis:application:importImports LUIS application from JSON or LU content.
USAGE
$ bf luis:application:import
OPTIONS
-h, --help show CLI help
-i, --in=in (required) File path containing LUIS application contents, uses STDIN if not
specified
--endpoint=endpoint (required) LUIS endpoint hostname
--json Display output as JSON
--name=name LUIS application name (optional)
--save Save configuration settings from imported app (appId, subscriptionKey & endpoint)
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default: config
subscriptionKey)
EXAMPLE
$ bf luis:application:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME} --in
{PATH_TO_JSON}
$ echo {SERIALIZED_JSON} | bf luis:application:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
--name {NAME}
See code: src\commands\luis\application\import.ts
bf luis:application:listLists all applications on LUIS service.
USAGE
$ bf luis:application:list
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help show CLI help
-o, --out=out Output results to specified file in JSON format, otherwise prints to STDOUT
(optional)
--endpoint=endpoint LUIS endpoint hostname
--skip=skip Number of entries to skip. Default: 0 (no skips)
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--take=take Number of etnries to return. Maximum page size is 500. Default: 100
EXAMPLE
$ bf luis:application:list --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --take 3
$ bf luis:application:list --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --out {PATH_TO_JSON_FILE}
See code: src\commands\luis\application\list.ts
bf luis:application:publishPublishes application's version
USAGE
$ bf luis:application:publish
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--direct Available only in direct version query. Do not publish to staging or production
--endpoint=endpoint LUIS endpoint hostname
--staging Publishes application version to Staging slot, otherwise publish to production
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to publish (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:application:publish --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --versionId
{INITIAL_VERSION_ID} --appId {APP_ID} --staging {BOOLEAN}
See code: src\commands\luis\application\publish.ts
bf luis:application:queryQueries application for intent predictions
USAGE
$ bf luis:application:query
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--log Logs query operation on service (default: true)
--query=query (required) Query string to predict
--staging Presence of flag targets the staging app, if no flag passed defaults to production
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--timezoneOffset=timezoneOffset Timezone offset for the location of the request in minutes (optional)
--verbose Returns all intents, otherwise only top scoring intent. (default: false)
EXAMPLE
$ bf luis:application:query --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --query
{QUERY} --prod {BOOLEAN}
See code: src\commands\luis\application\query.ts
bf luis:application:renameRenames the application and updates its description
USAGE
$ bf luis:application:rename
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--description=description Description of LUIS application
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--name=name (required) (required) Name of LUIS application
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
EXAMPLE
$ bf luis:application:rename --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --name
{NAME} --description {DESCRIPTION}
See code: src\commands\luis\application\rename.ts
bf luis:application:showShows application information
USAGE
$ bf luis:application:show
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
EXAMPLE
$ bf luis:application:show --appId {APPLICATION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
See code: src\commands\luis\application\show.ts
bf luis:buildBuild lu files to train and publish luis applications
USAGE
$ bf luis:build
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:build command help
-i, --in=in (required) Lu file or folder
-o, --out=out Output folder name to write out .dialog and settings files. If not specified,
application setting will be output to console
--authoringKey=authoringKey (required) LUIS authoring key. Refered to as subscriptionKey in other cli commands.
--botName=botName (required) Bot name
--defaultCulture=defaultCulture Culture code for the content. Infer from .lu if available. Defaults to en-us
--deleteOldVersion Deletes old version of LUIS application after building new one.
--dialog=dialog Dialog recognizer type [multiLanguage|crosstrained]. No dialog recognizers will be
generated if not specified. Only valid if --out is set
--directVersionPublish Available only in direct version query. Do not publish to staging or production
--endpoint=endpoint (required) Luis 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
--isStaging Publishes luis application to staging slot if set. Default to production slot
--log Writes out log messages to console
--luConfig=luConfig Path to config for lu build which can contain switches for arguments
--region=region [default: westus] LUIS authoring region [westus|westeurope|australiaeast]
--schema=schema Defines $schema for generated .dialog files
--suffix=suffix Environment name as a suffix identifier to include in LUIS app name. Defaults to
current logged in user alias
EXAMPLE
$ bf luis:build --in {INPUT_FILE_OR_FOLDER} --authoringKey {AUTHORING_KEY} --botName {BOT_NAME}
See code: src\commands\luis\build.ts
bf luis:convertConvert .lu file(s) to a LUIS application JSON model or vice versa
USAGE
$ bf luis:convert
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:convert help
-i, --in=in Source .lu file(s) or LUIS application JSON model
-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 .lu file(s)
--culture=culture Lang code for the LUIS application
--description=description Text describing the LUIS applicaion
--log Enables log messages
--name=name Name of the LUIS application
--schemaversion=schemaversion Schema version of the LUIS application
--sort When set, intent, utterances, entities are alphabetically sorted in .lu files
--versionid=versionid Version ID of the LUIS application
See code: src\commands\luis\convert.ts
bf luis:cross-trainLu and Qna cross train tool
USAGE
$ bf luis: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
--exclude=exclude Excludes folders under the input directory, separated by ",". If not specified, all luis and
qna files will be included in the cross-train
--[no-]inner-dialog Only do inner dialog cross train
--intentName=intentName [default: _Interruption] Interruption intent name
--[no-]intra-dialog Only do intra dialog cross train
--log Writes out log messages to console
See code: src\commands\luis\cross-train.ts
bf luis:endpoints:listReturns available deployment endpoints
USAGE
$ bf luis:endpoints:list
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help show CLI help
-o, --out=out Output results to specified file in JSON format, otherwise prints to STDOUT
(optional)
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
EXAMPLE
$ bf luis:endpoints:list --appId {APPLICATION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
--out {PATH_TO_JSON_FILE}
See code: src\commands\luis\endpoints\list.ts
bf luis:generate:csGenerate:cs generates a strongly typed C# source code from an exported (json) LUIS model.
USAGE
$ bf luis:generate:cs
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:generate:cs help
-i, --in=in Path to the file containing the LUIS application JSON model
-o, --out=out Output file or folder name. If not specified stdout will be used as output
--className=className Name of the autogenerated class (can include namespace)
See code: src\commands\luis\generate\cs.ts
bf luis:generate:tsGenerate:ts generates a strongly typed typescript source code from an exported (json) LUIS model.
USAGE
$ bf luis:generate:ts
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:generate:ts help
-i, --in=in Path to the file containing the LUIS application JSON model
-o, --out=out Output file or folder name. If not specified stdout will be used as output
--className=className Name of the autogenerated class
See code: src\commands\luis\generate\ts.ts
bf luis:testTest a .lu file or LUIS application JSON model against a published LUIS model
USAGE
$ bf luis:test
OPTIONS
-a, --appId=appId (required) LUIS application Id
-h, --help luis:test help
-i, --in=in Source .lu file or LUIS application JSON model for testing
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-s, --subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key
--allowIntentsCount=allowIntentsCount [default: 1] Top-scoring intent or top n Intent with score to show in the
result
--endpoint=endpoint [default: https://westus.api.cognitive.microsoft.com] LUIS endpoint hostname
--force If --out flag is provided with the path to an existing file, overwrites that
file
--intentOnly Only test intent
--staging Presence of flag targets the staging app, if no flag passed defaults to
production
See code: src\commands\luis\test.ts
bf luis:train:runIssues asynchronous training request for LUIS application
USAGE
$ bf luis:train:run
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--mode=mode Value specifying mode of training (Standard | Neural).
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to show training status (defaults to config:LUIS:versionId)
--wait Wait until training complete and then display status
EXAMPLE
$ bf luis:train:run --appId {APPLICATION_ID} --versionId {VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey
{SUBSCRIPTION_KEY}
See code: src\commands\luis\train\run.ts
bf luis:train:showShows training status
USAGE
$ bf luis:train:show
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to show training status (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:train:show --appId {APPLICATION_ID} --versionId {VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey
{SUBSCRIPTION_KEY}
See code: src\commands\luis\train\show.ts
bf luis:translateTranslate given LUIS application JSON model or lu file(s)
USAGE
$ bf luis:translate
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites
that file
-h, --help luis:translate help
-i, --in=in Source .lu file(s) or LUIS 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 file .lu 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 .lu file
--translate_link_text When set, machine translate link description in .lu file
--translatekey=translatekey (required) Machine translation endpoint key.
See code: src\commands\luis\translate.ts
bf luis:version:cloneCreates a new version equivalent to the current snapshot of the selected application version.
USAGE
$ bf luis:version:clone
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--subscriptionKey=subscriptionKey LUIS authoring (Ocp-Apim-subscription) key
--targetVersionId=targetVersionId (required) Destination version to create
--versionId=versionId (required) Source version to clone (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:version:clone --appId {APP_ID} --versionId {VERSION_ID} --targetVersionId {TARGET_VERSION_ID}
--endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
See code: src\commands\luis\version\clone.ts
bf luis:version:deleteDeletes a LUIS application version
USAGE
$ bf luis:version:delete
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to delete
EXAMPLE
$ bf luis:version:delete --appId {APP_ID} --versionId {VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey
{SUBSCRIPTION_KEY}
See code: src\commands\luis\version\delete.ts
bf luis:version:exportExports a LUIS application to JSON format
USAGE
$ bf luis:version:export
OPTIONS
-f, --force Overwrites output file if exists, otherwise creates a parallel numbered file
(optional)
-h, --help show CLI help
-o, --out=out Save exported application to specified file, uses STDOUT if not specified
(optional)
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--exportLU Export format type as LU
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to export (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:version:export --appId {APP_ID} --versionId {VERSION_ID} --out {FILENAME.json or PATH/FILENAME.json}
--endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
See code: src\commands\luis\version\export.ts
bf luis:version:importImports a new version into a LUIS application from JSON or LU content.
USAGE
$ bf luis:version:import
OPTIONS
-h, --help show CLI help
-i, --in=in (required) File path containing LUIS application contents, uses STDIN if not
specified
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId Version to import (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:version:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --in
{PATH_TO_JSON} --versionId {VERSION_ID}
$ echo {SERIALIZED_JSON} | bf luis:version:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
--appId {APP_ID}
See code: src\commands\luis\version\import.ts
bf luis:version:listReturns application's versions
USAGE
$ bf luis:version:list
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help show CLI help
-o, --out=out Output results to specified folder and/or file in JSON format, otherwise prints to
STDOUT (optional)
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--skip=skip Number of entries to skip. Default: 0 (no skips)
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--take=take Number of etnries to return. Maximum page size is 500. Default: 100
EXAMPLE
$ bf luis:version:list --appId {APPLICATION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --take
3
$ bf luis:version:list --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --out {PATH_TO_JSON_FILE}
See code: src\commands\luis\version\list.ts
bf luis:version:renameRenames application version
USAGE
$ bf luis:version:rename
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--newVersionId=newVersionId (required) New version id
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to update (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:version:rename --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --name
{NAME} --description {DESCRIPTION}
See code: src\commands\luis\version\rename.ts
bf luisbf luis:application:assignazureaccountbf luis:application:createbf luis:application:deletebf luis:application:importbf luis:application:listbf luis:application:publishbf luis:application:querybf luis:application:renamebf luis:application:showbf luis:buildbf luis:convertbf luis:cross-trainbf luis:endpoints:listbf luis:generate:csbf luis:generate:tsbf luis:testbf luis:train:runbf luis:train:showbf luis:translatebf luis:version:clonebf luis:version:deletebf luis:version:exportbf luis:version:importbf luis:version:listbf luis:version:renamebf luisManages LUIS assets on service and/or locally.
USAGE
$ bf luis
OPTIONS
-h, --help LUIS command help
See code: src/commands/luis/index.ts
bf luis:application:assignazureaccountAssign a LUIS azure accounts to an application
USAGE
$ bf luis:application:assignazureaccount
OPTIONS
-h, --help show CLI help
--accountName=accountName (required) Account name
--appId=appId (required) LUIS application Id (defaults to config:set:luis --appId
{APPLICATION_ID})
--armToken=armToken (required) User`s ARM token used to validate azure accounts information
(default: config:set:luis --armToken {ARM_TOKEN})
--azureSubscriptionId=azureSubscriptionId (required) Azure Subscription Id
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--resourceGroup=resourceGroup (required) Resource Group
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:set:luis --subscriptionKey {SUBSCRIPTION_KEY})
See code: src/commands/luis/application/assignazureaccount.ts
bf luis:application:createCreates a new LUIS application
USAGE
$ bf luis:application:create
OPTIONS
-h, --help show CLI help
--culture=culture Specify culture language (default: en-us)
--description=description Description of LUIS application
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--name=name (required) Name of LUIS application
--save Save configuration settings from imported app (appId & endpoint)
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--tokenizerVersion=tokenizerVersion Version specifies how sentences are tokenized (optional). See also:
https://aka.ms/luistokens
--versionId=versionId (required) LUIS version Id. (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:application:create --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME} --culture
{CULTURE}
--domain {DOMAIN} --description {DESCRIPTION} --versionId {INITIAL_VERSION_ID}
See code: src/commands/luis/application/create.ts
bf luis:application:deleteDeletes a LUIS application
USAGE
$ bf luis:application:delete
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--force Force delete with no confirmation
--json Display output as JSON
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
EXAMPLE
$ bf luis:application:delete --appId {APP_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
See code: src/commands/luis/application/delete.ts
bf luis:application:importImports LUIS application from JSON or LU content.
USAGE
$ bf luis:application:import
OPTIONS
-h, --help show CLI help
-i, --in=in (required) File path containing LUIS application contents, uses STDIN if not
specified
--endpoint=endpoint (required) LUIS endpoint hostname
--json Display output as JSON
--name=name LUIS application name (optional)
--save Save configuration settings from imported app (appId, subscriptionKey & endpoint)
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default: config
subscriptionKey)
EXAMPLE
$ bf luis:application:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME} --in
{PATH_TO_JSON}
$ echo {SERIALIZED_JSON} | bf luis:application:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
--name {NAME}
See code: src/commands/luis/application/import.ts
bf luis:application:listLists all applications on LUIS service.
USAGE
$ bf luis:application:list
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help show CLI help
-o, --out=out Output results to specified file in JSON format, otherwise prints to STDOUT
(optional)
--endpoint=endpoint LUIS endpoint hostname
--skip=skip Number of entries to skip. Default: 0 (no skips)
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--take=take Number of etnries to return. Maximum page size is 500. Default: 100
EXAMPLE
$ bf luis:application:list --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --take 3
$ bf luis:application:list --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --out {PATH_TO_JSON_FILE}
See code: src/commands/luis/application/list.ts
bf luis:application:publishPublishes application's version
USAGE
$ bf luis:application:publish
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--direct Available only in direct version query. Do not publish to staging or production
--endpoint=endpoint LUIS endpoint hostname
--staging Publishes application version to Staging slot, otherwise publish to production
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to publish (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:application:publish --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --versionId
{INITIAL_VERSION_ID} --appId {APP_ID} --staging {BOOLEAN}
See code: src/commands/luis/application/publish.ts
bf luis:application:queryQueries application for intent predictions
USAGE
$ bf luis:application:query
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--log Logs query operation on service (default: true)
--query=query (required) Query string to predict
--staging Presence of flag targets the staging app, if no flag passed defaults to production
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--timezoneOffset=timezoneOffset Timezone offset for the location of the request in minutes (optional)
--verbose Returns all intents, otherwise only top scoring intent. (default: false)
EXAMPLE
$ bf luis:application:query --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --query
{QUERY} --prod {BOOLEAN}
See code: src/commands/luis/application/query.ts
bf luis:application:renameRenames the application and updates its description
USAGE
$ bf luis:application:rename
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--description=description Description of LUIS application
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--name=name (required) (required) Name of LUIS application
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
EXAMPLE
$ bf luis:application:rename --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --name
{NAME} --description {DESCRIPTION}
See code: src/commands/luis/application/rename.ts
bf luis:application:showShows application information
USAGE
$ bf luis:application:show
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
EXAMPLE
$ bf luis:application:show --appId {APPLICATION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
See code: src/commands/luis/application/show.ts
bf luis:buildBuild lu files to train and publish luis applications
USAGE
$ bf luis:build
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:build command help
-i, --in=in (required) Lu file or folder
-o, --out=out Output folder name to write out .dialog and settings files. If not specified,
application setting will be output to console
--authoringKey=authoringKey (required) LUIS authoring key. Refered to as subscriptionKey in other cli commands.
--botName=botName (required) Bot name
--defaultCulture=defaultCulture Culture code for the content. Infer from .lu if available. Defaults to en-us
--deleteOldVersion Deletes old version of LUIS application after building new one.
--dialog=dialog Dialog recognizer type [multiLanguage|crosstrained]. No dialog recognizers will be
generated if not specified. Only valid if --out is set
--directVersionPublish Available only in direct version query. Do not publish to staging or production
--endpoint=endpoint (required) Luis 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
--isStaging Publishes luis application to staging slot if set. Default to production slot
--log Writes out log messages to console
--luConfig=luConfig Path to config for lu build which can contain switches for arguments
--region=region [default: westus] LUIS authoring region [westus|westeurope|australiaeast]
--schema=schema Defines $schema for generated .dialog files
--suffix=suffix Environment name as a suffix identifier to include in LUIS app name. Defaults to
current logged in user alias
EXAMPLE
$ bf luis:build --in {INPUT_FILE_OR_FOLDER} --authoringKey {AUTHORING_KEY} --botName {BOT_NAME}
See code: src/commands/luis/build.ts
bf luis:convertConvert .lu file(s) to a LUIS application JSON model or vice versa
USAGE
$ bf luis:convert
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:convert help
-i, --in=in Source .lu file(s) or LUIS application JSON model
-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 .lu file(s)
--culture=culture Lang code for the LUIS application
--description=description Text describing the LUIS applicaion
--log Enables log messages
--name=name Name of the LUIS application
--schemaversion=schemaversion Schema version of the LUIS application
--sort When set, intent, utterances, entities are alphabetically sorted in .lu files
--versionid=versionid Version ID of the LUIS application
See code: src/commands/luis/convert.ts
bf luis:cross-trainLu and Qna cross train tool
USAGE
$ bf luis: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
--exclude=exclude Excludes folders under the input directory, separated by ",". If not specified, all luis and
qna files will be included in the cross-train
--[no-]inner-dialog Only do inner dialog cross train
--intentName=intentName [default: _Interruption] Interruption intent name
--[no-]intra-dialog Only do intra dialog cross train
--log Writes out log messages to console
See code: src/commands/luis/cross-train.ts
bf luis:endpoints:listReturns available deployment endpoints
USAGE
$ bf luis:endpoints:list
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help show CLI help
-o, --out=out Output results to specified file in JSON format, otherwise prints to STDOUT
(optional)
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
EXAMPLE
$ bf luis:endpoints:list --appId {APPLICATION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
--out {PATH_TO_JSON_FILE}
See code: src/commands/luis/endpoints/list.ts
bf luis:generate:csGenerate:cs generates a strongly typed C# source code from an exported (json) LUIS model.
USAGE
$ bf luis:generate:cs
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:generate:cs help
-i, --in=in Path to the file containing the LUIS application JSON model
-o, --out=out Output file or folder name. If not specified stdout will be used as output
--className=className Name of the autogenerated class (can include namespace)
See code: src/commands/luis/generate/cs.ts
bf luis:generate:tsGenerate:ts generates a strongly typed typescript source code from an exported (json) LUIS model.
USAGE
$ bf luis:generate:ts
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help luis:generate:ts help
-i, --in=in Path to the file containing the LUIS application JSON model
-o, --out=out Output file or folder name. If not specified stdout will be used as output
--className=className Name of the autogenerated class
See code: src/commands/luis/generate/ts.ts
bf luis:testTest a .lu file or LUIS application JSON model against a published LUIS model
USAGE
$ bf luis:test
OPTIONS
-a, --appId=appId (required) LUIS application Id
-h, --help luis:test help
-i, --in=in Source .lu file or LUIS application JSON model for testing
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-s, --subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key
--allowIntentsCount=allowIntentsCount [default: 1] Top-scoring intent or top n Intent with score to show in the
result
--endpoint=endpoint [default: https://westus.api.cognitive.microsoft.com] LUIS endpoint hostname
--force If --out flag is provided with the path to an existing file, overwrites that
file
--intentOnly Only test intent
--staging Presence of flag targets the staging app, if no flag passed defaults to
production
See code: src/commands/luis/test.ts
bf luis:train:runIssues asynchronous training request for LUIS application
USAGE
$ bf luis:train:run
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--mode=mode Value specifying mode of training (Standard | Neural).
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to show training status (defaults to config:LUIS:versionId)
--wait Wait until training complete and then display status
EXAMPLE
$ bf luis:train:run --appId {APPLICATION_ID} --versionId {VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey
{SUBSCRIPTION_KEY}
See code: src/commands/luis/train/run.ts
bf luis:train:showShows training status
USAGE
$ bf luis:train:show
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to show training status (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:train:show --appId {APPLICATION_ID} --versionId {VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey
{SUBSCRIPTION_KEY}
See code: src/commands/luis/train/show.ts
bf luis:translateTranslate given LUIS application JSON model or lu file(s)
USAGE
$ bf luis:translate
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites
that file
-h, --help luis:translate help
-i, --in=in Source .lu file(s) or LUIS 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 file .lu 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 .lu file
--translate_link_text When set, machine translate link description in .lu file
--translatekey=translatekey (required) Machine translation endpoint key.
See code: src/commands/luis/translate.ts
bf luis:version:cloneCreates a new version equivalent to the current snapshot of the selected application version.
USAGE
$ bf luis:version:clone
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--subscriptionKey=subscriptionKey LUIS authoring (Ocp-Apim-subscription) key
--targetVersionId=targetVersionId (required) Destination version to create
--versionId=versionId (required) Source version to clone (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:version:clone --appId {APP_ID} --versionId {VERSION_ID} --targetVersionId {TARGET_VERSION_ID}
--endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
See code: src/commands/luis/version/clone.ts
bf luis:version:deleteDeletes a LUIS application version
USAGE
$ bf luis:version:delete
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to delete
EXAMPLE
$ bf luis:version:delete --appId {APP_ID} --versionId {VERSION_ID} --endpoint {ENDPOINT} --subscriptionKey
{SUBSCRIPTION_KEY}
See code: src/commands/luis/version/delete.ts
bf luis:version:exportExports a LUIS application to JSON format
USAGE
$ bf luis:version:export
OPTIONS
-f, --force Overwrites output file if exists, otherwise creates a parallel numbered file
(optional)
-h, --help show CLI help
-o, --out=out Save exported application to specified file, uses STDOUT if not specified
(optional)
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--exportLU Export format type as LU
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to export (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:version:export --appId {APP_ID} --versionId {VERSION_ID} --out {FILENAME.json or PATH/FILENAME.json}
--endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
See code: src/commands/luis/version/export.ts
bf luis:version:importImports a new version into a LUIS application from JSON or LU content.
USAGE
$ bf luis:version:import
OPTIONS
-h, --help show CLI help
-i, --in=in (required) File path containing LUIS application contents, uses STDIN if not
specified
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId Version to import (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:version:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --in
{PATH_TO_JSON} --versionId {VERSION_ID}
$ echo {SERIALIZED_JSON} | bf luis:version:import --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY}
--appId {APP_ID}
See code: src/commands/luis/version/import.ts
bf luis:version:listReturns application's versions
USAGE
$ bf luis:version:list
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help show CLI help
-o, --out=out Output results to specified folder and/or file in JSON format, otherwise prints to
STDOUT (optional)
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--skip=skip Number of entries to skip. Default: 0 (no skips)
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--take=take Number of etnries to return. Maximum page size is 500. Default: 100
EXAMPLE
$ bf luis:version:list --appId {APPLICATION_ID} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --take
3
$ bf luis:version:list --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --out {PATH_TO_JSON_FILE}
See code: src/commands/luis/version/list.ts
bf luis:version:renameRenames application version
USAGE
$ bf luis:version:rename
OPTIONS
-h, --help show CLI help
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
--endpoint=endpoint LUIS endpoint hostname
--json Display output as JSON
--newVersionId=newVersionId (required) New version id
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
--versionId=versionId (required) Version to update (defaults to config:LUIS:versionId)
EXAMPLE
$ bf luis:version:rename --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID} --name
{NAME} --description {DESCRIPTION}
See code: src/commands/luis/version/rename.ts
FAQs
@microsoft/bf-luis-cli ======================
The npm package @microsoft/bf-luis-cli receives a total of 0 weekly downloads. As such, @microsoft/bf-luis-cli popularity was classified as not popular.
We found that @microsoft/bf-luis-cli 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.
Security News
As vulnerability data bottlenecks grow, the federal government is formally investigating NIST’s handling of the National Vulnerability Database.
Research
Security News
Socket’s Threat Research Team has uncovered 60 npm packages using post-install scripts to silently exfiltrate hostnames, IP addresses, DNS servers, and user directories to a Discord-controlled endpoint.
Security News
TypeScript Native Previews offers a 10x faster Go-based compiler, now available on npm for public testing with early editor and language support.