/
transcribe-streaming.json
1615 lines (1615 loc) · 86 KB
/
transcribe-streaming.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.transcribestreaming#Alternative": {
"type": "structure",
"members": {
"Transcript": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The text that was transcribed from the audio.</p>"
}
},
"Items": {
"target": "com.amazonaws.transcribestreaming#ItemList",
"traits": {
"smithy.api#documentation": "<p>One or more alternative interpretations of the input audio. </p>"
}
},
"Entities": {
"target": "com.amazonaws.transcribestreaming#EntityList",
"traits": {
"smithy.api#documentation": "<p>Contains the entities identified as personally identifiable information (PII) in the transcription output.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of possible transcriptions for the audio.</p>"
}
},
"com.amazonaws.transcribestreaming#AlternativeList": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#Alternative"
}
},
"com.amazonaws.transcribestreaming#AudioChunk": {
"type": "blob"
},
"com.amazonaws.transcribestreaming#AudioEvent": {
"type": "structure",
"members": {
"AudioChunk": {
"target": "com.amazonaws.transcribestreaming#AudioChunk",
"traits": {
"smithy.api#documentation": "<p>An audio blob that contains the next part of the audio that you want to transcribe. The\n maximum audio chunk size is 32 KB.</p>",
"smithy.api#eventPayload": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides a wrapper for the audio chunks that you are sending.</p>\n <p>For information on audio encoding in Amazon Transcribe, see \n <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/input.html\">Speech input</a>. For information\n on audio encoding formats in Amazon Transcribe Medical, see \n <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html\">Speech input</a>.</p>"
}
},
"com.amazonaws.transcribestreaming#AudioStream": {
"type": "union",
"members": {
"AudioEvent": {
"target": "com.amazonaws.transcribestreaming#AudioEvent",
"traits": {
"smithy.api#documentation": "<p>A blob of audio from your application. You audio stream consists of one or more audio\n events.</p>\n <p>For information on audio encoding formats in Amazon Transcribe, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/input.html\">Speech input</a>. For\n information on audio encoding formats in Amazon Transcribe Medical, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html\">Speech input</a>.</p>\n <p>For more information on stream encoding in Amazon Transcribe, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html\">Event stream encoding</a>. For\n information on stream encoding in Amazon Transcribe Medical, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/event-stream-med.html\">Event stream encoding</a>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the audio stream from your application to Amazon Transcribe.</p>",
"smithy.api#streaming": {}
}
},
"com.amazonaws.transcribestreaming#BadRequestException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.transcribestreaming#String"
}
},
"traits": {
"smithy.api#documentation": "<p>One or more arguments to the <code>StartStreamTranscription</code> or\n <code>StartMedicalStreamTranscription</code> operation was invalid. For example,\n <code>MediaEncoding</code> was not set to a valid encoding, or <code>LanguageCode</code> was\n not set to a valid code. Check the parameters and try your request again.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.transcribestreaming#Boolean": {
"type": "boolean"
},
"com.amazonaws.transcribestreaming#Confidence": {
"type": "double",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.transcribestreaming#ConflictException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.transcribestreaming#String"
}
},
"traits": {
"smithy.api#documentation": "<p>A new stream started with the same session ID. The current stream has been\n terminated.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.transcribestreaming#ContentIdentificationType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PII",
"name": "PII"
}
]
}
},
"com.amazonaws.transcribestreaming#ContentRedactionType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PII",
"name": "PII"
}
]
}
},
"com.amazonaws.transcribestreaming#Double": {
"type": "double"
},
"com.amazonaws.transcribestreaming#Entity": {
"type": "structure",
"members": {
"StartTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The start time of speech that was identified as PII.</p>"
}
},
"EndTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The end time of speech that was identified as PII.</p>"
}
},
"Category": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The category of information identified in this entity; for example, PII.</p>"
}
},
"Type": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The type of PII identified in this entity; for example, name or credit card number.</p>"
}
},
"Content": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The words in the transcription output that have been identified as a PII entity.</p>"
}
},
"Confidence": {
"target": "com.amazonaws.transcribestreaming#Confidence",
"traits": {
"smithy.api#documentation": "<p>A value between zero and one that Amazon Transcribe assigns to PII identified in the source audio. Larger values indicate a higher confidence in PII identification.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The entity identified as personally identifiable information (PII).</p>"
}
},
"com.amazonaws.transcribestreaming#EntityList": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#Entity"
}
},
"com.amazonaws.transcribestreaming#InternalFailureException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.transcribestreaming#String"
}
},
"traits": {
"smithy.api#documentation": "<p>A problem occurred while processing the audio. Amazon Transcribe or Amazon Transcribe Medical terminated processing. Try\n your request again.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500
}
},
"com.amazonaws.transcribestreaming#Item": {
"type": "structure",
"members": {
"StartTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The offset from the beginning of the audio stream to the beginning of the audio that\n resulted in the item.</p>"
}
},
"EndTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The offset from the beginning of the audio stream to the end of the audio that resulted in\n the item.</p>"
}
},
"Type": {
"target": "com.amazonaws.transcribestreaming#ItemType",
"traits": {
"smithy.api#documentation": "<p>The type of the item. <code>PRONUNCIATION</code> indicates that the item is a word\n that was recognized in the input audio. <code>PUNCTUATION</code> indicates that the item\n was interpreted as a pause in the input audio.</p>"
}
},
"Content": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The word or punctuation that was recognized in the input audio.</p>"
}
},
"VocabularyFilterMatch": {
"target": "com.amazonaws.transcribestreaming#Boolean",
"traits": {
"smithy.api#documentation": "<p>Indicates whether a word in the item matches a word in the vocabulary filter you've chosen\n for your media stream. If <code>true</code> then a word in the item matches your\n vocabulary filter.</p>"
}
},
"Speaker": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>If speaker identification is enabled, shows the speakers identified in the media\n stream.</p>"
}
},
"Confidence": {
"target": "com.amazonaws.transcribestreaming#Confidence",
"traits": {
"smithy.api#documentation": "<p>A value between zero and one for an item that is a confidence score that Amazon Transcribe assigns to each\n word or phrase that it transcribes.</p>"
}
},
"Stable": {
"target": "com.amazonaws.transcribestreaming#Stable",
"traits": {
"smithy.api#documentation": "<p>If partial result stabilization has been enabled, indicates whether the word or phrase in\n the item is stable. If <code>Stable</code> is <code>true</code>, the result is stable.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A word, phrase, or punctuation mark that is transcribed from the input audio.</p>"
}
},
"com.amazonaws.transcribestreaming#ItemList": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#Item"
}
},
"com.amazonaws.transcribestreaming#ItemType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "pronunciation",
"name": "PRONUNCIATION"
},
{
"value": "punctuation",
"name": "PUNCTUATION"
}
]
}
},
"com.amazonaws.transcribestreaming#LanguageCode": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "en-US",
"name": "EN_US"
},
{
"value": "en-GB",
"name": "EN_GB"
},
{
"value": "es-US",
"name": "ES_US"
},
{
"value": "fr-CA",
"name": "FR_CA"
},
{
"value": "fr-FR",
"name": "FR_FR"
},
{
"value": "en-AU",
"name": "EN_AU"
},
{
"value": "it-IT",
"name": "IT_IT"
},
{
"value": "de-DE",
"name": "DE_DE"
},
{
"value": "pt-BR",
"name": "PT_BR"
},
{
"value": "ja-JP",
"name": "JA_JP"
},
{
"value": "ko-KR",
"name": "KO_KR"
},
{
"value": "zh-CN",
"name": "ZH_CN"
}
]
}
},
"com.amazonaws.transcribestreaming#LanguageIdentification": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#LanguageWithScore"
}
},
"com.amazonaws.transcribestreaming#LanguageOptions": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 200
},
"smithy.api#pattern": "^[a-zA-Z-,]+$"
}
},
"com.amazonaws.transcribestreaming#LanguageWithScore": {
"type": "structure",
"members": {
"LanguageCode": {
"target": "com.amazonaws.transcribestreaming#LanguageCode",
"traits": {
"smithy.api#documentation": "<p>The language code of the language identified by Amazon Transcribe.</p>"
}
},
"Score": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The confidence score for the associated language code. Confidence scores are values\n between zero and one; larger values indicate a higher confidence in the identified language.\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The language codes of the identified languages and their associated confidence scores. \n The confidence score is a value between zero and one; a larger value indicates a higher \n confidence in the identified language.</p>"
}
},
"com.amazonaws.transcribestreaming#LimitExceededException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.transcribestreaming#String"
}
},
"traits": {
"smithy.api#documentation": "<p>You have exceeded the maximum number of concurrent transcription streams, are starting\n transcription streams too quickly, or the maximum audio length of 4 hours. Wait until a stream\n has finished processing, or break your audio stream into smaller chunks and try your request\n again.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 429
}
},
"com.amazonaws.transcribestreaming#MediaEncoding": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "pcm",
"name": "PCM"
},
{
"value": "ogg-opus",
"name": "OGG_OPUS"
},
{
"value": "flac",
"name": "FLAC"
}
]
}
},
"com.amazonaws.transcribestreaming#MediaSampleRateHertz": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 8000,
"max": 48000
}
}
},
"com.amazonaws.transcribestreaming#MedicalAlternative": {
"type": "structure",
"members": {
"Transcript": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The text that was transcribed from the audio.</p>"
}
},
"Items": {
"target": "com.amazonaws.transcribestreaming#MedicalItemList",
"traits": {
"smithy.api#documentation": "<p>A list of objects that contains words and punctuation marks that represents one or\n more interpretations of the input audio.</p>"
}
},
"Entities": {
"target": "com.amazonaws.transcribestreaming#MedicalEntityList",
"traits": {
"smithy.api#documentation": "<p>Contains the medical entities identified as personal health information in the transcription output.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of possible transcriptions for the audio.</p>"
}
},
"com.amazonaws.transcribestreaming#MedicalAlternativeList": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#MedicalAlternative"
}
},
"com.amazonaws.transcribestreaming#MedicalContentIdentificationType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PHI",
"name": "PHI"
}
]
}
},
"com.amazonaws.transcribestreaming#MedicalEntity": {
"type": "structure",
"members": {
"StartTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The start time of the speech that was identified as a medical entity.</p>"
}
},
"EndTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The end time of the speech that was identified as a medical entity.</p>"
}
},
"Category": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The type of personal health information of the medical entity.</p>"
}
},
"Content": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The word or words in the transcription output that have been identified as a\n medical entity.</p>"
}
},
"Confidence": {
"target": "com.amazonaws.transcribestreaming#Confidence",
"traits": {
"smithy.api#documentation": "<p>A value between zero and one that Amazon Transcribe Medical assigned to the personal health information\n that it identified in the source audio. Larger values indicate that Amazon Transcribe Medical has higher\n confidence in the personal health information that it identified.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The medical entity identified as personal health information.</p>"
}
},
"com.amazonaws.transcribestreaming#MedicalEntityList": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#MedicalEntity"
}
},
"com.amazonaws.transcribestreaming#MedicalItem": {
"type": "structure",
"members": {
"StartTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The number of seconds into an audio stream that indicates the creation time of an\n item.</p>"
}
},
"EndTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The number of seconds into an audio stream that indicates the creation time of an\n item.</p>"
}
},
"Type": {
"target": "com.amazonaws.transcribestreaming#ItemType",
"traits": {
"smithy.api#documentation": "<p>The type of the item. <code>PRONUNCIATION</code> indicates that the item is a word\n that was recognized in the input audio. <code>PUNCTUATION</code> indicates that the item\n was interpreted as a pause in the input audio, such as a period to indicate the end of a\n sentence.</p>"
}
},
"Content": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>The word or punctuation mark that was recognized in the input audio.</p>"
}
},
"Confidence": {
"target": "com.amazonaws.transcribestreaming#Confidence",
"traits": {
"smithy.api#documentation": "<p>A value between 0 and 1 for an item that is a confidence score that Amazon Transcribe Medical assigns to\n each word that it transcribes.</p>"
}
},
"Speaker": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>If speaker identification is enabled, shows the integer values that correspond to the\n different speakers identified in the stream. For example, if the value of\n <code>Speaker</code> in the stream is either a <code>0</code> or a <code>1</code>,\n that indicates that Amazon Transcribe Medical has identified two speakers in the stream. The value of\n <code>0</code> corresponds to one speaker and the value of <code>1</code>\n corresponds to the other speaker.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A word, phrase, or punctuation mark that is transcribed from the input audio.</p>"
}
},
"com.amazonaws.transcribestreaming#MedicalItemList": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#MedicalItem"
}
},
"com.amazonaws.transcribestreaming#MedicalResult": {
"type": "structure",
"members": {
"ResultId": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for the result.</p>"
}
},
"StartTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The time, in seconds, from the beginning of the audio stream to the beginning of the\n result.</p>"
}
},
"EndTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The time, in seconds, from the beginning of the audio stream to the end of the\n result.</p>"
}
},
"IsPartial": {
"target": "com.amazonaws.transcribestreaming#Boolean",
"traits": {
"smithy.api#documentation": "<p>Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio.\n Transcription results are returned based on these segments.</p>\n <p>The <code>IsPartial</code> field is <code>true</code> to indicate that Amazon Transcribe Medical has\n additional transcription data to send. The <code>IsPartial</code> field is\n <code>false</code> to indicate that this is the last transcription result for the\n segment.</p>"
}
},
"Alternatives": {
"target": "com.amazonaws.transcribestreaming#MedicalAlternativeList",
"traits": {
"smithy.api#documentation": "<p>A list of possible transcriptions of the audio. Each alternative typically contains\n one <code>Item</code> that contains the result of the transcription.</p>"
}
},
"ChannelId": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio\n channel separately.</p>\n <p>You can use <code>ChannelId</code> to retrieve the transcription results for a single\n channel in your audio stream.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The results of transcribing a portion of the input audio stream.</p>"
}
},
"com.amazonaws.transcribestreaming#MedicalResultList": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#MedicalResult"
}
},
"com.amazonaws.transcribestreaming#MedicalTranscript": {
"type": "structure",
"members": {
"Results": {
"target": "com.amazonaws.transcribestreaming#MedicalResultList",
"traits": {
"smithy.api#documentation": "<p>\n <a>MedicalResult</a> objects that contain the results of transcribing a\n portion of the input audio stream. The array can be empty.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The medical transcript in a <a>MedicalTranscriptEvent</a>.</p>"
}
},
"com.amazonaws.transcribestreaming#MedicalTranscriptEvent": {
"type": "structure",
"members": {
"Transcript": {
"target": "com.amazonaws.transcribestreaming#MedicalTranscript",
"traits": {
"smithy.api#documentation": "<p>The transcription of the audio stream. The transcription is composed of all of the\n items in the results list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a set of transcription results from the server to the client. It contains\n one or more segments of the transcription.</p>"
}
},
"com.amazonaws.transcribestreaming#MedicalTranscriptResultStream": {
"type": "union",
"members": {
"TranscriptEvent": {
"target": "com.amazonaws.transcribestreaming#MedicalTranscriptEvent",
"traits": {
"smithy.api#documentation": "<p>A portion of the transcription of the audio stream. Events are sent periodically from\n Amazon Transcribe Medical to your application. The event can be a partial transcription of a section of the\n audio stream, or it can be the entire transcription of that portion of the audio\n stream.</p>"
}
},
"BadRequestException": {
"target": "com.amazonaws.transcribestreaming#BadRequestException"
},
"LimitExceededException": {
"target": "com.amazonaws.transcribestreaming#LimitExceededException"
},
"InternalFailureException": {
"target": "com.amazonaws.transcribestreaming#InternalFailureException"
},
"ConflictException": {
"target": "com.amazonaws.transcribestreaming#ConflictException"
},
"ServiceUnavailableException": {
"target": "com.amazonaws.transcribestreaming#ServiceUnavailableException"
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the transcription result stream from Amazon Transcribe Medical to your application.</p>",
"smithy.api#streaming": {}
}
},
"com.amazonaws.transcribestreaming#ModelName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 200
},
"smithy.api#pattern": "^[0-9a-zA-Z._-]+$"
}
},
"com.amazonaws.transcribestreaming#NumberOfChannels": {
"type": "integer",
"traits": {
"smithy.api#box": {},
"smithy.api#range": {
"min": 2
}
}
},
"com.amazonaws.transcribestreaming#PartialResultsStability": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "high",
"name": "HIGH"
},
{
"value": "medium",
"name": "MEDIUM"
},
{
"value": "low",
"name": "LOW"
}
]
}
},
"com.amazonaws.transcribestreaming#PiiEntityTypes": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 300
},
"smithy.api#pattern": "^[A-Z_, ]+$"
}
},
"com.amazonaws.transcribestreaming#RequestId": {
"type": "string"
},
"com.amazonaws.transcribestreaming#Result": {
"type": "structure",
"members": {
"ResultId": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for the result. </p>"
}
},
"StartTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The offset in seconds from the beginning of the audio stream to the beginning of the\n result.</p>"
}
},
"EndTime": {
"target": "com.amazonaws.transcribestreaming#Double",
"traits": {
"smithy.api#documentation": "<p>The offset in seconds from the beginning of the audio stream to the end of the\n result.</p>"
}
},
"IsPartial": {
"target": "com.amazonaws.transcribestreaming#Boolean",
"traits": {
"smithy.api#documentation": "<p>Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio.\n Transcription results are returned based on these segments. </p>\n <p>The <code>IsPartial</code> field is <code>true</code> to indicate that Amazon Transcribe has\n additional transcription data to send, <code>false</code> to indicate that this is the last\n transcription result for the segment.</p>"
}
},
"Alternatives": {
"target": "com.amazonaws.transcribestreaming#AlternativeList",
"traits": {
"smithy.api#documentation": "<p>A list of possible transcriptions for the audio. Each alternative typically contains one\n <code>item</code> that contains the result of the transcription.</p>"
}
},
"ChannelId": {
"target": "com.amazonaws.transcribestreaming#String",
"traits": {
"smithy.api#documentation": "<p>When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio\n channel separately.</p>\n <p>You can use <code>ChannelId</code> to retrieve the transcription results for a single\n channel in your audio stream.</p>"
}
},
"LanguageCode": {
"target": "com.amazonaws.transcribestreaming#LanguageCode",
"traits": {
"smithy.api#documentation": "<p>The language code of the identified language in your media stream.</p>"
}
},
"LanguageIdentification": {
"target": "com.amazonaws.transcribestreaming#LanguageIdentification",
"traits": {
"smithy.api#documentation": "<p>The language code of the dominant language identified in your media.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of transcribing a portion of the input audio stream. </p>"
}
},
"com.amazonaws.transcribestreaming#ResultList": {
"type": "list",
"member": {
"target": "com.amazonaws.transcribestreaming#Result"
}
},
"com.amazonaws.transcribestreaming#ServiceUnavailableException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.transcribestreaming#String"
}
},
"traits": {
"smithy.api#documentation": "<p>Service is currently unavailable. Try your request later.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 503
}
},
"com.amazonaws.transcribestreaming#SessionId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 36,
"max": 36
},
"smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
}
},
"com.amazonaws.transcribestreaming#Specialty": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "PRIMARYCARE",
"name": "PRIMARYCARE"
},
{
"value": "CARDIOLOGY",
"name": "CARDIOLOGY"
},
{
"value": "NEUROLOGY",
"name": "NEUROLOGY"
},
{
"value": "ONCOLOGY",
"name": "ONCOLOGY"
},
{
"value": "RADIOLOGY",
"name": "RADIOLOGY"
},
{
"value": "UROLOGY",
"name": "UROLOGY"
}
]
}
},
"com.amazonaws.transcribestreaming#Stable": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.transcribestreaming#StartMedicalStreamTranscription": {
"type": "operation",
"input": {
"target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscriptionRequest"
},
"output": {
"target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscriptionResponse"
},
"errors": [
{
"target": "com.amazonaws.transcribestreaming#BadRequestException"
},
{
"target": "com.amazonaws.transcribestreaming#ConflictException"
},
{
"target": "com.amazonaws.transcribestreaming#InternalFailureException"
},
{
"target": "com.amazonaws.transcribestreaming#LimitExceededException"
},
{
"target": "com.amazonaws.transcribestreaming#ServiceUnavailableException"
}
],
"traits": {
"smithy.api#documentation": "<p>Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the\n transcription results are streamed to your application.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/medical-stream-transcription",
"code": 200
}
}
},
"com.amazonaws.transcribestreaming#StartMedicalStreamTranscriptionRequest": {
"type": "structure",
"members": {
"LanguageCode": {
"target": "com.amazonaws.transcribestreaming#LanguageCode",
"traits": {
"smithy.api#documentation": "<p> Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US\n English (en-US). </p>",
"smithy.api#httpHeader": "x-amzn-transcribe-language-code",
"smithy.api#required": {}
}
},
"MediaSampleRateHertz": {
"target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz",
"traits": {
"smithy.api#documentation": "<p>The sample rate of the input audio (in Hertz). Amazon Transcribe medical supports a range from \n 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your\n audio.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-sample-rate",
"smithy.api#required": {}
}
},
"MediaEncoding": {
"target": "com.amazonaws.transcribestreaming#MediaEncoding",
"traits": {
"smithy.api#documentation": "<p>The encoding used for the input audio.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-media-encoding",
"smithy.api#required": {}
}
},
"VocabularyName": {
"target": "com.amazonaws.transcribestreaming#VocabularyName",
"traits": {
"smithy.api#documentation": "<p>The name of the medical custom vocabulary to use when processing the real-time\n stream.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name"
}
},
"Specialty": {
"target": "com.amazonaws.transcribestreaming#Specialty",
"traits": {
"smithy.api#documentation": "<p>The medical specialty of the clinician or provider.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-specialty",
"smithy.api#required": {}
}
},
"Type": {
"target": "com.amazonaws.transcribestreaming#Type",
"traits": {
"smithy.api#documentation": "<p>The type of input audio. Choose <code>DICTATION</code> for a provider dictating\n patient notes. Choose <code>CONVERSATION</code> for a dialogue between a patient and one\n or more medical professionanls.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-type",
"smithy.api#required": {}
}
},
"ShowSpeakerLabel": {
"target": "com.amazonaws.transcribestreaming#Boolean",
"traits": {
"smithy.api#documentation": "<p>When <code>true</code>, enables speaker identification in your real-time\n stream.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label"
}
},
"SessionId": {
"target": "com.amazonaws.transcribestreaming#SessionId",
"traits": {
"smithy.api#documentation": "<p> Optional. An identifier for the transcription session. If you don't provide a session\n ID, Amazon Transcribe generates one for you and returns it in the response. </p>",
"smithy.api#httpHeader": "x-amzn-transcribe-session-id"
}
},
"AudioStream": {
"target": "com.amazonaws.transcribestreaming#AudioStream",
"traits": {
"smithy.api#httpPayload": {},
"smithy.api#required": {}
}
},
"EnableChannelIdentification": {
"target": "com.amazonaws.transcribestreaming#Boolean",
"traits": {
"smithy.api#documentation": "<p>When <code>true</code>, instructs Amazon Transcribe Medical to process each audio channel separately and\n then merge the transcription output of each channel into a single transcription.</p>\n <p>Amazon Transcribe Medical also produces a transcription of each item. An item includes the start time,\n end time, and any alternative transcriptions.</p>\n <p>You can't set both <code>ShowSpeakerLabel</code> and\n <code>EnableChannelIdentification</code> in the same request. If you set both, your\n request returns a <code>BadRequestException</code>.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification"
}
},
"NumberOfChannels": {
"target": "com.amazonaws.transcribestreaming#NumberOfChannels",
"traits": {
"smithy.api#documentation": "<p>The number of channels that are in your audio stream.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels"
}
},
"ContentIdentificationType": {
"target": "com.amazonaws.transcribestreaming#MedicalContentIdentificationType",
"traits": {
"smithy.api#documentation": "<p>Set this field to <code>PHI</code> to identify personal health information in the\n transcription output.</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-content-identification-type"
}
}
}
},
"com.amazonaws.transcribestreaming#StartMedicalStreamTranscriptionResponse": {
"type": "structure",
"members": {
"RequestId": {
"target": "com.amazonaws.transcribestreaming#RequestId",
"traits": {
"smithy.api#documentation": "<p>An identifier for the streaming transcription.</p>",
"smithy.api#httpHeader": "x-amzn-request-id"
}
},
"LanguageCode": {
"target": "com.amazonaws.transcribestreaming#LanguageCode",
"traits": {
"smithy.api#documentation": "<p>The language code for the response transcript. For Amazon Transcribe Medical, this is US English\n (en-US).</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-language-code"
}
},
"MediaSampleRateHertz": {
"target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz",
"traits": {
"smithy.api#documentation": "<p>The sample rate of the input audio, in Hertz (Hz).</p>",
"smithy.api#httpHeader": "x-amzn-transcribe-sample-rate"
}
},
"MediaEncoding": {