-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Expand file tree
/
Copy pathroutes.tsp
More file actions
841 lines (769 loc) · 24.7 KB
/
routes.tsp
File metadata and controls
841 lines (769 loc) · 24.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
import "@azure-tools/typespec-azure-core";
import "@typespec/rest";
import "./models/project.tsp";
import "./models/common.tsp";
import "@typespec/http";
import "@typespec/versioning";
import "@azure-tools/typespec-client-generator-core";
using TypeSpec.Rest;
using TypeSpec.Http;
using Azure.Core;
using Azure.Core.Traits;
using Azure.ClientGenerator.Core;
using TypeSpec.Versioning;
namespace Language.Conversations.Authoring;
alias ServiceTraits = NoRepeatableRequests &
NoConditionalRequests &
NoClientRequestId;
alias languageOperations = ResourceOperations<
ServiceTraits,
Foundations.ErrorResponse
>;
/**
* Lists the deployments belonging to a project.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listDeployments", "csharp")
op conversationAuthoringListDeployments is languageOperations.ResourceList<
AnalyzeConversationAuthoringProjectDeployment,
ListQueryParametersTrait<StandardListQueryParameters>
>;
/**
* Lists the existing projects.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listProjects", "csharp")
op conversationAuthoringListProjects is languageOperations.ResourceList<
AnalyzeConversationAuthoringProjectMetadata,
ListQueryParametersTrait<StandardListQueryParameters>
>;
/**
* Lists the supported languages for the given project type.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listSupportedLanguages", "csharp")
op conversationAuthoringListSupportedLanguages is languageOperations.ResourceList<
AnalyzeConversationAuthoringSupportedLanguage,
ListQueryParametersTrait<StandardListQueryParameters &
ProjectKindQueryParameter>
>;
/**
* Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listAssignedResourceDeployments", "csharp")
@added(Versions.v2024_11_15_preview)
op conversationAuthoringListAssignedResourceDeployments is languageOperations.ResourceList<
AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata,
ListQueryParametersTrait<StandardListQueryParameters>
>;
/**
* Lists the deployments resources assigned to the project.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listDeploymentResources", "csharp")
@added(Versions.v2024_11_15_preview)
op conversationAuthoringListDeploymentResources is languageOperations.ResourceList<
AnalyzeConversationAuthoringAssignedDeploymentResource,
ListQueryParametersTrait<StandardListQueryParameters>
>;
/**
* Lists the supported prebuilt entities that can be used while creating composed entities.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listSupportedPrebuiltEntities", "csharp")
op conversationAuthoringListSupportedPrebuiltEntities is languageOperations.ResourceList<
AnalyzeConversationAuthoringPrebuiltEntity,
ListQueryParametersTrait<StandardListQueryParameters &
SupportedPrebuiltEntitiesQueryParameter>
>;
/**
* Lists the support training config version for a given project type.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listTrainingConfigVersions", "csharp")
op conversationAuthoringListTrainingConfigVersions is languageOperations.ResourceList<
AnalyzeConversationAuthoringTrainingConfigVersion,
ListQueryParametersTrait<StandardListQueryParameters &
ProjectKindQueryParameter>
>;
/**
* Lists the non-expired training jobs created for a project.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listTrainingJobs", "csharp")
op conversationAuthoringListTrainingJobs is languageOperations.ResourceList<
AnalyzeConversationAuthoringTrainingJobState,
ListQueryParametersTrait<StandardListQueryParameters>
>;
/**
* Lists the trained models belonging to a project.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listTrainedModels", "csharp")
op conversationAuthoringListTrainedModels is languageOperations.ResourceList<
AnalyzeConversationAuthoringProjectTrainedModel,
ListQueryParametersTrait<StandardListQueryParameters>
>;
/**
* Lists the exported models belonging to a project.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names"
@clientName("listExportedModels", "csharp")
@added(Versions.v2024_11_15_preview)
op conversationAuthoringListExportedModels is languageOperations.ResourceList<
AnalyzeConversationAuthoringExportedTrainedModel,
ListQueryParametersTrait<StandardListQueryParameters>
>;
interface ConversationAuthoringDeployment {
/**
* Gets the details of a deployment.
*/
@get
getDeployment is languageOperations.ResourceRead<AnalyzeConversationAuthoringProjectDeployment>;
/**
* Creates a new deployment or replaces an existing one.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}")
@put
@pollingOperation(ConversationAuthoringDeployment.getDeploymentStatus)
deployProject is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The name of the specific deployment of the project to use.
*/
@path
deploymentName: string;
/**
* The new deployment info.
*/
@body
@clientName("details", "csharp")
body: AnalyzeConversationAuthoringCreateDeploymentOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Deletes a project deployment.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}")
@delete
@pollingOperation(ConversationAuthoringDeployment.getDeploymentStatus)
deleteDeployment is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The name of the specific deployment of the project to use.
*/
@path
deploymentName: string;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Deletes a project deployment from the specified assigned resources.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources")
@post
@pollingOperation(
ConversationAuthoringDeployment.getDeploymentDeleteFromResourcesStatus
)
@added(Versions.v2024_11_15_preview)
deleteDeploymentFromResources is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The name of the specific deployment of the project to use.
*/
@path
deploymentName: string;
/**
* The options for deleting the deployment.
*/
@body
@clientName("details", "csharp")
body: AnalyzeConversationAuthoringDeleteDeploymentOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status of an existing delete deployment from specific resources job.
*/
@added(Versions.v2024_11_15_preview)
getDeploymentDeleteFromResourcesStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState>;
/**
* Gets the status of an existing deployment job.
*/
getDeploymentStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringDeploymentJobState>;
}
interface ConversationAuthoringProject {
/**
* Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/resources/:assign")
@post
@pollingOperation(
ConversationAuthoringProject.getAssignDeploymentResourcesStatus
)
@added(Versions.v2024_11_15_preview)
assignDeploymentResources is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The new project resources info.
*/
@body
@clientName("details", "csharp")
body: AnalyzeConversationAuthoringAssignDeploymentResourcesOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/resources/:unassign")
@post
@pollingOperation(
ConversationAuthoringProject.getUnassignDeploymentResourcesStatus
)
@added(Versions.v2024_11_15_preview)
unassignDeploymentResources is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The info for the deployment resources to be deleted.
*/
@body
@clientName("details", "csharp")
body: AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status of an existing assign deployment resources job.
*/
@added(Versions.v2024_11_15_preview)
getAssignDeploymentResourcesStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringDeploymentResourcesJobState>;
/**
* Gets the status of an existing unassign deployment resources job.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}")
@get
@added(Versions.v2024_11_15_preview)
getUnassignDeploymentResourcesStatus is Azure.Core.Foundations.Operation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The job ID.
*/
@path
jobId: string;
},
AnalyzeConversationAuthoringDeploymentResourcesJobState,
{},
Foundations.ErrorResponse
>;
/**
* Swaps two existing deployments with each other.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/deployments/:swap")
@post
@pollingOperation(ConversationAuthoringProject.getSwapDeploymentsStatus)
swapDeployments is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The job object to swap two deployments.
*/
@body
@clientName("details", "csharp")
body: AnalyzeConversationAuthoringSwapDeploymentsOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status of an existing swap deployment job.
*/
getSwapDeploymentsStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringSwapDeploymentsJobState>;
/**
* Gets the details of a project.
*/
getProject is languageOperations.ResourceRead<AnalyzeConversationAuthoringProjectMetadata>;
/**
* Creates a new project or updates an existing one.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Need to rename the body"
@createsOrUpdatesResource(AnalyzeConversationAuthoringProjectMetadata)
@patch(#{ implicitOptionality: false })
createProject is Foundations.ResourceOperation<
AnalyzeConversationAuthoringProjectMetadata,
{
@doc("This request has a JSON Merge Patch body.")
@TypeSpec.Http.header("Content-Type")
contentType: "application/merge-patch+json";
/** The request body */
@clientName("details", "csharp")
@bodyRoot
body: AnalyzeConversationAuthoringCreateProjectOptions;
},
Foundations.ResourceCreatedOrOkResponse<AnalyzeConversationAuthoringProjectMetadata>,
{},
Foundations.ErrorResponse
>;
/**
* Deletes a project.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}")
@delete
@pollingOperation(ConversationAuthoringProject.getProjectDeletionStatus)
deleteProject is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status for a project deletion job.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}")
@get
getProjectDeletionStatus is Azure.Core.Foundations.Operation<
{
/**
* The job ID.
*/
@path
jobId: string;
},
AnalyzeConversationAuthoringProjectDeletionJobState,
{},
Foundations.ErrorResponse
>;
/**
* Triggers a job to export a project's data.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/:export")
@post
@pollingOperation(ConversationAuthoringProject.getExportStatus)
export is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The format of the exported project file to use.
*/
#suppress "@azure-tools/typespec-azure-core/casing-style"
@query("format")
ExportedProjectFormat?: ExportedProjectFormat;
/**
* Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.
*/
@query("stringIndexType")
stringIndexType: StringIndexType;
/**
* Kind of asset to export.
*/
@query("assetKind")
assetKind?: string;
/**
* Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.
*/
@query("trainedModelLabel")
trainedModelLabel?: string;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/:import")
@post
@pollingOperation(ConversationAuthoringProject.getImportStatus)
`import` is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The format of the exported project file to use.
*/
#suppress "@azure-tools/typespec-azure-core/casing-style"
@query("format")
ExportedProjectFormat?: ExportedProjectFormat;
/**
* The project data to import.
*/
@body
@clientName("exportedProject", "csharp")
body: AnalyzeConversationAuthoringExportedProject;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status of an export job. Once job completes, returns the project metadata, and assets.
*/
getExportStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringExportProjectJobState>;
/**
* Gets the status for an import.
*/
getImportStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringImportProjectJobState>;
/**
* Generates a copy project operation authorization to the current target Azure resource.
*/
#suppress "@azure-tools/typespec-azure-core/casing-style"
@post
@added(Versions.v2024_11_15_preview)
@actionSeparator("/:")
@action("authorize-copy")
@clientName("AuthorizeProjectCopy", "csharp")
copyProjectAuthorization is languageOperations.ResourceAction<
AnalyzeConversationAuthoringProjectMetadata,
AnalyzeConversationAuthoringCopyAuthorizationOptions,
AnalyzeConversationAuthoringCopiedProjectOptions
>;
/**
* Copies an existing project to another Azure resource.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/:copy")
@post
@pollingOperation(ConversationAuthoringProject.getCopyProjectStatus)
@added(Versions.v2024_11_15_preview)
copyProject is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The copy project info.
*/
@body
@clientName("details", "csharp")
body: AnalyzeConversationAuthoringCopiedProjectOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status of an existing copy project job.
*/
@added(Versions.v2024_11_15_preview)
getCopyProjectStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringCopiedProjectJobState>;
/**
* Triggers a training job for a project.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/:train")
@post
@pollingOperation(ConversationAuthoringProject.getTrainingStatus)
train is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The training input parameters.
*/
@body
@clientName("details", "csharp")
body: AnalyzeConversationAuthoringTrainingJobOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status for a training job.
*/
getTrainingStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringTrainingJobState>;
/**
* Triggers a cancellation for a running training job.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel")
@post
@pollingOperation(ConversationAuthoringProject.getTrainingStatus)
cancelTrainingJob is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The job ID.
*/
@path
jobId: string;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
}
interface ConversationAuthoringExportedModel {
/**
* Gets the details of an exported model.
*/
@added(Versions.v2024_11_15_preview)
getExportedModel is languageOperations.ResourceRead<AnalyzeConversationAuthoringExportedTrainedModel>;
/**
* Deletes an existing exported model.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/exported-models/{exportedModelName}")
@delete
@pollingOperation(
ConversationAuthoringExportedModel.getExportedModelJobStatus
)
@added(Versions.v2024_11_15_preview)
deleteExportedModel is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@path
projectName: string;
/**
* The exported model name.
*/
@path
exportedModelName: string;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Creates a new exported model or replaces an existing one.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/exported-models/{exportedModelName}")
@put
@pollingOperation(
ConversationAuthoringExportedModel.getExportedModelJobStatus
)
@added(Versions.v2024_11_15_preview)
createOrUpdateExportedModel is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@path
projectName: string;
/**
* The exported model name.
*/
@path
exportedModelName: string;
/**
* The exported model info.
*/
@body
@clientName("details", "csharp")
body: ExportedModelOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status for an existing job to create or update an exported model.
*/
@added(Versions.v2024_11_15_preview)
getExportedModelJobStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringExportedModelJobState>;
}
interface ConversationAuthoringTrainedModel {
/**
* Gets the details of a trained model.
*/
getTrainedModel is languageOperations.ResourceRead<AnalyzeConversationAuthoringProjectTrainedModel>;
/**
* Deletes an existing trained model.
*/
deleteTrainedModel is languageOperations.ResourceDelete<AnalyzeConversationAuthoringProjectTrainedModel>;
/**
* Triggers evaluation operation on a trained model.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate")
@post
@pollingOperation(ConversationAuthoringTrainedModel.getEvaluationStatus)
@added(Versions.v2024_11_15_preview)
evaluateModel is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The trained model label.
*/
@path
trainedModelLabel: string;
/**
* The training input parameters.
*/
@body
@clientName("details", "csharp")
body: AnalyzeConversationAuthoringEvaluationOptions;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Restores the snapshot of this trained model to be the current working directory of the project.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot")
@post
@pollingOperation(ConversationAuthoringTrainedModel.getLoadSnapshotStatus)
loadSnapshot is Foundations.LongRunningOperation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The trained model label.
*/
@path
trainedModelLabel: string;
},
AcceptedResponse,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status for an evaluation job.
*/
@added(Versions.v2024_11_15_preview)
getEvaluationStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringEvaluationJobState>;
/**
* Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-names" "Existing name"
getModelEvaluationResults is languageOperations.ResourceList<
AnalyzeConversationAuthoringUtteranceEvaluationResult,
ListQueryParametersTrait<StandardListQueryParameters &
StringIndexTypeQueryParameter>
>;
/**
* Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.
*/
#suppress "@azure-tools/typespec-azure-core/use-standard-operations"
@route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result")
@get
getModelEvaluationSummary is Foundations.Operation<
{
/**
* The name of the project to use.
*/
@maxLength(100)
@path
projectName: string;
/**
* The trained model label.
*/
@path
trainedModelLabel: string;
},
AnalyzeConversationAuthoringEvaluationSummary,
{},
Foundations.ErrorResponse
>;
/**
* Gets the status for loading a snapshot.
*/
getLoadSnapshotStatus is languageOperations.ResourceRead<AnalyzeConversationAuthoringLoadSnapshotJobState>;
}