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

Commit d4d7149

Browse files
axelsrzaxelsrz
committed
Updated documentation for luis:generate
1 parent 2ea32b4 commit d4d7149

File tree

4 files changed

+36
-34
lines changed

4 files changed

+36
-34
lines changed

‎packages/cli/README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ $ npm install -g @microsoft/botframework-cli
1515
$ bf COMMAND
1616
running command...
1717
$ bf (-v|--version|version)
18-
@microsoft/botframework-cli/1.0.0 darwin-x64 node-v12.1.0
18+
@microsoft/botframework-cli/1.0.0 darwin-x64 node-v12.3.1
1919
$ bf --help [COMMAND]
2020
USAGE
2121
$ bf COMMAND
@@ -250,9 +250,9 @@ USAGE
250250
$ bf luis:generate:cs
251251
252252
OPTIONS
253-
--className=className Name of the class
254-
--force If --in flag provided with the path to an existing file, overwrites it
255-
--in=in Source .lu file(s) or LUIS application JSON model
253+
--className=className Name of the autogenerated class (can include namespace)
254+
--force If --in flag is provided with the path to an existing file, overwrites that file
255+
--in=in Path to the file containing the LUIS application JSON model
256256
--out=out Output file or folder name. If not specified stdout will be used as output
257257
```
258258

@@ -267,9 +267,9 @@ USAGE
267267
$ bf luis:generate:ts
268268
269269
OPTIONS
270-
--className=className Name of the class
271-
--force If --in flag provided with the path to an existing file, overwrites it
272-
--in=in Source .lu file(s) or LUIS application JSON model
270+
--className=className Name of the autogenerated class
271+
--force If --in flag is provided with the path to an existing file, overwrites that file
272+
--in=in Path to the file containing the LUIS application JSON model
273273
--out=out Output file or folder name. If not specified stdout will be used as output
274274
```
275275

@@ -289,8 +289,8 @@ OPTIONS
289289
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
290290
--srclang=srclang Source lang code. Auto detect if missing.
291291
--tgtlang=tgtlang (required) Comma separated list of target languages.
292-
--translate_comments=translate_comments When set, machine translate comments found in .lu or .qna file
293-
--translate_link_text=translate_link_text When set, machine translate link description in .lu or .qna file
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
294294
--translatekey=translatekey (required) Machine translation endpoint key.
295295
```
296296

@@ -442,7 +442,7 @@ OPTIONS
442442
--name=name Name of the QnA KB
443443
--out=out Output file or folder name. If not specified stdout will be used as output
444444
--recurse Indicates if sub-folders need to be considered to file .qna file(s)
445-
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .lu files
445+
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files
446446
```
447447

448448
_See code: [@microsoft/bf-luis](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/convert.ts)_
@@ -839,20 +839,20 @@ _See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cl
839839

840840
## `bf qnamaker:translate`
841841

842-
Translate given LUIS application JSON model or lu file(s)
842+
Translate given QnA maker application JSON model or qna file(s)
843843

844844
```
845845
USAGE
846846
$ bf qnamaker:translate
847847
848848
OPTIONS
849-
--in=in (required) Source .lu file(s) or LUIS application JSON model
849+
--in=in (required) Source .qna file(s) or QnA maker application JSON model
850850
--out=out Output folder name. If not specified stdout will be used as output
851-
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
851+
--recurse Indicates if sub-folders need to be considered to find .qna file(s)
852852
--srclang=srclang Source lang code. Auto detect if missing.
853853
--tgtlang=tgtlang (required) Comma separated list of target languages.
854-
--translate_comments=translate_comments When set, machine translate comments found in .lu or .qna file
855-
--translate_link_text=translate_link_text When set, machine translate link description in .lu or .qna file
854+
--translate_comments=translate_comments When set, machine translate comments found in .qna file
855+
--translate_link_text=translate_link_text When set, machine translate link description in .qna file
856856
--translatekey=translatekey (required) Machine translation endpoint key.
857857
```
858858

‎packages/luis/README.md‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ USAGE
3232
OPTIONS
3333
--culture=culture Lang code for the LUIS application
3434
--description=description Text describing the LUIS applicaion
35-
--in=in (required) Source .lu file(s) or LUIS application JSON model
35+
--in=in Source .lu file(s) or LUIS application JSON model
3636
--log Enables log messages
3737
--name=name Name of the LUIS application
3838
--out=out Output file or folder name. If not specified stdout will be used as output
@@ -53,8 +53,9 @@ USAGE
5353
$ bf luis:generate:cs
5454
5555
OPTIONS
56-
--className=className Name of the class
57-
--in=in Source .lu file(s) or LUIS application JSON model
56+
--className=className Name of the autogenerated class (can include namespace)
57+
--force If --in flag is provided with the path to an existing file, overwrites that file
58+
--in=in Path to the file containing the LUIS application JSON model
5859
--out=out Output file or folder name. If not specified stdout will be used as output
5960
```
6061

@@ -69,8 +70,9 @@ USAGE
6970
$ bf luis:generate:ts
7071
7172
OPTIONS
72-
--className=className Name of the class
73-
--in=in Source .lu file(s) or LUIS application JSON model
73+
--className=className Name of the autogenerated class
74+
--force If --in flag is provided with the path to an existing file, overwrites that file
75+
--in=in Path to the file containing the LUIS application JSON model
7476
--out=out Output file or folder name. If not specified stdout will be used as output
7577
```
7678

