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

Commit 6dbebec

Browse files
author
Eyal
authored
Fix luis api spec (#359)
* bf cli doc header * updated readme.md * update readme.md * minor link fix * powerBI dashboard * powerBI usage stats dashboard * dialog cli spec * fix my readme * reverted readme * added draft * pbi update * bf:luis cli usage update * update usage * LUIS authkey to subscriptionKey * minor spec fixes * updated luis cli usage spec * fix command ordering and camel case
1 parent c08a09a commit 6dbebec

File tree

1 file changed

+23
-29
lines changed

1 file changed

+23
-29
lines changed

specs/LUIS-CLI-Usage-Spec.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ Parameters:
6464

6565

6666

67-
### clone:version
67+
### version:clone
68+
6869

6970
Synopsis: Creates a new version equivalent to the current snapshot of the selected application version.
7071

@@ -73,10 +74,10 @@ Reference: [Clone version](https://westus.dev.cognitive.microsoft.com/docs/serv
7374
Parameters:
7475

7576
```
76-
--srcversionId Source version to clone (mandatory, defaults to config:LUIS:versionId)
77-
--destversionId Destination version to create (mandatory)
78-
--appid LUIS application Id (mandatory, defaults to config:LUIS:appId)
79-
--subscriptionKey LUIS authoring (Ocp-Apim-subscription) key
77+
--versionId Source version to clone (mandatory, defaults to config:LUIS:versionId)
78+
--targetVersionId Destination version to create (mandatory)
79+
--appId LUIS application Id (mandatory, defaults to config:LUIS:appId)
80+
--subscriptionKey LUIS authoring (Ocp-Apim-subscription) key
8081
```
8182

8283
Returns:
@@ -87,7 +88,7 @@ Returns:
8788

8889

8990

90-
### create:application
91+
### application:create
9192

9293
Synopsis: Creates a new LUIS application
9394

@@ -116,9 +117,7 @@ Returns:
116117
* Or error code with error message
117118
* Echo newly created application Id
118119

119-
120-
121-
### delete:application
120+
### application:delete
122121

123122
Synopsis: Deletes a LUIS application.
124123

@@ -128,7 +127,7 @@ Parameters:
128127

129128
```
130129
--subscriptionkey LUIS cognitive services subscription key (mandatory, default: config:LUIS:subscriptionKey)
131-
--appid LUIS application Id (mandatory, defaults to config:LUIS:appId)
130+
--appId LUIS application Id (mandatory, defaults to config:LUIS:appId)
132131
--force If specified, ignore application dependencies. (optional, default: false). **TBD**: Do we still have to specify true/false? presence of flag should suffice
133132
```
134133

@@ -139,7 +138,7 @@ Returns:
139138

140139

141140

142-
### delete:version
141+
### version:delete
143142

144143
Synopsis: Deletes a LUIS application version.
145144

@@ -160,7 +159,7 @@ Returns:
160159

161160

162161

163-
### export:version
162+
### version:export
164163

165164
Synopsis: Exports a LUIS application to JSON format .
166165

@@ -189,8 +188,7 @@ Returns:
189188
* If file specified, print out written file full path
190189

191190

192-
193-
### import:application
191+
### application:import
194192

195193
Synopsis: Imports LUIS application from JSON or LU content.
196194

@@ -220,7 +218,7 @@ Returns:
220218

221219

222220

223-
### import:version
221+
### version:import
224222

225223
Synopsis: Imports a new version into a LUIS application from JSON or LU content.
226224

@@ -249,9 +247,8 @@ Returns:
249247

250248
* Prints out created version Id
251249

252-
253250

254-
### list:applications
251+
### application:list
255252

256253
Synopsis: Lists all applications on LUIS service.
257254

@@ -277,7 +274,7 @@ Returns:
277274

278275

279276

280-
### list:endpoints
277+
### endpoint:list
281278

282279
Synopsis: Returns available deployment endpoints
283280

@@ -300,9 +297,8 @@ Returns:
300297

301298
* Prints out deployment endpoints unless output file is specified
302299

303-
304300

305-
### list:versions
301+
### version:list
306302

307303
Synopsis: Returns application's versions
308304

@@ -329,7 +325,7 @@ Returns:
329325

330326

331327

332-
### publish:application **TBD**: Original spec states publish:version
328+
### application:publish **TBD**: Original spec states publish:version
333329

334330
Synopsis: Publishes application's version
335331

@@ -367,9 +363,7 @@ Returns:
367363
}
368364
```
369365

370-
371-
372-
### rename:application
366+
### application:rename
373367

374368
Synopsis: Renames the application and updates its description
375369

@@ -391,7 +385,7 @@ Returns:
391385

392386

393387

394-
### rename:version
388+
### version:rename
395389

396390
Synopsis: Renames application version
397391

@@ -413,7 +407,7 @@ Returns:
413407

414408

415409

416-
### show:application
410+
### application:show
417411

418412
Synopsis: Shows application information
419413

@@ -466,7 +460,7 @@ Returns:
466460

467461

468462

469-
### show:training **TBD**: Change from show:trainingstatus
463+
### train:show **TBD**: Change from show:trainingstatus
470464

471465
Synopsis: Shows training status
472466

@@ -507,7 +501,7 @@ Returns:
507501
]
508502
```
509503

510-
### train **TBD**: Changed from original table spec
504+
### train:run **TBD**: Changed from original table spec
511505

512506
Synopsis: Issues asynchronous training request for LUIS application
513507

@@ -526,7 +520,7 @@ Returns:
526520

527521

528522

529-
### query **TBD**: Ensure it is the right one
523+
### application:query **TBD**: Ensure it is the right one
530524

531525
Synopsis: Queries application for intent predictions
532526

0 commit comments

Comments
 (0)