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

Commit adcf8b5

Browse files
munozemiliomunozemilio
committed
Updating generated docs
1 parent 26ac202 commit adcf8b5

File tree

7 files changed

+49
-50
lines changed

7 files changed

+49
-50
lines changed

‎packages/cli/README.md‎

Lines changed: 27 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,15 @@ botframework-cli
44

55

66
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
7-
[![Version](https://img.shields.io/npm/v/botframework-cli.svg)](https://www.npmjs.com/package/@microsoft/botframework-cli)
8-
[![Downloads/week](https://img.shields.io/npm/dw/botframework-cli.svg)](https://www.npmjs.com/package/@microsoft/botframework-cli)
7+
[![Version](https://img.shields.io/npm/v/botframework-cli.svg)](![npm (scoped)](https://img.shields.io/npm/v/@microsoft/botframework-cli))
8+
[![Downloads](https://img.shields.io/npm/dw/botframework-cli.svg)](![npm](https://img.shields.io/npm/dt/@microsoft/botframework-cli))
99
[![License](https://img.shields.io/npm/l/botframework-cli.svg)](https://github.com/microsoft/botframework-cli/blob/master/packages/cli/package.json)
1010

1111
# Usage
1212
<!-- usage -->
1313
```sh-session
1414
$ npm install -g @microsoft/botframework-cli
1515
$ bf COMMAND
16-
running command...
17-
$ bf (-v|--version|version)
18-
@microsoft/botframework-cli/1.0.0 darwin-x64 node-v12.3.1
19-
$ bf --help [COMMAND]
20-
USAGE
21-
$ bf COMMAND
22-
...
2316
```
2417
<!-- usagestop -->
2518
# Commands
@@ -154,6 +147,7 @@ USAGE
154147
155148
OPTIONS
156149
-d, --disable Disable tlemetry
150+
-e, --enable Enable tlemetry
157151
-h, --help show CLI help
158152
```
159153

@@ -239,7 +233,7 @@ OPTIONS
239233
--versionid=versionid Version ID of the LUIS application
240234
```
241235

242-
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/convert.ts)_
236+
_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/convert.ts)_
243237

244238
## `bf luis:generate:cs`
245239

@@ -256,7 +250,7 @@ OPTIONS
256250
--out=out Output file or folder name. If not specified stdout will be used as output
257251
```
258252

259-
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/generate/cs.ts)_
253+
_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/generate/cs.ts)_
260254

261255
## `bf luis:generate:ts`
262256

@@ -273,7 +267,7 @@ OPTIONS
273267
--out=out Output file or folder name. If not specified stdout will be used as output
274268
```
275269

276-
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/generate/ts.ts)_
270+
_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/generate/ts.ts)_
277271

278272
## `bf luis:translate`
279273

@@ -284,17 +278,17 @@ USAGE
284278
$ bf luis:translate
285279
286280
OPTIONS
287-
--in=in (required) Source .lu file(s) or LUIS application JSON model
288-
--out=out Output folder name. If not specified stdout will be used as output
289-
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
290-
--srclang=srclang Source lang code. Auto detect if missing.
291-
--tgtlang=tgtlang (required) Comma separated list of target languages.
292-
--translate_comments=translate_comments When set, machine translate comments found in .lu file
293-
--translate_link_text=translate_link_text When set, machine translate link description in .lu file
294-
--translatekey=translatekey (required) Machine translation endpoint key.
281+
--in=in Source .lu file(s) or LUIS application JSON model
282+
--out=out Output folder name. If not specified stdout will be used as output
283+
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
284+
--srclang=srclang Source lang code. Auto detect if missing.
285+
--tgtlang=tgtlang (required) Comma separated list of target languages.
286+
--translate_comments When set, machine translate comments found in .lu file
287+
--translate_link_text When set, machine translate link description in .lu file
288+
--translatekey=translatekey (required) Machine translation endpoint key.
295289
```
296290

297-
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/translate.ts)_
291+
_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/translate.ts)_
298292

299293
## `bf plugins`
300294

@@ -437,15 +431,15 @@ USAGE
437431
438432
OPTIONS
439433
--alterations Indicates if files is QnA Alterations
440-
--in=in (required) Source .qna file(s) or QnA KB JSON file
434+
--in=in Source .qna file(s) or QnA KB JSON file
441435
--log Enables log messages
442436
--name=name Name of the QnA KB
443437
--out=out Output file or folder name. If not specified stdout will be used as output
444438
--recurse Indicates if sub-folders need to be considered to file .qna file(s)
445439
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files
446440
```
447441

448-
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/convert.ts)_
442+
_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/convert.ts)_
449443

450444
## `bf qnamaker:create:kb`
451445

@@ -710,23 +704,25 @@ USAGE
710704
711705
OPTIONS
712706
-h, --help qnamaker:query command help
707+
--context=context Path to Context object json file with previous QnA
713708
714709
--endpointKey=endpointKey Specifies the endpoint key for your private QnA service (From qnamaker.ai portal user
715-
settings page). Overrides the value present in config.
710+
settings page). Overrides the value present in config
716711
717-
--hostname=hostname Specifies the url for your private QnA service. Overrides the value present in
718-
config.
712+
--hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config
719713
720714
--kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the value present in the
721715
config
722716
723-
--question=question (required) Query to get a prediction for.
717+
--qnaId=qnaId Exact qnaId to fetch from the knowledgebase, this field takes priority over question
718+
719+
--question=question (required) Query to get a prediction for
724720
725721
--scorethreshold=scorethreshold Specifies the confidence score threshold for the returned answer.
726722
727-
--strictfilters=strictfilters Path to json file {"strictfilters": MetadataDTO[]}
723+
--strictfilters=strictfilters Path to json file with MetadataDTO[] e.g {"strictfilters": MetadataDTO[]}
728724
729-
--test Query against the test index.
725+
--test Query against the test index
730726
731727
--top=top Specifies the number of matching results
732728
```
@@ -846,7 +842,7 @@ USAGE
846842
$ bf qnamaker:translate
847843
848844
OPTIONS
849-
--in=in (required) Source .qna file(s) or QnA maker application JSON model
845+
--in=in Source .qna file(s) or QnA maker application JSON model
850846
--out=out Output folder name. If not specified stdout will be used as output
851847
--recurse Indicates if sub-folders need to be considered to find .qna file(s)
852848
--srclang=srclang Source lang code. Auto detect if missing.
@@ -856,7 +852,7 @@ OPTIONS
856852
--translatekey=translatekey (required) Machine translation endpoint key.
857853
```
858854

859-
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/translate.ts)_
855+
_See code: [@microsoft/bf-lu](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/translate.ts)_
860856

861857
## `bf qnamaker:update`
862858

‎packages/config/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ USAGE
7373
7474
OPTIONS
7575
-d, --disable Disable tlemetry
76+
-e, --enable Enable tlemetry
7677
-h, --help show CLI help
7778
```
7879

‎packages/luis/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,14 @@ USAGE
8787
$ bf luis:translate
8888
8989
OPTIONS
90-
--in=in (required) Source .lu file(s) or LUIS application JSON model
91-
--out=out Output folder name. If not specified stdout will be used as output
92-
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
93-
--srclang=srclang Source lang code. Auto detect if missing.
94-
--tgtlang=tgtlang (required) Comma separated list of target languages.
95-
--translate_comments=translate_comments When set, machine translate comments found in .lu file
96-
--translate_link_text=translate_link_text When set, machine translate link description in .lu file
97-
--translatekey=translatekey (required) Machine translation endpoint key.
90+
--in=in Source .lu file(s) or LUIS application JSON model
91+
--out=out Output folder name. If not specified stdout will be used as output
92+
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
93+
--srclang=srclang Source lang code. Auto detect if missing.
94+
--tgtlang=tgtlang (required) Comma separated list of target languages.
95+
--translate_comments When set, machine translate comments found in .lu file
96+
--translate_link_text When set, machine translate link description in .lu file
97+
--translatekey=translatekey (required) Machine translation endpoint key.
9898
```
9999

100100
_See code: [src/commands/luis/translate.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/luis/translate.ts)_
@@ -109,7 +109,7 @@ USAGE
109109
110110
OPTIONS
111111
--alterations Indicates if files is QnA Alterations
112-
--in=in (required) Source .qna file(s) or QnA KB JSON file
112+
--in=in Source .qna file(s) or QnA KB JSON file
113113
--log Enables log messages
114114
--name=name Name of the QnA KB
115115
--out=out Output file or folder name. If not specified stdout will be used as output
@@ -128,7 +128,7 @@ USAGE
128128
$ bf qnamaker:translate
129129
130130
OPTIONS
131-
--in=in (required) Source .qna file(s) or QnA maker application JSON model
131+
--in=in Source .qna file(s) or QnA maker application JSON model
132132
--out=out Output folder name. If not specified stdout will be used as output
133133
--recurse Indicates if sub-folders need to be considered to find .qna file(s)
134134
--srclang=srclang Source lang code. Auto detect if missing.

‎packages/luis/src/commands/luis/translate.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export default class LuisTranslate extends Command {
1212
static description = ' Translate given LUIS application JSON model or lu file(s)'
1313

1414
static flags: flags.Input<any> = {
15-
in: flags.string({description: 'Source .lu file(s) or LUIS application JSON model', required: true}),
15+
in: flags.string({description: 'Source .lu file(s) or LUIS application JSON model'}),
1616
recurse: flags.boolean({description: 'Indicates if sub-folders need to be considered to file .lu file(s)'}),
1717
out: flags.string({description: 'Output folder name. If not specified stdout will be used as output'}),
1818
srclang: flags.string({description: 'Source lang code. Auto detect if missing.'}),

‎packages/luis/src/commands/qnamaker/convert.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export default class QnamakerConvert extends Command {
1010
static description = 'Convert .lu file(s) to a QnA application JSON model or vice versa'
1111

1212
static flags: flags.Input<any> = {
13-
in: flags.string({description: 'Source .qna file(s) or QnA KB JSON file', required: true}),
13+
in: flags.string({description: 'Source .qna file(s) or QnA KB JSON file'}),
1414
alterations: flags.boolean({description: 'Indicates if files is QnA Alterations'}),
1515
log: flags.boolean({description: 'Enables log messages', default: false}),
1616
sort: flags.boolean({description: 'When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files', default: false}),

‎packages/luis/src/commands/qnamaker/translate.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export default class QnamakerTranslate extends Command {
1212
static description = 'Translate given QnA maker application JSON model or qna file(s)'
1313

1414
static flags: flags.Input<any> = {
15-
in: flags.string({description: 'Source .qna file(s) or QnA maker application JSON model', required: true}),
15+
in: flags.string({description: 'Source .qna file(s) or QnA maker application JSON model'}),
1616
recurse: flags.boolean({description: 'Indicates if sub-folders need to be considered to find .qna file(s)'}),
1717
out: flags.string({description: 'Output folder name. If not specified stdout will be used as output'}),
1818
srclang: flags.string({description: 'Source lang code. Auto detect if missing.'}),

‎packages/qnamaker/README.md‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -311,23 +311,25 @@ USAGE
311311
312312
OPTIONS
313313
-h, --help qnamaker:query command help
314+
--context=context Path to Context object json file with previous QnA
314315
315316
--endpointKey=endpointKey Specifies the endpoint key for your private QnA service (From qnamaker.ai portal user
316-
settings page). Overrides the value present in config.
317+
settings page). Overrides the value present in config
317318
318-
--hostname=hostname Specifies the url for your private QnA service. Overrides the value present in
319-
config.
319+
--hostname=hostname Specifies the url for your private QnA service. Overrides the value present in config
320320
321321
--kbId=kbId Specifies the active qnamaker knowledgebase id. Overrides the value present in the
322322
config
323323
324-
--question=question (required) Query to get a prediction for.
324+
--qnaId=qnaId Exact qnaId to fetch from the knowledgebase, this field takes priority over question
325+
326+
--question=question (required) Query to get a prediction for
325327
326328
--scorethreshold=scorethreshold Specifies the confidence score threshold for the returned answer.
327329
328-
--strictfilters=strictfilters Path to json file {"strictfilters": MetadataDTO[]}
330+
--strictfilters=strictfilters Path to json file with MetadataDTO[] e.g {"strictfilters": MetadataDTO[]}
329331
330-
--test Query against the test index.
332+
--test Query against the test index
331333
332334
--top=top Specifies the number of matching results
333335
```

0 commit comments

Comments
 (0)