botframework-cli - @microsoft/bf-luis-cli 4.9.0-preview.124620
> npm install @microsoft/bf-luis-cli@4.9.0-preview.124620
@microsoft/bf-luis-cli
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.
Relevant docs
Commands
bf luis
bf luis:application:assignazureaccount
bf luis:application:create
bf luis:application:delete
bf luis:application:import
bf luis:application:list
bf luis:application:publish
bf luis:application:query
bf luis:application:rename
bf luis:application:show
bf luis:build
bf luis:convert
bf luis:endpoints:list
bf luis:generate:cs
bf luis:generate:ts
bf luis:test
bf luis:train:run
bf luis:train:show
bf luis:translate
bf luis:version:clone
bf luis:version:delete
bf luis:version:export
bf luis:version:import
bf luis:version:list
bf luis:version:rename
bf luis
Manages 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:assignazureaccount
Assign 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:LUIS:appId)
--armToken=armToken (required) The bearer authorization header to use; containing the user`s
ARM token used to validate azure accounts information
--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:LUIS:subscriptionKey)
See code: src\commands\luis\application\assignazureaccount.ts
bf luis:application:create
Creates 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} --usageScenario {USAGE_SCENARIO}
See code: src\commands\luis\application\create.ts
bf luis:application:delete
Deletes 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:import
Imports 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:list
Lists 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:publish
Publishes 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
(default: false)
--endpoint=endpoint LUIS endpoint hostname
--staging Publishes application version to Staging slot, otherwise publish to production
(default: false)
--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:query
Queries 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:rename
Renames 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:show
Shows 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:build
Build lu files to train and publish luis applications
USAGE
$ bf luis:build
OPTIONS
-f, --force If --dialog flag is provided, overwirtes relevant dialog file
-h, --help show CLI help
-i, --in=in Lu file or folder
-o, --out=out Output file or folder name. If not specified, current directory will be used as
output
--authoringKey=authoringKey (required) LUIS authoring key
--botName=botName Bot name
--defaultCulture=defaultCulture Culture code for the content. Infer from .lu if available. Defaults to en-us
--dialog Write out .dialog files
--fallbackLocale=fallbackLocale Locale to be used at the fallback if no locale specific recognizer is found. Only
valid if --dialog is set
--log write out log messages to console
--luConfig=luConfig Path to config for lu build
--region=region [default: westus] LUIS authoring region [westus|westeurope|australiaeast]
--suffix=suffix Environment name as a suffix identifier to include in LUIS app name. Defaults to
current logged in useralias
EXAMPLE
$ bf luis:build --in {INPUT_FILE_OR_FOLDER} --authoringKey {AUTHORING_KEY} --botName {BOT_NAME} --dialog {true}
See code: src\commands\luis\build.ts
bf luis:convert
Convert .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:endpoints:list
Returns 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:cs
Generate: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:ts
Generate: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:test
Test 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:run
Issues 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
--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:show
Shows 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:translate
Translate 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.
--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:clone
Creates 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:delete
Deletes 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:export
Exports 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
--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:import
Imports 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 export (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:list
Returns 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:rename
Renames 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 luis
bf luis:application:create
bf luis:application:delete
bf luis:application:import
bf luis:application:list
bf luis:application:publish
bf luis:application:query
bf luis:application:rename
bf luis:application:show
bf luis:build
bf luis:convert
bf luis:endpoints:list
bf luis:test
bf luis:generate:cs
bf luis:generate:ts
bf luis:train:run
bf luis:train:show
bf luis:translate
bf luis:version:clone
bf luis:version:delete
bf luis:version:export
bf luis:version:import
bf luis:version:list
bf luis:version:rename
bf luis
Manages 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:create
Creates 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} --usageScenario {USAGE_SCENARIO}
See code: src/commands/luis/application/create.ts
bf luis:application:delete
Deletes 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:import
Imports 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:list
Lists 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:publish
Publishes 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
(default: false)
--endpoint=endpoint LUIS endpoint hostname
--staging Publishes application version to Staging slot, otherwise publish to production
(default: false)
--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:query
Queries 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:rename
Renames 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:show
Shows 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:build
Build lu files to train and publish luis applications
USAGE
$ bf luis:build
OPTIONS
-f, --force If --dialog flag is provided, overwirtes relevant dialog file
-h, --help show CLI help
-i, --in=in Lu file or folder
-o, --out=out Output file or folder name. If not specified, current directory will be used as
output
--authoringKey=authoringKey (required) LUIS authoring key
--botName=botName Bot name
--defaultCulture=defaultCulture Culture code for the content. Infer from .lu if available. Defaults to en-us
--dialog Write out .dialog files
--fallbackLocale=fallbackLocale Locale to be used at the fallback if no locale specific recognizer is found. Only
valid if --dialog is set
--log write out log messages to console
--luConfig=luConfig Path to config for lu build
--region=region [default: westus] LUIS authoring region [westus|westeurope|australiaeast]
--suffix=suffix Environment name as a suffix identifier to include in LUIS app name. Defaults to
current logged in useralias
EXAMPLE
$ bf luis:build --in {INPUT_FILE_OR_FOLDER} --authoringKey {AUTHORING_KEY} --botName {BOT_NAME} --dialog {true}
See code: src/commands/luis/build.ts
bf luis:convert
Convert .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:endpoints:list
Returns 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:test
Test 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
EXAMPLE
$ bf luis:test -i {TESTDATA.lu} -o {RESULT.lu} --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --appId {APP_ID}
See code: src/commands/luis/test.ts
bf luis:generate:cs
Generate: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:ts
Generate: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:train:run
Issues 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
--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:show
Shows 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:translate
Translate 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.
--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:clone
Creates 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:delete
Deletes 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:export
Exports 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
--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:import
Imports 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 export (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:list
Returns 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:rename
Renames 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
OwnersChrisM |
|
Project URLhttps://github.com/microsoft/botframework-cli |
|
LicenseMIT |
|
Keywordsoclif-plugin |
|
Info15627 total downloads |
|
1 downloads for version 4.9.0-preview.124620 | |
Download (24.94 KB) | |
Dependencies@azure/cognitiveservices-luis-authoring@4.0.0-preview.1, @azure/cognitiveservices-luis-runtime@5.0.0, @azure/ms-rest-azure-js@2.0.1, @microsoft/bf-cli-command@4.9.0-preview.124620, @microsoft/bf-lu@4.9.0-preview.124620, @oclif/command@~1.5.19, @oclif/config@~1.13.3, @oclif/errors@~1.2.2, @types/node-fetch@~2.5.5, @types/sinon@^7.5.0, cli-ux@~5.3.3, fs-extra@^8.1.0, lodash@^4.17.15, node-fetch@~2.6.0, tslib@^1.10.0, username@^4.1.0 |
|
Dependencies (dev)@oclif/dev-cli@~1.22.2, @oclif/plugin-help@~2.2.1, @oclif/test@~1.2.5, @oclif/tslint@~3.1.1, @types/chai@^4.2.4, @types/lodash@~4.14.146, @types/mocha@^5.2.7, @types/node@^10.17.4, @types/rimraf@^2.0.3, chai@^4.2.0, globby@^10.0.1, mocha@^6.2.2, nyc@^14.1.1, rimraf@^3.0.0, sinon@^7.5.0, ts-node@^8.4.1, tslint@^5.20.1, typescript@^3.5.3, uuid@^3.3.3 |
Package history
Version | Size | Last updated | Downloads | Mirrored? | |||
---|---|---|---|---|---|---|---|
![]() |
4.10.0-preview.148066 | 43.16 KB | Mon, 20 Jul 2020 04:04:25 GMT | 12 |
|
||
![]() |
4.10.0-preview.147978 | 43.16 KB | Sun, 19 Jul 2020 00:24:11 GMT | 1 |
|
||
![]() |
4.10.0-preview.147970 | 43.16 KB | Sat, 18 Jul 2020 22:21:18 GMT | 1 |
|
||
![]() |
4.10.0-preview.147574 | 43.16 KB | Fri, 17 Jul 2020 09:02:46 GMT | 2 |
|
||
![]() |
4.10.0-preview.147526 | 43.16 KB | Fri, 17 Jul 2020 07:10:07 GMT | 2 |
|
||
![]() |
4.10.0-preview.146618 | 43.04 KB | Wed, 15 Jul 2020 02:07:38 GMT | 6 |
|
||
![]() |
4.10.0-preview.146521 | 43.04 KB | Tue, 14 Jul 2020 21:32:23 GMT | 1 |
|
||
![]() |
4.10.0-preview.146517 | 43.04 KB | Tue, 14 Jul 2020 21:28:22 GMT | 0 |
|
||
![]() |
4.10.0-preview.146512 | 43.04 KB | Tue, 14 Jul 2020 21:18:34 GMT | 0 |
|
||
![]() |
4.10.0-preview.146508 | 43.04 KB | Tue, 14 Jul 2020 21:13:20 GMT | 0 |
|
||
![]() |
4.10.0-preview.146502 | 43.04 KB | Tue, 14 Jul 2020 21:02:40 GMT | 0 |
|
||
![]() |
4.10.0-preview.146500 | 43.04 KB | Tue, 14 Jul 2020 20:59:52 GMT | 0 |
|
||
![]() |
4.10.0-preview.146490 | 43.04 KB | Tue, 14 Jul 2020 20:57:00 GMT | 0 |
|
||
![]() |
4.10.0-preview.146482 | 43.04 KB | Tue, 14 Jul 2020 20:38:22 GMT | 0 |
|
||
![]() |
4.10.0-preview.146469 | 43.04 KB | Tue, 14 Jul 2020 20:32:18 GMT | 0 |
|
||
![]() |
4.10.0-preview.146458 | 43.04 KB | Tue, 14 Jul 2020 20:23:41 GMT | 0 |
|
||
![]() |
4.10.0-preview.146427 | 43.04 KB | Tue, 14 Jul 2020 19:49:48 GMT | 0 |
|
||
![]() |
4.10.0-preview.146110 | 43.04 KB | Tue, 14 Jul 2020 04:25:45 GMT | 3 |
|
||
![]() |
4.10.0-preview.146107 | 43.04 KB | Tue, 14 Jul 2020 04:22:43 GMT | 0 |
|
||
![]() |
4.10.0-preview.146096 | 43.04 KB | Tue, 14 Jul 2020 04:19:26 GMT | 0 |
|
||
![]() |
4.10.0-preview.146082 | 43.04 KB | Tue, 14 Jul 2020 03:46:07 GMT | 0 |
|
||
![]() |
4.10.0-preview.146075 | 43.04 KB | Tue, 14 Jul 2020 03:35:49 GMT | 0 |
|
||
![]() |
4.10.0-preview.146067 | 43.04 KB | Tue, 14 Jul 2020 03:26:47 GMT | 0 |
|
||
![]() |
4.10.0-preview.146060 | 43.04 KB | Tue, 14 Jul 2020 03:08:18 GMT | 0 |
|
||
![]() |
4.10.0-preview.146053 | 43.04 KB | Tue, 14 Jul 2020 02:28:17 GMT | 0 |
|
||
![]() |
4.10.0-preview.146040 | 43.04 KB | Tue, 14 Jul 2020 01:42:12 GMT | 0 |
|
||
![]() |
4.10.0-preview.145500 | 43.04 KB | Fri, 10 Jul 2020 23:57:10 GMT | 13 |
|
||
![]() |