@aws-sdk/client-transcribe 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +402 -0
- package/package.json +5 -5
|
@@ -19,23 +19,27 @@ import { TranscribeServiceException as __BaseException } from "./TranscribeServi
|
|
|
19
19
|
*/
|
|
20
20
|
export interface AbsoluteTimeRange {
|
|
21
21
|
/**
|
|
22
|
+
* @public
|
|
22
23
|
* <p>The time, in milliseconds, when Amazon Transcribe starts searching for the specified
|
|
23
24
|
* criteria in your audio. If you include <code>StartTime</code> in your request, you must
|
|
24
25
|
* also include <code>EndTime</code>.</p>
|
|
25
26
|
*/
|
|
26
27
|
StartTime?: number;
|
|
27
28
|
/**
|
|
29
|
+
* @public
|
|
28
30
|
* <p>The time, in milliseconds, when Amazon Transcribe stops searching for the specified
|
|
29
31
|
* criteria in your audio. If you include <code>EndTime</code> in your request, you must
|
|
30
32
|
* also include <code>StartTime</code>.</p>
|
|
31
33
|
*/
|
|
32
34
|
EndTime?: number;
|
|
33
35
|
/**
|
|
36
|
+
* @public
|
|
34
37
|
* <p>The time, in milliseconds, from the start of your media file until the specified value.
|
|
35
38
|
* Amazon Transcribe searches for your specified criteria in this time segment.</p>
|
|
36
39
|
*/
|
|
37
40
|
First?: number;
|
|
38
41
|
/**
|
|
42
|
+
* @public
|
|
39
43
|
* <p>The time, in milliseconds, from the specified value until the end of your media file.
|
|
40
44
|
* Amazon Transcribe searches for your specified criteria in this time segment.</p>
|
|
41
45
|
*/
|
|
@@ -104,10 +108,12 @@ export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantR
|
|
|
104
108
|
*/
|
|
105
109
|
export interface ChannelDefinition {
|
|
106
110
|
/**
|
|
111
|
+
* @public
|
|
107
112
|
* <p>Specify the audio channel you want to define.</p>
|
|
108
113
|
*/
|
|
109
114
|
ChannelId?: number;
|
|
110
115
|
/**
|
|
116
|
+
* @public
|
|
111
117
|
* <p>Specify the speaker you want to define. Omitting this parameter is equivalent to
|
|
112
118
|
* specifying both participants.</p>
|
|
113
119
|
*/
|
|
@@ -171,6 +177,7 @@ export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
|
|
|
171
177
|
*/
|
|
172
178
|
export interface Media {
|
|
173
179
|
/**
|
|
180
|
+
* @public
|
|
174
181
|
* <p>The Amazon S3 location of the media file you want to transcribe. For
|
|
175
182
|
* example:</p>
|
|
176
183
|
* <ul>
|
|
@@ -191,6 +198,7 @@ export interface Media {
|
|
|
191
198
|
*/
|
|
192
199
|
MediaFileUri?: string;
|
|
193
200
|
/**
|
|
201
|
+
* @public
|
|
194
202
|
* <p>The Amazon S3 location of the media file you want to redact. For
|
|
195
203
|
* example:</p>
|
|
196
204
|
* <ul>
|
|
@@ -288,12 +296,14 @@ export type RedactionType = (typeof RedactionType)[keyof typeof RedactionType];
|
|
|
288
296
|
*/
|
|
289
297
|
export interface ContentRedaction {
|
|
290
298
|
/**
|
|
299
|
+
* @public
|
|
291
300
|
* <p>Specify the category of information you want to redact; <code>PII</code> (personally
|
|
292
301
|
* identifiable information) is the only valid value. You can use
|
|
293
302
|
* <code>PiiEntityTypes</code> to choose which types of PII you want to redact.</p>
|
|
294
303
|
*/
|
|
295
304
|
RedactionType: RedactionType | string | undefined;
|
|
296
305
|
/**
|
|
306
|
+
* @public
|
|
297
307
|
* <p>Specify if you want only a redacted transcript, or if you want a redacted and an
|
|
298
308
|
* unredacted transcript.</p>
|
|
299
309
|
* <p>When you choose <code>redacted</code>
|
|
@@ -304,6 +314,7 @@ export interface ContentRedaction {
|
|
|
304
314
|
*/
|
|
305
315
|
RedactionOutput: RedactionOutput | string | undefined;
|
|
306
316
|
/**
|
|
317
|
+
* @public
|
|
307
318
|
* <p>Specify which types of personally identifiable information (PII) you want to redact in
|
|
308
319
|
* your transcript. You can include as many types as you'd like, or you can select
|
|
309
320
|
* <code>ALL</code>.</p>
|
|
@@ -343,6 +354,7 @@ export interface ContentRedaction {
|
|
|
343
354
|
*/
|
|
344
355
|
export interface LanguageIdSettings {
|
|
345
356
|
/**
|
|
357
|
+
* @public
|
|
346
358
|
* <p>The name of the custom vocabulary you want to use when processing your transcription
|
|
347
359
|
* job. Custom vocabulary names are case sensitive.</p>
|
|
348
360
|
* <p>The language of the specified custom vocabulary must match the language code that you
|
|
@@ -352,6 +364,7 @@ export interface LanguageIdSettings {
|
|
|
352
364
|
*/
|
|
353
365
|
VocabularyName?: string;
|
|
354
366
|
/**
|
|
367
|
+
* @public
|
|
355
368
|
* <p>The name of the custom vocabulary filter you want to use when processing your
|
|
356
369
|
* transcription job. Custom vocabulary filter names are case sensitive.</p>
|
|
357
370
|
* <p>The language of the specified custom vocabulary filter must match the language code
|
|
@@ -363,6 +376,7 @@ export interface LanguageIdSettings {
|
|
|
363
376
|
*/
|
|
364
377
|
VocabularyFilterName?: string;
|
|
365
378
|
/**
|
|
379
|
+
* @public
|
|
366
380
|
* <p>The name of the custom language model you want to use when processing your
|
|
367
381
|
* transcription job. Note that custom language model names are case sensitive.</p>
|
|
368
382
|
* <p>The language of the specified custom language model must match the language code that
|
|
@@ -393,11 +407,13 @@ export type VocabularyFilterMethod = (typeof VocabularyFilterMethod)[keyof typeo
|
|
|
393
407
|
*/
|
|
394
408
|
export interface CallAnalyticsJobSettings {
|
|
395
409
|
/**
|
|
410
|
+
* @public
|
|
396
411
|
* <p>The name of the custom vocabulary you want to include in your Call Analytics
|
|
397
412
|
* transcription request. Custom vocabulary names are case sensitive.</p>
|
|
398
413
|
*/
|
|
399
414
|
VocabularyName?: string;
|
|
400
415
|
/**
|
|
416
|
+
* @public
|
|
401
417
|
* <p>The name of the custom vocabulary filter you want to include in your Call Analytics
|
|
402
418
|
* transcription request. Custom vocabulary filter names are case sensitive.</p>
|
|
403
419
|
* <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
|
|
@@ -405,6 +421,7 @@ export interface CallAnalyticsJobSettings {
|
|
|
405
421
|
*/
|
|
406
422
|
VocabularyFilterName?: string;
|
|
407
423
|
/**
|
|
424
|
+
* @public
|
|
408
425
|
* <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
|
|
409
426
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
410
427
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
@@ -412,6 +429,7 @@ export interface CallAnalyticsJobSettings {
|
|
|
412
429
|
*/
|
|
413
430
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
414
431
|
/**
|
|
432
|
+
* @public
|
|
415
433
|
* <p>The name of the custom language model you want to use when processing your Call
|
|
416
434
|
* Analytics job. Note that custom language model names are case sensitive.</p>
|
|
417
435
|
* <p>The language of the specified custom language model must match the language code that
|
|
@@ -421,6 +439,7 @@ export interface CallAnalyticsJobSettings {
|
|
|
421
439
|
*/
|
|
422
440
|
LanguageModelName?: string;
|
|
423
441
|
/**
|
|
442
|
+
* @public
|
|
424
443
|
* <p>Makes it possible to redact or flag specified personally identifiable information
|
|
425
444
|
* (PII) in your transcript. If you use <code>ContentRedaction</code>, you must also
|
|
426
445
|
* include the sub-parameters: <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
|
|
@@ -428,6 +447,7 @@ export interface CallAnalyticsJobSettings {
|
|
|
428
447
|
*/
|
|
429
448
|
ContentRedaction?: ContentRedaction;
|
|
430
449
|
/**
|
|
450
|
+
* @public
|
|
431
451
|
* <p>You can specify two or more language codes that represent the languages you think may
|
|
432
452
|
* be present in your media. Including more than five is not recommended. If you're unsure
|
|
433
453
|
* what languages are present, do not include this parameter.</p>
|
|
@@ -439,6 +459,7 @@ export interface CallAnalyticsJobSettings {
|
|
|
439
459
|
*/
|
|
440
460
|
LanguageOptions?: (LanguageCode | string)[];
|
|
441
461
|
/**
|
|
462
|
+
* @public
|
|
442
463
|
* <p>If using automatic language identification in your request and you want to apply a
|
|
443
464
|
* custom language model, a custom vocabulary, or a custom vocabulary filter, include
|
|
444
465
|
* <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
@@ -475,6 +496,7 @@ export interface CallAnalyticsJobSettings {
|
|
|
475
496
|
*/
|
|
476
497
|
export interface Transcript {
|
|
477
498
|
/**
|
|
499
|
+
* @public
|
|
478
500
|
* <p>The Amazon S3 location of your transcript. You can use this URI to access or
|
|
479
501
|
* download your transcript.</p>
|
|
480
502
|
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
@@ -493,6 +515,7 @@ export interface Transcript {
|
|
|
493
515
|
*/
|
|
494
516
|
TranscriptFileUri?: string;
|
|
495
517
|
/**
|
|
518
|
+
* @public
|
|
496
519
|
* <p>The Amazon S3 location of your redacted transcript. You can use this URI to
|
|
497
520
|
* access or download your transcript.</p>
|
|
498
521
|
* <p>If you included <code>OutputBucketName</code> in your transcription job request, this
|
|
@@ -528,11 +551,13 @@ export interface Transcript {
|
|
|
528
551
|
*/
|
|
529
552
|
export interface CallAnalyticsJob {
|
|
530
553
|
/**
|
|
554
|
+
* @public
|
|
531
555
|
* <p>The name of the Call Analytics job. Job names are case sensitive and must be unique
|
|
532
556
|
* within an Amazon Web Services account.</p>
|
|
533
557
|
*/
|
|
534
558
|
CallAnalyticsJobName?: string;
|
|
535
559
|
/**
|
|
560
|
+
* @public
|
|
536
561
|
* <p>Provides the status of the specified Call Analytics job.</p>
|
|
537
562
|
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
538
563
|
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
@@ -542,6 +567,7 @@ export interface CallAnalyticsJob {
|
|
|
542
567
|
*/
|
|
543
568
|
CallAnalyticsJobStatus?: CallAnalyticsJobStatus | string;
|
|
544
569
|
/**
|
|
570
|
+
* @public
|
|
545
571
|
* <p>The language code used to create your Call Analytics job. For a list of supported
|
|
546
572
|
* languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>
|
|
547
573
|
* table.</p>
|
|
@@ -551,24 +577,29 @@ export interface CallAnalyticsJob {
|
|
|
551
577
|
*/
|
|
552
578
|
LanguageCode?: LanguageCode | string;
|
|
553
579
|
/**
|
|
580
|
+
* @public
|
|
554
581
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
555
582
|
*/
|
|
556
583
|
MediaSampleRateHertz?: number;
|
|
557
584
|
/**
|
|
585
|
+
* @public
|
|
558
586
|
* <p>The format of the input media file.</p>
|
|
559
587
|
*/
|
|
560
588
|
MediaFormat?: MediaFormat | string;
|
|
561
589
|
/**
|
|
590
|
+
* @public
|
|
562
591
|
* <p>Provides the Amazon S3 location of the media file you used in your Call
|
|
563
592
|
* Analytics request.</p>
|
|
564
593
|
*/
|
|
565
594
|
Media?: Media;
|
|
566
595
|
/**
|
|
596
|
+
* @public
|
|
567
597
|
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
568
598
|
* transcript.</p>
|
|
569
599
|
*/
|
|
570
600
|
Transcript?: Transcript;
|
|
571
601
|
/**
|
|
602
|
+
* @public
|
|
572
603
|
* <p>The date and time the specified Call Analytics job began processing.</p>
|
|
573
604
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
574
605
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
@@ -576,6 +607,7 @@ export interface CallAnalyticsJob {
|
|
|
576
607
|
*/
|
|
577
608
|
StartTime?: Date;
|
|
578
609
|
/**
|
|
610
|
+
* @public
|
|
579
611
|
* <p>The date and time the specified Call Analytics job request was made.</p>
|
|
580
612
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
581
613
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
@@ -583,6 +615,7 @@ export interface CallAnalyticsJob {
|
|
|
583
615
|
*/
|
|
584
616
|
CreationTime?: Date;
|
|
585
617
|
/**
|
|
618
|
+
* @public
|
|
586
619
|
* <p>The date and time the specified Call Analytics job finished processing.</p>
|
|
587
620
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
588
621
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
@@ -590,6 +623,7 @@ export interface CallAnalyticsJob {
|
|
|
590
623
|
*/
|
|
591
624
|
CompletionTime?: Date;
|
|
592
625
|
/**
|
|
626
|
+
* @public
|
|
593
627
|
* <p>If <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>,
|
|
594
628
|
* <code>FailureReason</code> contains information about why the Call Analytics job
|
|
595
629
|
* request failed.</p>
|
|
@@ -642,10 +676,12 @@ export interface CallAnalyticsJob {
|
|
|
642
676
|
*/
|
|
643
677
|
FailureReason?: string;
|
|
644
678
|
/**
|
|
679
|
+
* @public
|
|
645
680
|
* <p>The Amazon Resource Name (ARN) you included in your request.</p>
|
|
646
681
|
*/
|
|
647
682
|
DataAccessRoleArn?: string;
|
|
648
683
|
/**
|
|
684
|
+
* @public
|
|
649
685
|
* <p>The confidence score associated with the language identified in your media
|
|
650
686
|
* file.</p>
|
|
651
687
|
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
@@ -654,12 +690,14 @@ export interface CallAnalyticsJob {
|
|
|
654
690
|
*/
|
|
655
691
|
IdentifiedLanguageScore?: number;
|
|
656
692
|
/**
|
|
693
|
+
* @public
|
|
657
694
|
* <p>Provides information on any additional settings that were included in your request.
|
|
658
695
|
* Additional settings include content redaction and language identification
|
|
659
696
|
* settings.</p>
|
|
660
697
|
*/
|
|
661
698
|
Settings?: CallAnalyticsJobSettings;
|
|
662
699
|
/**
|
|
700
|
+
* @public
|
|
663
701
|
* <p>Indicates which speaker is on which channel.</p>
|
|
664
702
|
*/
|
|
665
703
|
ChannelDefinitions?: ChannelDefinition[];
|
|
@@ -670,11 +708,13 @@ export interface CallAnalyticsJob {
|
|
|
670
708
|
*/
|
|
671
709
|
export interface CallAnalyticsJobSummary {
|
|
672
710
|
/**
|
|
711
|
+
* @public
|
|
673
712
|
* <p>The name of the Call Analytics job. Job names are case sensitive and must be unique
|
|
674
713
|
* within an Amazon Web Services account.</p>
|
|
675
714
|
*/
|
|
676
715
|
CallAnalyticsJobName?: string;
|
|
677
716
|
/**
|
|
717
|
+
* @public
|
|
678
718
|
* <p>The date and time the specified Call Analytics job request was made.</p>
|
|
679
719
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
680
720
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
@@ -682,6 +722,7 @@ export interface CallAnalyticsJobSummary {
|
|
|
682
722
|
*/
|
|
683
723
|
CreationTime?: Date;
|
|
684
724
|
/**
|
|
725
|
+
* @public
|
|
685
726
|
* <p>The date and time your Call Analytics job began processing.</p>
|
|
686
727
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
687
728
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
@@ -689,6 +730,7 @@ export interface CallAnalyticsJobSummary {
|
|
|
689
730
|
*/
|
|
690
731
|
StartTime?: Date;
|
|
691
732
|
/**
|
|
733
|
+
* @public
|
|
692
734
|
* <p>The date and time the specified Call Analytics job finished processing.</p>
|
|
693
735
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
694
736
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
@@ -696,10 +738,12 @@ export interface CallAnalyticsJobSummary {
|
|
|
696
738
|
*/
|
|
697
739
|
CompletionTime?: Date;
|
|
698
740
|
/**
|
|
741
|
+
* @public
|
|
699
742
|
* <p>The language code used to create your Call Analytics transcription.</p>
|
|
700
743
|
*/
|
|
701
744
|
LanguageCode?: LanguageCode | string;
|
|
702
745
|
/**
|
|
746
|
+
* @public
|
|
703
747
|
* <p>Provides the status of your Call Analytics job.</p>
|
|
704
748
|
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
705
749
|
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
@@ -709,6 +753,7 @@ export interface CallAnalyticsJobSummary {
|
|
|
709
753
|
*/
|
|
710
754
|
CallAnalyticsJobStatus?: CallAnalyticsJobStatus | string;
|
|
711
755
|
/**
|
|
756
|
+
* @public
|
|
712
757
|
* <p>If <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>,
|
|
713
758
|
* <code>FailureReason</code> contains information about why the Call Analytics job
|
|
714
759
|
* failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
@@ -744,23 +789,27 @@ export type InputType = (typeof InputType)[keyof typeof InputType];
|
|
|
744
789
|
*/
|
|
745
790
|
export interface RelativeTimeRange {
|
|
746
791
|
/**
|
|
792
|
+
* @public
|
|
747
793
|
* <p>The time, in percentage, when Amazon Transcribe starts searching for the specified
|
|
748
794
|
* criteria in your media file. If you include <code>StartPercentage</code> in your
|
|
749
795
|
* request, you must also include <code>EndPercentage</code>.</p>
|
|
750
796
|
*/
|
|
751
797
|
StartPercentage?: number;
|
|
752
798
|
/**
|
|
799
|
+
* @public
|
|
753
800
|
* <p>The time, in percentage, when Amazon Transcribe stops searching for the specified
|
|
754
801
|
* criteria in your media file. If you include <code>EndPercentage</code> in your request,
|
|
755
802
|
* you must also include <code>StartPercentage</code>.</p>
|
|
756
803
|
*/
|
|
757
804
|
EndPercentage?: number;
|
|
758
805
|
/**
|
|
806
|
+
* @public
|
|
759
807
|
* <p>The time, in percentage, from the start of your media file until the specified value.
|
|
760
808
|
* Amazon Transcribe searches for your specified criteria in this time segment.</p>
|
|
761
809
|
*/
|
|
762
810
|
First?: number;
|
|
763
811
|
/**
|
|
812
|
+
* @public
|
|
764
813
|
* <p>The time, in percentage, from the specified value until the end of your media file.
|
|
765
814
|
* Amazon Transcribe searches for your specified criteria in this time segment.</p>
|
|
766
815
|
*/
|
|
@@ -790,26 +839,31 @@ export interface RelativeTimeRange {
|
|
|
790
839
|
*/
|
|
791
840
|
export interface InterruptionFilter {
|
|
792
841
|
/**
|
|
842
|
+
* @public
|
|
793
843
|
* <p>Specify the duration of the interruptions in milliseconds. For example, you can flag
|
|
794
844
|
* speech that contains more than 10,000 milliseconds of interruptions.</p>
|
|
795
845
|
*/
|
|
796
846
|
Threshold?: number;
|
|
797
847
|
/**
|
|
848
|
+
* @public
|
|
798
849
|
* <p>Specify the interrupter that you want to flag. Omitting this parameter is equivalent
|
|
799
850
|
* to specifying both participants.</p>
|
|
800
851
|
*/
|
|
801
852
|
ParticipantRole?: ParticipantRole | string;
|
|
802
853
|
/**
|
|
854
|
+
* @public
|
|
803
855
|
* <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
|
|
804
856
|
* which you want to search for an interruption. See for more detail.</p>
|
|
805
857
|
*/
|
|
806
858
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
807
859
|
/**
|
|
860
|
+
* @public
|
|
808
861
|
* <p>Makes it possible to specify a time range (in percentage) in your media file, during
|
|
809
862
|
* which you want to search for an interruption. See for more detail.</p>
|
|
810
863
|
*/
|
|
811
864
|
RelativeTimeRange?: RelativeTimeRange;
|
|
812
865
|
/**
|
|
866
|
+
* @public
|
|
813
867
|
* <p>Set to <code>TRUE</code> to flag speech that does not contain interruptions. Set to
|
|
814
868
|
* <code>FALSE</code> to flag speech that contains interruptions.</p>
|
|
815
869
|
*/
|
|
@@ -833,21 +887,25 @@ export interface InterruptionFilter {
|
|
|
833
887
|
*/
|
|
834
888
|
export interface NonTalkTimeFilter {
|
|
835
889
|
/**
|
|
890
|
+
* @public
|
|
836
891
|
* <p>Specify the duration, in milliseconds, of the period of silence that you want to flag.
|
|
837
892
|
* For example, you can flag a silent period that lasts 30,000 milliseconds.</p>
|
|
838
893
|
*/
|
|
839
894
|
Threshold?: number;
|
|
840
895
|
/**
|
|
896
|
+
* @public
|
|
841
897
|
* <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
|
|
842
898
|
* which you want to search for a period of silence. See for more detail.</p>
|
|
843
899
|
*/
|
|
844
900
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
845
901
|
/**
|
|
902
|
+
* @public
|
|
846
903
|
* <p>Makes it possible to specify a time range (in percentage) in your media file, during
|
|
847
904
|
* which you want to search for a period of silence. See for more detail.</p>
|
|
848
905
|
*/
|
|
849
906
|
RelativeTimeRange?: RelativeTimeRange;
|
|
850
907
|
/**
|
|
908
|
+
* @public
|
|
851
909
|
* <p>Set to <code>TRUE</code> to flag periods of speech. Set to <code>FALSE</code> to flag
|
|
852
910
|
* periods of silence</p>
|
|
853
911
|
*/
|
|
@@ -895,25 +953,30 @@ export type SentimentValue = (typeof SentimentValue)[keyof typeof SentimentValue
|
|
|
895
953
|
*/
|
|
896
954
|
export interface SentimentFilter {
|
|
897
955
|
/**
|
|
956
|
+
* @public
|
|
898
957
|
* <p>Specify the sentiments that you want to flag.</p>
|
|
899
958
|
*/
|
|
900
959
|
Sentiments: (SentimentValue | string)[] | undefined;
|
|
901
960
|
/**
|
|
961
|
+
* @public
|
|
902
962
|
* <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
|
|
903
963
|
* which you want to search for the specified sentiments. See for more detail.</p>
|
|
904
964
|
*/
|
|
905
965
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
906
966
|
/**
|
|
967
|
+
* @public
|
|
907
968
|
* <p>Makes it possible to specify a time range (in percentage) in your media file, during
|
|
908
969
|
* which you want to search for the specified sentiments. See for more detail.</p>
|
|
909
970
|
*/
|
|
910
971
|
RelativeTimeRange?: RelativeTimeRange;
|
|
911
972
|
/**
|
|
973
|
+
* @public
|
|
912
974
|
* <p>Specify the participant that you want to flag. Omitting this parameter is equivalent
|
|
913
975
|
* to specifying both participants.</p>
|
|
914
976
|
*/
|
|
915
977
|
ParticipantRole?: ParticipantRole | string;
|
|
916
978
|
/**
|
|
979
|
+
* @public
|
|
917
980
|
* <p>Set to <code>TRUE</code> to flag the sentiments that you didn't include in your
|
|
918
981
|
* request. Set to <code>FALSE</code> to flag the sentiments that you specified in your
|
|
919
982
|
* request.</p>
|
|
@@ -954,6 +1017,7 @@ export type TranscriptFilterType = (typeof TranscriptFilterType)[keyof typeof Tr
|
|
|
954
1017
|
*/
|
|
955
1018
|
export interface TranscriptFilter {
|
|
956
1019
|
/**
|
|
1020
|
+
* @public
|
|
957
1021
|
* <p>Flag the presence or absence of an exact match to the phrases that you specify. For
|
|
958
1022
|
* example, if you specify the phrase "speak to a manager" as your <code>Targets</code>
|
|
959
1023
|
* value, only that exact phrase is flagged.</p>
|
|
@@ -963,27 +1027,32 @@ export interface TranscriptFilter {
|
|
|
963
1027
|
*/
|
|
964
1028
|
TranscriptFilterType: TranscriptFilterType | string | undefined;
|
|
965
1029
|
/**
|
|
1030
|
+
* @public
|
|
966
1031
|
* <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
|
|
967
1032
|
* which you want to search for the specified key words or phrases. See for more detail.</p>
|
|
968
1033
|
*/
|
|
969
1034
|
AbsoluteTimeRange?: AbsoluteTimeRange;
|
|
970
1035
|
/**
|
|
1036
|
+
* @public
|
|
971
1037
|
* <p>Makes it possible to specify a time range (in percentage) in your media file, during
|
|
972
1038
|
* which you want to search for the specified key words or phrases. See for more detail.</p>
|
|
973
1039
|
*/
|
|
974
1040
|
RelativeTimeRange?: RelativeTimeRange;
|
|
975
1041
|
/**
|
|
1042
|
+
* @public
|
|
976
1043
|
* <p>Specify the participant that you want to flag. Omitting this parameter is equivalent
|
|
977
1044
|
* to specifying both participants.</p>
|
|
978
1045
|
*/
|
|
979
1046
|
ParticipantRole?: ParticipantRole | string;
|
|
980
1047
|
/**
|
|
1048
|
+
* @public
|
|
981
1049
|
* <p>Set to <code>TRUE</code> to flag the absence of the phrase that you specified in your
|
|
982
1050
|
* request. Set to <code>FALSE</code> to flag the presence of the phrase that you specified
|
|
983
1051
|
* in your request.</p>
|
|
984
1052
|
*/
|
|
985
1053
|
Negate?: boolean;
|
|
986
1054
|
/**
|
|
1055
|
+
* @public
|
|
987
1056
|
* <p>Specify the phrases that you want to flag.</p>
|
|
988
1057
|
*/
|
|
989
1058
|
Targets: string[] | undefined;
|
|
@@ -1005,6 +1074,7 @@ export type Rule = Rule.InterruptionFilterMember | Rule.NonTalkTimeFilterMember
|
|
|
1005
1074
|
*/
|
|
1006
1075
|
export declare namespace Rule {
|
|
1007
1076
|
/**
|
|
1077
|
+
* @public
|
|
1008
1078
|
* <p>Flag the presence or absence of periods of silence in your Call Analytics
|
|
1009
1079
|
* transcription output. Refer to for more
|
|
1010
1080
|
* detail.</p>
|
|
@@ -1017,6 +1087,7 @@ export declare namespace Rule {
|
|
|
1017
1087
|
$unknown?: never;
|
|
1018
1088
|
}
|
|
1019
1089
|
/**
|
|
1090
|
+
* @public
|
|
1020
1091
|
* <p>Flag the presence or absence of interruptions in your Call Analytics transcription
|
|
1021
1092
|
* output. Refer to for more detail.</p>
|
|
1022
1093
|
*/
|
|
@@ -1028,6 +1099,7 @@ export declare namespace Rule {
|
|
|
1028
1099
|
$unknown?: never;
|
|
1029
1100
|
}
|
|
1030
1101
|
/**
|
|
1102
|
+
* @public
|
|
1031
1103
|
* <p>Flag the presence or absence of specific words or phrases in your Call Analytics
|
|
1032
1104
|
* transcription output. Refer to for more
|
|
1033
1105
|
* detail.</p>
|
|
@@ -1040,6 +1112,7 @@ export declare namespace Rule {
|
|
|
1040
1112
|
$unknown?: never;
|
|
1041
1113
|
}
|
|
1042
1114
|
/**
|
|
1115
|
+
* @public
|
|
1043
1116
|
* <p>Flag the presence or absence of specific sentiments in your Call Analytics
|
|
1044
1117
|
* transcription output. Refer to for more
|
|
1045
1118
|
* detail.</p>
|
|
@@ -1051,6 +1124,9 @@ export declare namespace Rule {
|
|
|
1051
1124
|
SentimentFilter: SentimentFilter;
|
|
1052
1125
|
$unknown?: never;
|
|
1053
1126
|
}
|
|
1127
|
+
/**
|
|
1128
|
+
* @public
|
|
1129
|
+
*/
|
|
1054
1130
|
interface $UnknownMember {
|
|
1055
1131
|
NonTalkTimeFilter?: never;
|
|
1056
1132
|
InterruptionFilter?: never;
|
|
@@ -1074,16 +1150,19 @@ export declare namespace Rule {
|
|
|
1074
1150
|
*/
|
|
1075
1151
|
export interface CategoryProperties {
|
|
1076
1152
|
/**
|
|
1153
|
+
* @public
|
|
1077
1154
|
* <p>The name of the Call Analytics category. Category names are case sensitive and must be
|
|
1078
1155
|
* unique within an Amazon Web Services account.</p>
|
|
1079
1156
|
*/
|
|
1080
1157
|
CategoryName?: string;
|
|
1081
1158
|
/**
|
|
1159
|
+
* @public
|
|
1082
1160
|
* <p>The rules used to define a Call Analytics category. Each category can have between 1
|
|
1083
1161
|
* and 20 rules.</p>
|
|
1084
1162
|
*/
|
|
1085
1163
|
Rules?: Rule[];
|
|
1086
1164
|
/**
|
|
1165
|
+
* @public
|
|
1087
1166
|
* <p>The date and time the specified Call Analytics category was created.</p>
|
|
1088
1167
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1089
1168
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -1091,6 +1170,7 @@ export interface CategoryProperties {
|
|
|
1091
1170
|
*/
|
|
1092
1171
|
CreateTime?: Date;
|
|
1093
1172
|
/**
|
|
1173
|
+
* @public
|
|
1094
1174
|
* <p>The date and time the specified Call Analytics category was last updated.</p>
|
|
1095
1175
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1096
1176
|
* example, <code>2022-05-05T12:45:32.691000-07:00</code> represents 12:45 PM UTC-7 on May
|
|
@@ -1098,6 +1178,7 @@ export interface CategoryProperties {
|
|
|
1098
1178
|
*/
|
|
1099
1179
|
LastUpdateTime?: Date;
|
|
1100
1180
|
/**
|
|
1181
|
+
* @public
|
|
1101
1182
|
* <p>The input type associated with the specified category. <code>POST_CALL</code>
|
|
1102
1183
|
* refers to a category that is applied to batch transcriptions; <code>REAL_TIME</code>
|
|
1103
1184
|
* refers to a category that is applied to streaming transcriptions.</p>
|
|
@@ -1140,6 +1221,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
1140
1221
|
*/
|
|
1141
1222
|
export interface CreateCallAnalyticsCategoryRequest {
|
|
1142
1223
|
/**
|
|
1224
|
+
* @public
|
|
1143
1225
|
* <p>A unique name, chosen by you, for your Call Analytics category. It's helpful to use a
|
|
1144
1226
|
* detailed naming system that will make sense to you in the future. For example, it's
|
|
1145
1227
|
* better to use <code>sentiment-positive-last30seconds</code> for a category over a
|
|
@@ -1148,6 +1230,7 @@ export interface CreateCallAnalyticsCategoryRequest {
|
|
|
1148
1230
|
*/
|
|
1149
1231
|
CategoryName: string | undefined;
|
|
1150
1232
|
/**
|
|
1233
|
+
* @public
|
|
1151
1234
|
* <p>Rules define a Call Analytics category. When creating a new category, you must create
|
|
1152
1235
|
* between 1 and 20 rules for that category. For each rule, you specify a filter you want
|
|
1153
1236
|
* applied to the attributes of a call. For example, you can choose a sentiment filter that
|
|
@@ -1155,6 +1238,7 @@ export interface CreateCallAnalyticsCategoryRequest {
|
|
|
1155
1238
|
*/
|
|
1156
1239
|
Rules: Rule[] | undefined;
|
|
1157
1240
|
/**
|
|
1241
|
+
* @public
|
|
1158
1242
|
* <p>Choose whether you want to create a real-time or a post-call category for your Call
|
|
1159
1243
|
* Analytics transcription.</p>
|
|
1160
1244
|
* <p>Specifying <code>POST_CALL</code> assigns your category to post-call transcriptions;
|
|
@@ -1172,6 +1256,7 @@ export interface CreateCallAnalyticsCategoryRequest {
|
|
|
1172
1256
|
*/
|
|
1173
1257
|
export interface CreateCallAnalyticsCategoryResponse {
|
|
1174
1258
|
/**
|
|
1259
|
+
* @public
|
|
1175
1260
|
* <p>Provides you with the properties of your new category, including its associated
|
|
1176
1261
|
* rules.</p>
|
|
1177
1262
|
*/
|
|
@@ -1215,6 +1300,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1215
1300
|
*/
|
|
1216
1301
|
export interface InputDataConfig {
|
|
1217
1302
|
/**
|
|
1303
|
+
* @public
|
|
1218
1304
|
* <p>The Amazon S3 location (URI) of the text files you want to use to train your
|
|
1219
1305
|
* custom language model.</p>
|
|
1220
1306
|
* <p>Here's an example URI path:
|
|
@@ -1223,6 +1309,7 @@ export interface InputDataConfig {
|
|
|
1223
1309
|
*/
|
|
1224
1310
|
S3Uri: string | undefined;
|
|
1225
1311
|
/**
|
|
1312
|
+
* @public
|
|
1226
1313
|
* <p>The Amazon S3 location (URI) of the text files you want to use to tune your
|
|
1227
1314
|
* custom language model.</p>
|
|
1228
1315
|
* <p>Here's an example URI path:
|
|
@@ -1231,6 +1318,7 @@ export interface InputDataConfig {
|
|
|
1231
1318
|
*/
|
|
1232
1319
|
TuningDataS3Uri?: string;
|
|
1233
1320
|
/**
|
|
1321
|
+
* @public
|
|
1234
1322
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
1235
1323
|
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
1236
1324
|
* specify doesn’t have the appropriate permissions to access the specified Amazon S3
|
|
@@ -1253,11 +1341,13 @@ export interface InputDataConfig {
|
|
|
1253
1341
|
*/
|
|
1254
1342
|
export interface Tag {
|
|
1255
1343
|
/**
|
|
1344
|
+
* @public
|
|
1256
1345
|
* <p>The first part of a key:value pair that forms a tag associated with a given resource.
|
|
1257
1346
|
* For example, in the tag <code>Department:Sales</code>, the key is 'Department'.</p>
|
|
1258
1347
|
*/
|
|
1259
1348
|
Key: string | undefined;
|
|
1260
1349
|
/**
|
|
1350
|
+
* @public
|
|
1261
1351
|
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
|
|
1262
1352
|
* For example, in the tag <code>Department:Sales</code>, the value is 'Sales'.</p>
|
|
1263
1353
|
* <p>Note that you can set the value of a tag to an empty string, but you can't set the
|
|
@@ -1271,6 +1361,7 @@ export interface Tag {
|
|
|
1271
1361
|
*/
|
|
1272
1362
|
export interface CreateLanguageModelRequest {
|
|
1273
1363
|
/**
|
|
1364
|
+
* @public
|
|
1274
1365
|
* <p>The language code that represents the language of your model. Each custom language
|
|
1275
1366
|
* model must contain terms in only one language, and the language you select for your
|
|
1276
1367
|
* custom language model must match the language of your training and tuning data.</p>
|
|
@@ -1286,6 +1377,7 @@ export interface CreateLanguageModelRequest {
|
|
|
1286
1377
|
*/
|
|
1287
1378
|
LanguageCode: CLMLanguageCode | string | undefined;
|
|
1288
1379
|
/**
|
|
1380
|
+
* @public
|
|
1289
1381
|
* <p>The Amazon Transcribe standard language model, or base model, used to create your
|
|
1290
1382
|
* custom language model. Amazon Transcribe offers two options for base models: Wideband
|
|
1291
1383
|
* and Narrowband.</p>
|
|
@@ -1295,6 +1387,7 @@ export interface CreateLanguageModelRequest {
|
|
|
1295
1387
|
*/
|
|
1296
1388
|
BaseModelName: BaseModelName | string | undefined;
|
|
1297
1389
|
/**
|
|
1390
|
+
* @public
|
|
1298
1391
|
* <p>A unique name, chosen by you, for your custom language model.</p>
|
|
1299
1392
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1300
1393
|
* Amazon Web Services account. If you try to create a new custom language model with
|
|
@@ -1303,6 +1396,7 @@ export interface CreateLanguageModelRequest {
|
|
|
1303
1396
|
*/
|
|
1304
1397
|
ModelName: string | undefined;
|
|
1305
1398
|
/**
|
|
1399
|
+
* @public
|
|
1306
1400
|
* <p>Contains the Amazon S3 location of the training data you want to use to create
|
|
1307
1401
|
* a new custom language model, and permissions to access this location.</p>
|
|
1308
1402
|
* <p>When using <code>InputDataConfig</code>, you must include these sub-parameters:
|
|
@@ -1315,6 +1409,7 @@ export interface CreateLanguageModelRequest {
|
|
|
1315
1409
|
*/
|
|
1316
1410
|
InputDataConfig: InputDataConfig | undefined;
|
|
1317
1411
|
/**
|
|
1412
|
+
* @public
|
|
1318
1413
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1319
1414
|
* language model at the time you create this new model.</p>
|
|
1320
1415
|
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
@@ -1340,25 +1435,30 @@ export type ModelStatus = (typeof ModelStatus)[keyof typeof ModelStatus];
|
|
|
1340
1435
|
*/
|
|
1341
1436
|
export interface CreateLanguageModelResponse {
|
|
1342
1437
|
/**
|
|
1438
|
+
* @public
|
|
1343
1439
|
* <p>The language code you selected for your custom language model.</p>
|
|
1344
1440
|
*/
|
|
1345
1441
|
LanguageCode?: CLMLanguageCode | string;
|
|
1346
1442
|
/**
|
|
1443
|
+
* @public
|
|
1347
1444
|
* <p>The Amazon Transcribe standard language model, or base model, you specified when
|
|
1348
1445
|
* creating your custom language model.</p>
|
|
1349
1446
|
*/
|
|
1350
1447
|
BaseModelName?: BaseModelName | string;
|
|
1351
1448
|
/**
|
|
1449
|
+
* @public
|
|
1352
1450
|
* <p>The name of your custom language model.</p>
|
|
1353
1451
|
*/
|
|
1354
1452
|
ModelName?: string;
|
|
1355
1453
|
/**
|
|
1454
|
+
* @public
|
|
1356
1455
|
* <p>Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
|
|
1357
1456
|
* locations you provided for your training (<code>S3Uri</code>) and tuning
|
|
1358
1457
|
* (<code>TuningDataS3Uri</code>) data.</p>
|
|
1359
1458
|
*/
|
|
1360
1459
|
InputDataConfig?: InputDataConfig;
|
|
1361
1460
|
/**
|
|
1461
|
+
* @public
|
|
1362
1462
|
* <p>The status of your custom language model. When the status displays as
|
|
1363
1463
|
* <code>COMPLETED</code>, your model is ready to use.</p>
|
|
1364
1464
|
*/
|
|
@@ -1369,6 +1469,7 @@ export interface CreateLanguageModelResponse {
|
|
|
1369
1469
|
*/
|
|
1370
1470
|
export interface CreateMedicalVocabularyRequest {
|
|
1371
1471
|
/**
|
|
1472
|
+
* @public
|
|
1372
1473
|
* <p>A unique name, chosen by you, for your new custom medical vocabulary.</p>
|
|
1373
1474
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1374
1475
|
* Amazon Web Services account. If you try to create a new custom medical vocabulary
|
|
@@ -1377,11 +1478,13 @@ export interface CreateMedicalVocabularyRequest {
|
|
|
1377
1478
|
*/
|
|
1378
1479
|
VocabularyName: string | undefined;
|
|
1379
1480
|
/**
|
|
1481
|
+
* @public
|
|
1380
1482
|
* <p>The language code that represents the language of the entries in your custom
|
|
1381
1483
|
* vocabulary. US English (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</p>
|
|
1382
1484
|
*/
|
|
1383
1485
|
LanguageCode: LanguageCode | string | undefined;
|
|
1384
1486
|
/**
|
|
1487
|
+
* @public
|
|
1385
1488
|
* <p>The Amazon S3 location (URI) of the text file that contains your custom
|
|
1386
1489
|
* medical vocabulary. The URI must be in the same Amazon Web Services Region as the
|
|
1387
1490
|
* resource you're calling.</p>
|
|
@@ -1391,6 +1494,7 @@ export interface CreateMedicalVocabularyRequest {
|
|
|
1391
1494
|
*/
|
|
1392
1495
|
VocabularyFileUri: string | undefined;
|
|
1393
1496
|
/**
|
|
1497
|
+
* @public
|
|
1394
1498
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1395
1499
|
* medical vocabulary at the time you create this new custom vocabulary.</p>
|
|
1396
1500
|
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
@@ -1416,22 +1520,26 @@ export type VocabularyState = (typeof VocabularyState)[keyof typeof VocabularySt
|
|
|
1416
1520
|
*/
|
|
1417
1521
|
export interface CreateMedicalVocabularyResponse {
|
|
1418
1522
|
/**
|
|
1523
|
+
* @public
|
|
1419
1524
|
* <p>The name you chose for your custom medical vocabulary.</p>
|
|
1420
1525
|
*/
|
|
1421
1526
|
VocabularyName?: string;
|
|
1422
1527
|
/**
|
|
1528
|
+
* @public
|
|
1423
1529
|
* <p>The language code you selected for your custom medical vocabulary. US English
|
|
1424
1530
|
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
1425
1531
|
* Medical.</p>
|
|
1426
1532
|
*/
|
|
1427
1533
|
LanguageCode?: LanguageCode | string;
|
|
1428
1534
|
/**
|
|
1535
|
+
* @public
|
|
1429
1536
|
* <p>The processing state of your custom medical vocabulary. If the state is
|
|
1430
1537
|
* <code>READY</code>, you can use the custom vocabulary in a
|
|
1431
1538
|
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
1432
1539
|
*/
|
|
1433
1540
|
VocabularyState?: VocabularyState | string;
|
|
1434
1541
|
/**
|
|
1542
|
+
* @public
|
|
1435
1543
|
* <p>The date and time you created your custom medical vocabulary.</p>
|
|
1436
1544
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1437
1545
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -1439,6 +1547,7 @@ export interface CreateMedicalVocabularyResponse {
|
|
|
1439
1547
|
*/
|
|
1440
1548
|
LastModifiedTime?: Date;
|
|
1441
1549
|
/**
|
|
1550
|
+
* @public
|
|
1442
1551
|
* <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
1443
1552
|
* contains information about why the medical transcription job request failed. See also:
|
|
1444
1553
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
@@ -1450,6 +1559,7 @@ export interface CreateMedicalVocabularyResponse {
|
|
|
1450
1559
|
*/
|
|
1451
1560
|
export interface CreateVocabularyRequest {
|
|
1452
1561
|
/**
|
|
1562
|
+
* @public
|
|
1453
1563
|
* <p>A unique name, chosen by you, for your new custom vocabulary.</p>
|
|
1454
1564
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1455
1565
|
* Amazon Web Services account. If you try to create a new custom vocabulary with the
|
|
@@ -1458,6 +1568,7 @@ export interface CreateVocabularyRequest {
|
|
|
1458
1568
|
*/
|
|
1459
1569
|
VocabularyName: string | undefined;
|
|
1460
1570
|
/**
|
|
1571
|
+
* @public
|
|
1461
1572
|
* <p>The language code that represents the language of the entries in your custom
|
|
1462
1573
|
* vocabulary. Each custom vocabulary must contain terms in only one language.</p>
|
|
1463
1574
|
* <p>A custom vocabulary can only be used to transcribe files in the same language as the
|
|
@@ -1469,6 +1580,7 @@ export interface CreateVocabularyRequest {
|
|
|
1469
1580
|
*/
|
|
1470
1581
|
LanguageCode: LanguageCode | string | undefined;
|
|
1471
1582
|
/**
|
|
1583
|
+
* @public
|
|
1472
1584
|
* <p>Use this parameter if you want to create your custom vocabulary by including all
|
|
1473
1585
|
* desired terms, as comma-separated values, within your request. The other option for
|
|
1474
1586
|
* creating your custom vocabulary is to save your entries in a text file and upload them
|
|
@@ -1483,6 +1595,7 @@ export interface CreateVocabularyRequest {
|
|
|
1483
1595
|
*/
|
|
1484
1596
|
Phrases?: string[];
|
|
1485
1597
|
/**
|
|
1598
|
+
* @public
|
|
1486
1599
|
* <p>The Amazon S3 location of the text file that contains your custom vocabulary.
|
|
1487
1600
|
* The URI must be located in the same Amazon Web Services Region as the resource you're
|
|
1488
1601
|
* calling.</p>
|
|
@@ -1494,6 +1607,7 @@ export interface CreateVocabularyRequest {
|
|
|
1494
1607
|
*/
|
|
1495
1608
|
VocabularyFileUri?: string;
|
|
1496
1609
|
/**
|
|
1610
|
+
* @public
|
|
1497
1611
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1498
1612
|
* vocabulary at the time you create this new custom vocabulary.</p>
|
|
1499
1613
|
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
@@ -1501,6 +1615,7 @@ export interface CreateVocabularyRequest {
|
|
|
1501
1615
|
*/
|
|
1502
1616
|
Tags?: Tag[];
|
|
1503
1617
|
/**
|
|
1618
|
+
* @public
|
|
1504
1619
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
1505
1620
|
* access the Amazon S3 bucket that contains your input files (in this case, your custom
|
|
1506
1621
|
* vocabulary). If the role that you specify doesn’t have the appropriate permissions to access
|
|
@@ -1518,20 +1633,24 @@ export interface CreateVocabularyRequest {
|
|
|
1518
1633
|
*/
|
|
1519
1634
|
export interface CreateVocabularyResponse {
|
|
1520
1635
|
/**
|
|
1636
|
+
* @public
|
|
1521
1637
|
* <p>The name you chose for your custom vocabulary.</p>
|
|
1522
1638
|
*/
|
|
1523
1639
|
VocabularyName?: string;
|
|
1524
1640
|
/**
|
|
1641
|
+
* @public
|
|
1525
1642
|
* <p>The language code you selected for your custom vocabulary.</p>
|
|
1526
1643
|
*/
|
|
1527
1644
|
LanguageCode?: LanguageCode | string;
|
|
1528
1645
|
/**
|
|
1646
|
+
* @public
|
|
1529
1647
|
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
1530
1648
|
* you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
|
|
1531
1649
|
* request.</p>
|
|
1532
1650
|
*/
|
|
1533
1651
|
VocabularyState?: VocabularyState | string;
|
|
1534
1652
|
/**
|
|
1653
|
+
* @public
|
|
1535
1654
|
* <p>The date and time you created your custom vocabulary.</p>
|
|
1536
1655
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1537
1656
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -1539,6 +1658,7 @@ export interface CreateVocabularyResponse {
|
|
|
1539
1658
|
*/
|
|
1540
1659
|
LastModifiedTime?: Date;
|
|
1541
1660
|
/**
|
|
1661
|
+
* @public
|
|
1542
1662
|
* <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
1543
1663
|
* contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common
|
|
1544
1664
|
* Errors</a>.</p>
|
|
@@ -1550,6 +1670,7 @@ export interface CreateVocabularyResponse {
|
|
|
1550
1670
|
*/
|
|
1551
1671
|
export interface CreateVocabularyFilterRequest {
|
|
1552
1672
|
/**
|
|
1673
|
+
* @public
|
|
1553
1674
|
* <p>A unique name, chosen by you, for your new custom vocabulary filter.</p>
|
|
1554
1675
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1555
1676
|
* Amazon Web Services account. If you try to create a new custom vocabulary filter with
|
|
@@ -1558,6 +1679,7 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1558
1679
|
*/
|
|
1559
1680
|
VocabularyFilterName: string | undefined;
|
|
1560
1681
|
/**
|
|
1682
|
+
* @public
|
|
1561
1683
|
* <p>The language code that represents the language of the entries in your vocabulary
|
|
1562
1684
|
* filter. Each custom vocabulary filter must contain terms in only one language.</p>
|
|
1563
1685
|
* <p>A custom vocabulary filter can only be used to transcribe files in the same language
|
|
@@ -1569,6 +1691,7 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1569
1691
|
*/
|
|
1570
1692
|
LanguageCode: LanguageCode | string | undefined;
|
|
1571
1693
|
/**
|
|
1694
|
+
* @public
|
|
1572
1695
|
* <p>Use this parameter if you want to create your custom vocabulary filter by including
|
|
1573
1696
|
* all desired terms, as comma-separated values, within your request. The other option for
|
|
1574
1697
|
* creating your vocabulary filter is to save your entries in a text file and upload them
|
|
@@ -1583,6 +1706,7 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1583
1706
|
*/
|
|
1584
1707
|
Words?: string[];
|
|
1585
1708
|
/**
|
|
1709
|
+
* @public
|
|
1586
1710
|
* <p>The Amazon S3 location of the text file that contains your custom vocabulary
|
|
1587
1711
|
* filter terms. The URI must be located in the same Amazon Web Services Region as the
|
|
1588
1712
|
* resource you're calling.</p>
|
|
@@ -1594,6 +1718,7 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1594
1718
|
*/
|
|
1595
1719
|
VocabularyFilterFileUri?: string;
|
|
1596
1720
|
/**
|
|
1721
|
+
* @public
|
|
1597
1722
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
|
|
1598
1723
|
* vocabulary filter at the time you create this new vocabulary filter.</p>
|
|
1599
1724
|
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
@@ -1601,6 +1726,7 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1601
1726
|
*/
|
|
1602
1727
|
Tags?: Tag[];
|
|
1603
1728
|
/**
|
|
1729
|
+
* @public
|
|
1604
1730
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
1605
1731
|
* access the Amazon S3 bucket that contains your input files (in this case, your custom
|
|
1606
1732
|
* vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access
|
|
@@ -1618,14 +1744,17 @@ export interface CreateVocabularyFilterRequest {
|
|
|
1618
1744
|
*/
|
|
1619
1745
|
export interface CreateVocabularyFilterResponse {
|
|
1620
1746
|
/**
|
|
1747
|
+
* @public
|
|
1621
1748
|
* <p>The name you chose for your custom vocabulary filter.</p>
|
|
1622
1749
|
*/
|
|
1623
1750
|
VocabularyFilterName?: string;
|
|
1624
1751
|
/**
|
|
1752
|
+
* @public
|
|
1625
1753
|
* <p>The language code you selected for your custom vocabulary filter.</p>
|
|
1626
1754
|
*/
|
|
1627
1755
|
LanguageCode?: LanguageCode | string;
|
|
1628
1756
|
/**
|
|
1757
|
+
* @public
|
|
1629
1758
|
* <p>The date and time you created your custom vocabulary filter.</p>
|
|
1630
1759
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1631
1760
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -1638,6 +1767,7 @@ export interface CreateVocabularyFilterResponse {
|
|
|
1638
1767
|
*/
|
|
1639
1768
|
export interface DeleteCallAnalyticsCategoryRequest {
|
|
1640
1769
|
/**
|
|
1770
|
+
* @public
|
|
1641
1771
|
* <p>The name of the Call Analytics category you want to delete. Category names are case
|
|
1642
1772
|
* sensitive.</p>
|
|
1643
1773
|
*/
|
|
@@ -1667,6 +1797,7 @@ export declare class NotFoundException extends __BaseException {
|
|
|
1667
1797
|
*/
|
|
1668
1798
|
export interface DeleteCallAnalyticsJobRequest {
|
|
1669
1799
|
/**
|
|
1800
|
+
* @public
|
|
1670
1801
|
* <p>The name of the Call Analytics job you want to delete. Job names are case
|
|
1671
1802
|
* sensitive.</p>
|
|
1672
1803
|
*/
|
|
@@ -1682,6 +1813,7 @@ export interface DeleteCallAnalyticsJobResponse {
|
|
|
1682
1813
|
*/
|
|
1683
1814
|
export interface DeleteLanguageModelRequest {
|
|
1684
1815
|
/**
|
|
1816
|
+
* @public
|
|
1685
1817
|
* <p>The name of the custom language model you want to delete. Model names are case
|
|
1686
1818
|
* sensitive.</p>
|
|
1687
1819
|
*/
|
|
@@ -1692,6 +1824,7 @@ export interface DeleteLanguageModelRequest {
|
|
|
1692
1824
|
*/
|
|
1693
1825
|
export interface DeleteMedicalTranscriptionJobRequest {
|
|
1694
1826
|
/**
|
|
1827
|
+
* @public
|
|
1695
1828
|
* <p>The name of the medical transcription job you want to delete. Job names are case
|
|
1696
1829
|
* sensitive.</p>
|
|
1697
1830
|
*/
|
|
@@ -1702,6 +1835,7 @@ export interface DeleteMedicalTranscriptionJobRequest {
|
|
|
1702
1835
|
*/
|
|
1703
1836
|
export interface DeleteMedicalVocabularyRequest {
|
|
1704
1837
|
/**
|
|
1838
|
+
* @public
|
|
1705
1839
|
* <p>The name of the custom medical vocabulary you want to delete. Custom medical
|
|
1706
1840
|
* vocabulary names are case sensitive.</p>
|
|
1707
1841
|
*/
|
|
@@ -1712,6 +1846,7 @@ export interface DeleteMedicalVocabularyRequest {
|
|
|
1712
1846
|
*/
|
|
1713
1847
|
export interface DeleteTranscriptionJobRequest {
|
|
1714
1848
|
/**
|
|
1849
|
+
* @public
|
|
1715
1850
|
* <p>The name of the transcription job you want to delete. Job names are case
|
|
1716
1851
|
* sensitive.</p>
|
|
1717
1852
|
*/
|
|
@@ -1722,6 +1857,7 @@ export interface DeleteTranscriptionJobRequest {
|
|
|
1722
1857
|
*/
|
|
1723
1858
|
export interface DeleteVocabularyRequest {
|
|
1724
1859
|
/**
|
|
1860
|
+
* @public
|
|
1725
1861
|
* <p>The name of the custom vocabulary you want to delete. Custom vocabulary names are case
|
|
1726
1862
|
* sensitive.</p>
|
|
1727
1863
|
*/
|
|
@@ -1732,6 +1868,7 @@ export interface DeleteVocabularyRequest {
|
|
|
1732
1868
|
*/
|
|
1733
1869
|
export interface DeleteVocabularyFilterRequest {
|
|
1734
1870
|
/**
|
|
1871
|
+
* @public
|
|
1735
1872
|
* <p>The name of the custom vocabulary filter you want to delete. Custom vocabulary filter
|
|
1736
1873
|
* names are case sensitive.</p>
|
|
1737
1874
|
*/
|
|
@@ -1742,6 +1879,7 @@ export interface DeleteVocabularyFilterRequest {
|
|
|
1742
1879
|
*/
|
|
1743
1880
|
export interface DescribeLanguageModelRequest {
|
|
1744
1881
|
/**
|
|
1882
|
+
* @public
|
|
1745
1883
|
* <p>The name of the custom language model you want information about. Model names are case
|
|
1746
1884
|
* sensitive.</p>
|
|
1747
1885
|
*/
|
|
@@ -1779,12 +1917,14 @@ export interface DescribeLanguageModelRequest {
|
|
|
1779
1917
|
*/
|
|
1780
1918
|
export interface LanguageModel {
|
|
1781
1919
|
/**
|
|
1920
|
+
* @public
|
|
1782
1921
|
* <p>A unique name, chosen by you, for your custom language model.</p>
|
|
1783
1922
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
1784
1923
|
* Amazon Web Services account.</p>
|
|
1785
1924
|
*/
|
|
1786
1925
|
ModelName?: string;
|
|
1787
1926
|
/**
|
|
1927
|
+
* @public
|
|
1788
1928
|
* <p>The date and time the specified custom language model was created.</p>
|
|
1789
1929
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1790
1930
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -1792,6 +1932,7 @@ export interface LanguageModel {
|
|
|
1792
1932
|
*/
|
|
1793
1933
|
CreateTime?: Date;
|
|
1794
1934
|
/**
|
|
1935
|
+
* @public
|
|
1795
1936
|
* <p>The date and time the specified custom language model was last modified.</p>
|
|
1796
1937
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
1797
1938
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -1799,6 +1940,7 @@ export interface LanguageModel {
|
|
|
1799
1940
|
*/
|
|
1800
1941
|
LastModifiedTime?: Date;
|
|
1801
1942
|
/**
|
|
1943
|
+
* @public
|
|
1802
1944
|
* <p>The language code used to create your custom language model. Each custom language
|
|
1803
1945
|
* model must contain terms in only one language, and the language you select for your
|
|
1804
1946
|
* custom language model must match the language of your training and tuning data.</p>
|
|
@@ -1808,16 +1950,19 @@ export interface LanguageModel {
|
|
|
1808
1950
|
*/
|
|
1809
1951
|
LanguageCode?: CLMLanguageCode | string;
|
|
1810
1952
|
/**
|
|
1953
|
+
* @public
|
|
1811
1954
|
* <p>The Amazon Transcribe standard language model, or base model, used to create your
|
|
1812
1955
|
* custom language model.</p>
|
|
1813
1956
|
*/
|
|
1814
1957
|
BaseModelName?: BaseModelName | string;
|
|
1815
1958
|
/**
|
|
1959
|
+
* @public
|
|
1816
1960
|
* <p>The status of the specified custom language model. When the status displays as
|
|
1817
1961
|
* <code>COMPLETED</code> the model is ready for use.</p>
|
|
1818
1962
|
*/
|
|
1819
1963
|
ModelStatus?: ModelStatus | string;
|
|
1820
1964
|
/**
|
|
1965
|
+
* @public
|
|
1821
1966
|
* <p>Shows if a more current base model is available for use with the specified custom
|
|
1822
1967
|
* language model.</p>
|
|
1823
1968
|
* <p>If <code>false</code>, your custom language model is using the most up-to-date base
|
|
@@ -1830,12 +1975,14 @@ export interface LanguageModel {
|
|
|
1830
1975
|
*/
|
|
1831
1976
|
UpgradeAvailability?: boolean;
|
|
1832
1977
|
/**
|
|
1978
|
+
* @public
|
|
1833
1979
|
* <p>If <code>ModelStatus</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
1834
1980
|
* contains information about why the custom language model request failed. See also:
|
|
1835
1981
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
1836
1982
|
*/
|
|
1837
1983
|
FailureReason?: string;
|
|
1838
1984
|
/**
|
|
1985
|
+
* @public
|
|
1839
1986
|
* <p>The Amazon S3 location of the input files used to train and tune your custom
|
|
1840
1987
|
* language model, in addition to the data access role ARN (Amazon Resource Name) that has
|
|
1841
1988
|
* permissions to access these data.</p>
|
|
@@ -1847,6 +1994,7 @@ export interface LanguageModel {
|
|
|
1847
1994
|
*/
|
|
1848
1995
|
export interface DescribeLanguageModelResponse {
|
|
1849
1996
|
/**
|
|
1997
|
+
* @public
|
|
1850
1998
|
* <p>Provides information about the specified custom language model.</p>
|
|
1851
1999
|
* <p>This parameter also shows if the base language model you used to create your custom
|
|
1852
2000
|
* language model has been updated. If Amazon Transcribe has updated the base model, you
|
|
@@ -1862,6 +2010,7 @@ export interface DescribeLanguageModelResponse {
|
|
|
1862
2010
|
*/
|
|
1863
2011
|
export interface GetCallAnalyticsCategoryRequest {
|
|
1864
2012
|
/**
|
|
2013
|
+
* @public
|
|
1865
2014
|
* <p>The name of the Call Analytics category you want information about. Category names are
|
|
1866
2015
|
* case sensitive.</p>
|
|
1867
2016
|
*/
|
|
@@ -1872,6 +2021,7 @@ export interface GetCallAnalyticsCategoryRequest {
|
|
|
1872
2021
|
*/
|
|
1873
2022
|
export interface GetCallAnalyticsCategoryResponse {
|
|
1874
2023
|
/**
|
|
2024
|
+
* @public
|
|
1875
2025
|
* <p>Provides you with the properties of the Call Analytics category you specified in your
|
|
1876
2026
|
* <code>GetCallAnalyticsCategory</code> request.</p>
|
|
1877
2027
|
*/
|
|
@@ -1882,6 +2032,7 @@ export interface GetCallAnalyticsCategoryResponse {
|
|
|
1882
2032
|
*/
|
|
1883
2033
|
export interface GetCallAnalyticsJobRequest {
|
|
1884
2034
|
/**
|
|
2035
|
+
* @public
|
|
1885
2036
|
* <p>The name of the Call Analytics job you want information about. Job names are case
|
|
1886
2037
|
* sensitive.</p>
|
|
1887
2038
|
*/
|
|
@@ -1892,6 +2043,7 @@ export interface GetCallAnalyticsJobRequest {
|
|
|
1892
2043
|
*/
|
|
1893
2044
|
export interface GetCallAnalyticsJobResponse {
|
|
1894
2045
|
/**
|
|
2046
|
+
* @public
|
|
1895
2047
|
* <p>Provides detailed information about the specified Call Analytics job, including job
|
|
1896
2048
|
* status and, if applicable, failure reason.</p>
|
|
1897
2049
|
*/
|
|
@@ -1902,6 +2054,7 @@ export interface GetCallAnalyticsJobResponse {
|
|
|
1902
2054
|
*/
|
|
1903
2055
|
export interface GetMedicalTranscriptionJobRequest {
|
|
1904
2056
|
/**
|
|
2057
|
+
* @public
|
|
1905
2058
|
* <p>The name of the medical transcription job you want information about. Job names are
|
|
1906
2059
|
* case sensitive.</p>
|
|
1907
2060
|
*/
|
|
@@ -1926,6 +2079,7 @@ export type MedicalContentIdentificationType = (typeof MedicalContentIdentificat
|
|
|
1926
2079
|
*/
|
|
1927
2080
|
export interface MedicalTranscriptionSetting {
|
|
1928
2081
|
/**
|
|
2082
|
+
* @public
|
|
1929
2083
|
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
1930
2084
|
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
1931
2085
|
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
@@ -1938,6 +2092,7 @@ export interface MedicalTranscriptionSetting {
|
|
|
1938
2092
|
*/
|
|
1939
2093
|
ShowSpeakerLabels?: boolean;
|
|
1940
2094
|
/**
|
|
2095
|
+
* @public
|
|
1941
2096
|
* <p>Specify the maximum number of speakers you want to partition in your media.</p>
|
|
1942
2097
|
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
1943
2098
|
* speakers are treated as a single speaker.</p>
|
|
@@ -1946,6 +2101,7 @@ export interface MedicalTranscriptionSetting {
|
|
|
1946
2101
|
*/
|
|
1947
2102
|
MaxSpeakerLabels?: number;
|
|
1948
2103
|
/**
|
|
2104
|
+
* @public
|
|
1949
2105
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
1950
2106
|
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
1951
2107
|
* appends the output for each channel into one transcript.</p>
|
|
@@ -1960,6 +2116,7 @@ export interface MedicalTranscriptionSetting {
|
|
|
1960
2116
|
*/
|
|
1961
2117
|
ChannelIdentification?: boolean;
|
|
1962
2118
|
/**
|
|
2119
|
+
* @public
|
|
1963
2120
|
* <p>To include alternative transcriptions within your transcription output, include
|
|
1964
2121
|
* <code>ShowAlternatives</code> in your transcription request.</p>
|
|
1965
2122
|
* <p>If you include <code>ShowAlternatives</code>, you must also include
|
|
@@ -1970,6 +2127,7 @@ export interface MedicalTranscriptionSetting {
|
|
|
1970
2127
|
*/
|
|
1971
2128
|
ShowAlternatives?: boolean;
|
|
1972
2129
|
/**
|
|
2130
|
+
* @public
|
|
1973
2131
|
* <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe
|
|
1974
2132
|
* Medical to include in your transcript.</p>
|
|
1975
2133
|
* <p>If you select a number greater than the number of alternative transcriptions generated
|
|
@@ -1982,6 +2140,7 @@ export interface MedicalTranscriptionSetting {
|
|
|
1982
2140
|
*/
|
|
1983
2141
|
MaxAlternatives?: number;
|
|
1984
2142
|
/**
|
|
2143
|
+
* @public
|
|
1985
2144
|
* <p>The name of the custom vocabulary you want to use when processing your medical
|
|
1986
2145
|
* transcription job. Custom vocabulary names are case sensitive.</p>
|
|
1987
2146
|
* <p>The language of the specified custom vocabulary must match the language code that you
|
|
@@ -2009,6 +2168,7 @@ export type Specialty = (typeof Specialty)[keyof typeof Specialty];
|
|
|
2009
2168
|
*/
|
|
2010
2169
|
export interface MedicalTranscript {
|
|
2011
2170
|
/**
|
|
2171
|
+
* @public
|
|
2012
2172
|
* <p>The Amazon S3 location of your transcript. You can use this URI to access or
|
|
2013
2173
|
* download your transcript.</p>
|
|
2014
2174
|
* <p>Note that this is the Amazon S3 location you specified in your request using the
|
|
@@ -2054,11 +2214,13 @@ export type Type = (typeof Type)[keyof typeof Type];
|
|
|
2054
2214
|
*/
|
|
2055
2215
|
export interface MedicalTranscriptionJob {
|
|
2056
2216
|
/**
|
|
2217
|
+
* @public
|
|
2057
2218
|
* <p>The name of the medical transcription job. Job names are case sensitive and must be
|
|
2058
2219
|
* unique within an Amazon Web Services account.</p>
|
|
2059
2220
|
*/
|
|
2060
2221
|
MedicalTranscriptionJobName?: string;
|
|
2061
2222
|
/**
|
|
2223
|
+
* @public
|
|
2062
2224
|
* <p>Provides the status of the specified medical transcription job.</p>
|
|
2063
2225
|
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2064
2226
|
* results at the location specified in <code>TranscriptFileUri</code>. If the status is
|
|
@@ -2067,20 +2229,24 @@ export interface MedicalTranscriptionJob {
|
|
|
2067
2229
|
*/
|
|
2068
2230
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
2069
2231
|
/**
|
|
2232
|
+
* @public
|
|
2070
2233
|
* <p>The language code used to create your medical transcription job. US English
|
|
2071
2234
|
* (<code>en-US</code>) is the only supported language for medical
|
|
2072
2235
|
* transcriptions.</p>
|
|
2073
2236
|
*/
|
|
2074
2237
|
LanguageCode?: LanguageCode | string;
|
|
2075
2238
|
/**
|
|
2239
|
+
* @public
|
|
2076
2240
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
2077
2241
|
*/
|
|
2078
2242
|
MediaSampleRateHertz?: number;
|
|
2079
2243
|
/**
|
|
2244
|
+
* @public
|
|
2080
2245
|
* <p>The format of the input media file.</p>
|
|
2081
2246
|
*/
|
|
2082
2247
|
MediaFormat?: MediaFormat | string;
|
|
2083
2248
|
/**
|
|
2249
|
+
* @public
|
|
2084
2250
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
2085
2251
|
* request.</p>
|
|
2086
2252
|
* <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
@@ -2088,11 +2254,13 @@ export interface MedicalTranscriptionJob {
|
|
|
2088
2254
|
*/
|
|
2089
2255
|
Media?: Media;
|
|
2090
2256
|
/**
|
|
2257
|
+
* @public
|
|
2091
2258
|
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
2092
2259
|
* transcript.</p>
|
|
2093
2260
|
*/
|
|
2094
2261
|
Transcript?: MedicalTranscript;
|
|
2095
2262
|
/**
|
|
2263
|
+
* @public
|
|
2096
2264
|
* <p>The date and time the specified medical transcription job began processing.</p>
|
|
2097
2265
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2098
2266
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
@@ -2100,6 +2268,7 @@ export interface MedicalTranscriptionJob {
|
|
|
2100
2268
|
*/
|
|
2101
2269
|
StartTime?: Date;
|
|
2102
2270
|
/**
|
|
2271
|
+
* @public
|
|
2103
2272
|
* <p>The date and time the specified medical transcription job request was made.</p>
|
|
2104
2273
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2105
2274
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
@@ -2107,6 +2276,7 @@ export interface MedicalTranscriptionJob {
|
|
|
2107
2276
|
*/
|
|
2108
2277
|
CreationTime?: Date;
|
|
2109
2278
|
/**
|
|
2279
|
+
* @public
|
|
2110
2280
|
* <p>The date and time the specified medical transcription job finished processing.</p>
|
|
2111
2281
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2112
2282
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
@@ -2114,6 +2284,7 @@ export interface MedicalTranscriptionJob {
|
|
|
2114
2284
|
*/
|
|
2115
2285
|
CompletionTime?: Date;
|
|
2116
2286
|
/**
|
|
2287
|
+
* @public
|
|
2117
2288
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
2118
2289
|
* <code>FailureReason</code> contains information about why the transcription job
|
|
2119
2290
|
* request failed.</p>
|
|
@@ -2166,26 +2337,31 @@ export interface MedicalTranscriptionJob {
|
|
|
2166
2337
|
*/
|
|
2167
2338
|
FailureReason?: string;
|
|
2168
2339
|
/**
|
|
2340
|
+
* @public
|
|
2169
2341
|
* <p>Provides information on any additional settings that were included in your request.
|
|
2170
2342
|
* Additional settings include channel identification, alternative transcriptions, speaker
|
|
2171
2343
|
* partitioning, custom vocabularies, and custom vocabulary filters.</p>
|
|
2172
2344
|
*/
|
|
2173
2345
|
Settings?: MedicalTranscriptionSetting;
|
|
2174
2346
|
/**
|
|
2347
|
+
* @public
|
|
2175
2348
|
* <p>Indicates whether content identification was enabled for your transcription
|
|
2176
2349
|
* request.</p>
|
|
2177
2350
|
*/
|
|
2178
2351
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
2179
2352
|
/**
|
|
2353
|
+
* @public
|
|
2180
2354
|
* <p>Describes the medical specialty represented in your media.</p>
|
|
2181
2355
|
*/
|
|
2182
2356
|
Specialty?: Specialty | string;
|
|
2183
2357
|
/**
|
|
2358
|
+
* @public
|
|
2184
2359
|
* <p>Indicates whether the input media is a dictation or a conversation, as specified in
|
|
2185
2360
|
* the <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
2186
2361
|
*/
|
|
2187
2362
|
Type?: Type | string;
|
|
2188
2363
|
/**
|
|
2364
|
+
* @public
|
|
2189
2365
|
* <p>The tags, each in the form of a key:value pair, assigned to the specified medical
|
|
2190
2366
|
* transcription job.</p>
|
|
2191
2367
|
*/
|
|
@@ -2196,6 +2372,7 @@ export interface MedicalTranscriptionJob {
|
|
|
2196
2372
|
*/
|
|
2197
2373
|
export interface GetMedicalTranscriptionJobResponse {
|
|
2198
2374
|
/**
|
|
2375
|
+
* @public
|
|
2199
2376
|
* <p>Provides detailed information about the specified medical transcription job, including
|
|
2200
2377
|
* job status and, if applicable, failure reason.</p>
|
|
2201
2378
|
*/
|
|
@@ -2206,6 +2383,7 @@ export interface GetMedicalTranscriptionJobResponse {
|
|
|
2206
2383
|
*/
|
|
2207
2384
|
export interface GetMedicalVocabularyRequest {
|
|
2208
2385
|
/**
|
|
2386
|
+
* @public
|
|
2209
2387
|
* <p>The name of the custom medical vocabulary you want information about. Custom medical
|
|
2210
2388
|
* vocabulary names are case sensitive.</p>
|
|
2211
2389
|
*/
|
|
@@ -2216,22 +2394,26 @@ export interface GetMedicalVocabularyRequest {
|
|
|
2216
2394
|
*/
|
|
2217
2395
|
export interface GetMedicalVocabularyResponse {
|
|
2218
2396
|
/**
|
|
2397
|
+
* @public
|
|
2219
2398
|
* <p>The name of the custom medical vocabulary you requested information about.</p>
|
|
2220
2399
|
*/
|
|
2221
2400
|
VocabularyName?: string;
|
|
2222
2401
|
/**
|
|
2402
|
+
* @public
|
|
2223
2403
|
* <p>The language code you selected for your custom medical vocabulary. US English
|
|
2224
2404
|
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
2225
2405
|
* Medical.</p>
|
|
2226
2406
|
*/
|
|
2227
2407
|
LanguageCode?: LanguageCode | string;
|
|
2228
2408
|
/**
|
|
2409
|
+
* @public
|
|
2229
2410
|
* <p>The processing state of your custom medical vocabulary. If the state is
|
|
2230
2411
|
* <code>READY</code>, you can use the custom vocabulary in a
|
|
2231
2412
|
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
2232
2413
|
*/
|
|
2233
2414
|
VocabularyState?: VocabularyState | string;
|
|
2234
2415
|
/**
|
|
2416
|
+
* @public
|
|
2235
2417
|
* <p>The date and time the specified custom medical vocabulary was last modified.</p>
|
|
2236
2418
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2237
2419
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -2239,12 +2421,14 @@ export interface GetMedicalVocabularyResponse {
|
|
|
2239
2421
|
*/
|
|
2240
2422
|
LastModifiedTime?: Date;
|
|
2241
2423
|
/**
|
|
2424
|
+
* @public
|
|
2242
2425
|
* <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
2243
2426
|
* contains information about why the custom medical vocabulary request failed. See also:
|
|
2244
2427
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
2245
2428
|
*/
|
|
2246
2429
|
FailureReason?: string;
|
|
2247
2430
|
/**
|
|
2431
|
+
* @public
|
|
2248
2432
|
* <p>The S3 location where the specified custom medical vocabulary is stored; use this URI
|
|
2249
2433
|
* to view or download the custom vocabulary.</p>
|
|
2250
2434
|
*/
|
|
@@ -2255,6 +2439,7 @@ export interface GetMedicalVocabularyResponse {
|
|
|
2255
2439
|
*/
|
|
2256
2440
|
export interface GetTranscriptionJobRequest {
|
|
2257
2441
|
/**
|
|
2442
|
+
* @public
|
|
2258
2443
|
* <p>The name of the transcription job you want information about. Job names are case
|
|
2259
2444
|
* sensitive.</p>
|
|
2260
2445
|
*/
|
|
@@ -2271,6 +2456,7 @@ export interface GetTranscriptionJobRequest {
|
|
|
2271
2456
|
*/
|
|
2272
2457
|
export interface JobExecutionSettings {
|
|
2273
2458
|
/**
|
|
2459
|
+
* @public
|
|
2274
2460
|
* <p>Makes it possible to enable job queuing when your concurrent request limit is
|
|
2275
2461
|
* exceeded. When <code>AllowDeferredExecution</code> is set to <code>true</code>,
|
|
2276
2462
|
* transcription job requests are placed in a queue until the number of jobs falls below
|
|
@@ -2282,6 +2468,7 @@ export interface JobExecutionSettings {
|
|
|
2282
2468
|
*/
|
|
2283
2469
|
AllowDeferredExecution?: boolean;
|
|
2284
2470
|
/**
|
|
2471
|
+
* @public
|
|
2285
2472
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
2286
2473
|
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
2287
2474
|
* specify doesn’t have the appropriate permissions to access the specified Amazon S3
|
|
@@ -2304,10 +2491,12 @@ export interface JobExecutionSettings {
|
|
|
2304
2491
|
*/
|
|
2305
2492
|
export interface LanguageCodeItem {
|
|
2306
2493
|
/**
|
|
2494
|
+
* @public
|
|
2307
2495
|
* <p>Provides the language code for each language identified in your media.</p>
|
|
2308
2496
|
*/
|
|
2309
2497
|
LanguageCode?: LanguageCode | string;
|
|
2310
2498
|
/**
|
|
2499
|
+
* @public
|
|
2311
2500
|
* <p>Provides the total time, in seconds, each identified language is spoken in your
|
|
2312
2501
|
* media.</p>
|
|
2313
2502
|
*/
|
|
@@ -2325,6 +2514,7 @@ export interface LanguageCodeItem {
|
|
|
2325
2514
|
*/
|
|
2326
2515
|
export interface ModelSettings {
|
|
2327
2516
|
/**
|
|
2517
|
+
* @public
|
|
2328
2518
|
* <p>The name of the custom language model you want to use when processing your
|
|
2329
2519
|
* transcription job. Note that custom language model names are case sensitive.</p>
|
|
2330
2520
|
* <p>The language of the specified custom language model must match the language code that
|
|
@@ -2342,11 +2532,13 @@ export interface ModelSettings {
|
|
|
2342
2532
|
*/
|
|
2343
2533
|
export interface Settings {
|
|
2344
2534
|
/**
|
|
2535
|
+
* @public
|
|
2345
2536
|
* <p>The name of the custom vocabulary you want to use in your transcription job request.
|
|
2346
2537
|
* This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</p>
|
|
2347
2538
|
*/
|
|
2348
2539
|
VocabularyName?: string;
|
|
2349
2540
|
/**
|
|
2541
|
+
* @public
|
|
2350
2542
|
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
2351
2543
|
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
2352
2544
|
* <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
|
|
@@ -2359,6 +2551,7 @@ export interface Settings {
|
|
|
2359
2551
|
*/
|
|
2360
2552
|
ShowSpeakerLabels?: boolean;
|
|
2361
2553
|
/**
|
|
2554
|
+
* @public
|
|
2362
2555
|
* <p>Specify the maximum number of speakers you want to partition in your media.</p>
|
|
2363
2556
|
* <p>Note that if your media contains more speakers than the specified number, multiple
|
|
2364
2557
|
* speakers are treated as a single speaker.</p>
|
|
@@ -2367,6 +2560,7 @@ export interface Settings {
|
|
|
2367
2560
|
*/
|
|
2368
2561
|
MaxSpeakerLabels?: number;
|
|
2369
2562
|
/**
|
|
2563
|
+
* @public
|
|
2370
2564
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
2371
2565
|
* <p>Channel identification transcribes the audio on each channel independently, then
|
|
2372
2566
|
* appends the output for each channel into one transcript.</p>
|
|
@@ -2378,6 +2572,7 @@ export interface Settings {
|
|
|
2378
2572
|
*/
|
|
2379
2573
|
ChannelIdentification?: boolean;
|
|
2380
2574
|
/**
|
|
2575
|
+
* @public
|
|
2381
2576
|
* <p>To include alternative transcriptions within your transcription output, include
|
|
2382
2577
|
* <code>ShowAlternatives</code> in your transcription request.</p>
|
|
2383
2578
|
* <p>If you have multi-channel audio and do not enable channel identification, your audio
|
|
@@ -2391,6 +2586,7 @@ export interface Settings {
|
|
|
2391
2586
|
*/
|
|
2392
2587
|
ShowAlternatives?: boolean;
|
|
2393
2588
|
/**
|
|
2589
|
+
* @public
|
|
2394
2590
|
* <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe
|
|
2395
2591
|
* to include in your transcript.</p>
|
|
2396
2592
|
* <p>If you select a number greater than the number of alternative transcriptions generated
|
|
@@ -2403,6 +2599,7 @@ export interface Settings {
|
|
|
2403
2599
|
*/
|
|
2404
2600
|
MaxAlternatives?: number;
|
|
2405
2601
|
/**
|
|
2602
|
+
* @public
|
|
2406
2603
|
* <p>The name of the custom vocabulary filter you want to use in your transcription job
|
|
2407
2604
|
* request. This name is case sensitive, cannot contain spaces, and must be unique within
|
|
2408
2605
|
* an Amazon Web Services account.</p>
|
|
@@ -2411,6 +2608,7 @@ export interface Settings {
|
|
|
2411
2608
|
*/
|
|
2412
2609
|
VocabularyFilterName?: string;
|
|
2413
2610
|
/**
|
|
2611
|
+
* @public
|
|
2414
2612
|
* <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
|
|
2415
2613
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
2416
2614
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
@@ -2437,12 +2635,14 @@ export type SubtitleFormat = (typeof SubtitleFormat)[keyof typeof SubtitleFormat
|
|
|
2437
2635
|
*/
|
|
2438
2636
|
export interface SubtitlesOutput {
|
|
2439
2637
|
/**
|
|
2638
|
+
* @public
|
|
2440
2639
|
* <p>Provides the format of your subtitle files. If your request included both WebVTT
|
|
2441
2640
|
* (<code>vtt</code>) and SubRip (<code>srt</code>) formats, both formats are
|
|
2442
2641
|
* shown.</p>
|
|
2443
2642
|
*/
|
|
2444
2643
|
Formats?: (SubtitleFormat | string)[];
|
|
2445
2644
|
/**
|
|
2645
|
+
* @public
|
|
2446
2646
|
* <p>The Amazon S3 location of your transcript. You can use this URI to access or
|
|
2447
2647
|
* download your subtitle file. Your subtitle file is stored in the same location as your
|
|
2448
2648
|
* transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are
|
|
@@ -2463,6 +2663,7 @@ export interface SubtitlesOutput {
|
|
|
2463
2663
|
*/
|
|
2464
2664
|
SubtitleFileUris?: string[];
|
|
2465
2665
|
/**
|
|
2666
|
+
* @public
|
|
2466
2667
|
* <p>Provides the start index value for your subtitle files. If you did not specify a value
|
|
2467
2668
|
* in your request, the default value of <code>0</code> is used.</p>
|
|
2468
2669
|
*/
|
|
@@ -2487,6 +2688,7 @@ export type ToxicityCategory = (typeof ToxicityCategory)[keyof typeof ToxicityCa
|
|
|
2487
2688
|
*/
|
|
2488
2689
|
export interface ToxicityDetectionSettings {
|
|
2489
2690
|
/**
|
|
2691
|
+
* @public
|
|
2490
2692
|
* <p> If you include <code>ToxicityDetection</code> in your transcription request, you
|
|
2491
2693
|
* must also include <code>ToxicityCategories</code>. The only accepted value for this
|
|
2492
2694
|
* parameter is <code>ALL</code>.</p>
|
|
@@ -2507,11 +2709,13 @@ export interface ToxicityDetectionSettings {
|
|
|
2507
2709
|
*/
|
|
2508
2710
|
export interface TranscriptionJob {
|
|
2509
2711
|
/**
|
|
2712
|
+
* @public
|
|
2510
2713
|
* <p>The name of the transcription job. Job names are case sensitive and must be unique
|
|
2511
2714
|
* within an Amazon Web Services account.</p>
|
|
2512
2715
|
*/
|
|
2513
2716
|
TranscriptionJobName?: string;
|
|
2514
2717
|
/**
|
|
2718
|
+
* @public
|
|
2515
2719
|
* <p>Provides the status of the specified transcription job.</p>
|
|
2516
2720
|
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2517
2721
|
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
@@ -2521,30 +2725,36 @@ export interface TranscriptionJob {
|
|
|
2521
2725
|
*/
|
|
2522
2726
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
2523
2727
|
/**
|
|
2728
|
+
* @public
|
|
2524
2729
|
* <p>The language code used to create your transcription job. This parameter is used with
|
|
2525
2730
|
* single-language identification. For multi-language identification requests, refer to the
|
|
2526
2731
|
* plural version of this parameter, <code>LanguageCodes</code>.</p>
|
|
2527
2732
|
*/
|
|
2528
2733
|
LanguageCode?: LanguageCode | string;
|
|
2529
2734
|
/**
|
|
2735
|
+
* @public
|
|
2530
2736
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
2531
2737
|
*/
|
|
2532
2738
|
MediaSampleRateHertz?: number;
|
|
2533
2739
|
/**
|
|
2740
|
+
* @public
|
|
2534
2741
|
* <p>The format of the input media file.</p>
|
|
2535
2742
|
*/
|
|
2536
2743
|
MediaFormat?: MediaFormat | string;
|
|
2537
2744
|
/**
|
|
2745
|
+
* @public
|
|
2538
2746
|
* <p>Provides the Amazon S3 location of the media file you used in your
|
|
2539
2747
|
* request.</p>
|
|
2540
2748
|
*/
|
|
2541
2749
|
Media?: Media;
|
|
2542
2750
|
/**
|
|
2751
|
+
* @public
|
|
2543
2752
|
* <p>Provides you with the Amazon S3 URI you can use to access your
|
|
2544
2753
|
* transcript.</p>
|
|
2545
2754
|
*/
|
|
2546
2755
|
Transcript?: Transcript;
|
|
2547
2756
|
/**
|
|
2757
|
+
* @public
|
|
2548
2758
|
* <p>The date and time the specified transcription job began processing.</p>
|
|
2549
2759
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2550
2760
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
@@ -2552,6 +2762,7 @@ export interface TranscriptionJob {
|
|
|
2552
2762
|
*/
|
|
2553
2763
|
StartTime?: Date;
|
|
2554
2764
|
/**
|
|
2765
|
+
* @public
|
|
2555
2766
|
* <p>The date and time the specified transcription job request was made.</p>
|
|
2556
2767
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2557
2768
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
@@ -2559,6 +2770,7 @@ export interface TranscriptionJob {
|
|
|
2559
2770
|
*/
|
|
2560
2771
|
CreationTime?: Date;
|
|
2561
2772
|
/**
|
|
2773
|
+
* @public
|
|
2562
2774
|
* <p>The date and time the specified transcription job finished processing.</p>
|
|
2563
2775
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2564
2776
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
@@ -2566,6 +2778,7 @@ export interface TranscriptionJob {
|
|
|
2566
2778
|
*/
|
|
2567
2779
|
CompletionTime?: Date;
|
|
2568
2780
|
/**
|
|
2781
|
+
* @public
|
|
2569
2782
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
2570
2783
|
* <code>FailureReason</code> contains information about why the transcription job
|
|
2571
2784
|
* request failed.</p>
|
|
@@ -2618,39 +2831,47 @@ export interface TranscriptionJob {
|
|
|
2618
2831
|
*/
|
|
2619
2832
|
FailureReason?: string;
|
|
2620
2833
|
/**
|
|
2834
|
+
* @public
|
|
2621
2835
|
* <p>Provides information on any additional settings that were included in your request.
|
|
2622
2836
|
* Additional settings include channel identification, alternative transcriptions, speaker
|
|
2623
2837
|
* partitioning, custom vocabularies, and custom vocabulary filters.</p>
|
|
2624
2838
|
*/
|
|
2625
2839
|
Settings?: Settings;
|
|
2626
2840
|
/**
|
|
2841
|
+
* @public
|
|
2627
2842
|
* <p>Provides information on the custom language model you included in your request.</p>
|
|
2628
2843
|
*/
|
|
2629
2844
|
ModelSettings?: ModelSettings;
|
|
2630
2845
|
/**
|
|
2846
|
+
* @public
|
|
2631
2847
|
* <p>Provides information about how your transcription job was processed. This parameter
|
|
2632
2848
|
* shows if your request was queued and what data access role was used.</p>
|
|
2633
2849
|
*/
|
|
2634
2850
|
JobExecutionSettings?: JobExecutionSettings;
|
|
2635
2851
|
/**
|
|
2852
|
+
* @public
|
|
2636
2853
|
* <p>Indicates whether redaction was enabled in your transcript.</p>
|
|
2637
2854
|
*/
|
|
2638
2855
|
ContentRedaction?: ContentRedaction;
|
|
2639
2856
|
/**
|
|
2857
|
+
* @public
|
|
2640
2858
|
* <p>Indicates whether automatic language identification was enabled (<code>TRUE</code>)
|
|
2641
2859
|
* for the specified transcription job.</p>
|
|
2642
2860
|
*/
|
|
2643
2861
|
IdentifyLanguage?: boolean;
|
|
2644
2862
|
/**
|
|
2863
|
+
* @public
|
|
2645
2864
|
* <p>Indicates whether automatic multi-language identification was enabled
|
|
2646
2865
|
* (<code>TRUE</code>) for the specified transcription job.</p>
|
|
2647
2866
|
*/
|
|
2648
2867
|
IdentifyMultipleLanguages?: boolean;
|
|
2649
2868
|
/**
|
|
2869
|
+
* @public
|
|
2650
2870
|
* <p>Provides the language codes you specified in your request.</p>
|
|
2651
2871
|
*/
|
|
2652
2872
|
LanguageOptions?: (LanguageCode | string)[];
|
|
2653
2873
|
/**
|
|
2874
|
+
* @public
|
|
2654
2875
|
* <p>The confidence score associated with the language identified in your media
|
|
2655
2876
|
* file.</p>
|
|
2656
2877
|
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
@@ -2659,26 +2880,31 @@ export interface TranscriptionJob {
|
|
|
2659
2880
|
*/
|
|
2660
2881
|
IdentifiedLanguageScore?: number;
|
|
2661
2882
|
/**
|
|
2883
|
+
* @public
|
|
2662
2884
|
* <p>The language codes used to create your transcription job. This parameter is used with
|
|
2663
2885
|
* multi-language identification. For single-language identification requests, refer to the
|
|
2664
2886
|
* singular version of this parameter, <code>LanguageCode</code>.</p>
|
|
2665
2887
|
*/
|
|
2666
2888
|
LanguageCodes?: LanguageCodeItem[];
|
|
2667
2889
|
/**
|
|
2890
|
+
* @public
|
|
2668
2891
|
* <p>The tags, each in the form of a key:value pair, assigned to the specified
|
|
2669
2892
|
* transcription job.</p>
|
|
2670
2893
|
*/
|
|
2671
2894
|
Tags?: Tag[];
|
|
2672
2895
|
/**
|
|
2896
|
+
* @public
|
|
2673
2897
|
* <p>Indicates whether subtitles were generated with your transcription.</p>
|
|
2674
2898
|
*/
|
|
2675
2899
|
Subtitles?: SubtitlesOutput;
|
|
2676
2900
|
/**
|
|
2901
|
+
* @public
|
|
2677
2902
|
* <p>Provides the name and language of all custom language models, custom vocabularies, and
|
|
2678
2903
|
* custom vocabulary filters that you included in your request.</p>
|
|
2679
2904
|
*/
|
|
2680
2905
|
LanguageIdSettings?: Record<string, LanguageIdSettings>;
|
|
2681
2906
|
/**
|
|
2907
|
+
* @public
|
|
2682
2908
|
* <p>Provides information about the toxicity detection settings applied to your transcription.</p>
|
|
2683
2909
|
*/
|
|
2684
2910
|
ToxicityDetection?: ToxicityDetectionSettings[];
|
|
@@ -2688,6 +2914,7 @@ export interface TranscriptionJob {
|
|
|
2688
2914
|
*/
|
|
2689
2915
|
export interface GetTranscriptionJobResponse {
|
|
2690
2916
|
/**
|
|
2917
|
+
* @public
|
|
2691
2918
|
* <p>Provides detailed information about the specified transcription job, including job
|
|
2692
2919
|
* status and, if applicable, failure reason.</p>
|
|
2693
2920
|
*/
|
|
@@ -2698,6 +2925,7 @@ export interface GetTranscriptionJobResponse {
|
|
|
2698
2925
|
*/
|
|
2699
2926
|
export interface GetVocabularyRequest {
|
|
2700
2927
|
/**
|
|
2928
|
+
* @public
|
|
2701
2929
|
* <p>The name of the custom vocabulary you want information about. Custom vocabulary names
|
|
2702
2930
|
* are case sensitive.</p>
|
|
2703
2931
|
*/
|
|
@@ -2708,20 +2936,24 @@ export interface GetVocabularyRequest {
|
|
|
2708
2936
|
*/
|
|
2709
2937
|
export interface GetVocabularyResponse {
|
|
2710
2938
|
/**
|
|
2939
|
+
* @public
|
|
2711
2940
|
* <p>The name of the custom vocabulary you requested information about.</p>
|
|
2712
2941
|
*/
|
|
2713
2942
|
VocabularyName?: string;
|
|
2714
2943
|
/**
|
|
2944
|
+
* @public
|
|
2715
2945
|
* <p>The language code you selected for your custom vocabulary.</p>
|
|
2716
2946
|
*/
|
|
2717
2947
|
LanguageCode?: LanguageCode | string;
|
|
2718
2948
|
/**
|
|
2949
|
+
* @public
|
|
2719
2950
|
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
2720
2951
|
* you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
|
|
2721
2952
|
* request.</p>
|
|
2722
2953
|
*/
|
|
2723
2954
|
VocabularyState?: VocabularyState | string;
|
|
2724
2955
|
/**
|
|
2956
|
+
* @public
|
|
2725
2957
|
* <p>The date and time the specified custom vocabulary was last modified.</p>
|
|
2726
2958
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2727
2959
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -2729,12 +2961,14 @@ export interface GetVocabularyResponse {
|
|
|
2729
2961
|
*/
|
|
2730
2962
|
LastModifiedTime?: Date;
|
|
2731
2963
|
/**
|
|
2964
|
+
* @public
|
|
2732
2965
|
* <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
|
|
2733
2966
|
* contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common
|
|
2734
2967
|
* Errors</a>.</p>
|
|
2735
2968
|
*/
|
|
2736
2969
|
FailureReason?: string;
|
|
2737
2970
|
/**
|
|
2971
|
+
* @public
|
|
2738
2972
|
* <p>The S3 location where the custom vocabulary is stored; use this URI to view or
|
|
2739
2973
|
* download the custom vocabulary.</p>
|
|
2740
2974
|
*/
|
|
@@ -2745,6 +2979,7 @@ export interface GetVocabularyResponse {
|
|
|
2745
2979
|
*/
|
|
2746
2980
|
export interface GetVocabularyFilterRequest {
|
|
2747
2981
|
/**
|
|
2982
|
+
* @public
|
|
2748
2983
|
* <p>The name of the custom vocabulary filter you want information about. Custom vocabulary
|
|
2749
2984
|
* filter names are case sensitive.</p>
|
|
2750
2985
|
*/
|
|
@@ -2755,14 +2990,17 @@ export interface GetVocabularyFilterRequest {
|
|
|
2755
2990
|
*/
|
|
2756
2991
|
export interface GetVocabularyFilterResponse {
|
|
2757
2992
|
/**
|
|
2993
|
+
* @public
|
|
2758
2994
|
* <p>The name of the custom vocabulary filter you requested information about.</p>
|
|
2759
2995
|
*/
|
|
2760
2996
|
VocabularyFilterName?: string;
|
|
2761
2997
|
/**
|
|
2998
|
+
* @public
|
|
2762
2999
|
* <p>The language code you selected for your custom vocabulary filter.</p>
|
|
2763
3000
|
*/
|
|
2764
3001
|
LanguageCode?: LanguageCode | string;
|
|
2765
3002
|
/**
|
|
3003
|
+
* @public
|
|
2766
3004
|
* <p>The date and time the specified custom vocabulary filter was last modified.</p>
|
|
2767
3005
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2768
3006
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -2770,6 +3008,7 @@ export interface GetVocabularyFilterResponse {
|
|
|
2770
3008
|
*/
|
|
2771
3009
|
LastModifiedTime?: Date;
|
|
2772
3010
|
/**
|
|
3011
|
+
* @public
|
|
2773
3012
|
* <p>The Amazon S3 location where the custom vocabulary filter is stored; use this
|
|
2774
3013
|
* URI to view or download the custom vocabulary filter.</p>
|
|
2775
3014
|
*/
|
|
@@ -2780,6 +3019,7 @@ export interface GetVocabularyFilterResponse {
|
|
|
2780
3019
|
*/
|
|
2781
3020
|
export interface ListCallAnalyticsCategoriesRequest {
|
|
2782
3021
|
/**
|
|
3022
|
+
* @public
|
|
2783
3023
|
* <p>If your <code>ListCallAnalyticsCategories</code> request returns more results than can
|
|
2784
3024
|
* be displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2785
3025
|
* string. To get the next page of results, copy this string and repeat your request,
|
|
@@ -2788,6 +3028,7 @@ export interface ListCallAnalyticsCategoriesRequest {
|
|
|
2788
3028
|
*/
|
|
2789
3029
|
NextToken?: string;
|
|
2790
3030
|
/**
|
|
3031
|
+
* @public
|
|
2791
3032
|
* <p>The maximum number of Call Analytics categories to return in each page of results. If
|
|
2792
3033
|
* there are fewer results than the value that you specify, only the actual results are
|
|
2793
3034
|
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
@@ -2799,6 +3040,7 @@ export interface ListCallAnalyticsCategoriesRequest {
|
|
|
2799
3040
|
*/
|
|
2800
3041
|
export interface ListCallAnalyticsCategoriesResponse {
|
|
2801
3042
|
/**
|
|
3043
|
+
* @public
|
|
2802
3044
|
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2803
3045
|
* results are displayed. To view the next set of results, copy the string associated with
|
|
2804
3046
|
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
@@ -2807,6 +3049,7 @@ export interface ListCallAnalyticsCategoriesResponse {
|
|
|
2807
3049
|
*/
|
|
2808
3050
|
NextToken?: string;
|
|
2809
3051
|
/**
|
|
3052
|
+
* @public
|
|
2810
3053
|
* <p>Provides detailed information about your Call Analytics categories, including all the
|
|
2811
3054
|
* rules associated with each category.</p>
|
|
2812
3055
|
*/
|
|
@@ -2817,17 +3060,20 @@ export interface ListCallAnalyticsCategoriesResponse {
|
|
|
2817
3060
|
*/
|
|
2818
3061
|
export interface ListCallAnalyticsJobsRequest {
|
|
2819
3062
|
/**
|
|
3063
|
+
* @public
|
|
2820
3064
|
* <p>Returns only Call Analytics jobs with the specified status. Jobs are ordered by
|
|
2821
3065
|
* creation date, with the newest job first. If you don't include <code>Status</code>, all
|
|
2822
3066
|
* Call Analytics jobs are returned.</p>
|
|
2823
3067
|
*/
|
|
2824
3068
|
Status?: CallAnalyticsJobStatus | string;
|
|
2825
3069
|
/**
|
|
3070
|
+
* @public
|
|
2826
3071
|
* <p>Returns only the Call Analytics jobs that contain the specified string. The search is
|
|
2827
3072
|
* not case sensitive.</p>
|
|
2828
3073
|
*/
|
|
2829
3074
|
JobNameContains?: string;
|
|
2830
3075
|
/**
|
|
3076
|
+
* @public
|
|
2831
3077
|
* <p>If your <code>ListCallAnalyticsJobs</code> request returns more results than can be
|
|
2832
3078
|
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2833
3079
|
* string. To get the next page of results, copy this string and repeat your request,
|
|
@@ -2836,6 +3082,7 @@ export interface ListCallAnalyticsJobsRequest {
|
|
|
2836
3082
|
*/
|
|
2837
3083
|
NextToken?: string;
|
|
2838
3084
|
/**
|
|
3085
|
+
* @public
|
|
2839
3086
|
* <p>The maximum number of Call Analytics jobs to return in each page of results. If there
|
|
2840
3087
|
* are fewer results than the value that you specify, only the actual results are returned.
|
|
2841
3088
|
* If you don't specify a value, a default of 5 is used.</p>
|
|
@@ -2847,11 +3094,13 @@ export interface ListCallAnalyticsJobsRequest {
|
|
|
2847
3094
|
*/
|
|
2848
3095
|
export interface ListCallAnalyticsJobsResponse {
|
|
2849
3096
|
/**
|
|
3097
|
+
* @public
|
|
2850
3098
|
* <p>Lists all Call Analytics jobs that have the status specified in your request. Jobs are
|
|
2851
3099
|
* ordered by creation date, with the newest job first.</p>
|
|
2852
3100
|
*/
|
|
2853
3101
|
Status?: CallAnalyticsJobStatus | string;
|
|
2854
3102
|
/**
|
|
3103
|
+
* @public
|
|
2855
3104
|
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2856
3105
|
* results are displayed. To view the next set of results, copy the string associated with
|
|
2857
3106
|
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
@@ -2860,6 +3109,7 @@ export interface ListCallAnalyticsJobsResponse {
|
|
|
2860
3109
|
*/
|
|
2861
3110
|
NextToken?: string;
|
|
2862
3111
|
/**
|
|
3112
|
+
* @public
|
|
2863
3113
|
* <p>Provides a summary of information about each result.</p>
|
|
2864
3114
|
*/
|
|
2865
3115
|
CallAnalyticsJobSummaries?: CallAnalyticsJobSummary[];
|
|
@@ -2869,17 +3119,20 @@ export interface ListCallAnalyticsJobsResponse {
|
|
|
2869
3119
|
*/
|
|
2870
3120
|
export interface ListLanguageModelsRequest {
|
|
2871
3121
|
/**
|
|
3122
|
+
* @public
|
|
2872
3123
|
* <p>Returns only custom language models with the specified status. Language models are
|
|
2873
3124
|
* ordered by creation date, with the newest model first. If you don't include
|
|
2874
3125
|
* <code>StatusEquals</code>, all custom language models are returned.</p>
|
|
2875
3126
|
*/
|
|
2876
3127
|
StatusEquals?: ModelStatus | string;
|
|
2877
3128
|
/**
|
|
3129
|
+
* @public
|
|
2878
3130
|
* <p>Returns only the custom language models that contain the specified string. The search
|
|
2879
3131
|
* is not case sensitive.</p>
|
|
2880
3132
|
*/
|
|
2881
3133
|
NameContains?: string;
|
|
2882
3134
|
/**
|
|
3135
|
+
* @public
|
|
2883
3136
|
* <p>If your <code>ListLanguageModels</code> request returns more results than can be
|
|
2884
3137
|
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2885
3138
|
* string. To get the next page of results, copy this string and repeat your request,
|
|
@@ -2888,6 +3141,7 @@ export interface ListLanguageModelsRequest {
|
|
|
2888
3141
|
*/
|
|
2889
3142
|
NextToken?: string;
|
|
2890
3143
|
/**
|
|
3144
|
+
* @public
|
|
2891
3145
|
* <p>The maximum number of custom language models to return in each page of results. If
|
|
2892
3146
|
* there are fewer results than the value that you specify, only the actual results are
|
|
2893
3147
|
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
@@ -2899,6 +3153,7 @@ export interface ListLanguageModelsRequest {
|
|
|
2899
3153
|
*/
|
|
2900
3154
|
export interface ListLanguageModelsResponse {
|
|
2901
3155
|
/**
|
|
3156
|
+
* @public
|
|
2902
3157
|
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
2903
3158
|
* results are displayed. To view the next set of results, copy the string associated with
|
|
2904
3159
|
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
@@ -2907,6 +3162,7 @@ export interface ListLanguageModelsResponse {
|
|
|
2907
3162
|
*/
|
|
2908
3163
|
NextToken?: string;
|
|
2909
3164
|
/**
|
|
3165
|
+
* @public
|
|
2910
3166
|
* <p>Provides information about the custom language models that match the criteria
|
|
2911
3167
|
* specified in your request.</p>
|
|
2912
3168
|
*/
|
|
@@ -2917,17 +3173,20 @@ export interface ListLanguageModelsResponse {
|
|
|
2917
3173
|
*/
|
|
2918
3174
|
export interface ListMedicalTranscriptionJobsRequest {
|
|
2919
3175
|
/**
|
|
3176
|
+
* @public
|
|
2920
3177
|
* <p>Returns only medical transcription jobs with the specified status. Jobs are ordered by
|
|
2921
3178
|
* creation date, with the newest job first. If you don't include <code>Status</code>, all
|
|
2922
3179
|
* medical transcription jobs are returned.</p>
|
|
2923
3180
|
*/
|
|
2924
3181
|
Status?: TranscriptionJobStatus | string;
|
|
2925
3182
|
/**
|
|
3183
|
+
* @public
|
|
2926
3184
|
* <p>Returns only the medical transcription jobs that contain the specified string. The
|
|
2927
3185
|
* search is not case sensitive.</p>
|
|
2928
3186
|
*/
|
|
2929
3187
|
JobNameContains?: string;
|
|
2930
3188
|
/**
|
|
3189
|
+
* @public
|
|
2931
3190
|
* <p>If your <code>ListMedicalTranscriptionJobs</code> request returns more results than
|
|
2932
3191
|
* can be displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
2933
3192
|
* string. To get the next page of results, copy this string and repeat your request,
|
|
@@ -2936,6 +3195,7 @@ export interface ListMedicalTranscriptionJobsRequest {
|
|
|
2936
3195
|
*/
|
|
2937
3196
|
NextToken?: string;
|
|
2938
3197
|
/**
|
|
3198
|
+
* @public
|
|
2939
3199
|
* <p>The maximum number of medical transcription jobs to return in each page of results. If
|
|
2940
3200
|
* there are fewer results than the value that you specify, only the actual results are
|
|
2941
3201
|
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
@@ -2960,11 +3220,13 @@ export type OutputLocationType = (typeof OutputLocationType)[keyof typeof Output
|
|
|
2960
3220
|
*/
|
|
2961
3221
|
export interface MedicalTranscriptionJobSummary {
|
|
2962
3222
|
/**
|
|
3223
|
+
* @public
|
|
2963
3224
|
* <p>The name of the medical transcription job. Job names are case sensitive and must be
|
|
2964
3225
|
* unique within an Amazon Web Services account.</p>
|
|
2965
3226
|
*/
|
|
2966
3227
|
MedicalTranscriptionJobName?: string;
|
|
2967
3228
|
/**
|
|
3229
|
+
* @public
|
|
2968
3230
|
* <p>The date and time the specified medical transcription job request was made.</p>
|
|
2969
3231
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2970
3232
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
@@ -2972,6 +3234,7 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2972
3234
|
*/
|
|
2973
3235
|
CreationTime?: Date;
|
|
2974
3236
|
/**
|
|
3237
|
+
* @public
|
|
2975
3238
|
* <p>The date and time your medical transcription job began processing.</p>
|
|
2976
3239
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2977
3240
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
@@ -2979,6 +3242,7 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2979
3242
|
*/
|
|
2980
3243
|
StartTime?: Date;
|
|
2981
3244
|
/**
|
|
3245
|
+
* @public
|
|
2982
3246
|
* <p>The date and time the specified medical transcription job finished processing.</p>
|
|
2983
3247
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
2984
3248
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
@@ -2986,12 +3250,14 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
2986
3250
|
*/
|
|
2987
3251
|
CompletionTime?: Date;
|
|
2988
3252
|
/**
|
|
3253
|
+
* @public
|
|
2989
3254
|
* <p>The language code used to create your medical transcription. US English
|
|
2990
3255
|
* (<code>en-US</code>) is the only supported language for medical
|
|
2991
3256
|
* transcriptions.</p>
|
|
2992
3257
|
*/
|
|
2993
3258
|
LanguageCode?: LanguageCode | string;
|
|
2994
3259
|
/**
|
|
3260
|
+
* @public
|
|
2995
3261
|
* <p>Provides the status of your medical transcription job.</p>
|
|
2996
3262
|
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
2997
3263
|
* results at the location specified in <code>TranscriptFileUri</code>. If the status is
|
|
@@ -3000,12 +3266,14 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
3000
3266
|
*/
|
|
3001
3267
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
3002
3268
|
/**
|
|
3269
|
+
* @public
|
|
3003
3270
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
3004
3271
|
* <code>FailureReason</code> contains information about why the transcription job
|
|
3005
3272
|
* failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
3006
3273
|
*/
|
|
3007
3274
|
FailureReason?: string;
|
|
3008
3275
|
/**
|
|
3276
|
+
* @public
|
|
3009
3277
|
* <p>Indicates where the specified medical transcription output is stored.</p>
|
|
3010
3278
|
* <p>If the value is <code>CUSTOMER_BUCKET</code>, the location is the Amazon S3
|
|
3011
3279
|
* bucket you specified using the <code>OutputBucketName</code> parameter in your request. If you also included
|
|
@@ -3016,15 +3284,18 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
3016
3284
|
*/
|
|
3017
3285
|
OutputLocationType?: OutputLocationType | string;
|
|
3018
3286
|
/**
|
|
3287
|
+
* @public
|
|
3019
3288
|
* <p>Provides the medical specialty represented in your media.</p>
|
|
3020
3289
|
*/
|
|
3021
3290
|
Specialty?: Specialty | string;
|
|
3022
3291
|
/**
|
|
3292
|
+
* @public
|
|
3023
3293
|
* <p>Labels all personal health information (PHI) identified in your transcript. For more
|
|
3024
3294
|
* information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
|
|
3025
3295
|
*/
|
|
3026
3296
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
3027
3297
|
/**
|
|
3298
|
+
* @public
|
|
3028
3299
|
* <p>Indicates whether the input media is a dictation or a conversation, as specified in
|
|
3029
3300
|
* the <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
3030
3301
|
*/
|
|
@@ -3035,11 +3306,13 @@ export interface MedicalTranscriptionJobSummary {
|
|
|
3035
3306
|
*/
|
|
3036
3307
|
export interface ListMedicalTranscriptionJobsResponse {
|
|
3037
3308
|
/**
|
|
3309
|
+
* @public
|
|
3038
3310
|
* <p>Lists all medical transcription jobs that have the status specified in your request.
|
|
3039
3311
|
* Jobs are ordered by creation date, with the newest job first.</p>
|
|
3040
3312
|
*/
|
|
3041
3313
|
Status?: TranscriptionJobStatus | string;
|
|
3042
3314
|
/**
|
|
3315
|
+
* @public
|
|
3043
3316
|
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
3044
3317
|
* results are displayed. To view the next set of results, copy the string associated with
|
|
3045
3318
|
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
@@ -3048,6 +3321,7 @@ export interface ListMedicalTranscriptionJobsResponse {
|
|
|
3048
3321
|
*/
|
|
3049
3322
|
NextToken?: string;
|
|
3050
3323
|
/**
|
|
3324
|
+
* @public
|
|
3051
3325
|
* <p>Provides a summary of information about each result.</p>
|
|
3052
3326
|
*/
|
|
3053
3327
|
MedicalTranscriptionJobSummaries?: MedicalTranscriptionJobSummary[];
|
|
@@ -3057,6 +3331,7 @@ export interface ListMedicalTranscriptionJobsResponse {
|
|
|
3057
3331
|
*/
|
|
3058
3332
|
export interface ListMedicalVocabulariesRequest {
|
|
3059
3333
|
/**
|
|
3334
|
+
* @public
|
|
3060
3335
|
* <p>If your <code>ListMedicalVocabularies</code> request returns more results than can be
|
|
3061
3336
|
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
3062
3337
|
* string. To get the next page of results, copy this string and repeat your request,
|
|
@@ -3065,18 +3340,21 @@ export interface ListMedicalVocabulariesRequest {
|
|
|
3065
3340
|
*/
|
|
3066
3341
|
NextToken?: string;
|
|
3067
3342
|
/**
|
|
3343
|
+
* @public
|
|
3068
3344
|
* <p>The maximum number of custom medical vocabularies to return in each page of results.
|
|
3069
3345
|
* If there are fewer results than the value that you specify, only the actual results are
|
|
3070
3346
|
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
3071
3347
|
*/
|
|
3072
3348
|
MaxResults?: number;
|
|
3073
3349
|
/**
|
|
3350
|
+
* @public
|
|
3074
3351
|
* <p>Returns only custom medical vocabularies with the specified state. Custom vocabularies
|
|
3075
3352
|
* are ordered by creation date, with the newest vocabulary first. If you don't include
|
|
3076
3353
|
* <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
|
|
3077
3354
|
*/
|
|
3078
3355
|
StateEquals?: VocabularyState | string;
|
|
3079
3356
|
/**
|
|
3357
|
+
* @public
|
|
3080
3358
|
* <p>Returns only the custom medical vocabularies that contain the specified string. The
|
|
3081
3359
|
* search is not case sensitive.</p>
|
|
3082
3360
|
*/
|
|
@@ -3089,11 +3367,13 @@ export interface ListMedicalVocabulariesRequest {
|
|
|
3089
3367
|
*/
|
|
3090
3368
|
export interface VocabularyInfo {
|
|
3091
3369
|
/**
|
|
3370
|
+
* @public
|
|
3092
3371
|
* <p>A unique name, chosen by you, for your custom vocabulary. This name is case sensitive,
|
|
3093
3372
|
* cannot contain spaces, and must be unique within an Amazon Web Services account.</p>
|
|
3094
3373
|
*/
|
|
3095
3374
|
VocabularyName?: string;
|
|
3096
3375
|
/**
|
|
3376
|
+
* @public
|
|
3097
3377
|
* <p>The language code used to create your custom vocabulary. Each custom vocabulary must
|
|
3098
3378
|
* contain terms in only one language.</p>
|
|
3099
3379
|
* <p>A custom vocabulary can only be used to transcribe files in the same language as the
|
|
@@ -3103,6 +3383,7 @@ export interface VocabularyInfo {
|
|
|
3103
3383
|
*/
|
|
3104
3384
|
LanguageCode?: LanguageCode | string;
|
|
3105
3385
|
/**
|
|
3386
|
+
* @public
|
|
3106
3387
|
* <p>The date and time the specified custom vocabulary was last modified.</p>
|
|
3107
3388
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3108
3389
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -3110,6 +3391,7 @@ export interface VocabularyInfo {
|
|
|
3110
3391
|
*/
|
|
3111
3392
|
LastModifiedTime?: Date;
|
|
3112
3393
|
/**
|
|
3394
|
+
* @public
|
|
3113
3395
|
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
3114
3396
|
* you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
|
|
3115
3397
|
* request.</p>
|
|
@@ -3121,12 +3403,14 @@ export interface VocabularyInfo {
|
|
|
3121
3403
|
*/
|
|
3122
3404
|
export interface ListMedicalVocabulariesResponse {
|
|
3123
3405
|
/**
|
|
3406
|
+
* @public
|
|
3124
3407
|
* <p>Lists all custom medical vocabularies that have the status specified in your request.
|
|
3125
3408
|
* Custom vocabularies are ordered by creation date, with the newest vocabulary
|
|
3126
3409
|
* first.</p>
|
|
3127
3410
|
*/
|
|
3128
3411
|
Status?: VocabularyState | string;
|
|
3129
3412
|
/**
|
|
3413
|
+
* @public
|
|
3130
3414
|
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
3131
3415
|
* results are displayed. To view the next set of results, copy the string associated with
|
|
3132
3416
|
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
@@ -3135,6 +3419,7 @@ export interface ListMedicalVocabulariesResponse {
|
|
|
3135
3419
|
*/
|
|
3136
3420
|
NextToken?: string;
|
|
3137
3421
|
/**
|
|
3422
|
+
* @public
|
|
3138
3423
|
* <p>Provides information about the custom medical vocabularies that match the criteria
|
|
3139
3424
|
* specified in your request.</p>
|
|
3140
3425
|
*/
|
|
@@ -3145,6 +3430,7 @@ export interface ListMedicalVocabulariesResponse {
|
|
|
3145
3430
|
*/
|
|
3146
3431
|
export interface ListTagsForResourceRequest {
|
|
3147
3432
|
/**
|
|
3433
|
+
* @public
|
|
3148
3434
|
* <p>Returns a list of all tags associated with the specified Amazon Resource Name (ARN).
|
|
3149
3435
|
* ARNs have the format
|
|
3150
3436
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
@@ -3162,10 +3448,12 @@ export interface ListTagsForResourceRequest {
|
|
|
3162
3448
|
*/
|
|
3163
3449
|
export interface ListTagsForResourceResponse {
|
|
3164
3450
|
/**
|
|
3451
|
+
* @public
|
|
3165
3452
|
* <p>The Amazon Resource Name (ARN) specified in your request.</p>
|
|
3166
3453
|
*/
|
|
3167
3454
|
ResourceArn?: string;
|
|
3168
3455
|
/**
|
|
3456
|
+
* @public
|
|
3169
3457
|
* <p>Lists all tags associated with the given transcription job, vocabulary, model, or
|
|
3170
3458
|
* resource.</p>
|
|
3171
3459
|
*/
|
|
@@ -3176,17 +3464,20 @@ export interface ListTagsForResourceResponse {
|
|
|
3176
3464
|
*/
|
|
3177
3465
|
export interface ListTranscriptionJobsRequest {
|
|
3178
3466
|
/**
|
|
3467
|
+
* @public
|
|
3179
3468
|
* <p>Returns only transcription jobs with the specified status. Jobs are ordered by
|
|
3180
3469
|
* creation date, with the newest job first. If you don't include <code>Status</code>, all
|
|
3181
3470
|
* transcription jobs are returned.</p>
|
|
3182
3471
|
*/
|
|
3183
3472
|
Status?: TranscriptionJobStatus | string;
|
|
3184
3473
|
/**
|
|
3474
|
+
* @public
|
|
3185
3475
|
* <p>Returns only the transcription jobs that contain the specified string. The search is
|
|
3186
3476
|
* not case sensitive.</p>
|
|
3187
3477
|
*/
|
|
3188
3478
|
JobNameContains?: string;
|
|
3189
3479
|
/**
|
|
3480
|
+
* @public
|
|
3190
3481
|
* <p>If your <code>ListTranscriptionJobs</code> request returns more results than can be
|
|
3191
3482
|
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
3192
3483
|
* string. To get the next page of results, copy this string and repeat your request,
|
|
@@ -3195,6 +3486,7 @@ export interface ListTranscriptionJobsRequest {
|
|
|
3195
3486
|
*/
|
|
3196
3487
|
NextToken?: string;
|
|
3197
3488
|
/**
|
|
3489
|
+
* @public
|
|
3198
3490
|
* <p>The maximum number of transcription jobs to return in each page of results. If there
|
|
3199
3491
|
* are fewer results than the value that you specify, only the actual results are returned.
|
|
3200
3492
|
* If you don't specify a value, a default of 5 is used.</p>
|
|
@@ -3207,11 +3499,13 @@ export interface ListTranscriptionJobsRequest {
|
|
|
3207
3499
|
*/
|
|
3208
3500
|
export interface TranscriptionJobSummary {
|
|
3209
3501
|
/**
|
|
3502
|
+
* @public
|
|
3210
3503
|
* <p>The name of the transcription job. Job names are case sensitive and must be unique
|
|
3211
3504
|
* within an Amazon Web Services account.</p>
|
|
3212
3505
|
*/
|
|
3213
3506
|
TranscriptionJobName?: string;
|
|
3214
3507
|
/**
|
|
3508
|
+
* @public
|
|
3215
3509
|
* <p>The date and time the specified transcription job request was made.</p>
|
|
3216
3510
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3217
3511
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
|
|
@@ -3219,6 +3513,7 @@ export interface TranscriptionJobSummary {
|
|
|
3219
3513
|
*/
|
|
3220
3514
|
CreationTime?: Date;
|
|
3221
3515
|
/**
|
|
3516
|
+
* @public
|
|
3222
3517
|
* <p>The date and time your transcription job began processing.</p>
|
|
3223
3518
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3224
3519
|
* example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
|
|
@@ -3226,6 +3521,7 @@ export interface TranscriptionJobSummary {
|
|
|
3226
3521
|
*/
|
|
3227
3522
|
StartTime?: Date;
|
|
3228
3523
|
/**
|
|
3524
|
+
* @public
|
|
3229
3525
|
* <p>The date and time the specified transcription job finished processing.</p>
|
|
3230
3526
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3231
3527
|
* example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
|
|
@@ -3233,10 +3529,12 @@ export interface TranscriptionJobSummary {
|
|
|
3233
3529
|
*/
|
|
3234
3530
|
CompletionTime?: Date;
|
|
3235
3531
|
/**
|
|
3532
|
+
* @public
|
|
3236
3533
|
* <p>The language code used to create your transcription.</p>
|
|
3237
3534
|
*/
|
|
3238
3535
|
LanguageCode?: LanguageCode | string;
|
|
3239
3536
|
/**
|
|
3537
|
+
* @public
|
|
3240
3538
|
* <p>Provides the status of your transcription job.</p>
|
|
3241
3539
|
* <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
|
|
3242
3540
|
* results at the location specified in <code>TranscriptFileUri</code> (or
|
|
@@ -3246,12 +3544,14 @@ export interface TranscriptionJobSummary {
|
|
|
3246
3544
|
*/
|
|
3247
3545
|
TranscriptionJobStatus?: TranscriptionJobStatus | string;
|
|
3248
3546
|
/**
|
|
3547
|
+
* @public
|
|
3249
3548
|
* <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
|
|
3250
3549
|
* <code>FailureReason</code> contains information about why the transcription job
|
|
3251
3550
|
* failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
|
|
3252
3551
|
*/
|
|
3253
3552
|
FailureReason?: string;
|
|
3254
3553
|
/**
|
|
3554
|
+
* @public
|
|
3255
3555
|
* <p>Indicates where the specified transcription output is stored.</p>
|
|
3256
3556
|
* <p>If the value is <code>CUSTOMER_BUCKET</code>, the location is the Amazon S3
|
|
3257
3557
|
* bucket you specified using the <code>OutputBucketName</code> parameter in your request. If you also included
|
|
@@ -3263,10 +3563,12 @@ export interface TranscriptionJobSummary {
|
|
|
3263
3563
|
*/
|
|
3264
3564
|
OutputLocationType?: OutputLocationType | string;
|
|
3265
3565
|
/**
|
|
3566
|
+
* @public
|
|
3266
3567
|
* <p>The content redaction settings of the transcription job.</p>
|
|
3267
3568
|
*/
|
|
3268
3569
|
ContentRedaction?: ContentRedaction;
|
|
3269
3570
|
/**
|
|
3571
|
+
* @public
|
|
3270
3572
|
* <p>Provides the name of the custom language model that was included in the specified
|
|
3271
3573
|
* transcription job.</p>
|
|
3272
3574
|
* <p>Only use <code>ModelSettings</code> with the <code>LanguageModelName</code>
|
|
@@ -3277,16 +3579,19 @@ export interface TranscriptionJobSummary {
|
|
|
3277
3579
|
*/
|
|
3278
3580
|
ModelSettings?: ModelSettings;
|
|
3279
3581
|
/**
|
|
3582
|
+
* @public
|
|
3280
3583
|
* <p>Indicates whether automatic language identification was enabled (<code>TRUE</code>)
|
|
3281
3584
|
* for the specified transcription job.</p>
|
|
3282
3585
|
*/
|
|
3283
3586
|
IdentifyLanguage?: boolean;
|
|
3284
3587
|
/**
|
|
3588
|
+
* @public
|
|
3285
3589
|
* <p>Indicates whether automatic multi-language identification was enabled
|
|
3286
3590
|
* (<code>TRUE</code>) for the specified transcription job.</p>
|
|
3287
3591
|
*/
|
|
3288
3592
|
IdentifyMultipleLanguages?: boolean;
|
|
3289
3593
|
/**
|
|
3594
|
+
* @public
|
|
3290
3595
|
* <p>The confidence score associated with the language identified in your media
|
|
3291
3596
|
* file.</p>
|
|
3292
3597
|
* <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
|
|
@@ -3295,12 +3600,14 @@ export interface TranscriptionJobSummary {
|
|
|
3295
3600
|
*/
|
|
3296
3601
|
IdentifiedLanguageScore?: number;
|
|
3297
3602
|
/**
|
|
3603
|
+
* @public
|
|
3298
3604
|
* <p>The language codes used to create your transcription job. This parameter is used with
|
|
3299
3605
|
* multi-language identification. For single-language identification, the singular version
|
|
3300
3606
|
* of this parameter, <code>LanguageCode</code>, is present.</p>
|
|
3301
3607
|
*/
|
|
3302
3608
|
LanguageCodes?: LanguageCodeItem[];
|
|
3303
3609
|
/**
|
|
3610
|
+
* @public
|
|
3304
3611
|
* <p>Indicates whether toxicity detection was enabled for the specified transcription
|
|
3305
3612
|
* job.</p>
|
|
3306
3613
|
*/
|
|
@@ -3311,11 +3618,13 @@ export interface TranscriptionJobSummary {
|
|
|
3311
3618
|
*/
|
|
3312
3619
|
export interface ListTranscriptionJobsResponse {
|
|
3313
3620
|
/**
|
|
3621
|
+
* @public
|
|
3314
3622
|
* <p>Lists all transcription jobs that have the status specified in your request. Jobs are
|
|
3315
3623
|
* ordered by creation date, with the newest job first.</p>
|
|
3316
3624
|
*/
|
|
3317
3625
|
Status?: TranscriptionJobStatus | string;
|
|
3318
3626
|
/**
|
|
3627
|
+
* @public
|
|
3319
3628
|
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
3320
3629
|
* results are displayed. To view the next set of results, copy the string associated with
|
|
3321
3630
|
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
@@ -3324,6 +3633,7 @@ export interface ListTranscriptionJobsResponse {
|
|
|
3324
3633
|
*/
|
|
3325
3634
|
NextToken?: string;
|
|
3326
3635
|
/**
|
|
3636
|
+
* @public
|
|
3327
3637
|
* <p>Provides a summary of information about each result.</p>
|
|
3328
3638
|
*/
|
|
3329
3639
|
TranscriptionJobSummaries?: TranscriptionJobSummary[];
|
|
@@ -3333,6 +3643,7 @@ export interface ListTranscriptionJobsResponse {
|
|
|
3333
3643
|
*/
|
|
3334
3644
|
export interface ListVocabulariesRequest {
|
|
3335
3645
|
/**
|
|
3646
|
+
* @public
|
|
3336
3647
|
* <p>If your <code>ListVocabularies</code> request returns more results than can be
|
|
3337
3648
|
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
3338
3649
|
* string. To get the next page of results, copy this string and repeat your request,
|
|
@@ -3341,18 +3652,21 @@ export interface ListVocabulariesRequest {
|
|
|
3341
3652
|
*/
|
|
3342
3653
|
NextToken?: string;
|
|
3343
3654
|
/**
|
|
3655
|
+
* @public
|
|
3344
3656
|
* <p>The maximum number of custom vocabularies to return in each page of results. If there
|
|
3345
3657
|
* are fewer results than the value that you specify, only the actual results are returned.
|
|
3346
3658
|
* If you don't specify a value, a default of 5 is used.</p>
|
|
3347
3659
|
*/
|
|
3348
3660
|
MaxResults?: number;
|
|
3349
3661
|
/**
|
|
3662
|
+
* @public
|
|
3350
3663
|
* <p>Returns only custom vocabularies with the specified state. Vocabularies are ordered by
|
|
3351
3664
|
* creation date, with the newest vocabulary first. If you don't include
|
|
3352
3665
|
* <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
|
|
3353
3666
|
*/
|
|
3354
3667
|
StateEquals?: VocabularyState | string;
|
|
3355
3668
|
/**
|
|
3669
|
+
* @public
|
|
3356
3670
|
* <p>Returns only the custom vocabularies that contain the specified string. The search is
|
|
3357
3671
|
* not case sensitive.</p>
|
|
3358
3672
|
*/
|
|
@@ -3363,11 +3677,13 @@ export interface ListVocabulariesRequest {
|
|
|
3363
3677
|
*/
|
|
3364
3678
|
export interface ListVocabulariesResponse {
|
|
3365
3679
|
/**
|
|
3680
|
+
* @public
|
|
3366
3681
|
* <p>Lists all custom vocabularies that have the status specified in your request.
|
|
3367
3682
|
* Vocabularies are ordered by creation date, with the newest vocabulary first.</p>
|
|
3368
3683
|
*/
|
|
3369
3684
|
Status?: VocabularyState | string;
|
|
3370
3685
|
/**
|
|
3686
|
+
* @public
|
|
3371
3687
|
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
3372
3688
|
* results are displayed. To view the next set of results, copy the string associated with
|
|
3373
3689
|
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
@@ -3376,6 +3692,7 @@ export interface ListVocabulariesResponse {
|
|
|
3376
3692
|
*/
|
|
3377
3693
|
NextToken?: string;
|
|
3378
3694
|
/**
|
|
3695
|
+
* @public
|
|
3379
3696
|
* <p>Provides information about the custom vocabularies that match the criteria specified
|
|
3380
3697
|
* in your request.</p>
|
|
3381
3698
|
*/
|
|
@@ -3386,6 +3703,7 @@ export interface ListVocabulariesResponse {
|
|
|
3386
3703
|
*/
|
|
3387
3704
|
export interface ListVocabularyFiltersRequest {
|
|
3388
3705
|
/**
|
|
3706
|
+
* @public
|
|
3389
3707
|
* <p>If your <code>ListVocabularyFilters</code> request returns more results than can be
|
|
3390
3708
|
* displayed, <code>NextToken</code> is displayed in the response with an associated
|
|
3391
3709
|
* string. To get the next page of results, copy this string and repeat your request,
|
|
@@ -3394,12 +3712,14 @@ export interface ListVocabularyFiltersRequest {
|
|
|
3394
3712
|
*/
|
|
3395
3713
|
NextToken?: string;
|
|
3396
3714
|
/**
|
|
3715
|
+
* @public
|
|
3397
3716
|
* <p>The maximum number of custom vocabulary filters to return in each page of results. If
|
|
3398
3717
|
* there are fewer results than the value that you specify, only the actual results are
|
|
3399
3718
|
* returned. If you don't specify a value, a default of 5 is used.</p>
|
|
3400
3719
|
*/
|
|
3401
3720
|
MaxResults?: number;
|
|
3402
3721
|
/**
|
|
3722
|
+
* @public
|
|
3403
3723
|
* <p>Returns only the custom vocabulary filters that contain the specified string. The
|
|
3404
3724
|
* search is not case sensitive.</p>
|
|
3405
3725
|
*/
|
|
@@ -3412,11 +3732,13 @@ export interface ListVocabularyFiltersRequest {
|
|
|
3412
3732
|
*/
|
|
3413
3733
|
export interface VocabularyFilterInfo {
|
|
3414
3734
|
/**
|
|
3735
|
+
* @public
|
|
3415
3736
|
* <p>A unique name, chosen by you, for your custom vocabulary filter. This name is case
|
|
3416
3737
|
* sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</p>
|
|
3417
3738
|
*/
|
|
3418
3739
|
VocabularyFilterName?: string;
|
|
3419
3740
|
/**
|
|
3741
|
+
* @public
|
|
3420
3742
|
* <p>The language code that represents the language of the entries in your vocabulary
|
|
3421
3743
|
* filter. Each custom vocabulary filter must contain terms in only one language.</p>
|
|
3422
3744
|
* <p>A custom vocabulary filter can only be used to transcribe files in the same language
|
|
@@ -3428,6 +3750,7 @@ export interface VocabularyFilterInfo {
|
|
|
3428
3750
|
*/
|
|
3429
3751
|
LanguageCode?: LanguageCode | string;
|
|
3430
3752
|
/**
|
|
3753
|
+
* @public
|
|
3431
3754
|
* <p>The date and time the specified custom vocabulary filter was last modified.</p>
|
|
3432
3755
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
3433
3756
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -3440,6 +3763,7 @@ export interface VocabularyFilterInfo {
|
|
|
3440
3763
|
*/
|
|
3441
3764
|
export interface ListVocabularyFiltersResponse {
|
|
3442
3765
|
/**
|
|
3766
|
+
* @public
|
|
3443
3767
|
* <p>If <code>NextToken</code> is present in your response, it indicates that not all
|
|
3444
3768
|
* results are displayed. To view the next set of results, copy the string associated with
|
|
3445
3769
|
* the <code>NextToken</code> parameter in your results output, then run your request again
|
|
@@ -3448,6 +3772,7 @@ export interface ListVocabularyFiltersResponse {
|
|
|
3448
3772
|
*/
|
|
3449
3773
|
NextToken?: string;
|
|
3450
3774
|
/**
|
|
3775
|
+
* @public
|
|
3451
3776
|
* <p>Provides information about the custom vocabulary filters that match the criteria
|
|
3452
3777
|
* specified in your request.</p>
|
|
3453
3778
|
*/
|
|
@@ -3458,6 +3783,7 @@ export interface ListVocabularyFiltersResponse {
|
|
|
3458
3783
|
*/
|
|
3459
3784
|
export interface StartCallAnalyticsJobRequest {
|
|
3460
3785
|
/**
|
|
3786
|
+
* @public
|
|
3461
3787
|
* <p>A unique name, chosen by you, for your Call Analytics job.</p>
|
|
3462
3788
|
* <p>This name is case sensitive, cannot contain spaces, and must be unique within an
|
|
3463
3789
|
* Amazon Web Services account. If you try to create a new job with the same name as an
|
|
@@ -3465,11 +3791,13 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3465
3791
|
*/
|
|
3466
3792
|
CallAnalyticsJobName: string | undefined;
|
|
3467
3793
|
/**
|
|
3794
|
+
* @public
|
|
3468
3795
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
3469
3796
|
* Call Analytics request.</p>
|
|
3470
3797
|
*/
|
|
3471
3798
|
Media: Media | undefined;
|
|
3472
3799
|
/**
|
|
3800
|
+
* @public
|
|
3473
3801
|
* <p>The Amazon S3 location where you want your Call Analytics transcription output
|
|
3474
3802
|
* stored. You can use any of the following formats to specify the output location:</p>
|
|
3475
3803
|
* <ol>
|
|
@@ -3495,6 +3823,7 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3495
3823
|
*/
|
|
3496
3824
|
OutputLocation?: string;
|
|
3497
3825
|
/**
|
|
3826
|
+
* @public
|
|
3498
3827
|
* <p>The KMS key you want to use to encrypt your Call Analytics
|
|
3499
3828
|
* output.</p>
|
|
3500
3829
|
* <p>If using a key located in the <b>current</b>
|
|
@@ -3541,6 +3870,7 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3541
3870
|
*/
|
|
3542
3871
|
OutputEncryptionKMSKeyId?: string;
|
|
3543
3872
|
/**
|
|
3873
|
+
* @public
|
|
3544
3874
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
3545
3875
|
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
3546
3876
|
* specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</p>
|
|
@@ -3552,11 +3882,13 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3552
3882
|
*/
|
|
3553
3883
|
DataAccessRoleArn?: string;
|
|
3554
3884
|
/**
|
|
3885
|
+
* @public
|
|
3555
3886
|
* <p>Specify additional optional settings in your request, including content redaction; allows you to apply custom language models,
|
|
3556
3887
|
* vocabulary filters, and custom vocabularies to your Call Analytics job.</p>
|
|
3557
3888
|
*/
|
|
3558
3889
|
Settings?: CallAnalyticsJobSettings;
|
|
3559
3890
|
/**
|
|
3891
|
+
* @public
|
|
3560
3892
|
* <p>Makes it possible to specify which speaker is on which channel. For example, if your
|
|
3561
3893
|
* agent is the first participant to speak, you would set <code>ChannelId</code> to
|
|
3562
3894
|
* <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
|
|
@@ -3569,6 +3901,7 @@ export interface StartCallAnalyticsJobRequest {
|
|
|
3569
3901
|
*/
|
|
3570
3902
|
export interface StartCallAnalyticsJobResponse {
|
|
3571
3903
|
/**
|
|
3904
|
+
* @public
|
|
3572
3905
|
* <p>Provides detailed information about the current Call Analytics job, including job
|
|
3573
3906
|
* status and, if applicable, failure reason.</p>
|
|
3574
3907
|
*/
|
|
@@ -3579,6 +3912,7 @@ export interface StartCallAnalyticsJobResponse {
|
|
|
3579
3912
|
*/
|
|
3580
3913
|
export interface StartMedicalTranscriptionJobRequest {
|
|
3581
3914
|
/**
|
|
3915
|
+
* @public
|
|
3582
3916
|
* <p>A unique name, chosen by you, for your medical transcription job. The name that you
|
|
3583
3917
|
* specify is also used as the default name of your transcription output file. If you want
|
|
3584
3918
|
* to specify a different name for your transcription output, use the
|
|
@@ -3589,6 +3923,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3589
3923
|
*/
|
|
3590
3924
|
MedicalTranscriptionJobName: string | undefined;
|
|
3591
3925
|
/**
|
|
3926
|
+
* @public
|
|
3592
3927
|
* <p>The language code that represents the language spoken in the input media file. US
|
|
3593
3928
|
* English (<code>en-US</code>) is the only valid value for medical transcription jobs. Any
|
|
3594
3929
|
* other value you enter for language code results in a <code>BadRequestException</code>
|
|
@@ -3596,6 +3931,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3596
3931
|
*/
|
|
3597
3932
|
LanguageCode: LanguageCode | string | undefined;
|
|
3598
3933
|
/**
|
|
3934
|
+
* @public
|
|
3599
3935
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
3600
3936
|
* <p>If you don't specify the media sample rate, Amazon Transcribe Medical determines it
|
|
3601
3937
|
* for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the
|
|
@@ -3605,10 +3941,12 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3605
3941
|
*/
|
|
3606
3942
|
MediaSampleRateHertz?: number;
|
|
3607
3943
|
/**
|
|
3944
|
+
* @public
|
|
3608
3945
|
* <p>Specify the format of your input media file.</p>
|
|
3609
3946
|
*/
|
|
3610
3947
|
MediaFormat?: MediaFormat | string;
|
|
3611
3948
|
/**
|
|
3949
|
+
* @public
|
|
3612
3950
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
3613
3951
|
* request.</p>
|
|
3614
3952
|
* <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
|
|
@@ -3616,6 +3954,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3616
3954
|
*/
|
|
3617
3955
|
Media: Media | undefined;
|
|
3618
3956
|
/**
|
|
3957
|
+
* @public
|
|
3619
3958
|
* <p>The name of the Amazon S3 bucket where you want your medical transcription
|
|
3620
3959
|
* output stored. Do not include the <code>S3://</code> prefix of the specified
|
|
3621
3960
|
* bucket.</p>
|
|
@@ -3632,6 +3971,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3632
3971
|
*/
|
|
3633
3972
|
OutputBucketName: string | undefined;
|
|
3634
3973
|
/**
|
|
3974
|
+
* @public
|
|
3635
3975
|
* <p>Use in combination with <code>OutputBucketName</code> to specify the output location
|
|
3636
3976
|
* of your transcript and, optionally, a unique name for your output file. The default name
|
|
3637
3977
|
* for your transcription output is the same as the name you specified for your medical
|
|
@@ -3669,6 +4009,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3669
4009
|
*/
|
|
3670
4010
|
OutputKey?: string;
|
|
3671
4011
|
/**
|
|
4012
|
+
* @public
|
|
3672
4013
|
* <p>The KMS key you want to use to encrypt your medical transcription
|
|
3673
4014
|
* output.</p>
|
|
3674
4015
|
* <p>If using a key located in the <b>current</b>
|
|
@@ -3715,28 +4056,33 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3715
4056
|
*/
|
|
3716
4057
|
OutputEncryptionKMSKeyId?: string;
|
|
3717
4058
|
/**
|
|
4059
|
+
* @public
|
|
3718
4060
|
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
|
|
3719
4061
|
* that provide an added layer of security for your data. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</p>
|
|
3720
4062
|
*/
|
|
3721
4063
|
KMSEncryptionContext?: Record<string, string>;
|
|
3722
4064
|
/**
|
|
4065
|
+
* @public
|
|
3723
4066
|
* <p>Specify additional optional settings in your request, including channel
|
|
3724
4067
|
* identification, alternative transcriptions, and speaker partitioning. You can use that to
|
|
3725
4068
|
* apply custom vocabularies to your transcription job.</p>
|
|
3726
4069
|
*/
|
|
3727
4070
|
Settings?: MedicalTranscriptionSetting;
|
|
3728
4071
|
/**
|
|
4072
|
+
* @public
|
|
3729
4073
|
* <p>Labels all personal health information (PHI) identified in your transcript. For more
|
|
3730
4074
|
* information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
|
|
3731
4075
|
*/
|
|
3732
4076
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
3733
4077
|
/**
|
|
4078
|
+
* @public
|
|
3734
4079
|
* <p>Specify the predominant medical specialty represented in your media. For batch
|
|
3735
4080
|
* transcriptions, <code>PRIMARYCARE</code> is the only valid value. If you require
|
|
3736
4081
|
* additional specialties, refer to .</p>
|
|
3737
4082
|
*/
|
|
3738
4083
|
Specialty: Specialty | string | undefined;
|
|
3739
4084
|
/**
|
|
4085
|
+
* @public
|
|
3740
4086
|
* <p>Specify whether your input media contains only one person (<code>DICTATION</code>) or
|
|
3741
4087
|
* contains a conversation between two people (<code>CONVERSATION</code>).</p>
|
|
3742
4088
|
* <p>For example, <code>DICTATION</code> could be used for a medical professional wanting
|
|
@@ -3745,6 +4091,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3745
4091
|
*/
|
|
3746
4092
|
Type: Type | string | undefined;
|
|
3747
4093
|
/**
|
|
4094
|
+
* @public
|
|
3748
4095
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new medical
|
|
3749
4096
|
* transcription job at the time you start this new job.</p>
|
|
3750
4097
|
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
@@ -3757,6 +4104,7 @@ export interface StartMedicalTranscriptionJobRequest {
|
|
|
3757
4104
|
*/
|
|
3758
4105
|
export interface StartMedicalTranscriptionJobResponse {
|
|
3759
4106
|
/**
|
|
4107
|
+
* @public
|
|
3760
4108
|
* <p>Provides detailed information about the current medical transcription job, including
|
|
3761
4109
|
* job status and, if applicable, failure reason.</p>
|
|
3762
4110
|
*/
|
|
@@ -3772,12 +4120,14 @@ export interface StartMedicalTranscriptionJobResponse {
|
|
|
3772
4120
|
*/
|
|
3773
4121
|
export interface Subtitles {
|
|
3774
4122
|
/**
|
|
4123
|
+
* @public
|
|
3775
4124
|
* <p>Specify the output format for your subtitle file; if you select both WebVTT
|
|
3776
4125
|
* (<code>vtt</code>) and SubRip (<code>srt</code>) formats, two output files are
|
|
3777
4126
|
* generated.</p>
|
|
3778
4127
|
*/
|
|
3779
4128
|
Formats?: (SubtitleFormat | string)[];
|
|
3780
4129
|
/**
|
|
4130
|
+
* @public
|
|
3781
4131
|
* <p>Specify the starting value that is assigned to the first subtitle segment.</p>
|
|
3782
4132
|
* <p>The default start index for Amazon Transcribe is <code>0</code>, which differs from
|
|
3783
4133
|
* the more widely used standard of <code>1</code>. If you're uncertain which value to use,
|
|
@@ -3791,6 +4141,7 @@ export interface Subtitles {
|
|
|
3791
4141
|
*/
|
|
3792
4142
|
export interface StartTranscriptionJobRequest {
|
|
3793
4143
|
/**
|
|
4144
|
+
* @public
|
|
3794
4145
|
* <p>A unique name, chosen by you, for your transcription job. The name that you specify is
|
|
3795
4146
|
* also used as the default name of your transcription output file. If you want to specify
|
|
3796
4147
|
* a different name for your transcription output, use the <code>OutputKey</code>
|
|
@@ -3801,6 +4152,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3801
4152
|
*/
|
|
3802
4153
|
TranscriptionJobName: string | undefined;
|
|
3803
4154
|
/**
|
|
4155
|
+
* @public
|
|
3804
4156
|
* <p>The language code that represents the language spoken in the input media file.</p>
|
|
3805
4157
|
* <p>If you're unsure of the language spoken in your media file, consider using
|
|
3806
4158
|
* <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable
|
|
@@ -3818,6 +4170,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3818
4170
|
*/
|
|
3819
4171
|
LanguageCode?: LanguageCode | string;
|
|
3820
4172
|
/**
|
|
4173
|
+
* @public
|
|
3821
4174
|
* <p>The sample rate, in hertz, of the audio track in your input media file.</p>
|
|
3822
4175
|
* <p>If you don't specify the media sample rate, Amazon Transcribe determines it for you.
|
|
3823
4176
|
* If you specify the sample rate, it must match the rate detected by Amazon Transcribe.
|
|
@@ -3826,15 +4179,18 @@ export interface StartTranscriptionJobRequest {
|
|
|
3826
4179
|
*/
|
|
3827
4180
|
MediaSampleRateHertz?: number;
|
|
3828
4181
|
/**
|
|
4182
|
+
* @public
|
|
3829
4183
|
* <p>Specify the format of your input media file.</p>
|
|
3830
4184
|
*/
|
|
3831
4185
|
MediaFormat?: MediaFormat | string;
|
|
3832
4186
|
/**
|
|
4187
|
+
* @public
|
|
3833
4188
|
* <p>Describes the Amazon S3 location of the media file you want to use in your
|
|
3834
4189
|
* request.</p>
|
|
3835
4190
|
*/
|
|
3836
4191
|
Media: Media | undefined;
|
|
3837
4192
|
/**
|
|
4193
|
+
* @public
|
|
3838
4194
|
* <p>The name of the Amazon S3 bucket where you want your transcription output
|
|
3839
4195
|
* stored. Do not include the <code>S3://</code> prefix of the specified bucket.</p>
|
|
3840
4196
|
* <p>If you want your output to go to a sub-folder of this bucket, specify it using the
|
|
@@ -3853,6 +4209,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3853
4209
|
*/
|
|
3854
4210
|
OutputBucketName?: string;
|
|
3855
4211
|
/**
|
|
4212
|
+
* @public
|
|
3856
4213
|
* <p>Use in combination with <code>OutputBucketName</code> to specify the output location
|
|
3857
4214
|
* of your transcript and, optionally, a unique name for your output file. The default name
|
|
3858
4215
|
* for your transcription output is the same as the name you specified for your
|
|
@@ -3890,6 +4247,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3890
4247
|
*/
|
|
3891
4248
|
OutputKey?: string;
|
|
3892
4249
|
/**
|
|
4250
|
+
* @public
|
|
3893
4251
|
* <p>The KMS key you want to use to encrypt your transcription
|
|
3894
4252
|
* output.</p>
|
|
3895
4253
|
* <p>If using a key located in the <b>current</b>
|
|
@@ -3936,11 +4294,13 @@ export interface StartTranscriptionJobRequest {
|
|
|
3936
4294
|
*/
|
|
3937
4295
|
OutputEncryptionKMSKeyId?: string;
|
|
3938
4296
|
/**
|
|
4297
|
+
* @public
|
|
3939
4298
|
* <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
|
|
3940
4299
|
* that provide an added layer of security for your data. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</p>
|
|
3941
4300
|
*/
|
|
3942
4301
|
KMSEncryptionContext?: Record<string, string>;
|
|
3943
4302
|
/**
|
|
4303
|
+
* @public
|
|
3944
4304
|
* <p>Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker
|
|
3945
4305
|
* partitioning. You can use that to apply custom vocabularies and vocabulary filters.</p>
|
|
3946
4306
|
* <p>If you want to include a custom vocabulary or a custom vocabulary filter (or both)
|
|
@@ -3955,6 +4315,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3955
4315
|
*/
|
|
3956
4316
|
Settings?: Settings;
|
|
3957
4317
|
/**
|
|
4318
|
+
* @public
|
|
3958
4319
|
* <p>Specify the custom language model you want to include with your transcription job. If
|
|
3959
4320
|
* you include <code>ModelSettings</code> in your request, you must include the
|
|
3960
4321
|
* <code>LanguageModelName</code> sub-parameter.</p>
|
|
@@ -3963,6 +4324,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3963
4324
|
*/
|
|
3964
4325
|
ModelSettings?: ModelSettings;
|
|
3965
4326
|
/**
|
|
4327
|
+
* @public
|
|
3966
4328
|
* <p>Makes it possible to control how your transcription job is processed. Currently, the
|
|
3967
4329
|
* only <code>JobExecutionSettings</code> modification you can choose is enabling job
|
|
3968
4330
|
* queueing using the <code>AllowDeferredExecution</code> sub-parameter.</p>
|
|
@@ -3972,6 +4334,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3972
4334
|
*/
|
|
3973
4335
|
JobExecutionSettings?: JobExecutionSettings;
|
|
3974
4336
|
/**
|
|
4337
|
+
* @public
|
|
3975
4338
|
* <p>Makes it possible to redact or flag specified personally identifiable information
|
|
3976
4339
|
* (PII) in your transcript. If you use <code>ContentRedaction</code>, you must also
|
|
3977
4340
|
* include the sub-parameters: <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
|
|
@@ -3979,6 +4342,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
3979
4342
|
*/
|
|
3980
4343
|
ContentRedaction?: ContentRedaction;
|
|
3981
4344
|
/**
|
|
4345
|
+
* @public
|
|
3982
4346
|
* <p>Enables automatic language identification in your transcription job request. Use this
|
|
3983
4347
|
* parameter if your media file contains only one language. If your media contains multiple
|
|
3984
4348
|
* languages, use <code>IdentifyMultipleLanguages</code> instead.</p>
|
|
@@ -4000,6 +4364,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
4000
4364
|
*/
|
|
4001
4365
|
IdentifyLanguage?: boolean;
|
|
4002
4366
|
/**
|
|
4367
|
+
* @public
|
|
4003
4368
|
* <p>Enables automatic multi-language identification in your transcription job request. Use
|
|
4004
4369
|
* this parameter if your media file contains more than one language. If your media
|
|
4005
4370
|
* contains only one language, use <code>IdentifyLanguage</code> instead.</p>
|
|
@@ -4020,6 +4385,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
4020
4385
|
*/
|
|
4021
4386
|
IdentifyMultipleLanguages?: boolean;
|
|
4022
4387
|
/**
|
|
4388
|
+
* @public
|
|
4023
4389
|
* <p>You can specify two or more language codes that represent the languages you think may
|
|
4024
4390
|
* be present in your media. Including more than five is not recommended. If you're unsure
|
|
4025
4391
|
* what languages are present, do not include this parameter.</p>
|
|
@@ -4032,11 +4398,13 @@ export interface StartTranscriptionJobRequest {
|
|
|
4032
4398
|
*/
|
|
4033
4399
|
LanguageOptions?: (LanguageCode | string)[];
|
|
4034
4400
|
/**
|
|
4401
|
+
* @public
|
|
4035
4402
|
* <p>Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and
|
|
4036
4403
|
* SubRip (*.srt) formats.</p>
|
|
4037
4404
|
*/
|
|
4038
4405
|
Subtitles?: Subtitles;
|
|
4039
4406
|
/**
|
|
4407
|
+
* @public
|
|
4040
4408
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to a new
|
|
4041
4409
|
* transcription job at the time you start this new job.</p>
|
|
4042
4410
|
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
@@ -4044,6 +4412,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
4044
4412
|
*/
|
|
4045
4413
|
Tags?: Tag[];
|
|
4046
4414
|
/**
|
|
4415
|
+
* @public
|
|
4047
4416
|
* <p>If using automatic language identification in your request and you want to apply a
|
|
4048
4417
|
* custom language model, a custom vocabulary, or a custom vocabulary filter, include
|
|
4049
4418
|
* <code>LanguageIdSettings</code> with the relevant sub-parameters
|
|
@@ -4075,6 +4444,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
4075
4444
|
*/
|
|
4076
4445
|
LanguageIdSettings?: Record<string, LanguageIdSettings>;
|
|
4077
4446
|
/**
|
|
4447
|
+
* @public
|
|
4078
4448
|
* <p>Enables toxic speech detection in your transcript. If you include
|
|
4079
4449
|
* <code>ToxicityDetection</code> in your request, you must also include
|
|
4080
4450
|
* <code>ToxicityCategories</code>.</p>
|
|
@@ -4089,6 +4459,7 @@ export interface StartTranscriptionJobRequest {
|
|
|
4089
4459
|
*/
|
|
4090
4460
|
export interface StartTranscriptionJobResponse {
|
|
4091
4461
|
/**
|
|
4462
|
+
* @public
|
|
4092
4463
|
* <p>Provides detailed information about the current transcription job, including job
|
|
4093
4464
|
* status and, if applicable, failure reason.</p>
|
|
4094
4465
|
*/
|
|
@@ -4099,6 +4470,7 @@ export interface StartTranscriptionJobResponse {
|
|
|
4099
4470
|
*/
|
|
4100
4471
|
export interface TagResourceRequest {
|
|
4101
4472
|
/**
|
|
4473
|
+
* @public
|
|
4102
4474
|
* <p>The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format
|
|
4103
4475
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
4104
4476
|
* <p>For example,
|
|
@@ -4110,6 +4482,7 @@ export interface TagResourceRequest {
|
|
|
4110
4482
|
*/
|
|
4111
4483
|
ResourceArn: string | undefined;
|
|
4112
4484
|
/**
|
|
4485
|
+
* @public
|
|
4113
4486
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to the specified
|
|
4114
4487
|
* resource.</p>
|
|
4115
4488
|
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
@@ -4127,6 +4500,7 @@ export interface TagResourceResponse {
|
|
|
4127
4500
|
*/
|
|
4128
4501
|
export interface UntagResourceRequest {
|
|
4129
4502
|
/**
|
|
4503
|
+
* @public
|
|
4130
4504
|
* <p>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove
|
|
4131
4505
|
* tags from. ARNs have the format
|
|
4132
4506
|
* <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
|
|
@@ -4139,6 +4513,7 @@ export interface UntagResourceRequest {
|
|
|
4139
4513
|
*/
|
|
4140
4514
|
ResourceArn: string | undefined;
|
|
4141
4515
|
/**
|
|
4516
|
+
* @public
|
|
4142
4517
|
* <p>Removes the specified tag keys from the specified Amazon Transcribe resource.</p>
|
|
4143
4518
|
*/
|
|
4144
4519
|
TagKeys: string[] | undefined;
|
|
@@ -4153,16 +4528,19 @@ export interface UntagResourceResponse {
|
|
|
4153
4528
|
*/
|
|
4154
4529
|
export interface UpdateCallAnalyticsCategoryRequest {
|
|
4155
4530
|
/**
|
|
4531
|
+
* @public
|
|
4156
4532
|
* <p>The name of the Call Analytics category you want to update. Category names are case
|
|
4157
4533
|
* sensitive.</p>
|
|
4158
4534
|
*/
|
|
4159
4535
|
CategoryName: string | undefined;
|
|
4160
4536
|
/**
|
|
4537
|
+
* @public
|
|
4161
4538
|
* <p>The rules used for the updated Call Analytics category. The rules you provide in this
|
|
4162
4539
|
* field replace the ones that are currently being used in the specified category.</p>
|
|
4163
4540
|
*/
|
|
4164
4541
|
Rules: Rule[] | undefined;
|
|
4165
4542
|
/**
|
|
4543
|
+
* @public
|
|
4166
4544
|
* <p>Choose whether you want to update a real-time or a post-call category. The
|
|
4167
4545
|
* input type you specify must match the input type specified when the category was created. For
|
|
4168
4546
|
* example, if you created a category with the <code>POST_CALL</code> input type, you must
|
|
@@ -4175,6 +4553,7 @@ export interface UpdateCallAnalyticsCategoryRequest {
|
|
|
4175
4553
|
*/
|
|
4176
4554
|
export interface UpdateCallAnalyticsCategoryResponse {
|
|
4177
4555
|
/**
|
|
4556
|
+
* @public
|
|
4178
4557
|
* <p>Provides you with the properties of the Call Analytics category you specified in your
|
|
4179
4558
|
* <code>UpdateCallAnalyticsCategory</code> request.</p>
|
|
4180
4559
|
*/
|
|
@@ -4185,17 +4564,20 @@ export interface UpdateCallAnalyticsCategoryResponse {
|
|
|
4185
4564
|
*/
|
|
4186
4565
|
export interface UpdateMedicalVocabularyRequest {
|
|
4187
4566
|
/**
|
|
4567
|
+
* @public
|
|
4188
4568
|
* <p>The name of the custom medical vocabulary you want to update. Custom medical
|
|
4189
4569
|
* vocabulary names are case sensitive.</p>
|
|
4190
4570
|
*/
|
|
4191
4571
|
VocabularyName: string | undefined;
|
|
4192
4572
|
/**
|
|
4573
|
+
* @public
|
|
4193
4574
|
* <p>The language code that represents the language of the entries in the custom vocabulary
|
|
4194
4575
|
* you want to update. US English (<code>en-US</code>) is the only language supported with
|
|
4195
4576
|
* Amazon Transcribe Medical.</p>
|
|
4196
4577
|
*/
|
|
4197
4578
|
LanguageCode: LanguageCode | string | undefined;
|
|
4198
4579
|
/**
|
|
4580
|
+
* @public
|
|
4199
4581
|
* <p>The Amazon S3 location of the text file that contains your custom medical
|
|
4200
4582
|
* vocabulary. The URI must be located in the same Amazon Web Services Region as the
|
|
4201
4583
|
* resource you're calling.</p>
|
|
@@ -4210,16 +4592,19 @@ export interface UpdateMedicalVocabularyRequest {
|
|
|
4210
4592
|
*/
|
|
4211
4593
|
export interface UpdateMedicalVocabularyResponse {
|
|
4212
4594
|
/**
|
|
4595
|
+
* @public
|
|
4213
4596
|
* <p>The name of the updated custom medical vocabulary.</p>
|
|
4214
4597
|
*/
|
|
4215
4598
|
VocabularyName?: string;
|
|
4216
4599
|
/**
|
|
4600
|
+
* @public
|
|
4217
4601
|
* <p>The language code you selected for your custom medical vocabulary. US English
|
|
4218
4602
|
* (<code>en-US</code>) is the only language supported with Amazon Transcribe
|
|
4219
4603
|
* Medical.</p>
|
|
4220
4604
|
*/
|
|
4221
4605
|
LanguageCode?: LanguageCode | string;
|
|
4222
4606
|
/**
|
|
4607
|
+
* @public
|
|
4223
4608
|
* <p>The date and time the specified custom medical vocabulary was last updated.</p>
|
|
4224
4609
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
4225
4610
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -4227,6 +4612,7 @@ export interface UpdateMedicalVocabularyResponse {
|
|
|
4227
4612
|
*/
|
|
4228
4613
|
LastModifiedTime?: Date;
|
|
4229
4614
|
/**
|
|
4615
|
+
* @public
|
|
4230
4616
|
* <p>The processing state of your custom medical vocabulary. If the state is
|
|
4231
4617
|
* <code>READY</code>, you can use the custom vocabulary in a
|
|
4232
4618
|
* <code>StartMedicalTranscriptionJob</code> request.</p>
|
|
@@ -4238,11 +4624,13 @@ export interface UpdateMedicalVocabularyResponse {
|
|
|
4238
4624
|
*/
|
|
4239
4625
|
export interface UpdateVocabularyRequest {
|
|
4240
4626
|
/**
|
|
4627
|
+
* @public
|
|
4241
4628
|
* <p>The name of the custom vocabulary you want to update. Custom vocabulary names are case
|
|
4242
4629
|
* sensitive.</p>
|
|
4243
4630
|
*/
|
|
4244
4631
|
VocabularyName: string | undefined;
|
|
4245
4632
|
/**
|
|
4633
|
+
* @public
|
|
4246
4634
|
* <p>The language code that represents the language of the entries in the custom vocabulary
|
|
4247
4635
|
* you want to update. Each custom vocabulary must contain terms in only one
|
|
4248
4636
|
* language.</p>
|
|
@@ -4255,6 +4643,7 @@ export interface UpdateVocabularyRequest {
|
|
|
4255
4643
|
*/
|
|
4256
4644
|
LanguageCode: LanguageCode | string | undefined;
|
|
4257
4645
|
/**
|
|
4646
|
+
* @public
|
|
4258
4647
|
* <p>Use this parameter if you want to update your custom vocabulary by including all
|
|
4259
4648
|
* desired terms, as comma-separated values, within your request. The other option for
|
|
4260
4649
|
* updating your custom vocabulary is to save your entries in a text file and upload them
|
|
@@ -4269,6 +4658,7 @@ export interface UpdateVocabularyRequest {
|
|
|
4269
4658
|
*/
|
|
4270
4659
|
Phrases?: string[];
|
|
4271
4660
|
/**
|
|
4661
|
+
* @public
|
|
4272
4662
|
* <p>The Amazon S3 location of the text file that contains your custom vocabulary.
|
|
4273
4663
|
* The URI must be located in the same Amazon Web Services Region as the resource you're
|
|
4274
4664
|
* calling.</p>
|
|
@@ -4280,6 +4670,7 @@ export interface UpdateVocabularyRequest {
|
|
|
4280
4670
|
*/
|
|
4281
4671
|
VocabularyFileUri?: string;
|
|
4282
4672
|
/**
|
|
4673
|
+
* @public
|
|
4283
4674
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
4284
4675
|
* access the Amazon S3 bucket that contains your input files (in this case, your custom
|
|
4285
4676
|
* vocabulary). If the role that you specify doesn’t have the appropriate permissions to access
|
|
@@ -4297,14 +4688,17 @@ export interface UpdateVocabularyRequest {
|
|
|
4297
4688
|
*/
|
|
4298
4689
|
export interface UpdateVocabularyResponse {
|
|
4299
4690
|
/**
|
|
4691
|
+
* @public
|
|
4300
4692
|
* <p>The name of the updated custom vocabulary.</p>
|
|
4301
4693
|
*/
|
|
4302
4694
|
VocabularyName?: string;
|
|
4303
4695
|
/**
|
|
4696
|
+
* @public
|
|
4304
4697
|
* <p>The language code you selected for your custom vocabulary.</p>
|
|
4305
4698
|
*/
|
|
4306
4699
|
LanguageCode?: LanguageCode | string;
|
|
4307
4700
|
/**
|
|
4701
|
+
* @public
|
|
4308
4702
|
* <p>The date and time the specified custom vocabulary was last updated.</p>
|
|
4309
4703
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
4310
4704
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|
|
@@ -4312,6 +4706,7 @@ export interface UpdateVocabularyResponse {
|
|
|
4312
4706
|
*/
|
|
4313
4707
|
LastModifiedTime?: Date;
|
|
4314
4708
|
/**
|
|
4709
|
+
* @public
|
|
4315
4710
|
* <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
|
|
4316
4711
|
* you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
|
|
4317
4712
|
* request.</p>
|
|
@@ -4323,11 +4718,13 @@ export interface UpdateVocabularyResponse {
|
|
|
4323
4718
|
*/
|
|
4324
4719
|
export interface UpdateVocabularyFilterRequest {
|
|
4325
4720
|
/**
|
|
4721
|
+
* @public
|
|
4326
4722
|
* <p>The name of the custom vocabulary filter you want to update. Custom vocabulary filter
|
|
4327
4723
|
* names are case sensitive.</p>
|
|
4328
4724
|
*/
|
|
4329
4725
|
VocabularyFilterName: string | undefined;
|
|
4330
4726
|
/**
|
|
4727
|
+
* @public
|
|
4331
4728
|
* <p>Use this parameter if you want to update your custom vocabulary filter by including
|
|
4332
4729
|
* all desired terms, as comma-separated values, within your request. The other option for
|
|
4333
4730
|
* updating your vocabulary filter is to save your entries in a text file and upload them
|
|
@@ -4342,6 +4739,7 @@ export interface UpdateVocabularyFilterRequest {
|
|
|
4342
4739
|
*/
|
|
4343
4740
|
Words?: string[];
|
|
4344
4741
|
/**
|
|
4742
|
+
* @public
|
|
4345
4743
|
* <p>The Amazon S3 location of the text file that contains your custom vocabulary
|
|
4346
4744
|
* filter terms. The URI must be located in the same Amazon Web Services Region as the
|
|
4347
4745
|
* resource you're calling.</p>
|
|
@@ -4353,6 +4751,7 @@ export interface UpdateVocabularyFilterRequest {
|
|
|
4353
4751
|
*/
|
|
4354
4752
|
VocabularyFilterFileUri?: string;
|
|
4355
4753
|
/**
|
|
4754
|
+
* @public
|
|
4356
4755
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
4357
4756
|
* access the Amazon S3 bucket that contains your input files (in this case, your custom
|
|
4358
4757
|
* vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access
|
|
@@ -4370,14 +4769,17 @@ export interface UpdateVocabularyFilterRequest {
|
|
|
4370
4769
|
*/
|
|
4371
4770
|
export interface UpdateVocabularyFilterResponse {
|
|
4372
4771
|
/**
|
|
4772
|
+
* @public
|
|
4373
4773
|
* <p>The name of the updated custom vocabulary filter.</p>
|
|
4374
4774
|
*/
|
|
4375
4775
|
VocabularyFilterName?: string;
|
|
4376
4776
|
/**
|
|
4777
|
+
* @public
|
|
4377
4778
|
* <p>The language code you selected for your custom vocabulary filter.</p>
|
|
4378
4779
|
*/
|
|
4379
4780
|
LanguageCode?: LanguageCode | string;
|
|
4380
4781
|
/**
|
|
4782
|
+
* @public
|
|
4381
4783
|
* <p>The date and time the specified custom vocabulary filter was last updated.</p>
|
|
4382
4784
|
* <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
|
|
4383
4785
|
* example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
|