Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Commit c42dcdc

Browse files
munozemiliomunozemilio
authored
Update Readme Files (#1256)
1 parent 8078cc6 commit c42dcdc

File tree

4 files changed

+101
-31
lines changed

4 files changed

+101
-31
lines changed

‎packages/cli/README.md‎

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ botframework-cli
77
[![License](https://img.shields.io/npm/l/@microsoft/botframework-cli)](https://github.com/microsoft/botframework-cli/blob/master/packages/cli/package.json)
88

99
# Dependency
10-
Node v12
10+
Node v14
1111

1212

1313
# Usage
@@ -74,6 +74,7 @@ $ npm install -g @microsoft/botframework-cli
7474
* [`bf orchestrator:create`](#bf-orchestratorcreate)
7575
* [`bf orchestrator:interactive`](#bf-orchestratorinteractive)
7676
* [`bf orchestrator:query`](#bf-orchestratorquery)
77+
* [`bf orchestrator:remove`](#bf-orchestratorremove)
7778
* [`bf orchestrator:test`](#bf-orchestratortest)
7879
* [`bf plugins`](#bf-plugins)
7980
* [`bf plugins:install PLUGIN`](#bf-pluginsinstall-plugin)
@@ -432,12 +433,20 @@ USAGE
432433
$ bf lg:analyze
433434
434435
OPTIONS
435-
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
436-
-h, --help lg:analyze help
437-
-i, --in=in (required) LG File or folder that contains .lg file(s)
438-
-o, --out=out Output file or folder name. If not specified stdout will be used as output
439-
-r, --recurse Consider sub-folders to find .lg file(s)
440-
-e, --external-functions Pass a list of external functions and add them to Expression functions, seprated by ",". for example, "function1,function2,function3"
436+
-e, --external-functions=function1,function2 Pass a list of external functions and add them to Expression functions,
437+
seprated by ",". for example, "function1,function2,function3"
438+
439+
-f, --force If --out flag is provided with the path to an existing file, overwrites
440+
that file
441+
442+
-h, --help lg:analyze help
443+
444+
-i, --in=in (required) LG File or folder that contains .lg file(s)
445+
446+
-o, --out=out Output file or folder name. If not specified stdout will be used as
447+
output
448+
449+
-r, --recurse Consider sub-folders to find .lg file(s)
441450
```
442451

443452
_See code: [@microsoft/bf-lg-cli](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_
@@ -582,7 +591,7 @@ EXAMPLE
582591
583592
$ bf luis:application:create --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME} --culture
584593
{CULTURE}
585-
--domain {DOMAIN} --description {DESCRIPTION} --versionId {INITIAL_VERSION_ID} --usageScenario {USAGE_SCENARIO}
594+
--domain {DOMAIN} --description {DESCRIPTION} --versionId {INITIAL_VERSION_ID}
586595
```
587596

588597
_See code: [@microsoft/bf-luis-cli](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/application/create.ts)_
@@ -799,14 +808,14 @@ USAGE
799808
OPTIONS
800809
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
801810
-h, --help luis:build command help
802-
-i, --in=in Lu file or folder
811+
-i, --in=in (required) Lu file or folder
803812
804813
-o, --out=out Output folder name to write out .dialog and settings files. If not specified,
805814
application setting will be output to console
806815
807-
--authoringKey=authoringKey LUIS authoring key
816+
--authoringKey=authoringKey (required) LUIS authoring key. Refered to as subscriptionKey in other cli commands.
808817
809-
--botName=botName Bot name
818+
--botName=botName (required) Bot name
810819
811820
--defaultCulture=defaultCulture Culture code for the content. Infer from .lu if available. Defaults to en-us
812821
@@ -817,7 +826,7 @@ OPTIONS
817826
818827
--directVersionPublish Available only in direct version query. Do not publish to staging or production
819828
820-
--endpoint=endpoint Luis authoring endpoint for publishing
829+
--endpoint=endpoint (required) Luis authoring endpoint for publishing
821830
822831
--fallbackLocale=fallbackLocale Locale to be used at the fallback if no locale specific recognizer is found. Only
823832
valid if --out is set
@@ -885,15 +894,16 @@ OPTIONS
885894
886895
--config=config Path to config file of mapping rules
887896
897+
--exclude=exclude Excludes folders under the input directory, separated by ",". If not specified, all luis and
898+
qna files will be included in the cross-train
899+
888900
--[no-]inner-dialog Only do inner dialog cross train
889901
890902
--intentName=intentName [default: _Interruption] Interruption intent name
891903
892904
--[no-]intra-dialog Only do intra dialog cross train
893905
894906
--log Writes out log messages to console
895-
896-
--exclude Excludes given folders under the input directory, for example, --exclude bin,obj,lib, this will ignore the /bin, /obj, /lib folders under the input path
897907
```
898908

899909
_See code: [@microsoft/bf-luis-cli](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/cross-train.ts)_
@@ -1325,9 +1335,9 @@ EXAMPLE
13251335
$ bf orchestrator:add --in ./path/to/file/ --snapshot ./path/to/snapshot/
13261336
$ bf orchestrator:add --in ./path/to/file/ --snapshot ./path/to/snapshot/ --out ./path/to/output/
13271337
$ bf orchestrator:add --in ./path/to/file/ --out ./path/to/output/ --model ./path/to/model/directory
1328-
$ bf orchestrator:add -t luis --id LUIS_APP_ID --version LUIS_APP_VERSION --key LUIS_KEY --routingname l_Weather
1338+
$ bf orchestrator:add -t luis --id LUIS_APP_ID --version LUIS_APP_VERSION --key LUIS_KEY --routingName l_Weather
13291339
--endpoint
1330-
$ bf orchestrator:add -t qna --id QNA_KB --key QNA_KB_SERVICE_KEY --routingname q_kb
1340+
$ bf orchestrator:add -t qna --id QNA_KB --key QNA_KB_SERVICE_KEY --routingName q_kb
13311341
```
13321342

13331343
_See code: [@microsoft/bf-orchestrator-cli](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/add.ts)_
@@ -1480,6 +1490,31 @@ EXAMPLE
14801490

14811491
_See code: [@microsoft/bf-orchestrator-cli](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/query.ts)_
14821492

1493+
## `bf orchestrator:remove`
1494+
1495+
Remove examples from LUIS app(s), QnaMaker kb(s) or .lu/.qna/.json files from Orchestrator snapshot file.
1496+
1497+
```
1498+
USAGE
1499+
$ bf orchestrator:remove
1500+
1501+
OPTIONS
1502+
-d, --debug
1503+
-h, --help Orchestrator remove command help
1504+
-i, --in=in Path to example file (.lu/.qna/.json/.blu).
1505+
-t, --type=type Type of input (luis/qna/file).
1506+
--id=id LUIS app id or QnAMaker kb id if type = luis/qna.
1507+
1508+
EXAMPLE
1509+
1510+
$ bf orchestrator:remove
1511+
$ bf orchestrator:remove -t luis --id LUIS_APP_ID
1512+
$ bf orchestrator:remove -t qna --id QNA_KB
1513+
$ bf orchestrator:remove -t file -i FILE_PATH
1514+
```
1515+
1516+
_See code: [@microsoft/bf-orchestrator-cli](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/remove.ts)_
1517+
14831518
## `bf orchestrator:test`
14841519

14851520
The "test" command can operate in three modes: test, evaluation, assessment.

‎packages/lg/README.md‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,20 @@ USAGE
4242
$ bf lg:analyze
4343
4444
OPTIONS
45-
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
46-
-h, --help lg:analyze help
47-
-i, --in=in (required) LG File or folder that contains .lg file(s)
48-
-o, --out=out Output file or folder name. If not specified stdout will be used as output
49-
-r, --recurse Consider sub-folders to find .lg file(s)
50-
-e, --external-functions Pass a list of external functions and add them to Expression functions, seprated by ",". for example, "function1,function2,function3"
45+
-e, --external-functions=function1,function2 Pass a list of external functions and add them to Expression functions,
46+
seprated by ",". for example, "function1,function2,function3"
47+
48+
-f, --force If --out flag is provided with the path to an existing file, overwrites
49+
that file
50+
51+
-h, --help lg:analyze help
52+
53+
-i, --in=in (required) LG File or folder that contains .lg file(s)
54+
55+
-o, --out=out Output file or folder name. If not specified stdout will be used as
56+
output
57+
58+
-r, --recurse Consider sub-folders to find .lg file(s)
5159
```
5260

5361
_See code: [src/commands/lg/analyze.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/lg/src/commands/lg/analyze.ts)_

‎packages/luis/README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ EXAMPLE
121121
122122
$ bf luis:application:create --endpoint {ENDPOINT} --subscriptionKey {SUBSCRIPTION_KEY} --name {NAME} --culture
123123
{CULTURE}
124-
--domain {DOMAIN} --description {DESCRIPTION} --versionId {INITIAL_VERSION_ID} --usageScenario {USAGE_SCENARIO}
124+
--domain {DOMAIN} --description {DESCRIPTION} --versionId {INITIAL_VERSION_ID}
125125
```
126126

127127
_See code: [src/commands/luis/application/create.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/application/create.ts)_
@@ -338,14 +338,14 @@ USAGE
338338
OPTIONS
339339
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
340340
-h, --help luis:build command help
341-
-i, --in=in Lu file or folder
341+
-i, --in=in (required) Lu file or folder
342342
343343
-o, --out=out Output folder name to write out .dialog and settings files. If not specified,
344344
application setting will be output to console
345345
346-
--authoringKey=authoringKey LUIS authoring key
346+
--authoringKey=authoringKey (required) LUIS authoring key. Refered to as subscriptionKey in other cli commands.
347347
348-
--botName=botName Bot name
348+
--botName=botName (required) Bot name
349349
350350
--defaultCulture=defaultCulture Culture code for the content. Infer from .lu if available. Defaults to en-us
351351
@@ -356,7 +356,7 @@ OPTIONS
356356
357357
--directVersionPublish Available only in direct version query. Do not publish to staging or production
358358
359-
--endpoint=endpoint Luis authoring endpoint for publishing
359+
--endpoint=endpoint (required) Luis authoring endpoint for publishing
360360
361361
--fallbackLocale=fallbackLocale Locale to be used at the fallback if no locale specific recognizer is found. Only
362362
valid if --out is set
@@ -424,15 +424,16 @@ OPTIONS
424424
425425
--config=config Path to config file of mapping rules
426426
427+
--exclude=exclude Excludes folders under the input directory, separated by ",". If not specified, all luis and
428+
qna files will be included in the cross-train
429+
427430
--[no-]inner-dialog Only do inner dialog cross train
428431
429432
--intentName=intentName [default: _Interruption] Interruption intent name
430433
431434
--[no-]intra-dialog Only do intra dialog cross train
432435
433436
--log Writes out log messages to console
434-
435-
--exclude Excludes given folders under the input directory, for example, --exclude bin,obj,lib, this will ignore the /bin, /obj, /lib folders under the input path
436437
```
437438

438439
_See code: [src/commands/luis/cross-train.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/cross-train.ts)_

‎packages/orchestrator/README.md‎

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Orchestrator CLI is a replacement of the [Dispatch CLI](https://github.com/micro
2323
* [`bf orchestrator:create`](#bf-orchestratorcreate)
2424
* [`bf orchestrator:interactive`](#bf-orchestratorinteractive)
2525
* [`bf orchestrator:query`](#bf-orchestratorquery)
26+
* [`bf orchestrator:remove`](#bf-orchestratorremove)
2627
* [`bf orchestrator:test`](#bf-orchestratortest)
2728

2829
## `bf orchestrator`
@@ -77,9 +78,9 @@ EXAMPLE
7778
$ bf orchestrator:add --in ./path/to/file/ --snapshot ./path/to/snapshot/
7879
$ bf orchestrator:add --in ./path/to/file/ --snapshot ./path/to/snapshot/ --out ./path/to/output/
7980
$ bf orchestrator:add --in ./path/to/file/ --out ./path/to/output/ --model ./path/to/model/directory
80-
$ bf orchestrator:add -t luis --id LUIS_APP_ID --version LUIS_APP_VERSION --key LUIS_KEY --routingname l_Weather
81+
$ bf orchestrator:add -t luis --id LUIS_APP_ID --version LUIS_APP_VERSION --key LUIS_KEY --routingName l_Weather
8182
--endpoint
82-
$ bf orchestrator:add -t qna --id QNA_KB --key QNA_KB_SERVICE_KEY --routingname q_kb
83+
$ bf orchestrator:add -t qna --id QNA_KB --key QNA_KB_SERVICE_KEY --routingName q_kb
8384
```
8485

8586
_See code: [src/commands/orchestrator/add.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/add.ts)_
@@ -232,6 +233,31 @@ EXAMPLE
232233

233234
_See code: [src/commands/orchestrator/query.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/query.ts)_
234235

236+
## `bf orchestrator:remove`
237+
238+
Remove examples from LUIS app(s), QnaMaker kb(s) or .lu/.qna/.json files from Orchestrator snapshot file.
239+
240+
```
241+
USAGE
242+
$ bf orchestrator:remove
243+
244+
OPTIONS
245+
-d, --debug
246+
-h, --help Orchestrator remove command help
247+
-i, --in=in Path to example file (.lu/.qna/.json/.blu).
248+
-t, --type=type Type of input (luis/qna/file).
249+
--id=id LUIS app id or QnAMaker kb id if type = luis/qna.
250+
251+
EXAMPLE
252+
253+
$ bf orchestrator:remove
254+
$ bf orchestrator:remove -t luis --id LUIS_APP_ID
255+
$ bf orchestrator:remove -t qna --id QNA_KB
256+
$ bf orchestrator:remove -t file -i FILE_PATH
257+
```
258+
259+
_See code: [src/commands/orchestrator/remove.ts](https://github.com/microsoft/botframework-cli/src/commands/orchestrator/remove.ts)_
260+
235261
## `bf orchestrator:test`
236262

237263
The "test" command can operate in three modes: test, evaluation, assessment.

0 commit comments

Comments
 (0)