@aws-sdk/client-transcribe-streaming 3.379.1 → 3.382.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 +223 -0
- package/package.json +5 -5
|
@@ -8,27 +8,33 @@ import { TranscribeStreamingServiceException as __BaseException } from "./Transc
|
|
|
8
8
|
*/
|
|
9
9
|
export interface Entity {
|
|
10
10
|
/**
|
|
11
|
+
* @public
|
|
11
12
|
* <p>The start time, in milliseconds, of the utterance that was identified as PII.</p>
|
|
12
13
|
*/
|
|
13
14
|
StartTime?: number;
|
|
14
15
|
/**
|
|
16
|
+
* @public
|
|
15
17
|
* <p>The end time, in milliseconds, of the utterance that was identified as PII.</p>
|
|
16
18
|
*/
|
|
17
19
|
EndTime?: number;
|
|
18
20
|
/**
|
|
21
|
+
* @public
|
|
19
22
|
* <p>The category of information identified. The only category is <code>PII</code>.</p>
|
|
20
23
|
*/
|
|
21
24
|
Category?: string;
|
|
22
25
|
/**
|
|
26
|
+
* @public
|
|
23
27
|
* <p>The type of PII identified. For example, <code>NAME</code> or
|
|
24
28
|
* <code>CREDIT_DEBIT_NUMBER</code>.</p>
|
|
25
29
|
*/
|
|
26
30
|
Type?: string;
|
|
27
31
|
/**
|
|
32
|
+
* @public
|
|
28
33
|
* <p>The word or words identified as PII.</p>
|
|
29
34
|
*/
|
|
30
35
|
Content?: string;
|
|
31
36
|
/**
|
|
37
|
+
* @public
|
|
32
38
|
* <p>The confidence score associated with the identified PII entity in your audio.</p>
|
|
33
39
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
34
40
|
* probability that the identified entity correctly matches the entity spoken in your
|
|
@@ -55,39 +61,47 @@ export type ItemType = (typeof ItemType)[keyof typeof ItemType];
|
|
|
55
61
|
*/
|
|
56
62
|
export interface Item {
|
|
57
63
|
/**
|
|
64
|
+
* @public
|
|
58
65
|
* <p>The start time, in milliseconds, of the transcribed item.</p>
|
|
59
66
|
*/
|
|
60
67
|
StartTime?: number;
|
|
61
68
|
/**
|
|
69
|
+
* @public
|
|
62
70
|
* <p>The end time, in milliseconds, of the transcribed item.</p>
|
|
63
71
|
*/
|
|
64
72
|
EndTime?: number;
|
|
65
73
|
/**
|
|
74
|
+
* @public
|
|
66
75
|
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken words) and
|
|
67
76
|
* <code>PUNCTUATION</code>.</p>
|
|
68
77
|
*/
|
|
69
78
|
Type?: ItemType | string;
|
|
70
79
|
/**
|
|
80
|
+
* @public
|
|
71
81
|
* <p>The word or punctuation that was transcribed.</p>
|
|
72
82
|
*/
|
|
73
83
|
Content?: string;
|
|
74
84
|
/**
|
|
85
|
+
* @public
|
|
75
86
|
* <p>Indicates whether the specified item matches a word in the vocabulary filter included in
|
|
76
87
|
* your request. If <code>true</code>, there is a vocabulary filter match.</p>
|
|
77
88
|
*/
|
|
78
89
|
VocabularyFilterMatch?: boolean;
|
|
79
90
|
/**
|
|
91
|
+
* @public
|
|
80
92
|
* <p>If speaker partitioning is enabled, <code>Speaker</code> labels the speaker of the
|
|
81
93
|
* specified item.</p>
|
|
82
94
|
*/
|
|
83
95
|
Speaker?: string;
|
|
84
96
|
/**
|
|
97
|
+
* @public
|
|
85
98
|
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
86
99
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
87
100
|
* probability that the identified item correctly matches the item spoken in your media.</p>
|
|
88
101
|
*/
|
|
89
102
|
Confidence?: number;
|
|
90
103
|
/**
|
|
104
|
+
* @public
|
|
91
105
|
* <p>If partial result stabilization is enabled, <code>Stable</code> indicates whether the specified
|
|
92
106
|
* item is stable (<code>true</code>) or if it may change when the segment is complete
|
|
93
107
|
* (<code>false</code>).</p>
|
|
@@ -101,14 +115,17 @@ export interface Item {
|
|
|
101
115
|
*/
|
|
102
116
|
export interface Alternative {
|
|
103
117
|
/**
|
|
118
|
+
* @public
|
|
104
119
|
* <p>Contains transcribed text.</p>
|
|
105
120
|
*/
|
|
106
121
|
Transcript?: string;
|
|
107
122
|
/**
|
|
123
|
+
* @public
|
|
108
124
|
* <p>Contains words, phrases, or punctuation marks in your transcription output.</p>
|
|
109
125
|
*/
|
|
110
126
|
Items?: Item[];
|
|
111
127
|
/**
|
|
128
|
+
* @public
|
|
112
129
|
* <p>Contains entities identified as personally identifiable information (PII) in your transcription
|
|
113
130
|
* output.</p>
|
|
114
131
|
*/
|
|
@@ -122,6 +139,7 @@ export interface Alternative {
|
|
|
122
139
|
*/
|
|
123
140
|
export interface AudioEvent {
|
|
124
141
|
/**
|
|
142
|
+
* @public
|
|
125
143
|
* <p>An audio blob that contains the next part of the audio that you want to transcribe. The
|
|
126
144
|
* maximum audio chunk size is 32 KB.</p>
|
|
127
145
|
*/
|
|
@@ -148,10 +166,12 @@ export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantR
|
|
|
148
166
|
*/
|
|
149
167
|
export interface ChannelDefinition {
|
|
150
168
|
/**
|
|
169
|
+
* @public
|
|
151
170
|
* <p>Specify the audio channel you want to define.</p>
|
|
152
171
|
*/
|
|
153
172
|
ChannelId: number | undefined;
|
|
154
173
|
/**
|
|
174
|
+
* @public
|
|
155
175
|
* <p>Specify the speaker you want to define. Omitting this parameter is equivalent to
|
|
156
176
|
* specifying both participants.</p>
|
|
157
177
|
*/
|
|
@@ -181,6 +201,7 @@ export type ContentRedactionOutput = (typeof ContentRedactionOutput)[keyof typeo
|
|
|
181
201
|
*/
|
|
182
202
|
export interface PostCallAnalyticsSettings {
|
|
183
203
|
/**
|
|
204
|
+
* @public
|
|
184
205
|
* <p>The Amazon S3 location where you want your Call Analytics post-call
|
|
185
206
|
* transcription output stored. You can use any of the following formats to specify the output
|
|
186
207
|
* location:</p>
|
|
@@ -198,6 +219,7 @@ export interface PostCallAnalyticsSettings {
|
|
|
198
219
|
*/
|
|
199
220
|
OutputLocation: string | undefined;
|
|
200
221
|
/**
|
|
222
|
+
* @public
|
|
201
223
|
* <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
|
202
224
|
* access the Amazon S3 bucket that contains your input files. If the role that you
|
|
203
225
|
* specify doesn’t have the appropriate permissions to access the specified Amazon S3
|
|
@@ -209,6 +231,7 @@ export interface PostCallAnalyticsSettings {
|
|
|
209
231
|
*/
|
|
210
232
|
DataAccessRoleArn: string | undefined;
|
|
211
233
|
/**
|
|
234
|
+
* @public
|
|
212
235
|
* <p>Specify whether you want only a redacted transcript or both a redacted and an unredacted
|
|
213
236
|
* transcript. If you choose redacted and unredacted, two JSON files are generated and stored in the
|
|
214
237
|
* Amazon S3 output location you specify.</p>
|
|
@@ -217,6 +240,7 @@ export interface PostCallAnalyticsSettings {
|
|
|
217
240
|
*/
|
|
218
241
|
ContentRedactionOutput?: ContentRedactionOutput | string;
|
|
219
242
|
/**
|
|
243
|
+
* @public
|
|
220
244
|
* <p>The KMS key you want to use to encrypt your Call Analytics post-call
|
|
221
245
|
* output.</p>
|
|
222
246
|
* <p>If using a key located in the <b>current</b>
|
|
@@ -265,10 +289,12 @@ export interface PostCallAnalyticsSettings {
|
|
|
265
289
|
*/
|
|
266
290
|
export interface ConfigurationEvent {
|
|
267
291
|
/**
|
|
292
|
+
* @public
|
|
268
293
|
* <p>Indicates which speaker is on which audio channel.</p>
|
|
269
294
|
*/
|
|
270
295
|
ChannelDefinitions?: ChannelDefinition[];
|
|
271
296
|
/**
|
|
297
|
+
* @public
|
|
272
298
|
* <p>Provides additional optional settings for your Call Analytics post-call request, including
|
|
273
299
|
* encryption and output locations for your redacted and unredacted transcript.</p>
|
|
274
300
|
*/
|
|
@@ -286,6 +312,7 @@ export type AudioStream = AudioStream.AudioEventMember | AudioStream.Configurati
|
|
|
286
312
|
*/
|
|
287
313
|
export declare namespace AudioStream {
|
|
288
314
|
/**
|
|
315
|
+
* @public
|
|
289
316
|
* <p>A blob of audio from your application. Your audio stream consists of one or more audio
|
|
290
317
|
* events.</p>
|
|
291
318
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html">Event stream encoding</a>.</p>
|
|
@@ -296,6 +323,7 @@ export declare namespace AudioStream {
|
|
|
296
323
|
$unknown?: never;
|
|
297
324
|
}
|
|
298
325
|
/**
|
|
326
|
+
* @public
|
|
299
327
|
* <p>Contains audio channel definitions and post-call analytics settings.</p>
|
|
300
328
|
*/
|
|
301
329
|
interface ConfigurationEventMember {
|
|
@@ -303,6 +331,9 @@ export declare namespace AudioStream {
|
|
|
303
331
|
ConfigurationEvent: ConfigurationEvent;
|
|
304
332
|
$unknown?: never;
|
|
305
333
|
}
|
|
334
|
+
/**
|
|
335
|
+
* @public
|
|
336
|
+
*/
|
|
306
337
|
interface $UnknownMember {
|
|
307
338
|
AudioEvent?: never;
|
|
308
339
|
ConfigurationEvent?: never;
|
|
@@ -339,27 +370,33 @@ export declare class BadRequestException extends __BaseException {
|
|
|
339
370
|
*/
|
|
340
371
|
export interface CallAnalyticsEntity {
|
|
341
372
|
/**
|
|
373
|
+
* @public
|
|
342
374
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the identified entity.</p>
|
|
343
375
|
*/
|
|
344
376
|
BeginOffsetMillis?: number;
|
|
345
377
|
/**
|
|
378
|
+
* @public
|
|
346
379
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the identified entity.</p>
|
|
347
380
|
*/
|
|
348
381
|
EndOffsetMillis?: number;
|
|
349
382
|
/**
|
|
383
|
+
* @public
|
|
350
384
|
* <p>The category of information identified. For example, <code>PII</code>.</p>
|
|
351
385
|
*/
|
|
352
386
|
Category?: string;
|
|
353
387
|
/**
|
|
388
|
+
* @public
|
|
354
389
|
* <p>The type of PII identified. For example, <code>NAME</code> or
|
|
355
390
|
* <code>CREDIT_DEBIT_NUMBER</code>.</p>
|
|
356
391
|
*/
|
|
357
392
|
Type?: string;
|
|
358
393
|
/**
|
|
394
|
+
* @public
|
|
359
395
|
* <p>The word or words that represent the identified entity.</p>
|
|
360
396
|
*/
|
|
361
397
|
Content?: string;
|
|
362
398
|
/**
|
|
399
|
+
* @public
|
|
363
400
|
* <p>The confidence score associated with the identification of an entity in your transcript.</p>
|
|
364
401
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
365
402
|
* probability that the identified entity correctly matches the entity spoken in your
|
|
@@ -374,34 +411,41 @@ export interface CallAnalyticsEntity {
|
|
|
374
411
|
*/
|
|
375
412
|
export interface CallAnalyticsItem {
|
|
376
413
|
/**
|
|
414
|
+
* @public
|
|
377
415
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the identified item.</p>
|
|
378
416
|
*/
|
|
379
417
|
BeginOffsetMillis?: number;
|
|
380
418
|
/**
|
|
419
|
+
* @public
|
|
381
420
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the identified item.</p>
|
|
382
421
|
*/
|
|
383
422
|
EndOffsetMillis?: number;
|
|
384
423
|
/**
|
|
424
|
+
* @public
|
|
385
425
|
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken words) and
|
|
386
426
|
* <code>PUNCTUATION</code>.</p>
|
|
387
427
|
*/
|
|
388
428
|
Type?: ItemType | string;
|
|
389
429
|
/**
|
|
430
|
+
* @public
|
|
390
431
|
* <p>The word or punctuation that was transcribed.</p>
|
|
391
432
|
*/
|
|
392
433
|
Content?: string;
|
|
393
434
|
/**
|
|
435
|
+
* @public
|
|
394
436
|
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
395
437
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
396
438
|
* probability that the identified item correctly matches the item spoken in your media.</p>
|
|
397
439
|
*/
|
|
398
440
|
Confidence?: number;
|
|
399
441
|
/**
|
|
442
|
+
* @public
|
|
400
443
|
* <p>Indicates whether the specified item matches a word in the vocabulary filter included in
|
|
401
444
|
* your Call Analytics request. If <code>true</code>, there is a vocabulary filter match.</p>
|
|
402
445
|
*/
|
|
403
446
|
VocabularyFilterMatch?: boolean;
|
|
404
447
|
/**
|
|
448
|
+
* @public
|
|
405
449
|
* <p>If partial result stabilization is enabled, <code>Stable</code> indicates whether the specified
|
|
406
450
|
* item is stable (<code>true</code>) or if it may change when the segment is complete
|
|
407
451
|
* (<code>false</code>).</p>
|
|
@@ -433,11 +477,13 @@ export type CallAnalyticsLanguageCode = (typeof CallAnalyticsLanguageCode)[keyof
|
|
|
433
477
|
*/
|
|
434
478
|
export interface TimestampRange {
|
|
435
479
|
/**
|
|
480
|
+
* @public
|
|
436
481
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the category
|
|
437
482
|
* match.</p>
|
|
438
483
|
*/
|
|
439
484
|
BeginOffsetMillis?: number;
|
|
440
485
|
/**
|
|
486
|
+
* @public
|
|
441
487
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the end of the category
|
|
442
488
|
* match.</p>
|
|
443
489
|
*/
|
|
@@ -449,6 +495,7 @@ export interface TimestampRange {
|
|
|
449
495
|
*/
|
|
450
496
|
export interface PointsOfInterest {
|
|
451
497
|
/**
|
|
498
|
+
* @public
|
|
452
499
|
* <p>Contains the timestamp ranges (start time through end time) of matched categories and rules.</p>
|
|
453
500
|
*/
|
|
454
501
|
TimestampRanges?: TimestampRange[];
|
|
@@ -460,10 +507,12 @@ export interface PointsOfInterest {
|
|
|
460
507
|
*/
|
|
461
508
|
export interface CategoryEvent {
|
|
462
509
|
/**
|
|
510
|
+
* @public
|
|
463
511
|
* <p>Lists the categories that were matched in your audio segment.</p>
|
|
464
512
|
*/
|
|
465
513
|
MatchedCategories?: string[];
|
|
466
514
|
/**
|
|
515
|
+
* @public
|
|
467
516
|
* <p>Contains information about the matched categories, including category names and timestamps.</p>
|
|
468
517
|
*/
|
|
469
518
|
MatchedDetails?: Record<string, PointsOfInterest>;
|
|
@@ -529,11 +578,13 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
529
578
|
*/
|
|
530
579
|
export interface CharacterOffsets {
|
|
531
580
|
/**
|
|
581
|
+
* @public
|
|
532
582
|
* <p>Provides the character count of the first character where a match is identified. For example, the first
|
|
533
583
|
* character associated with an issue or a category match in a segment transcript.</p>
|
|
534
584
|
*/
|
|
535
585
|
Begin?: number;
|
|
536
586
|
/**
|
|
587
|
+
* @public
|
|
537
588
|
* <p>Provides the character count of the last character where a match is identified. For example, the last
|
|
538
589
|
* character associated with an issue or a category match in a segment transcript.</p>
|
|
539
590
|
*/
|
|
@@ -545,6 +596,7 @@ export interface CharacterOffsets {
|
|
|
545
596
|
*/
|
|
546
597
|
export interface IssueDetected {
|
|
547
598
|
/**
|
|
599
|
+
* @public
|
|
548
600
|
* <p>Provides the timestamps that identify when in an audio segment the specified issue occurs.</p>
|
|
549
601
|
*/
|
|
550
602
|
CharacterOffsets?: CharacterOffsets;
|
|
@@ -571,48 +623,58 @@ export type Sentiment = (typeof Sentiment)[keyof typeof Sentiment];
|
|
|
571
623
|
*/
|
|
572
624
|
export interface UtteranceEvent {
|
|
573
625
|
/**
|
|
626
|
+
* @public
|
|
574
627
|
* <p>The unique identifier that is associated with the specified <code>UtteranceEvent</code>.</p>
|
|
575
628
|
*/
|
|
576
629
|
UtteranceId?: string;
|
|
577
630
|
/**
|
|
631
|
+
* @public
|
|
578
632
|
* <p>Indicates whether the segment in the <code>UtteranceEvent</code> is complete
|
|
579
633
|
* (<code>FALSE</code>) or partial (<code>TRUE</code>).</p>
|
|
580
634
|
*/
|
|
581
635
|
IsPartial?: boolean;
|
|
582
636
|
/**
|
|
637
|
+
* @public
|
|
583
638
|
* <p>Provides the role of the speaker for each audio channel, either <code>CUSTOMER</code> or
|
|
584
639
|
* <code>AGENT</code>.</p>
|
|
585
640
|
*/
|
|
586
641
|
ParticipantRole?: ParticipantRole | string;
|
|
587
642
|
/**
|
|
643
|
+
* @public
|
|
588
644
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the
|
|
589
645
|
* <code>UtteranceEvent</code>.</p>
|
|
590
646
|
*/
|
|
591
647
|
BeginOffsetMillis?: number;
|
|
592
648
|
/**
|
|
649
|
+
* @public
|
|
593
650
|
* <p>The time, in milliseconds, from the beginning of the audio stream to the start of the
|
|
594
651
|
* <code>UtteranceEvent</code>.</p>
|
|
595
652
|
*/
|
|
596
653
|
EndOffsetMillis?: number;
|
|
597
654
|
/**
|
|
655
|
+
* @public
|
|
598
656
|
* <p>Contains transcribed text.</p>
|
|
599
657
|
*/
|
|
600
658
|
Transcript?: string;
|
|
601
659
|
/**
|
|
660
|
+
* @public
|
|
602
661
|
* <p>Contains words, phrases, or punctuation marks that are associated with the specified
|
|
603
662
|
* <code>UtteranceEvent</code>.</p>
|
|
604
663
|
*/
|
|
605
664
|
Items?: CallAnalyticsItem[];
|
|
606
665
|
/**
|
|
666
|
+
* @public
|
|
607
667
|
* <p>Contains entities identified as personally identifiable information (PII) in your transcription
|
|
608
668
|
* output.</p>
|
|
609
669
|
*/
|
|
610
670
|
Entities?: CallAnalyticsEntity[];
|
|
611
671
|
/**
|
|
672
|
+
* @public
|
|
612
673
|
* <p>Provides the sentiment that was detected in the specified segment.</p>
|
|
613
674
|
*/
|
|
614
675
|
Sentiment?: Sentiment | string;
|
|
615
676
|
/**
|
|
677
|
+
* @public
|
|
616
678
|
* <p>Provides the issue that was detected in the specified segment.</p>
|
|
617
679
|
*/
|
|
618
680
|
IssuesDetected?: IssueDetected[];
|
|
@@ -628,6 +690,7 @@ export type CallAnalyticsTranscriptResultStream = CallAnalyticsTranscriptResultS
|
|
|
628
690
|
*/
|
|
629
691
|
export declare namespace CallAnalyticsTranscriptResultStream {
|
|
630
692
|
/**
|
|
693
|
+
* @public
|
|
631
694
|
* <p>Contains set of transcription results from one or more audio segments, along with additional
|
|
632
695
|
* information per your request parameters. This can include information relating to channel definitions,
|
|
633
696
|
* partial result stabilization, sentiment, issue detection, and other transcription-related data.</p>
|
|
@@ -643,6 +706,7 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
643
706
|
$unknown?: never;
|
|
644
707
|
}
|
|
645
708
|
/**
|
|
709
|
+
* @public
|
|
646
710
|
* <p>Provides information on matched categories that were used to generate real-time supervisor
|
|
647
711
|
* alerts.</p>
|
|
648
712
|
*/
|
|
@@ -657,6 +721,7 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
657
721
|
$unknown?: never;
|
|
658
722
|
}
|
|
659
723
|
/**
|
|
724
|
+
* @public
|
|
660
725
|
* <p>One or more arguments to the <code>StartStreamTranscription</code>,
|
|
661
726
|
* <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
|
|
662
727
|
* operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
|
|
@@ -673,6 +738,7 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
673
738
|
$unknown?: never;
|
|
674
739
|
}
|
|
675
740
|
/**
|
|
741
|
+
* @public
|
|
676
742
|
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
677
743
|
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
678
744
|
*/
|
|
@@ -687,6 +753,7 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
687
753
|
$unknown?: never;
|
|
688
754
|
}
|
|
689
755
|
/**
|
|
756
|
+
* @public
|
|
690
757
|
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
691
758
|
* processing.</p>
|
|
692
759
|
*/
|
|
@@ -701,6 +768,7 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
701
768
|
$unknown?: never;
|
|
702
769
|
}
|
|
703
770
|
/**
|
|
771
|
+
* @public
|
|
704
772
|
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
705
773
|
*/
|
|
706
774
|
interface ConflictExceptionMember {
|
|
@@ -714,6 +782,7 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
714
782
|
$unknown?: never;
|
|
715
783
|
}
|
|
716
784
|
/**
|
|
785
|
+
* @public
|
|
717
786
|
* <p>The service is currently unavailable. Try your request later.</p>
|
|
718
787
|
*/
|
|
719
788
|
interface ServiceUnavailableExceptionMember {
|
|
@@ -726,6 +795,9 @@ export declare namespace CallAnalyticsTranscriptResultStream {
|
|
|
726
795
|
ServiceUnavailableException: ServiceUnavailableException;
|
|
727
796
|
$unknown?: never;
|
|
728
797
|
}
|
|
798
|
+
/**
|
|
799
|
+
* @public
|
|
800
|
+
*/
|
|
729
801
|
interface $UnknownMember {
|
|
730
802
|
UtteranceEvent?: never;
|
|
731
803
|
CategoryEvent?: never;
|
|
@@ -802,10 +874,12 @@ export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
|
|
|
802
874
|
*/
|
|
803
875
|
export interface LanguageWithScore {
|
|
804
876
|
/**
|
|
877
|
+
* @public
|
|
805
878
|
* <p>The language code of the identified language.</p>
|
|
806
879
|
*/
|
|
807
880
|
LanguageCode?: LanguageCode | string;
|
|
808
881
|
/**
|
|
882
|
+
* @public
|
|
809
883
|
* <p>The confidence score associated with the identified language code. Confidence scores are values
|
|
810
884
|
* between zero and one; larger values indicate a higher confidence in the identified language.</p>
|
|
811
885
|
*/
|
|
@@ -832,22 +906,27 @@ export type MediaEncoding = (typeof MediaEncoding)[keyof typeof MediaEncoding];
|
|
|
832
906
|
*/
|
|
833
907
|
export interface MedicalEntity {
|
|
834
908
|
/**
|
|
909
|
+
* @public
|
|
835
910
|
* <p>The start time, in milliseconds, of the utterance that was identified as PHI.</p>
|
|
836
911
|
*/
|
|
837
912
|
StartTime?: number;
|
|
838
913
|
/**
|
|
914
|
+
* @public
|
|
839
915
|
* <p>The end time, in milliseconds, of the utterance that was identified as PHI.</p>
|
|
840
916
|
*/
|
|
841
917
|
EndTime?: number;
|
|
842
918
|
/**
|
|
919
|
+
* @public
|
|
843
920
|
* <p>The category of information identified. The only category is <code>PHI</code>.</p>
|
|
844
921
|
*/
|
|
845
922
|
Category?: string;
|
|
846
923
|
/**
|
|
924
|
+
* @public
|
|
847
925
|
* <p>The word or words identified as PHI.</p>
|
|
848
926
|
*/
|
|
849
927
|
Content?: string;
|
|
850
928
|
/**
|
|
929
|
+
* @public
|
|
851
930
|
* <p>The confidence score associated with the identified PHI entity in your audio.</p>
|
|
852
931
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
853
932
|
* probability that the identified entity correctly matches the entity spoken in your
|
|
@@ -862,23 +941,28 @@ export interface MedicalEntity {
|
|
|
862
941
|
*/
|
|
863
942
|
export interface MedicalItem {
|
|
864
943
|
/**
|
|
944
|
+
* @public
|
|
865
945
|
* <p>The start time, in milliseconds, of the transcribed item.</p>
|
|
866
946
|
*/
|
|
867
947
|
StartTime?: number;
|
|
868
948
|
/**
|
|
949
|
+
* @public
|
|
869
950
|
* <p>The end time, in milliseconds, of the transcribed item.</p>
|
|
870
951
|
*/
|
|
871
952
|
EndTime?: number;
|
|
872
953
|
/**
|
|
954
|
+
* @public
|
|
873
955
|
* <p>The type of item identified. Options are: <code>PRONUNCIATION</code> (spoken
|
|
874
956
|
* words) and <code>PUNCTUATION</code>.</p>
|
|
875
957
|
*/
|
|
876
958
|
Type?: ItemType | string;
|
|
877
959
|
/**
|
|
960
|
+
* @public
|
|
878
961
|
* <p>The word or punctuation that was transcribed.</p>
|
|
879
962
|
*/
|
|
880
963
|
Content?: string;
|
|
881
964
|
/**
|
|
965
|
+
* @public
|
|
882
966
|
* <p>The confidence score associated with a word or phrase in your transcript.</p>
|
|
883
967
|
* <p>Confidence scores are values between 0 and 1. A larger value indicates a higher
|
|
884
968
|
* probability that the identified item correctly matches the item spoken in your
|
|
@@ -886,6 +970,7 @@ export interface MedicalItem {
|
|
|
886
970
|
*/
|
|
887
971
|
Confidence?: number;
|
|
888
972
|
/**
|
|
973
|
+
* @public
|
|
889
974
|
* <p>If speaker partitioning is enabled, <code>Speaker</code> labels the speaker of the
|
|
890
975
|
* specified item.</p>
|
|
891
976
|
*/
|
|
@@ -899,14 +984,17 @@ export interface MedicalItem {
|
|
|
899
984
|
*/
|
|
900
985
|
export interface MedicalAlternative {
|
|
901
986
|
/**
|
|
987
|
+
* @public
|
|
902
988
|
* <p>Contains transcribed text.</p>
|
|
903
989
|
*/
|
|
904
990
|
Transcript?: string;
|
|
905
991
|
/**
|
|
992
|
+
* @public
|
|
906
993
|
* <p>Contains words, phrases, or punctuation marks in your transcription output.</p>
|
|
907
994
|
*/
|
|
908
995
|
Items?: MedicalItem[];
|
|
909
996
|
/**
|
|
997
|
+
* @public
|
|
910
998
|
* <p>Contains entities identified as personal health information (PHI) in your transcription
|
|
911
999
|
* output.</p>
|
|
912
1000
|
*/
|
|
@@ -934,30 +1022,36 @@ export type MedicalContentIdentificationType = (typeof MedicalContentIdentificat
|
|
|
934
1022
|
*/
|
|
935
1023
|
export interface MedicalResult {
|
|
936
1024
|
/**
|
|
1025
|
+
* @public
|
|
937
1026
|
* <p>Provides a unique identifier for the <code>Result</code>.</p>
|
|
938
1027
|
*/
|
|
939
1028
|
ResultId?: string;
|
|
940
1029
|
/**
|
|
1030
|
+
* @public
|
|
941
1031
|
* <p>The start time, in milliseconds, of the <code>Result</code>.</p>
|
|
942
1032
|
*/
|
|
943
1033
|
StartTime?: number;
|
|
944
1034
|
/**
|
|
1035
|
+
* @public
|
|
945
1036
|
* <p>The end time, in milliseconds, of the <code>Result</code>.</p>
|
|
946
1037
|
*/
|
|
947
1038
|
EndTime?: number;
|
|
948
1039
|
/**
|
|
1040
|
+
* @public
|
|
949
1041
|
* <p>Indicates if the segment is complete.</p>
|
|
950
1042
|
* <p>If <code>IsPartial</code> is <code>true</code>, the segment is not complete. If
|
|
951
1043
|
* <code>IsPartial</code> is <code>false</code>, the segment is complete.</p>
|
|
952
1044
|
*/
|
|
953
1045
|
IsPartial?: boolean;
|
|
954
1046
|
/**
|
|
1047
|
+
* @public
|
|
955
1048
|
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may
|
|
956
1049
|
* contain one or more of <code>Items</code>, <code>Entities</code>, or
|
|
957
1050
|
* <code>Transcript</code>.</p>
|
|
958
1051
|
*/
|
|
959
1052
|
Alternatives?: MedicalAlternative[];
|
|
960
1053
|
/**
|
|
1054
|
+
* @public
|
|
961
1055
|
* <p>Indicates the channel identified for the <code>Result</code>.</p>
|
|
962
1056
|
*/
|
|
963
1057
|
ChannelId?: string;
|
|
@@ -973,6 +1067,7 @@ export interface MedicalResult {
|
|
|
973
1067
|
*/
|
|
974
1068
|
export interface MedicalTranscript {
|
|
975
1069
|
/**
|
|
1070
|
+
* @public
|
|
976
1071
|
* <p>Contains a set of transcription results from one or more audio segments, along with
|
|
977
1072
|
* additional information per your request parameters. This can include information relating to
|
|
978
1073
|
* alternative transcriptions, channel identification, partial result stabilization, language
|
|
@@ -989,6 +1084,7 @@ export interface MedicalTranscript {
|
|
|
989
1084
|
*/
|
|
990
1085
|
export interface MedicalTranscriptEvent {
|
|
991
1086
|
/**
|
|
1087
|
+
* @public
|
|
992
1088
|
* <p>Contains <code>Results</code>, which contains a set of transcription results from one or
|
|
993
1089
|
* more audio segments, along with additional information per your request parameters. This can
|
|
994
1090
|
* include information relating to alternative transcriptions, channel identification, partial result
|
|
@@ -1006,6 +1102,7 @@ export type MedicalTranscriptResultStream = MedicalTranscriptResultStream.BadReq
|
|
|
1006
1102
|
*/
|
|
1007
1103
|
export declare namespace MedicalTranscriptResultStream {
|
|
1008
1104
|
/**
|
|
1105
|
+
* @public
|
|
1009
1106
|
* <p>The <code>MedicalTranscriptEvent</code> associated with a
|
|
1010
1107
|
* <code>MedicalTranscriptResultStream</code>.</p>
|
|
1011
1108
|
* <p>Contains a set of transcription results from one or more audio segments, along with
|
|
@@ -1023,6 +1120,7 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1023
1120
|
$unknown?: never;
|
|
1024
1121
|
}
|
|
1025
1122
|
/**
|
|
1123
|
+
* @public
|
|
1026
1124
|
* <p>One or more arguments to the <code>StartStreamTranscription</code>,
|
|
1027
1125
|
* <code>StartMedicalStreamTranscription</code>, or <code>StartCallAnalyticsStreamTranscription</code>
|
|
1028
1126
|
* operation was not valid. For example, <code>MediaEncoding</code> or <code>LanguageCode</code>
|
|
@@ -1038,6 +1136,7 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1038
1136
|
$unknown?: never;
|
|
1039
1137
|
}
|
|
1040
1138
|
/**
|
|
1139
|
+
* @public
|
|
1041
1140
|
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
1042
1141
|
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
1043
1142
|
*/
|
|
@@ -1051,6 +1150,7 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1051
1150
|
$unknown?: never;
|
|
1052
1151
|
}
|
|
1053
1152
|
/**
|
|
1153
|
+
* @public
|
|
1054
1154
|
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
1055
1155
|
* processing.</p>
|
|
1056
1156
|
*/
|
|
@@ -1064,6 +1164,7 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1064
1164
|
$unknown?: never;
|
|
1065
1165
|
}
|
|
1066
1166
|
/**
|
|
1167
|
+
* @public
|
|
1067
1168
|
* <p>A new stream started with the same session ID. The current stream has been terminated.</p>
|
|
1068
1169
|
*/
|
|
1069
1170
|
interface ConflictExceptionMember {
|
|
@@ -1076,6 +1177,7 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1076
1177
|
$unknown?: never;
|
|
1077
1178
|
}
|
|
1078
1179
|
/**
|
|
1180
|
+
* @public
|
|
1079
1181
|
* <p>The service is currently unavailable. Try your request later.</p>
|
|
1080
1182
|
*/
|
|
1081
1183
|
interface ServiceUnavailableExceptionMember {
|
|
@@ -1087,6 +1189,9 @@ export declare namespace MedicalTranscriptResultStream {
|
|
|
1087
1189
|
ServiceUnavailableException: ServiceUnavailableException;
|
|
1088
1190
|
$unknown?: never;
|
|
1089
1191
|
}
|
|
1192
|
+
/**
|
|
1193
|
+
* @public
|
|
1194
|
+
*/
|
|
1090
1195
|
interface $UnknownMember {
|
|
1091
1196
|
TranscriptEvent?: never;
|
|
1092
1197
|
BadRequestException?: never;
|
|
@@ -1131,37 +1236,45 @@ export type PartialResultsStability = (typeof PartialResultsStability)[keyof typ
|
|
|
1131
1236
|
*/
|
|
1132
1237
|
export interface Result {
|
|
1133
1238
|
/**
|
|
1239
|
+
* @public
|
|
1134
1240
|
* <p>Provides a unique identifier for the <code>Result</code>.</p>
|
|
1135
1241
|
*/
|
|
1136
1242
|
ResultId?: string;
|
|
1137
1243
|
/**
|
|
1244
|
+
* @public
|
|
1138
1245
|
* <p>The start time, in milliseconds, of the <code>Result</code>.</p>
|
|
1139
1246
|
*/
|
|
1140
1247
|
StartTime?: number;
|
|
1141
1248
|
/**
|
|
1249
|
+
* @public
|
|
1142
1250
|
* <p>The end time, in milliseconds, of the <code>Result</code>.</p>
|
|
1143
1251
|
*/
|
|
1144
1252
|
EndTime?: number;
|
|
1145
1253
|
/**
|
|
1254
|
+
* @public
|
|
1146
1255
|
* <p>Indicates if the segment is complete.</p>
|
|
1147
1256
|
* <p>If <code>IsPartial</code> is <code>true</code>, the segment is not complete. If
|
|
1148
1257
|
* <code>IsPartial</code> is <code>false</code>, the segment is complete.</p>
|
|
1149
1258
|
*/
|
|
1150
1259
|
IsPartial?: boolean;
|
|
1151
1260
|
/**
|
|
1261
|
+
* @public
|
|
1152
1262
|
* <p>A list of possible alternative transcriptions for the input audio. Each alternative may contain
|
|
1153
1263
|
* one or more of <code>Items</code>, <code>Entities</code>, or <code>Transcript</code>.</p>
|
|
1154
1264
|
*/
|
|
1155
1265
|
Alternatives?: Alternative[];
|
|
1156
1266
|
/**
|
|
1267
|
+
* @public
|
|
1157
1268
|
* <p>Indicates which audio channel is associated with the <code>Result</code>.</p>
|
|
1158
1269
|
*/
|
|
1159
1270
|
ChannelId?: string;
|
|
1160
1271
|
/**
|
|
1272
|
+
* @public
|
|
1161
1273
|
* <p>The language code that represents the language spoken in your audio stream.</p>
|
|
1162
1274
|
*/
|
|
1163
1275
|
LanguageCode?: LanguageCode | string;
|
|
1164
1276
|
/**
|
|
1277
|
+
* @public
|
|
1165
1278
|
* <p>The language code of the dominant language identified in your stream.</p>
|
|
1166
1279
|
* <p>If you enabled channel identification and each channel of your audio contains a different language,
|
|
1167
1280
|
* you may have more than one result.</p>
|
|
@@ -1202,6 +1315,7 @@ export type VocabularyFilterMethod = (typeof VocabularyFilterMethod)[keyof typeo
|
|
|
1202
1315
|
*/
|
|
1203
1316
|
export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
1204
1317
|
/**
|
|
1318
|
+
* @public
|
|
1205
1319
|
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
1206
1320
|
* <p>If you're unsure of the language spoken in your audio, consider using
|
|
1207
1321
|
* <code>IdentifyLanguage</code> to enable automatic language identification.</p>
|
|
@@ -1211,12 +1325,14 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1211
1325
|
*/
|
|
1212
1326
|
LanguageCode: CallAnalyticsLanguageCode | string | undefined;
|
|
1213
1327
|
/**
|
|
1328
|
+
* @public
|
|
1214
1329
|
* <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio,
|
|
1215
1330
|
* is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz.
|
|
1216
1331
|
* Note that the sample rate you specify must match that of your audio.</p>
|
|
1217
1332
|
*/
|
|
1218
1333
|
MediaSampleRateHertz: number | undefined;
|
|
1219
1334
|
/**
|
|
1335
|
+
* @public
|
|
1220
1336
|
* <p>Specify the encoding of your input audio. Supported formats are:</p>
|
|
1221
1337
|
* <ul>
|
|
1222
1338
|
* <li>
|
|
@@ -1233,6 +1349,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1233
1349
|
*/
|
|
1234
1350
|
MediaEncoding: MediaEncoding | string | undefined;
|
|
1235
1351
|
/**
|
|
1352
|
+
* @public
|
|
1236
1353
|
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
1237
1354
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1238
1355
|
* <p>If the language of the specified custom vocabulary doesn't match the language identified in
|
|
@@ -1241,18 +1358,21 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1241
1358
|
*/
|
|
1242
1359
|
VocabularyName?: string;
|
|
1243
1360
|
/**
|
|
1361
|
+
* @public
|
|
1244
1362
|
* <p>Specify a name for your Call Analytics transcription session. If you don't include this parameter
|
|
1245
1363
|
* in your request, Amazon Transcribe generates an ID and returns it in the response.</p>
|
|
1246
1364
|
* <p>You can use a session ID to retry a streaming session.</p>
|
|
1247
1365
|
*/
|
|
1248
1366
|
SessionId?: string;
|
|
1249
1367
|
/**
|
|
1368
|
+
* @public
|
|
1250
1369
|
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
1251
1370
|
* data frames.</p>
|
|
1252
1371
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
1253
1372
|
*/
|
|
1254
1373
|
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
1255
1374
|
/**
|
|
1375
|
+
* @public
|
|
1256
1376
|
* <p>Specify the name of the custom vocabulary filter that you want to use when processing your
|
|
1257
1377
|
* transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
1258
1378
|
* <p>If the language of the specified custom vocabulary filter doesn't match the language identified in
|
|
@@ -1262,6 +1382,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1262
1382
|
*/
|
|
1263
1383
|
VocabularyFilterName?: string;
|
|
1264
1384
|
/**
|
|
1385
|
+
* @public
|
|
1265
1386
|
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
1266
1387
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
1267
1388
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
@@ -1269,6 +1390,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1269
1390
|
*/
|
|
1270
1391
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
1271
1392
|
/**
|
|
1393
|
+
* @public
|
|
1272
1394
|
* <p>Specify the name of the custom language model that you want to use when processing your
|
|
1273
1395
|
* transcription. Note that language model names are case sensitive.</p>
|
|
1274
1396
|
* <p>The language of the specified language model must match the language code you specify
|
|
@@ -1278,6 +1400,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1278
1400
|
*/
|
|
1279
1401
|
LanguageModelName?: string;
|
|
1280
1402
|
/**
|
|
1403
|
+
* @public
|
|
1281
1404
|
* <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce
|
|
1282
1405
|
* latency in your output, but may impact accuracy. For more information, see
|
|
1283
1406
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
@@ -1285,6 +1408,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1285
1408
|
*/
|
|
1286
1409
|
EnablePartialResultsStabilization?: boolean;
|
|
1287
1410
|
/**
|
|
1411
|
+
* @public
|
|
1288
1412
|
* <p>Specify the level of stability to use when you enable partial results stabilization
|
|
1289
1413
|
* (<code>EnablePartialResultsStabilization</code>).</p>
|
|
1290
1414
|
* <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly
|
|
@@ -1294,6 +1418,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1294
1418
|
*/
|
|
1295
1419
|
PartialResultsStability?: PartialResultsStability | string;
|
|
1296
1420
|
/**
|
|
1421
|
+
* @public
|
|
1297
1422
|
* <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
|
|
1298
1423
|
* <p>Content identification is performed at the segment level; PII specified in
|
|
1299
1424
|
* <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
|
|
@@ -1305,6 +1430,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1305
1430
|
*/
|
|
1306
1431
|
ContentIdentificationType?: ContentIdentificationType | string;
|
|
1307
1432
|
/**
|
|
1433
|
+
* @public
|
|
1308
1434
|
* <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
|
|
1309
1435
|
* <p>Content redaction is performed at the segment level; PII specified in
|
|
1310
1436
|
* <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
|
|
@@ -1316,6 +1442,7 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1316
1442
|
*/
|
|
1317
1443
|
ContentRedactionType?: ContentRedactionType | string;
|
|
1318
1444
|
/**
|
|
1445
|
+
* @public
|
|
1319
1446
|
* <p>Specify which types of personally identifiable information (PII) you want to redact in your
|
|
1320
1447
|
* transcript. You can include as many types as you'd like, or you can select
|
|
1321
1448
|
* <code>ALL</code>.</p>
|
|
@@ -1335,64 +1462,79 @@ export interface StartCallAnalyticsStreamTranscriptionRequest {
|
|
|
1335
1462
|
*/
|
|
1336
1463
|
export interface StartCallAnalyticsStreamTranscriptionResponse {
|
|
1337
1464
|
/**
|
|
1465
|
+
* @public
|
|
1338
1466
|
* <p>Provides the identifier for your Call Analytics streaming request.</p>
|
|
1339
1467
|
*/
|
|
1340
1468
|
RequestId?: string;
|
|
1341
1469
|
/**
|
|
1470
|
+
* @public
|
|
1342
1471
|
* <p>Provides the language code that you specified in your Call Analytics request.</p>
|
|
1343
1472
|
*/
|
|
1344
1473
|
LanguageCode?: CallAnalyticsLanguageCode | string;
|
|
1345
1474
|
/**
|
|
1475
|
+
* @public
|
|
1346
1476
|
* <p>Provides the sample rate that you specified in your Call Analytics request.</p>
|
|
1347
1477
|
*/
|
|
1348
1478
|
MediaSampleRateHertz?: number;
|
|
1349
1479
|
/**
|
|
1480
|
+
* @public
|
|
1350
1481
|
* <p>Provides the media encoding you specified in your Call Analytics request.</p>
|
|
1351
1482
|
*/
|
|
1352
1483
|
MediaEncoding?: MediaEncoding | string;
|
|
1353
1484
|
/**
|
|
1485
|
+
* @public
|
|
1354
1486
|
* <p>Provides the name of the custom vocabulary that you specified in your Call Analytics request.</p>
|
|
1355
1487
|
*/
|
|
1356
1488
|
VocabularyName?: string;
|
|
1357
1489
|
/**
|
|
1490
|
+
* @public
|
|
1358
1491
|
* <p>Provides the identifier for your Call Analytics transcription session.</p>
|
|
1359
1492
|
*/
|
|
1360
1493
|
SessionId?: string;
|
|
1361
1494
|
/**
|
|
1495
|
+
* @public
|
|
1362
1496
|
* <p>Provides detailed information about your Call Analytics streaming session.</p>
|
|
1363
1497
|
*/
|
|
1364
1498
|
CallAnalyticsTranscriptResultStream?: AsyncIterable<CallAnalyticsTranscriptResultStream>;
|
|
1365
1499
|
/**
|
|
1500
|
+
* @public
|
|
1366
1501
|
* <p>Provides the name of the custom vocabulary filter that you specified in your Call Analytics
|
|
1367
1502
|
* request.</p>
|
|
1368
1503
|
*/
|
|
1369
1504
|
VocabularyFilterName?: string;
|
|
1370
1505
|
/**
|
|
1506
|
+
* @public
|
|
1371
1507
|
* <p>Provides the vocabulary filtering method used in your Call Analytics transcription.</p>
|
|
1372
1508
|
*/
|
|
1373
1509
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
1374
1510
|
/**
|
|
1511
|
+
* @public
|
|
1375
1512
|
* <p>Provides the name of the custom language model that you specified in your Call Analytics
|
|
1376
1513
|
* request.</p>
|
|
1377
1514
|
*/
|
|
1378
1515
|
LanguageModelName?: string;
|
|
1379
1516
|
/**
|
|
1517
|
+
* @public
|
|
1380
1518
|
* <p>Shows whether partial results stabilization was enabled for your Call Analytics transcription.</p>
|
|
1381
1519
|
*/
|
|
1382
1520
|
EnablePartialResultsStabilization?: boolean;
|
|
1383
1521
|
/**
|
|
1522
|
+
* @public
|
|
1384
1523
|
* <p>Provides the stabilization level used for your transcription.</p>
|
|
1385
1524
|
*/
|
|
1386
1525
|
PartialResultsStability?: PartialResultsStability | string;
|
|
1387
1526
|
/**
|
|
1527
|
+
* @public
|
|
1388
1528
|
* <p>Shows whether content identification was enabled for your Call Analytics transcription.</p>
|
|
1389
1529
|
*/
|
|
1390
1530
|
ContentIdentificationType?: ContentIdentificationType | string;
|
|
1391
1531
|
/**
|
|
1532
|
+
* @public
|
|
1392
1533
|
* <p>Shows whether content redaction was enabled for your Call Analytics transcription.</p>
|
|
1393
1534
|
*/
|
|
1394
1535
|
ContentRedactionType?: ContentRedactionType | string;
|
|
1395
1536
|
/**
|
|
1537
|
+
* @public
|
|
1396
1538
|
* <p>Lists the PII entity types you specified in your Call Analytics request.</p>
|
|
1397
1539
|
*/
|
|
1398
1540
|
PiiEntityTypes?: string;
|
|
@@ -1414,6 +1556,7 @@ export type Type = (typeof Type)[keyof typeof Type];
|
|
|
1414
1556
|
*/
|
|
1415
1557
|
export interface StartMedicalStreamTranscriptionRequest {
|
|
1416
1558
|
/**
|
|
1559
|
+
* @public
|
|
1417
1560
|
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
1418
1561
|
* <important>
|
|
1419
1562
|
* <p>Amazon Transcribe Medical only supports US English (<code>en-US</code>).</p>
|
|
@@ -1421,12 +1564,14 @@ export interface StartMedicalStreamTranscriptionRequest {
|
|
|
1421
1564
|
*/
|
|
1422
1565
|
LanguageCode: LanguageCode | string | undefined;
|
|
1423
1566
|
/**
|
|
1567
|
+
* @public
|
|
1424
1568
|
* <p>The sample rate of the input audio (in hertz). Amazon Transcribe Medical supports a
|
|
1425
1569
|
* range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that
|
|
1426
1570
|
* of your audio.</p>
|
|
1427
1571
|
*/
|
|
1428
1572
|
MediaSampleRateHertz: number | undefined;
|
|
1429
1573
|
/**
|
|
1574
|
+
* @public
|
|
1430
1575
|
* <p>Specify the encoding used for the input audio. Supported formats are:</p>
|
|
1431
1576
|
* <ul>
|
|
1432
1577
|
* <li>
|
|
@@ -1444,27 +1589,32 @@ export interface StartMedicalStreamTranscriptionRequest {
|
|
|
1444
1589
|
*/
|
|
1445
1590
|
MediaEncoding: MediaEncoding | string | undefined;
|
|
1446
1591
|
/**
|
|
1592
|
+
* @public
|
|
1447
1593
|
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
1448
1594
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1449
1595
|
*/
|
|
1450
1596
|
VocabularyName?: string;
|
|
1451
1597
|
/**
|
|
1598
|
+
* @public
|
|
1452
1599
|
* <p>Specify the medical specialty contained in your audio.</p>
|
|
1453
1600
|
*/
|
|
1454
1601
|
Specialty: Specialty | string | undefined;
|
|
1455
1602
|
/**
|
|
1603
|
+
* @public
|
|
1456
1604
|
* <p>Specify the type of input audio. For example, choose <code>DICTATION</code> for a
|
|
1457
1605
|
* provider dictating patient notes and <code>CONVERSATION</code> for a dialogue between a
|
|
1458
1606
|
* patient and a medical professional.</p>
|
|
1459
1607
|
*/
|
|
1460
1608
|
Type: Type | string | undefined;
|
|
1461
1609
|
/**
|
|
1610
|
+
* @public
|
|
1462
1611
|
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
|
|
1463
1612
|
* partitioning labels the speech from individual speakers in your media file.</p>
|
|
1464
1613
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
|
|
1465
1614
|
*/
|
|
1466
1615
|
ShowSpeakerLabel?: boolean;
|
|
1467
1616
|
/**
|
|
1617
|
+
* @public
|
|
1468
1618
|
* <p>Specify a name for your transcription session. If you don't include this parameter in
|
|
1469
1619
|
* your request, Amazon Transcribe Medical generates an ID and returns it in the
|
|
1470
1620
|
* response.</p>
|
|
@@ -1472,12 +1622,14 @@ export interface StartMedicalStreamTranscriptionRequest {
|
|
|
1472
1622
|
*/
|
|
1473
1623
|
SessionId?: string;
|
|
1474
1624
|
/**
|
|
1625
|
+
* @public
|
|
1475
1626
|
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
1476
1627
|
* data frames.</p>
|
|
1477
1628
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
1478
1629
|
*/
|
|
1479
1630
|
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
1480
1631
|
/**
|
|
1632
|
+
* @public
|
|
1481
1633
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
1482
1634
|
* <p>Channel identification transcribes the audio on each channel independently, then appends
|
|
1483
1635
|
* the output for each channel into one transcript.</p>
|
|
@@ -1487,11 +1639,13 @@ export interface StartMedicalStreamTranscriptionRequest {
|
|
|
1487
1639
|
*/
|
|
1488
1640
|
EnableChannelIdentification?: boolean;
|
|
1489
1641
|
/**
|
|
1642
|
+
* @public
|
|
1490
1643
|
* <p>Specify the number of channels in your audio stream. Up to two channels are
|
|
1491
1644
|
* supported.</p>
|
|
1492
1645
|
*/
|
|
1493
1646
|
NumberOfChannels?: number;
|
|
1494
1647
|
/**
|
|
1648
|
+
* @public
|
|
1495
1649
|
* <p>Labels all personal health information (PHI) identified in your transcript.</p>
|
|
1496
1650
|
* <p>Content identification is performed at the segment level; PHI is flagged upon complete
|
|
1497
1651
|
* transcription of an audio segment.</p>
|
|
@@ -1505,55 +1659,68 @@ export interface StartMedicalStreamTranscriptionRequest {
|
|
|
1505
1659
|
*/
|
|
1506
1660
|
export interface StartMedicalStreamTranscriptionResponse {
|
|
1507
1661
|
/**
|
|
1662
|
+
* @public
|
|
1508
1663
|
* <p>Provides the identifier for your streaming request.</p>
|
|
1509
1664
|
*/
|
|
1510
1665
|
RequestId?: string;
|
|
1511
1666
|
/**
|
|
1667
|
+
* @public
|
|
1512
1668
|
* <p>Provides the language code that you specified in your request. This must be
|
|
1513
1669
|
* <code>en-US</code>.</p>
|
|
1514
1670
|
*/
|
|
1515
1671
|
LanguageCode?: LanguageCode | string;
|
|
1516
1672
|
/**
|
|
1673
|
+
* @public
|
|
1517
1674
|
* <p>Provides the sample rate that you specified in your request.</p>
|
|
1518
1675
|
*/
|
|
1519
1676
|
MediaSampleRateHertz?: number;
|
|
1520
1677
|
/**
|
|
1678
|
+
* @public
|
|
1521
1679
|
* <p>Provides the media encoding you specified in your request.</p>
|
|
1522
1680
|
*/
|
|
1523
1681
|
MediaEncoding?: MediaEncoding | string;
|
|
1524
1682
|
/**
|
|
1683
|
+
* @public
|
|
1525
1684
|
* <p>Provides the name of the custom vocabulary that you specified in your request.</p>
|
|
1526
1685
|
*/
|
|
1527
1686
|
VocabularyName?: string;
|
|
1528
1687
|
/**
|
|
1688
|
+
* @public
|
|
1529
1689
|
* <p>Provides the medical specialty that you specified in your request.</p>
|
|
1530
1690
|
*/
|
|
1531
1691
|
Specialty?: Specialty | string;
|
|
1532
1692
|
/**
|
|
1693
|
+
* @public
|
|
1533
1694
|
* <p>Provides the type of audio you specified in your request.</p>
|
|
1534
1695
|
*/
|
|
1535
1696
|
Type?: Type | string;
|
|
1536
1697
|
/**
|
|
1698
|
+
* @public
|
|
1537
1699
|
* <p>Shows whether speaker partitioning was enabled for your transcription.</p>
|
|
1538
1700
|
*/
|
|
1539
1701
|
ShowSpeakerLabel?: boolean;
|
|
1540
1702
|
/**
|
|
1703
|
+
* @public
|
|
1541
1704
|
* <p>Provides the identifier for your transcription session.</p>
|
|
1542
1705
|
*/
|
|
1543
1706
|
SessionId?: string;
|
|
1544
1707
|
/**
|
|
1708
|
+
* @public
|
|
1545
1709
|
* <p>Provides detailed information about your streaming session.</p>
|
|
1546
1710
|
*/
|
|
1547
1711
|
TranscriptResultStream?: AsyncIterable<MedicalTranscriptResultStream>;
|
|
1548
1712
|
/**
|
|
1713
|
+
* @public
|
|
1549
1714
|
* <p>Shows whether channel identification was enabled for your transcription.</p>
|
|
1550
1715
|
*/
|
|
1551
1716
|
EnableChannelIdentification?: boolean;
|
|
1552
1717
|
/**
|
|
1718
|
+
* @public
|
|
1553
1719
|
* <p>Provides the number of channels that you specified in your request.</p>
|
|
1554
1720
|
*/
|
|
1555
1721
|
NumberOfChannels?: number;
|
|
1556
1722
|
/**
|
|
1723
|
+
* @public
|
|
1557
1724
|
* <p>Shows whether content identification was enabled for your transcription.</p>
|
|
1558
1725
|
*/
|
|
1559
1726
|
ContentIdentificationType?: MedicalContentIdentificationType | string;
|
|
@@ -1563,6 +1730,7 @@ export interface StartMedicalStreamTranscriptionResponse {
|
|
|
1563
1730
|
*/
|
|
1564
1731
|
export interface StartStreamTranscriptionRequest {
|
|
1565
1732
|
/**
|
|
1733
|
+
* @public
|
|
1566
1734
|
* <p>Specify the language code that represents the language spoken in your audio.</p>
|
|
1567
1735
|
* <p>If you're unsure of the language spoken in your audio, consider using
|
|
1568
1736
|
* <code>IdentifyLanguage</code> to enable automatic language identification.</p>
|
|
@@ -1572,12 +1740,14 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1572
1740
|
*/
|
|
1573
1741
|
LanguageCode?: LanguageCode | string;
|
|
1574
1742
|
/**
|
|
1743
|
+
* @public
|
|
1575
1744
|
* <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio,
|
|
1576
1745
|
* is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz.
|
|
1577
1746
|
* Note that the sample rate you specify must match that of your audio.</p>
|
|
1578
1747
|
*/
|
|
1579
1748
|
MediaSampleRateHertz: number | undefined;
|
|
1580
1749
|
/**
|
|
1750
|
+
* @public
|
|
1581
1751
|
* <p>Specify the encoding of your input audio. Supported formats are:</p>
|
|
1582
1752
|
* <ul>
|
|
1583
1753
|
* <li>
|
|
@@ -1594,6 +1764,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1594
1764
|
*/
|
|
1595
1765
|
MediaEncoding: MediaEncoding | string | undefined;
|
|
1596
1766
|
/**
|
|
1767
|
+
* @public
|
|
1597
1768
|
* <p>Specify the name of the custom vocabulary that you want to use when processing your
|
|
1598
1769
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1599
1770
|
* <p>If the language of the specified custom vocabulary doesn't match the language identified in
|
|
@@ -1608,18 +1779,21 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1608
1779
|
*/
|
|
1609
1780
|
VocabularyName?: string;
|
|
1610
1781
|
/**
|
|
1782
|
+
* @public
|
|
1611
1783
|
* <p>Specify a name for your transcription session. If you don't include this parameter in your request,
|
|
1612
1784
|
* Amazon Transcribe generates an ID and returns it in the response.</p>
|
|
1613
1785
|
* <p>You can use a session ID to retry a streaming session.</p>
|
|
1614
1786
|
*/
|
|
1615
1787
|
SessionId?: string;
|
|
1616
1788
|
/**
|
|
1789
|
+
* @public
|
|
1617
1790
|
* <p>An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket
|
|
1618
1791
|
* data frames.</p>
|
|
1619
1792
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html">Transcribing streaming audio</a>.</p>
|
|
1620
1793
|
*/
|
|
1621
1794
|
AudioStream: AsyncIterable<AudioStream> | undefined;
|
|
1622
1795
|
/**
|
|
1796
|
+
* @public
|
|
1623
1797
|
* <p>Specify the name of the custom vocabulary filter that you want to use when processing your
|
|
1624
1798
|
* transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
1625
1799
|
* <p>If the language of the specified custom vocabulary filter doesn't match the language identified in
|
|
@@ -1635,6 +1809,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1635
1809
|
*/
|
|
1636
1810
|
VocabularyFilterName?: string;
|
|
1637
1811
|
/**
|
|
1812
|
+
* @public
|
|
1638
1813
|
* <p>Specify how you want your vocabulary filter applied to your transcript.</p>
|
|
1639
1814
|
* <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
|
|
1640
1815
|
* <p>To delete words, choose <code>remove</code>.</p>
|
|
@@ -1642,12 +1817,14 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1642
1817
|
*/
|
|
1643
1818
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
1644
1819
|
/**
|
|
1820
|
+
* @public
|
|
1645
1821
|
* <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning
|
|
1646
1822
|
* labels the speech from individual speakers in your media file.</p>
|
|
1647
1823
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a>.</p>
|
|
1648
1824
|
*/
|
|
1649
1825
|
ShowSpeakerLabel?: boolean;
|
|
1650
1826
|
/**
|
|
1827
|
+
* @public
|
|
1651
1828
|
* <p>Enables channel identification in multi-channel audio.</p>
|
|
1652
1829
|
* <p>Channel identification transcribes the audio on each channel independently, then appends the
|
|
1653
1830
|
* output for each channel into one transcript.</p>
|
|
@@ -1657,11 +1834,13 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1657
1834
|
*/
|
|
1658
1835
|
EnableChannelIdentification?: boolean;
|
|
1659
1836
|
/**
|
|
1837
|
+
* @public
|
|
1660
1838
|
* <p>Specify the number of channels in your audio stream. Up to two channels are
|
|
1661
1839
|
* supported.</p>
|
|
1662
1840
|
*/
|
|
1663
1841
|
NumberOfChannels?: number;
|
|
1664
1842
|
/**
|
|
1843
|
+
* @public
|
|
1665
1844
|
* <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce
|
|
1666
1845
|
* latency in your output, but may impact accuracy. For more information, see
|
|
1667
1846
|
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result
|
|
@@ -1669,6 +1848,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1669
1848
|
*/
|
|
1670
1849
|
EnablePartialResultsStabilization?: boolean;
|
|
1671
1850
|
/**
|
|
1851
|
+
* @public
|
|
1672
1852
|
* <p>Specify the level of stability to use when you enable partial results stabilization
|
|
1673
1853
|
* (<code>EnablePartialResultsStabilization</code>).</p>
|
|
1674
1854
|
* <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly
|
|
@@ -1678,6 +1858,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1678
1858
|
*/
|
|
1679
1859
|
PartialResultsStability?: PartialResultsStability | string;
|
|
1680
1860
|
/**
|
|
1861
|
+
* @public
|
|
1681
1862
|
* <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
|
|
1682
1863
|
* <p>Content identification is performed at the segment level; PII specified in
|
|
1683
1864
|
* <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
|
|
@@ -1689,6 +1870,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1689
1870
|
*/
|
|
1690
1871
|
ContentIdentificationType?: ContentIdentificationType | string;
|
|
1691
1872
|
/**
|
|
1873
|
+
* @public
|
|
1692
1874
|
* <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
|
|
1693
1875
|
* <p>Content redaction is performed at the segment level; PII specified in
|
|
1694
1876
|
* <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
|
|
@@ -1700,6 +1882,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1700
1882
|
*/
|
|
1701
1883
|
ContentRedactionType?: ContentRedactionType | string;
|
|
1702
1884
|
/**
|
|
1885
|
+
* @public
|
|
1703
1886
|
* <p>Specify which types of personally identifiable information (PII) you want to redact in your
|
|
1704
1887
|
* transcript. You can include as many types as you'd like, or you can select
|
|
1705
1888
|
* <code>ALL</code>.</p>
|
|
@@ -1714,6 +1897,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1714
1897
|
*/
|
|
1715
1898
|
PiiEntityTypes?: string;
|
|
1716
1899
|
/**
|
|
1900
|
+
* @public
|
|
1717
1901
|
* <p>Specify the name of the custom language model that you want to use when processing your
|
|
1718
1902
|
* transcription. Note that language model names are case sensitive.</p>
|
|
1719
1903
|
* <p>The language of the specified language model must match the language code you specify
|
|
@@ -1723,6 +1907,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1723
1907
|
*/
|
|
1724
1908
|
LanguageModelName?: string;
|
|
1725
1909
|
/**
|
|
1910
|
+
* @public
|
|
1726
1911
|
* <p>Enables automatic language identification for your transcription.</p>
|
|
1727
1912
|
* <p>If you include <code>IdentifyLanguage</code>, you can optionally include a list of
|
|
1728
1913
|
* language codes, using <code>LanguageOptions</code>, that you think may be present in
|
|
@@ -1741,6 +1926,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1741
1926
|
*/
|
|
1742
1927
|
IdentifyLanguage?: boolean;
|
|
1743
1928
|
/**
|
|
1929
|
+
* @public
|
|
1744
1930
|
* <p>Specify two or more language codes that represent the languages you think may be present
|
|
1745
1931
|
* in your media; including more than five is not recommended. If you're unsure what languages are present, do
|
|
1746
1932
|
* not include this parameter.</p>
|
|
@@ -1757,6 +1943,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1757
1943
|
*/
|
|
1758
1944
|
LanguageOptions?: string;
|
|
1759
1945
|
/**
|
|
1946
|
+
* @public
|
|
1760
1947
|
* <p>Specify a preferred language from the subset of languages codes you specified in
|
|
1761
1948
|
* <code>LanguageOptions</code>.</p>
|
|
1762
1949
|
* <p>You can only use this parameter if you've included <code>IdentifyLanguage</code> and
|
|
@@ -1764,6 +1951,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1764
1951
|
*/
|
|
1765
1952
|
PreferredLanguage?: LanguageCode | string;
|
|
1766
1953
|
/**
|
|
1954
|
+
* @public
|
|
1767
1955
|
* <p>Specify the names of the custom vocabularies that you want to use when processing your
|
|
1768
1956
|
* transcription. Note that vocabulary names are case sensitive.</p>
|
|
1769
1957
|
* <p>If none of the languages of the specified custom vocabularies match the language identified in
|
|
@@ -1778,6 +1966,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1778
1966
|
*/
|
|
1779
1967
|
VocabularyNames?: string;
|
|
1780
1968
|
/**
|
|
1969
|
+
* @public
|
|
1781
1970
|
* <p>Specify the names of the custom vocabulary filters that you want to use when processing
|
|
1782
1971
|
* your transcription. Note that vocabulary filter names are case sensitive.</p>
|
|
1783
1972
|
* <p>If none of the languages of the specified custom vocabulary filters match the language identified
|
|
@@ -1804,6 +1993,7 @@ export interface StartStreamTranscriptionRequest {
|
|
|
1804
1993
|
*/
|
|
1805
1994
|
export interface Transcript {
|
|
1806
1995
|
/**
|
|
1996
|
+
* @public
|
|
1807
1997
|
* <p>Contains a set of transcription results from one or more audio segments, along with additional
|
|
1808
1998
|
* information per your request parameters. This can include information relating to alternative
|
|
1809
1999
|
* transcriptions, channel identification, partial result stabilization, language identification, and other
|
|
@@ -1820,6 +2010,7 @@ export interface Transcript {
|
|
|
1820
2010
|
*/
|
|
1821
2011
|
export interface TranscriptEvent {
|
|
1822
2012
|
/**
|
|
2013
|
+
* @public
|
|
1823
2014
|
* <p>Contains <code>Results</code>, which contains a set of transcription results from one or
|
|
1824
2015
|
* more audio segments, along with additional information per your request parameters. This can
|
|
1825
2016
|
* include information relating to alternative transcriptions, channel identification, partial
|
|
@@ -1837,6 +2028,7 @@ export type TranscriptResultStream = TranscriptResultStream.BadRequestExceptionM
|
|
|
1837
2028
|
*/
|
|
1838
2029
|
export declare namespace TranscriptResultStream {
|
|
1839
2030
|
/**
|
|
2031
|
+
* @public
|
|
1840
2032
|
* <p>Contains <code>Transcript</code>, which contains <code>Results</code>. The
|
|
1841
2033
|
* <code></code> object contains a set of transcription
|
|
1842
2034
|
* results from one or more audio segments, along with additional information per your request
|
|
@@ -1852,6 +2044,7 @@ export declare namespace TranscriptResultStream {
|
|
|
1852
2044
|
$unknown?: never;
|
|
1853
2045
|
}
|
|
1854
2046
|
/**
|
|
2047
|
+
* @public
|
|
1855
2048
|
* <p>A client error occurred when the stream was created. Check the parameters of the request
|
|
1856
2049
|
* and try your request again.</p>
|
|
1857
2050
|
*/
|
|
@@ -1865,6 +2058,7 @@ export declare namespace TranscriptResultStream {
|
|
|
1865
2058
|
$unknown?: never;
|
|
1866
2059
|
}
|
|
1867
2060
|
/**
|
|
2061
|
+
* @public
|
|
1868
2062
|
* <p>Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length
|
|
1869
2063
|
* limit. Break your audio stream into smaller chunks and try your request again.</p>
|
|
1870
2064
|
*/
|
|
@@ -1878,6 +2072,7 @@ export declare namespace TranscriptResultStream {
|
|
|
1878
2072
|
$unknown?: never;
|
|
1879
2073
|
}
|
|
1880
2074
|
/**
|
|
2075
|
+
* @public
|
|
1881
2076
|
* <p>A problem occurred while processing the audio. Amazon Transcribe terminated
|
|
1882
2077
|
* processing.</p>
|
|
1883
2078
|
*/
|
|
@@ -1891,6 +2086,7 @@ export declare namespace TranscriptResultStream {
|
|
|
1891
2086
|
$unknown?: never;
|
|
1892
2087
|
}
|
|
1893
2088
|
/**
|
|
2089
|
+
* @public
|
|
1894
2090
|
* <p>A new stream started with the same session ID. The current stream has been
|
|
1895
2091
|
* terminated.</p>
|
|
1896
2092
|
*/
|
|
@@ -1904,6 +2100,7 @@ export declare namespace TranscriptResultStream {
|
|
|
1904
2100
|
$unknown?: never;
|
|
1905
2101
|
}
|
|
1906
2102
|
/**
|
|
2103
|
+
* @public
|
|
1907
2104
|
* <p>The service is currently unavailable. Try your request later.</p>
|
|
1908
2105
|
*/
|
|
1909
2106
|
interface ServiceUnavailableExceptionMember {
|
|
@@ -1915,6 +2112,9 @@ export declare namespace TranscriptResultStream {
|
|
|
1915
2112
|
ServiceUnavailableException: ServiceUnavailableException;
|
|
1916
2113
|
$unknown?: never;
|
|
1917
2114
|
}
|
|
2115
|
+
/**
|
|
2116
|
+
* @public
|
|
2117
|
+
*/
|
|
1918
2118
|
interface $UnknownMember {
|
|
1919
2119
|
TranscriptEvent?: never;
|
|
1920
2120
|
BadRequestException?: never;
|
|
@@ -1940,96 +2140,119 @@ export declare namespace TranscriptResultStream {
|
|
|
1940
2140
|
*/
|
|
1941
2141
|
export interface StartStreamTranscriptionResponse {
|
|
1942
2142
|
/**
|
|
2143
|
+
* @public
|
|
1943
2144
|
* <p>Provides the identifier for your streaming request.</p>
|
|
1944
2145
|
*/
|
|
1945
2146
|
RequestId?: string;
|
|
1946
2147
|
/**
|
|
2148
|
+
* @public
|
|
1947
2149
|
* <p>Provides the language code that you specified in your request.</p>
|
|
1948
2150
|
*/
|
|
1949
2151
|
LanguageCode?: LanguageCode | string;
|
|
1950
2152
|
/**
|
|
2153
|
+
* @public
|
|
1951
2154
|
* <p>Provides the sample rate that you specified in your request.</p>
|
|
1952
2155
|
*/
|
|
1953
2156
|
MediaSampleRateHertz?: number;
|
|
1954
2157
|
/**
|
|
2158
|
+
* @public
|
|
1955
2159
|
* <p>Provides the media encoding you specified in your request.</p>
|
|
1956
2160
|
*/
|
|
1957
2161
|
MediaEncoding?: MediaEncoding | string;
|
|
1958
2162
|
/**
|
|
2163
|
+
* @public
|
|
1959
2164
|
* <p>Provides the name of the custom vocabulary that you specified in your request.</p>
|
|
1960
2165
|
*/
|
|
1961
2166
|
VocabularyName?: string;
|
|
1962
2167
|
/**
|
|
2168
|
+
* @public
|
|
1963
2169
|
* <p>Provides the identifier for your transcription session.</p>
|
|
1964
2170
|
*/
|
|
1965
2171
|
SessionId?: string;
|
|
1966
2172
|
/**
|
|
2173
|
+
* @public
|
|
1967
2174
|
* <p>Provides detailed information about your streaming session.</p>
|
|
1968
2175
|
*/
|
|
1969
2176
|
TranscriptResultStream?: AsyncIterable<TranscriptResultStream>;
|
|
1970
2177
|
/**
|
|
2178
|
+
* @public
|
|
1971
2179
|
* <p>Provides the name of the custom vocabulary filter that you specified in your
|
|
1972
2180
|
* request.</p>
|
|
1973
2181
|
*/
|
|
1974
2182
|
VocabularyFilterName?: string;
|
|
1975
2183
|
/**
|
|
2184
|
+
* @public
|
|
1976
2185
|
* <p>Provides the vocabulary filtering method used in your transcription.</p>
|
|
1977
2186
|
*/
|
|
1978
2187
|
VocabularyFilterMethod?: VocabularyFilterMethod | string;
|
|
1979
2188
|
/**
|
|
2189
|
+
* @public
|
|
1980
2190
|
* <p>Shows whether speaker partitioning was enabled for your transcription.</p>
|
|
1981
2191
|
*/
|
|
1982
2192
|
ShowSpeakerLabel?: boolean;
|
|
1983
2193
|
/**
|
|
2194
|
+
* @public
|
|
1984
2195
|
* <p>Shows whether channel identification was enabled for your transcription.</p>
|
|
1985
2196
|
*/
|
|
1986
2197
|
EnableChannelIdentification?: boolean;
|
|
1987
2198
|
/**
|
|
2199
|
+
* @public
|
|
1988
2200
|
* <p>Provides the number of channels that you specified in your request.</p>
|
|
1989
2201
|
*/
|
|
1990
2202
|
NumberOfChannels?: number;
|
|
1991
2203
|
/**
|
|
2204
|
+
* @public
|
|
1992
2205
|
* <p>Shows whether partial results stabilization was enabled for your transcription.</p>
|
|
1993
2206
|
*/
|
|
1994
2207
|
EnablePartialResultsStabilization?: boolean;
|
|
1995
2208
|
/**
|
|
2209
|
+
* @public
|
|
1996
2210
|
* <p>Provides the stabilization level used for your transcription.</p>
|
|
1997
2211
|
*/
|
|
1998
2212
|
PartialResultsStability?: PartialResultsStability | string;
|
|
1999
2213
|
/**
|
|
2214
|
+
* @public
|
|
2000
2215
|
* <p>Shows whether content identification was enabled for your transcription.</p>
|
|
2001
2216
|
*/
|
|
2002
2217
|
ContentIdentificationType?: ContentIdentificationType | string;
|
|
2003
2218
|
/**
|
|
2219
|
+
* @public
|
|
2004
2220
|
* <p>Shows whether content redaction was enabled for your transcription.</p>
|
|
2005
2221
|
*/
|
|
2006
2222
|
ContentRedactionType?: ContentRedactionType | string;
|
|
2007
2223
|
/**
|
|
2224
|
+
* @public
|
|
2008
2225
|
* <p>Lists the PII entity types you specified in your request.</p>
|
|
2009
2226
|
*/
|
|
2010
2227
|
PiiEntityTypes?: string;
|
|
2011
2228
|
/**
|
|
2229
|
+
* @public
|
|
2012
2230
|
* <p>Provides the name of the custom language model that you specified in your request.</p>
|
|
2013
2231
|
*/
|
|
2014
2232
|
LanguageModelName?: string;
|
|
2015
2233
|
/**
|
|
2234
|
+
* @public
|
|
2016
2235
|
* <p>Shows whether automatic language identification was enabled for your
|
|
2017
2236
|
* transcription.</p>
|
|
2018
2237
|
*/
|
|
2019
2238
|
IdentifyLanguage?: boolean;
|
|
2020
2239
|
/**
|
|
2240
|
+
* @public
|
|
2021
2241
|
* <p>Provides the language codes that you specified in your request.</p>
|
|
2022
2242
|
*/
|
|
2023
2243
|
LanguageOptions?: string;
|
|
2024
2244
|
/**
|
|
2245
|
+
* @public
|
|
2025
2246
|
* <p>Provides the preferred language that you specified in your request.</p>
|
|
2026
2247
|
*/
|
|
2027
2248
|
PreferredLanguage?: LanguageCode | string;
|
|
2028
2249
|
/**
|
|
2250
|
+
* @public
|
|
2029
2251
|
* <p>Provides the names of the custom vocabularies that you specified in your request.</p>
|
|
2030
2252
|
*/
|
|
2031
2253
|
VocabularyNames?: string;
|
|
2032
2254
|
/**
|
|
2255
|
+
* @public
|
|
2033
2256
|
* <p>Provides the names of the custom vocabulary filters that you specified in your
|
|
2034
2257
|
* request.</p>
|
|
2035
2258
|
*/
|