microsoft
/
botframework-cli
зеркало из https://github.com/microsoft/botframework-cli.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Updating docs (#1172)

This commit is contained in:
Emilio Munoz 2021-04-01 16:05:02 -07:00 коммит произвёл GitHub
Родитель e7d2e8f64e
Коммит ecafb816d5
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
8 изменённых файлов: 610 добавлений и 763 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

894
packages/cli/README.md
Просмотреть файл

Разница между файлами не показана из-за своего большого размера Загрузить разницу

17
packages/config/README.md
Просмотреть файл

@ -9,6 +9,7 @@ This package is intended for Microsoft use only and should be consumed through @
# Commands
<!-- commands -->
* [`bf config`](#bf-config)
* [`bf config:remove`](#bf-configremove)
* [`bf config:set`](#bf-configset)
* [`bf config:set:luis`](#bf-configsetluis)
* [`bf config:set:qnamaker`](#bf-configsetqnamaker)
@ -32,6 +33,21 @@ OPTIONS
_See code: [src/commands/config/index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/index.ts)_
## `bf config:remove`
Removes the specified key from the config file
```
USAGE
$ bf config:remove
OPTIONS
-h, --help config:remove help
-k, --key=key (required) Name of the key to remove
```
_See code: [src/commands/config/remove.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/config/src/commands/config/remove.ts)_
## `bf config:set`
Adds the specified key and value to the config file
@ -59,6 +75,7 @@ USAGE
OPTIONS
-h, --help show CLI help
--appId=appId LUIS application Id
--armToken=armToken User`s ARM token used to validate azure accounts information)
--authoringKey=authoringKey LUIS cognitive services authoring key (aka Ocp-Apim-Subscription-Key).
--endpoint=endpoint LUIS application endpoint hostname, ex: <region>.api.cognitive.microsoft.com
--subscriptionKey=subscriptionKey LUIS cognitive services subscription key (aka Ocp-Apim-Subscription-Key)

38
packages/lg/README.md
Просмотреть файл

@ -14,10 +14,10 @@ This package is intended for Microsoft use only and should be consumed through @
# Commands
<!-- commands -->
* [`bf lg`](#bf-lg)
* [`bf lg:analyze`](#bf-lganalyze)
* [`bf lg:expand`](#bf-lgexpand)
* [`bf lg:translate`](#bf-lgtranslate)
* [`bf lg:verify`](#bf-lgverify)
* [`bf lg:analyze`](#bf-lganalyze)
## `bf lg`
@ -33,6 +33,24 @@ OPTIONS
_See code: [src/commands/lg/index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/index.ts)_
## `bf lg:analyze`
Analyze templates in .lg files to show all the places where a template is used
```
USAGE
$ bf lg:analyze
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help lg:analyze help
-i, --in=in (required) LG File or folder that contains .lg file(s)
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-r, --recurse Consider sub-folders to find .lg file(s)
```
_See code: [src/commands/lg/analyze.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_
## `bf lg:expand`
Expand one or all templates in .lg file(s). Expand an inline expression.
@ -97,24 +115,6 @@ OPTIONS
```
_See code: [src/commands/lg/verify.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/verify.ts)_
## `bf lg:analyze`
Analyze templates in .lg files to show all the places where a template is used.
```
USAGE
$ bf lg:analyze
OPTIONS
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
-h, --help lg:analyze help
-i, --in=in (required) LG File or folder that contains .lg file(s)
-o, --out=out Output file or folder name. If not specified stdout will be used as output
-r, --recurse Consider sub-folders to find .lg file(s)
```
_See code: [src/commands/lg/verify.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_
<!-- commandsstop -->
[1]:https://aka.ms/lg-file-format

52
packages/luis/README.md
Просмотреть файл

@ -71,10 +71,12 @@ USAGE
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
--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
@ -85,7 +87,7 @@ OPTIONS
--resourceGroup=resourceGroup (required) Resource Group
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
config:LUIS:subscriptionKey)
config:set:luis --subscriptionKey {SUBSCRIPTION_KEY})
```
_See code: [src/commands/luis/application/assignazureaccount.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/application/assignazureaccount.ts)_
@ -422,14 +424,13 @@ OPTIONS
--config=config Path to config file of mapping rules
--[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
--inner-dialog Only performs the inner dialog cross train, defalt is true, to set it as false, use --no-inner-dialog
--intra-dialog Only performs the intra dialog cross train, defalt is true, to set it as false, use --no-intra-dialog
```
_See code: [src/commands/luis/cross-train.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/cross-train.ts)_
@ -596,16 +597,29 @@ 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.
-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](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/translate.ts)_

313
packages/orchestrator/README.md
Просмотреть файл

@ -15,13 +15,12 @@ Orchestrator CLI is a replacement of the [Dispatch CLI](https://github.com/micro
# Commands
<!-- commands -->
* [`bf orchestrator`](#bf-orchestrator)
* [`bf orchestrator:add`](#bf-orchestratoradd)
* [`bf orchestrator:build`](#bf-orchestratorbuild)
* [`bf orchestrator:create`](#bf-orchestratorcreate)
* [`bf orchestrator:basemodel:get`](#bf-orchestratorbasemodelget)
* [`bf orchestrator:basemodel:list`](#bf-orchestratorbasemodellist)
* [`bf orchestrator:build`](#bf-orchestratorbuild)
* [`bf orchestrator:create`](#bf-orchestratorcreate)
* [`bf orchestrator:interactive`](#bf-orchestratorinteractive)
* [`bf orchestrator:query`](#bf-orchestratorquery)
* [`bf orchestrator:test`](#bf-orchestratortest)
@ -38,8 +37,7 @@ OPTIONS
-h, --help Orchestrator commands help
```
_See code: [src\commands\orchestrator\index.ts]https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/index.ts)_
_See code: [src/commands/orchestrator/index.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/index.ts)_
## `bf orchestrator:add`
@ -51,31 +49,82 @@ USAGE
OPTIONS
-d, --debug
-h, --help Orchestrator add command help.
-i, --in=in Path to example file (.lu/.qna/.json/.blu).
-m, --model=model Path to Orchestrator base model directory.
-e, --entityModel=entity-model Path to Orchestrator entity base model directory.
-o, --out=out Path where generated orchestrator example file will be placed.
Default to current working directory.
-t, --type Type of input (luis/qna/file).
-e, --entityModel=entityModel Path to Orchestrator entity base model directory.
-f, --force If --out flag is provided with the path to an existing file, overwrites that file.
-h, --help Orchestrator add command help
-i, --in=in Path to example file (.lu/.qna/.json/.blu).
-k, --key=key LUIS authoring key or QnAMaker service key if type = luis/qna.
-m, --model=model Path to Orchestrator model directory.
--id LUIS app id or QnAMaker kb id if type = luis/qna.
--key LUIS authoring key or QnAMaker service key if type = luis/qna.
--endpoint LUIS/QnAMaker endpoint.
--routingName Routing name, default to file name.
--dialog Generate multi language or cross train Orchestrator recognizers.
-o, --out=out Path where generated Orchestrator example file will be placed. Default to current
working directory.
-t, --type=type Type of input (luis/qna/file).
-v, --version=version Applies only for type=luis, LUIS app version
--dialog Generate multi language or cross train Orchestrator recognizers.
--endpoint=endpoint LUIS/QnAMaker endpoint.
--id=id LUIS app id or QnAMaker kb id if type = luis/qna.
--routingName=routingName Routing name, default to file name.
EXAMPLE
$ bf orchestrator:add
$ bf orchestrator:add --in ./path/to/file/ --snapshot ./path/to/snapshot/
$ bf orchestrator:add --in ./path/to/file/ --snapshot ./path/to/snapshot/ --out ./path/to/output/
$ bf orchestrator:add --in ./path/to/file/ --out ./path/to/output/ --model ./path/to/model/directory
$ bf orchestrator:add -t luis --id LUIS_APP_ID --version LUIS_APP_VERSION --key LUIS_KEY --routingname l_Weather --endpoint
$ bf orchestrator:add -t qna --id QNA_KB --key QNA_KB_SERVICE_KEY --routingname q_kb
$ bf orchestrator:add
$ bf orchestrator:add --in ./path/to/file/ --snapshot ./path/to/snapshot/
$ bf orchestrator:add --in ./path/to/file/ --snapshot ./path/to/snapshot/ --out ./path/to/output/
$ bf orchestrator:add --in ./path/to/file/ --out ./path/to/output/ --model ./path/to/model/directory
$ bf orchestrator:add -t luis --id LUIS_APP_ID --version LUIS_APP_VERSION --key LUIS_KEY --routingname l_Weather
--endpoint
$ bf orchestrator:add -t qna --id QNA_KB --key QNA_KB_SERVICE_KEY --routingname q_kb
```
_See code: [src\commands\orchestrator\add.ts](https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/add.ts)_
_See code: [src/commands/orchestrator/add.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/add.ts)_
## `bf orchestrator:basemodel:get`
Gets Orchestrator base model
```
USAGE
$ bf orchestrator:basemodel:get
OPTIONS
-d, --debug
-h, --help Orchestrator basemodel:get command help
-o, --out=out Optional. Path to where Orchestrator base model will be saved to. Default to current working
directory.
-v, --verbose Enable verbose logging
--getEntity Optional. Download default entity model at the same time, which will be placed in the entity
subfolder of the output path.
--versionId=versionId Optional. Base model version to download -- reference basemodel:list output for options. If
not specified, default model will be downloaded.
```
_See code: [src/commands/orchestrator/basemodel/get.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/basemodel/get.ts)_
## `bf orchestrator:basemodel:list`
Lists all Orchestrator base model versions
```
USAGE
$ bf orchestrator:basemodel:list
OPTIONS
-h, --help Orchestrator basemodel:list command help
-r, --raw Optional. Raw output
--all Optional. Display all models
```
_See code: [src/commands/orchestrator/basemodel/list.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/basemodel/list.ts)_
## `bf orchestrator:build`
@ -87,27 +136,24 @@ USAGE
OPTIONS
-d, --debug
-h, --help Orchestrator build command help.
-i, --in=in Path to lu file or folder with lu files.
-m, --model=model Path to Orchestrator base model directory.
-e, --entityModel=entity-model Path to Orchestrator entity base model directory.
-o, --out=out Path where Orchestrator snapshot/dialog file(s) will be placed.
Default to current working directory.
--luConfig Path to luConfig file.
--dialog Generate multi language or cross train Orchestrator recognizers.
-e, --entityModel=entityModel Path to Orchestrator entity base model directory.
-h, --help Orchestrator build command help
-i, --in=in Path to lu file or folder with lu files.
-m, --model=model Path to Orchestrator model.
EXAMPLE
-o, --out=out Path where Orchestrator snapshot/dialog file(s) will be placed. Default to current
working directory.
$ bf orchestrator:build
$ bf orchestrator:build --in ./path/to/files/ --out ./path/to/output/ --dialog
--dialog Generate multi language or cross train Orchestrator recognizers.
--luconfig=luconfig Path to luconfig.json.
```
_See code: [src\commands\orchestrator\build.ts](https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/build.ts)_
_See code: [src/commands/orchestrator/build.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/build.ts)_
## `bf orchestrator:create`
Create orchestrator snapshot (.blu) file from .lu/.qna/.json/.tsv/.dispatch files, which represent bot modules.
Create orchestrator snapshot (.blu) file from .lu/.qna/.json/.tsv/.dispatch files, which represent bot modules
```
USAGE
@ -115,118 +161,133 @@ USAGE
OPTIONS
-d, --debug
-h, --help Orchestrator create command help
-i, --in=in The path to source label files from where orchestrator example file will
be created from. Default to the current working directory.
Valid file extensions are lu, .qna, .json and .tsv.
-m, --model=model Path to Orchestrator base model directory.
-e, --entityModel=entity-model Path to Orchestrator entity base model directory.
-o, --out=out Path where generated orchestrator example file will be placed.
Default to current working directory.
--hierarchical Add hierarchical labels based on lu/qna file name.
-e, --entityModel=entityModel Path to Orchestrator entity base model directory.
-h, --help Orchestrator create command help
EXAMPLE
-i, --in=in The path to source label files from where orchestrator example file will be created
from. Default to current working directory.
$ bf orchestrator:create
$ bf orchestrator:create --in ./path/to/file/
$ bf orchestrator:create --in ./path/to/file/ --out ./path/to/output/
$ bf orchestrator:create --in ./path/to/file/ --out ./path/to/output/ --model ./path/to/base/model/directory
-m, --model=model Path to Orchestrator base model directory.
-o, --out=out Path where generated Orchestrator snapshot file will be placed. Default to current
working directory.
--hierarchical Add hierarchical labels based on .lu/.qna file name. Resulting snapshot file will
contain.lu/.qna file name as labels instead of the intents defined in the .lu file(s).
--refresh Refetch LUIS app(s)/QnAMaker kb(s) previously added and recreate Orchestrator snapshot.
```
_See code: [src\commands\orchestrator\create.ts](https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/create.ts)_
## `bf orchestrator:basemodel:get`
Gets Orchestrator base model
```
USAGE
$ bf orchestrator:basemodel:get
OPTIONS
-o, --out Optional. Path to where Orchestrator base model will be saved to. Default to current working directory.
--versionId Optional. Base model version to download -- reference basemodel:list output for options. If not specified, default model will be downloaded.
-h, --help Show CLI help
```
_See code: [src\commands\orchestrator\basemodel\get.ts](https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/basemodel/get.ts)_
## `bf orchestrator:basemodel:list`
Lists all Orchestrator base model versions
```
USAGE
$ bf orchestrator:basemodel:list
OPTIONS
-r, --raw Optional. Raw output
-h, --help Show CLI help
```
_See code: [src\commands\orchestrator\basemodel\list.ts](https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/basemodel/list.ts)_
_See code: [src/commands/orchestrator/create.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/create.ts)_
## `bf orchestrator:interactive`
```
USAGE
$ bf orchestrator:interactive --out=<analysis-and-output-folder> --model=<base-model-and-config-folder>
[--entityModel=<entity-base-model-and-config-folder>]
[--in=<previous-generated-blu-training-set-file>]
OPTIONS
-d, --debug Print detailed debugging information during execution.
-h, --help Orchestrator 'interactive' command help.
-i, --in=in Optional path to a previously created Orchestrator .blu file.
This argument is optional users can use the 'interactive' command
to start an Orchestrator snapshot from scratch. The 'n' commandlet
can save the utterance labels into a snapshot (.blu) file.
-m, --model=model Directory or a config file hosting Orchestrator base model files.
-e, --entityModel=entity-model Path to Orchestrator entity base model directory.
-o, --out=out Directory where analysis and output files will be placed.
```
_See code: [src\commands\orchestrator\interactive.ts](https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/interactive.ts)_
## `bf orchestrator:query`
Query Orchestrator base model and a snapshot/train file.
Real-time interaction with Orchestrator model and analysis. Can return score of given utterance using previously created orchestrator examples
```
USAGE
$ bf orchestrator:query --model=<base-model-and-config-folder> --query=<query>
[--entityModel=<entity-base-model-and-config-folder>]
[--in=<previous-generated-blu-training-set-file>]
[--limit=<limit-of-number-of-predictions>]
$ bf orchestrator:interactive
OPTIONS
-d, --debug
-h, --help Orchestrator query command help
-i, --in=in Path to previously created Orchestrator snapshot (.blu file).
-q, --query=query Query string to predict.
-m, --model=model Path to Orchestrator base model directory.
-e, --entityModel=entity-model Path to Orchestrator entity base model directory.
-l, --limit=# (optional) Limit of number of predictions.
-e, --entityModel=entityModel Path to Orchestrator entity base model directory.
-h, --help show CLI help
-l, --in=in Optional path to a previously created Orchestrator .blu file.
-m, --model=model (required) Directory or hosting Orchestrator config and base model files.
-o, --out=out Optional Directory where analysis and output files will be placed.
EXAMPLE
$ bf orchestrator:query --in ./path/to/blufile/ --query /query/string/to/predict
$ bf orchestrator:query --in ./path/to/blufile/ --query /query/string/to/predict --model ./path/to/base/model/directory
$ bf orchestrator:interactive --in=./path/to/snapshot/file --out=./path/to/output/folder/
--model=./path/to/model/directory
```
_See code: [src\commands\orchestrator\query.ts](https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/query.ts)_
_See code: [src/commands/orchestrator/interactive.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/interactive.ts)_
## `bf orchestrator:query`
Query Orchestrator base model and a snapshot/train file
```
USAGE
$ bf orchestrator:query
OPTIONS
-d, --debug
-e, --entityModel=entityModel Path to Orchestrator entity base model directory.
-h, --help show CLI help
-i, --in=in (required) Path to a previously created Orchestrator snapshot (.blu file).
-l, --limit=limit (optional) Limit of number of predictions. Default to 3. Less or equal to 0 for listing
all predictions.
-m, --model=model (required) Path to Orchestrator base model directory.
-q, --query=query (required) Query string to predict.
EXAMPLE
$ bf orchestrator:query --in=./path/to/snapshot/file --query=hi --model=./path/to/base/model/directory
```
_See code: [src/commands/orchestrator/query.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/query.ts)_
## `bf orchestrator:test`
```
_See code: [src\commands\orchestrator\test.ts](https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/test.ts)_
The "test" command can operate in three modes: test, evaluation, assessment.
```
USAGE
$ bf orchestrator:test
_See code: [src\commands\orchestrator\test.ts]https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/orchestrator/test.ts)_
OPTIONS
-d, --debug
-e, --entityModel=entityModel Path to Orchestrator entity base model directory.
-h, --help show CLI help
-i, --in=in (required) Path to a previously created Orchestrator .blu file.
-m, --model=model Optional directory for hosting Orchestrator config and base model files, not needed for
the "assessment" mode.
-o, --out=out (required) Directory where analysis and output files will be placed.
-p, --prediction=prediction Optional path to a prediction label file, or comma-separated paths to a collection of
(e.g., crosss-valiaton) files.
-t, --test=test Optional path to a test file. This option enable the "test" mode.
DESCRIPTION
1) Test mode: test a collection of utterance/label samples loaded from a test file against
a previously generated Orchestrator .blu snapshot/train file,
and create a detailed train/test evaluation report.
2) Evaluation mode: create an leave-one-out cross validation (LOOCV) evaluation report
on a previously generated Orchestrator .blu snapshot/train file.
3) Assessment mode: assess a collection of utterance/label predictions against their ground-truth labels and
create an evaluation report. This mode can evaluate predictions produced by
other NLP or machine learning systems. There is no need for an Orchestrator base model.
Notice that, this mode is generic and can apply to evaluate any ML systems, learners, models,
and scenarios if a user can carefully construct the prediction and grounf-truth files by
the specification detailed below.
Essentially the key to a NLP data instance is a text (utterance, sentence, query, document, etc.), which
is the basis of all the features feeding to a ML model. For other ML systems, the key to
a data instance can be built directly from the features and put in place of text
in a prediction and ground-truth file.
The 'test' mode is activated if there is a '--test' argument set for a test file.
The 'assessment' mode is activated if there is a '--prediction' argument set for a prediction file.
If there is no '--test' or '--prediction' arguments, then "test" command runs on the 'evaluation' mode.
EXAMPLE
$ bf orchestrator:test --in=./path/to/snapshot/file --test=./path/to/test/file/ --out=./path/to/output/
--model=./path/to/model/directory
$ bf orchestrator:test --in=./path/to/ground-truth/file --prediction=./path/to/prediction/file
--out=./path/to/output/folder/
$ bf orchestrator:test --in=./path/to/snapshot/file --out=./path/to/output/folder/
[--model=./path/to/model/directory]
```
_See code: [src/commands/orchestrator/test.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/test.ts)_
<!-- commandsstop -->
# Orchestrator CLI settings file

24
packages/plugins/README.md
Просмотреть файл

@ -28,6 +28,7 @@ npm config set registry https://registry.npmjs.org/
<!-- commands -->
* [`bf plugins`](#bf-plugins)
* [`bf plugins:install PLUGIN`](#bf-pluginsinstall-plugin)
* [`bf plugins:link PLUGIN`](#bf-pluginslink-plugin)
* [`bf plugins:list`](#bf-pluginslist)
* [`bf plugins:uninstall [PLUGIN]`](#bf-pluginsuninstall-plugin)
@ -74,6 +75,29 @@ ALIASES
_See code: [src/commands/plugins/install.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/plugins/src/commands/plugins/install.ts)_
## `bf plugins:link PLUGIN`
Links a plugin into the BF CLI for development
```
USAGE
$ bf plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
```
_See code: [src/commands/plugins/link.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/plugins/src/commands/plugins/link.ts)_
## `bf plugins:list`
List installed plugins

33
packages/qnamaker/README.md
Просмотреть файл

@ -643,16 +643,29 @@ 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.
--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.
-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](https://github.com/microsoft/botframework-cli/tree/master/packages/qnamaker/src/commands/qnamaker/translate.ts)_

2
scripts/fixurls.js
Просмотреть файл

@ -2,7 +2,7 @@ const path = require('path')
const fs = require('fs-extra')
const updateUrls = async () => {
let plugins = ['config', 'chatdown', 'dialog', 'qnamaker', 'luis', 'plugins', 'lg', 'cli']
let plugins = ['config', 'chatdown', 'dialog', 'qnamaker', 'luis', 'plugins', 'lg', 'orchestrator', 'cli']
for (let i = 0; i < plugins.length; i++) {
await cleanUrls(plugins[i])
}