@@ -90,8 +92,8 @@ OPTIONS
9092
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
9193
--srclang=srclang Source lang code. Auto detect if missing.
9294
--tgtlang=tgtlang (required) Comma separated list of target languages.
93-
--translate_comments=translate_comments When set, machine translate comments found in .lu or .qna file
94-
--translate_link_text=translate_link_text When set, machine translate link description in .lu or .qna file
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
9597
--translatekey=translatekey (required) Machine translation endpoint key.
9698
```
9799

@@ -112,27 +114,27 @@ OPTIONS
112114
--name=name Name of the QnA KB
113115
--out=out Output file or folder name. If not specified stdout will be used as output
114116
--recurse Indicates if sub-folders need to be considered to file .qna file(s)
115-
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .lu files
117+
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files
116118
```
117119

118120
_See code: [src/commands/qnamaker/convert.ts](https://github.com/microsoft/botframework-cli/blob/v1.0.0/src/commands/qnamaker/convert.ts)_
119121

120122
## `bf qnamaker:translate`
121123

122-
Translate given LUIS application JSON model or lu file(s)
124+
Translate given QnA maker application JSON model or qna file(s)
123125

124126
```
125127
USAGE
126128
$ bf qnamaker:translate
127129
128130
OPTIONS
129-
--in=in (required) Source .lu file(s) or LUIS application JSON model
131+
--in=in (required) Source .qna file(s) or QnA maker application JSON model
130132
--out=out Output folder name. If not specified stdout will be used as output
131-
--recurse Indicates if sub-folders need to be considered to file .lu file(s)
133+
--recurse Indicates if sub-folders need to be considered to find .qna file(s)
132134
--srclang=srclang Source lang code. Auto detect if missing.
133135
--tgtlang=tgtlang (required) Comma separated list of target languages.
134-
--translate_comments=translate_comments When set, machine translate comments found in .lu or .qna file
135-
--translate_link_text=translate_link_text When set, machine translate link description in .lu or .qna file
136+
--translate_comments=translate_comments When set, machine translate comments found in .qna file
137+
--translate_link_text=translate_link_text When set, machine translate link description in .qna file
136138
--translatekey=translatekey (required) Machine translation endpoint key.
137139
```
138140

‎packages/luis/src/commands/luis/generate/cs.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ export default class LuisGenerateCs extends Command {
1010
static description = 'Generate:cs generates a strongly typed C# source code from an exported (json) LUIS model.'
1111

1212
static flags: flags.Input<any> = {
13-
in: flags.string({description: 'Source .lu file(s) or LUIS application JSON model'}),
13+
in: flags.string({description: 'Path to the file containing the LUIS application JSON model'}),
1414
out: flags.string({description: 'Output file or folder name. If not specified stdout will be used as output', default: ''}),
15-
className: flags.string({description: 'Name of the class'}),
16-
force: flags.boolean({description: 'If --in flag provided with the path to an existing file, overwrites it', default: false}),
15+
className: flags.string({description: 'Name of the autogenerated class (can include namespace)'}),
16+
force: flags.boolean({description: 'If --in flag is provided with the path to an existing file, overwrites that file', default: false}),
1717
}
1818

1919
reorderEntities(app: any, name: string): void {

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ export default class LuisGenerateTs extends Command {
1010
static description = 'Generate:ts generates a strongly typed typescript source code from an exported (json) LUIS model.'
1111

1212
static flags: flags.Input<any> = {
13-
in: flags.string({description: 'Source .lu file(s) or LUIS application JSON model'}),
13+
in: flags.string({description: 'Path to the file containing the LUIS application JSON model'}),
1414
out: flags.string({description: 'Output file or folder name. If not specified stdout will be used as output', default: ''}),
15-
className: flags.string({description: 'Name of the class'}),
16-
force: flags.boolean({description: 'If --in flag provided with the path to an existing file, overwrites it', default: false}),
15+
className: flags.string({description: 'Name of the autogenerated class'}),
16+
force: flags.boolean({description: 'If --in flag is provided with the path to an existing file, overwrites that file', default: false}),
1717
}
1818

1919
reorderEntities(app: any, name: string): void {

0 commit comments

Comments
 (0)