/
types.go
1785 lines (1469 loc) · 83.9 KB
/
types.go
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
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// A time range, in milliseconds, between two points in your media file. You can
// use StartTime and EndTime to search a custom segment. For example, setting
// StartTime to 10000 and EndTime to 50000 only searches for your specified
// criteria in the audio contained between the 10,000 millisecond mark and the
// 50,000 millisecond mark of your media file. You must use StartTime and EndTime
// as a set; that is, if you include one, you must include both. You can use also
// First to search from the start of the audio until the time that you specify, or
// Last to search from the time that you specify until the end of the audio. For
// example, setting First to 50000 only searches for your specified criteria in
// the audio contained between the start of the media file to the 50,000
// millisecond mark. You can use First and Last independently of each other. If
// you prefer to use percentage instead of milliseconds, see .
type AbsoluteTimeRange struct {
// The time, in milliseconds, when Amazon Transcribe stops searching for the
// specified criteria in your audio. If you include EndTime in your request, you
// must also include StartTime .
EndTime *int64
// The time, in milliseconds, from the start of your media file until the
// specified value. Amazon Transcribe searches for your specified criteria in this
// time segment.
First *int64
// The time, in milliseconds, from the specified value until the end of your media
// file. Amazon Transcribe searches for your specified criteria in this time
// segment.
Last *int64
// The time, in milliseconds, when Amazon Transcribe starts searching for the
// specified criteria in your audio. If you include StartTime in your request, you
// must also include EndTime .
StartTime *int64
noSmithyDocumentSerde
}
// Provides detailed information about a Call Analytics job. To view the job's
// status, refer to CallAnalyticsJobStatus . If the status is COMPLETED , the job
// is finished. You can find your completed transcript at the URI specified in
// TranscriptFileUri . If the status is FAILED , FailureReason provides details on
// why your transcription job failed. If you enabled personally identifiable
// information (PII) redaction, the redacted transcript appears at the location
// specified in RedactedTranscriptFileUri . If you chose to redact the audio in
// your media file, you can find your redacted media file at the location specified
// in the RedactedMediaFileUri field of your response.
type CallAnalyticsJob struct {
// The name of the Call Analytics job. Job names are case sensitive and must be
// unique within an Amazon Web Services account.
CallAnalyticsJobName *string
// Provides the status of the specified Call Analytics job. If the status is
// COMPLETED , the job is finished and you can find the results at the location
// specified in TranscriptFileUri (or RedactedTranscriptFileUri , if you requested
// transcript redaction). If the status is FAILED , FailureReason provides details
// on why your transcription job failed.
CallAnalyticsJobStatus CallAnalyticsJobStatus
// Indicates which speaker is on which channel.
ChannelDefinitions []ChannelDefinition
// The date and time the specified Call Analytics job finished processing.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
// processing at 12:33 PM UTC-7 on May 4, 2022.
CompletionTime *time.Time
// The date and time the specified Call Analytics job request was made. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
CreationTime *time.Time
// The Amazon Resource Name (ARN) you included in your request.
DataAccessRoleArn *string
// If CallAnalyticsJobStatus is FAILED , FailureReason contains information about
// why the Call Analytics job request failed. The FailureReason field contains one
// of the following values:
// - Unsupported media format . The media format specified in MediaFormat isn't
// valid. Refer to refer to the MediaFormat parameter for a list of supported
// formats.
// - The media format provided does not match the detected media format . The
// media format specified in MediaFormat doesn't match the format of the input
// file. Check the media format of your media file and correct the specified value.
//
// - Invalid sample rate for audio file . The sample rate specified in
// MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and
// 48,000 hertz.
// - The sample rate provided does not match the detected sample rate . The
// sample rate specified in MediaSampleRateHertz doesn't match the sample rate
// detected in your input media file. Check the sample rate of your media file and
// correct the specified value.
// - Invalid file size: file size too large . The size of your media file is
// larger than what Amazon Transcribe can process. For more information, refer to
// Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
// .
// - Invalid number of channels: number of channels too large . Your audio
// contains more channels than Amazon Transcribe is able to process. For more
// information, refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
// .
FailureReason *string
// The confidence score associated with the language identified in your media
// file. Confidence scores are values between 0 and 1; a larger value indicates a
// higher probability that the identified language correctly matches the language
// spoken in your media.
IdentifiedLanguageScore *float32
// The language code used to create your Call Analytics job. For a list of
// supported languages and their associated language codes, refer to the Supported
// languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
// table. If you do not know the language spoken in your media file, you can omit
// this field and let Amazon Transcribe automatically identify the language of your
// media. To improve the accuracy of language identification, you can include
// several language codes and Amazon Transcribe chooses the closest match for your
// transcription.
LanguageCode LanguageCode
// Provides the Amazon S3 location of the media file you used in your Call
// Analytics request.
Media *Media
// The format of the input media file.
MediaFormat MediaFormat
// The sample rate, in hertz, of the audio track in your input media file.
MediaSampleRateHertz *int32
// Provides information on any additional settings that were included in your
// request. Additional settings include content redaction and language
// identification settings.
Settings *CallAnalyticsJobSettings
// The date and time the specified Call Analytics job began processing. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
StartTime *time.Time
// Provides you with the Amazon S3 URI you can use to access your transcript.
Transcript *Transcript
noSmithyDocumentSerde
}
// Provides additional optional settings for your request, including content
// redaction, automatic language identification; allows you to apply custom
// language models, custom vocabulary filters, and custom vocabularies.
type CallAnalyticsJobSettings struct {
// Makes it possible to redact or flag specified personally identifiable
// information (PII) in your transcript. If you use ContentRedaction , you must
// also include the sub-parameters: RedactionOutput and RedactionType . You can
// optionally include PiiEntityTypes to choose which types of PII you want to
// redact.
ContentRedaction *ContentRedaction
// If using automatic language identification in your request and you want to
// apply a custom language model, a custom vocabulary, or a custom vocabulary
// filter, include LanguageIdSettings with the relevant sub-parameters (
// VocabularyName , LanguageModelName , and VocabularyFilterName ).
// LanguageIdSettings supports two to five language codes. Each language code you
// include can have an associated custom language model, custom vocabulary, and
// custom vocabulary filter. The language codes that you specify must match the
// languages of the associated custom language models, custom vocabularies, and
// custom vocabulary filters. It's recommended that you include LanguageOptions
// when using LanguageIdSettings to ensure that the correct language dialect is
// identified. For example, if you specify a custom vocabulary that is in en-US
// but Amazon Transcribe determines that the language spoken in your media is en-AU
// , your custom vocabulary is not applied to your transcription. If you include
// LanguageOptions and include en-US as the only English language dialect, your
// custom vocabulary is applied to your transcription. If you want to include a
// custom language model, custom vocabulary, or custom vocabulary filter with your
// request but do not want to use automatic language identification, use instead
// the parameter with the LanguageModelName , VocabularyName , or
// VocabularyFilterName sub-parameters. For a list of languages supported with Call
// Analytics, refer to Supported languages and language-specific features (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
// .
LanguageIdSettings map[string]LanguageIdSettings
// The name of the custom language model you want to use when processing your Call
// Analytics job. Note that custom language model names are case sensitive. The
// language of the specified custom language model must match the language code
// that you specify in your transcription request. If the languages do not match,
// the custom language model isn't applied. There are no errors or warnings
// associated with a language mismatch.
LanguageModelName *string
// You can specify two or more language codes that represent the languages you
// think may be present in your media. Including more than five is not recommended.
// If you're unsure what languages are present, do not include this parameter.
// Including language options can improve the accuracy of language identification.
// For a list of languages supported with Call Analytics, refer to the Supported
// languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
// table. To transcribe speech in Modern Standard Arabic ( ar-SA ), your media file
// must be encoded at a sample rate of 16,000 Hz or higher.
LanguageOptions []LanguageCode
// Contains GenerateAbstractiveSummary , which is a required parameter if you want
// to enable Generative call summarization in your Call Analytics request.
Summarization *Summarization
// Specify how you want your custom vocabulary filter applied to your transcript.
// To replace words with *** , choose mask . To delete words, choose remove . To
// flag words without changing them, choose tag .
VocabularyFilterMethod VocabularyFilterMethod
// The name of the custom vocabulary filter you want to include in your Call
// Analytics transcription request. Custom vocabulary filter names are case
// sensitive. Note that if you include VocabularyFilterName in your request, you
// must also include VocabularyFilterMethod .
VocabularyFilterName *string
// The name of the custom vocabulary you want to include in your Call Analytics
// transcription request. Custom vocabulary names are case sensitive.
VocabularyName *string
noSmithyDocumentSerde
}
// Provides detailed information about a specific Call Analytics job.
type CallAnalyticsJobSummary struct {
// The name of the Call Analytics job. Job names are case sensitive and must be
// unique within an Amazon Web Services account.
CallAnalyticsJobName *string
// Provides the status of your Call Analytics job. If the status is COMPLETED , the
// job is finished and you can find the results at the location specified in
// TranscriptFileUri (or RedactedTranscriptFileUri , if you requested transcript
// redaction). If the status is FAILED , FailureReason provides details on why
// your transcription job failed.
CallAnalyticsJobStatus CallAnalyticsJobStatus
// The date and time the specified Call Analytics job finished processing.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
// processing at 12:33 PM UTC-7 on May 4, 2022.
CompletionTime *time.Time
// The date and time the specified Call Analytics job request was made. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
CreationTime *time.Time
// If CallAnalyticsJobStatus is FAILED , FailureReason contains information about
// why the Call Analytics job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
// .
FailureReason *string
// The language code used to create your Call Analytics transcription.
LanguageCode LanguageCode
// The date and time your Call Analytics job began processing. Timestamps are in
// the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
StartTime *time.Time
noSmithyDocumentSerde
}
// Provides you with the properties of the Call Analytics category you specified
// in your request. This includes the list of rules that define the specified
// category.
type CategoryProperties struct {
// The name of the Call Analytics category. Category names are case sensitive and
// must be unique within an Amazon Web Services account.
CategoryName *string
// The date and time the specified Call Analytics category was created. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
CreateTime *time.Time
// The input type associated with the specified category. POST_CALL refers to a
// category that is applied to batch transcriptions; REAL_TIME refers to a
// category that is applied to streaming transcriptions.
InputType InputType
// The date and time the specified Call Analytics category was last updated.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May 5, 2022.
LastUpdateTime *time.Time
// The rules used to define a Call Analytics category. Each category can have
// between 1 and 20 rules.
Rules []Rule
noSmithyDocumentSerde
}
// Makes it possible to specify which speaker is on which channel. For example, if
// your agent is the first participant to speak, you would set ChannelId to 0 (to
// indicate the first channel) and ParticipantRole to AGENT (to indicate that it's
// the agent speaking).
type ChannelDefinition struct {
// Specify the audio channel you want to define.
ChannelId int32
// Specify the speaker you want to define. Omitting this parameter is equivalent
// to specifying both participants.
ParticipantRole ParticipantRole
noSmithyDocumentSerde
}
// Makes it possible to redact or flag specified personally identifiable
// information (PII) in your transcript. If you use ContentRedaction , you must
// also include the sub-parameters: RedactionOutput and RedactionType . You can
// optionally include PiiEntityTypes to choose which types of PII you want to
// redact.
type ContentRedaction struct {
// Specify if you want only a redacted transcript, or if you want a redacted and
// an unredacted transcript. When you choose redacted Amazon Transcribe creates
// only a redacted transcript. When you choose redacted_and_unredacted Amazon
// Transcribe creates a redacted and an unredacted transcript (as two separate
// files).
//
// This member is required.
RedactionOutput RedactionOutput
// Specify the category of information you want to redact; PII (personally
// identifiable information) is the only valid value. You can use PiiEntityTypes
// to choose which types of PII you want to redact. If you do not include
// PiiEntityTypes in your request, all PII is redacted.
//
// This member is required.
RedactionType RedactionType
// Specify which types of personally identifiable information (PII) you want to
// redact in your transcript. You can include as many types as you'd like, or you
// can select ALL . If you do not include PiiEntityTypes in your request, all PII
// is redacted.
PiiEntityTypes []PiiEntityType
noSmithyDocumentSerde
}
// Contains the Amazon S3 location of the training data you want to use to create
// a new custom language model, and permissions to access this location. When using
// InputDataConfig , you must include these sub-parameters: S3Uri and
// DataAccessRoleArn . You can optionally include TuningDataS3Uri .
type InputDataConfig struct {
// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
// the Amazon S3 bucket that contains your input files. If the role that you
// specify doesn’t have the appropriate permissions to access the specified Amazon
// S3 location, your request fails. IAM role ARNs have the format
// arn:partition:iam::account:role/role-name-with-path . For example:
// arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns)
// .
//
// This member is required.
DataAccessRoleArn *string
// The Amazon S3 location (URI) of the text files you want to use to train your
// custom language model. Here's an example URI path:
// s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
//
// This member is required.
S3Uri *string
// The Amazon S3 location (URI) of the text files you want to use to tune your
// custom language model. Here's an example URI path:
// s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
TuningDataS3Uri *string
noSmithyDocumentSerde
}
// Flag the presence or absence of interruptions in your Call Analytics
// transcription output. Rules using InterruptionFilter are designed to match:
// - Instances where an agent interrupts a customer
// - Instances where a customer interrupts an agent
// - Either participant interrupting the other
// - A lack of interruptions
//
// See Rule criteria for post-call categories (https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch)
// for usage examples.
type InterruptionFilter struct {
// Makes it possible to specify a time range (in milliseconds) in your audio,
// during which you want to search for an interruption. See for more detail.
AbsoluteTimeRange *AbsoluteTimeRange
// Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to
// flag speech that contains interruptions.
Negate *bool
// Specify the interrupter that you want to flag. Omitting this parameter is
// equivalent to specifying both participants.
ParticipantRole ParticipantRole
// Makes it possible to specify a time range (in percentage) in your media file,
// during which you want to search for an interruption. See for more detail.
RelativeTimeRange *RelativeTimeRange
// Specify the duration of the interruptions in milliseconds. For example, you can
// flag speech that contains more than 10,000 milliseconds of interruptions.
Threshold *int64
noSmithyDocumentSerde
}
// Makes it possible to control how your transcription job is processed.
// Currently, the only JobExecutionSettings modification you can choose is
// enabling job queueing using the AllowDeferredExecution sub-parameter. If you
// include JobExecutionSettings in your request, you must also include the
// sub-parameters: AllowDeferredExecution and DataAccessRoleArn .
type JobExecutionSettings struct {
// Makes it possible to enable job queuing when your concurrent request limit is
// exceeded. When AllowDeferredExecution is set to true , transcription job
// requests are placed in a queue until the number of jobs falls below the
// concurrent request limit. If AllowDeferredExecution is set to false and the
// number of transcription job requests exceed the concurrent request limit, you
// get a LimitExceededException error. If you include AllowDeferredExecution in
// your request, you must also include DataAccessRoleArn .
AllowDeferredExecution *bool
// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
// the Amazon S3 bucket that contains your input files. If the role that you
// specify doesn’t have the appropriate permissions to access the specified Amazon
// S3 location, your request fails. IAM role ARNs have the format
// arn:partition:iam::account:role/role-name-with-path . For example:
// arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns)
// . Note that if you include DataAccessRoleArn in your request, you must also
// include AllowDeferredExecution .
DataAccessRoleArn *string
noSmithyDocumentSerde
}
// Provides information on the speech contained in a discreet utterance when
// multi-language identification is enabled in your request. This utterance
// represents a block of speech consisting of one language, preceded or followed by
// a block of speech in a different language.
type LanguageCodeItem struct {
// Provides the total time, in seconds, each identified language is spoken in your
// media.
DurationInSeconds *float32
// Provides the language code for each language identified in your media.
LanguageCode LanguageCode
noSmithyDocumentSerde
}
// If using automatic language identification in your request and you want to
// apply a custom language model, a custom vocabulary, or a custom vocabulary
// filter, include LanguageIdSettings with the relevant sub-parameters (
// VocabularyName , LanguageModelName , and VocabularyFilterName ). Note that
// multi-language identification ( IdentifyMultipleLanguages ) doesn't support
// custom language models. LanguageIdSettings supports two to five language codes.
// Each language code you include can have an associated custom language model,
// custom vocabulary, and custom vocabulary filter. The language codes that you
// specify must match the languages of the associated custom language models,
// custom vocabularies, and custom vocabulary filters. It's recommended that you
// include LanguageOptions when using LanguageIdSettings to ensure that the
// correct language dialect is identified. For example, if you specify a custom
// vocabulary that is in en-US but Amazon Transcribe determines that the language
// spoken in your media is en-AU , your custom vocabulary is not applied to your
// transcription. If you include LanguageOptions and include en-US as the only
// English language dialect, your custom vocabulary is applied to your
// transcription. If you want to include a custom language model with your request
// but do not want to use automatic language identification, use instead the
// parameter with the LanguageModelName sub-parameter. If you want to include a
// custom vocabulary or a custom vocabulary filter (or both) with your request but
// do not want to use automatic language identification, use instead the parameter
// with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
type LanguageIdSettings struct {
// The name of the custom language model you want to use when processing your
// transcription job. Note that custom language model names are case sensitive. The
// language of the specified custom language model must match the language code
// that you specify in your transcription request. If the languages do not match,
// the custom language model isn't applied. There are no errors or warnings
// associated with a language mismatch.
LanguageModelName *string
// The name of the custom vocabulary filter you want to use when processing your
// transcription job. Custom vocabulary filter names are case sensitive. The
// language of the specified custom vocabulary filter must match the language code
// that you specify in your transcription request. If the languages do not match,
// the custom vocabulary filter isn't applied. There are no errors or warnings
// associated with a language mismatch. Note that if you include
// VocabularyFilterName in your request, you must also include
// VocabularyFilterMethod .
VocabularyFilterName *string
// The name of the custom vocabulary you want to use when processing your
// transcription job. Custom vocabulary names are case sensitive. The language of
// the specified custom vocabulary must match the language code that you specify in
// your transcription request. If the languages do not match, the custom vocabulary
// isn't applied. There are no errors or warnings associated with a language
// mismatch.
VocabularyName *string
noSmithyDocumentSerde
}
// Provides information about a custom language model, including:
// - The base model name
// - When the model was created
// - The location of the files used to train the model
// - When the model was last modified
// - The name you chose for the model
// - The model's language
// - The model's processing state
// - Any available upgrades for the base model
type LanguageModel struct {
// The Amazon Transcribe standard language model, or base model, used to create
// your custom language model.
BaseModelName BaseModelName
// The date and time the specified custom language model was created. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
CreateTime *time.Time
// If ModelStatus is FAILED , FailureReason contains information about why the
// custom language model request failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
// .
FailureReason *string
// The Amazon S3 location of the input files used to train and tune your custom
// language model, in addition to the data access role ARN (Amazon Resource Name)
// that has permissions to access these data.
InputDataConfig *InputDataConfig
// The language code used to create your custom language model. Each custom
// language model must contain terms in only one language, and the language you
// select for your custom language model must match the language of your training
// and tuning data. For a list of supported languages and their associated language
// codes, refer to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
// table. Note that US English ( en-US ) is the only language supported with Amazon
// Transcribe Medical.
LanguageCode CLMLanguageCode
// The date and time the specified custom language model was last modified.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
LastModifiedTime *time.Time
// A unique name, chosen by you, for your custom language model. This name is case
// sensitive, cannot contain spaces, and must be unique within an Amazon Web
// Services account.
ModelName *string
// The status of the specified custom language model. When the status displays as
// COMPLETED the model is ready for use.
ModelStatus ModelStatus
// Shows if a more current base model is available for use with the specified
// custom language model. If false , your custom language model is using the most
// up-to-date base model. If true , there is a newer base model available than the
// one your language model is using. Note that to update a base model, you must
// recreate the custom language model using the new base model. Base model upgrades
// for existing custom language models are not supported.
UpgradeAvailability *bool
noSmithyDocumentSerde
}
// Describes the Amazon S3 location of the media file you want to use in your
// request. For information on supported media formats, refer to the MediaFormat
// parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
// section in the Amazon S3 Developer Guide.
type Media struct {
// The Amazon S3 location of the media file you want to transcribe. For example:
// - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
// - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
// Note that the Amazon S3 bucket that contains your input media must be located
// in the same Amazon Web Services Region where you're making your transcription
// request.
MediaFileUri *string
// The Amazon S3 location of the media file you want to redact. For example:
// - s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
// - s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
// Note that the Amazon S3 bucket that contains your input media must be located
// in the same Amazon Web Services Region where you're making your transcription
// request. RedactedMediaFileUri produces a redacted audio file in addition to a
// redacted transcript. It is only supported for Call Analytics (
// StartCallAnalyticsJob ) transcription requests.
RedactedMediaFileUri *string
noSmithyDocumentSerde
}
// Indicates which speaker is on which channel. The options are CLINICIAN and
// PATIENT
type MedicalScribeChannelDefinition struct {
// Specify the audio channel you want to define.
//
// This member is required.
ChannelId int32
// Specify the participant that you want to flag. The options are CLINICIAN and
// PATIENT
//
// This member is required.
ParticipantRole MedicalScribeParticipantRole
noSmithyDocumentSerde
}
// Provides detailed information about a Medical Scribe job. To view the status of
// the specified Medical Scribe job, check the MedicalScribeJobStatus field. If
// the status is COMPLETED , the job is finished and you can find the results at
// the locations specified in MedicalScribeOutput . If the status is FAILED ,
// FailureReason provides details on why your Medical Scribe job failed.
type MedicalScribeJob struct {
// Makes it possible to specify which speaker is on which channel. For example, if
// the clinician is the first participant to speak, you would set ChannelId of the
// first ChannelDefinition in the list to 0 (to indicate the first channel) and
// ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking).
// Then you would set the ChannelId of the second ChannelDefinition in the list to
// 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate
// that it's the patient speaking).
ChannelDefinitions []MedicalScribeChannelDefinition
// The date and time the specified Medical Scribe job finished processing.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished
// processing at 12:32 PM UTC-7 on May 4, 2022.
CompletionTime *time.Time
// The date and time the specified Medical Scribe job request was made. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
CreationTime *time.Time
// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
// the Amazon S3 bucket that contains your input files, write to the output bucket,
// and use your KMS key if supplied. If the role that you specify doesn’t have the
// appropriate permissions your request fails. IAM role ARNs have the format
// arn:partition:iam::account:role/role-name-with-path . For example:
// arn:aws:iam::111122223333:role/Admin . For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns)
// .
DataAccessRoleArn *string
// If MedicalScribeJobStatus is FAILED , FailureReason contains information about
// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
// .
FailureReason *string
// The language code used to create your Medical Scribe job. US English ( en-US )
// is the only supported language for Medical Scribe jobs.
LanguageCode MedicalScribeLanguageCode
// Describes the Amazon S3 location of the media file you want to use in your
// request. For information on supported media formats, refer to the MediaFormat
// parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
// section in the Amazon S3 Developer Guide.
Media *Media
// The name of the Medical Scribe job. Job names are case sensitive and must be
// unique within an Amazon Web Services account.
MedicalScribeJobName *string
// Provides the status of the specified Medical Scribe job. If the status is
// COMPLETED , the job is finished and you can find the results at the location
// specified in MedicalScribeOutput If the status is FAILED , FailureReason
// provides details on why your Medical Scribe job failed.
MedicalScribeJobStatus MedicalScribeJobStatus
// The location of the output of your Medical Scribe job. ClinicalDocumentUri
// holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds
// the Amazon S3 URI for the Transcript.
MedicalScribeOutput *MedicalScribeOutput
// Makes it possible to control how your Medical Scribe job is processed using a
// MedicalScribeSettings object. Specify ChannelIdentification if
// ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification
// and ChannelDefinitions are not set. One and only one of ChannelIdentification
// and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels
// must also be set. Use Settings to specify a vocabulary or vocabulary filter or
// both using VocabularyName , VocabularyFilterName . VocabularyFilterMethod must
// be specified if VocabularyFilterName is set.
Settings *MedicalScribeSettings
// The date and time your Medical Scribe job began processing. Timestamps are in
// the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
StartTime *time.Time
// Adds one or more custom tags, each in the form of a key:value pair, to the
// Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer
// to Tagging resources (https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html)
// .
Tags []Tag
noSmithyDocumentSerde
}
// Provides detailed information about a specific Medical Scribe job.
type MedicalScribeJobSummary struct {
// The date and time the specified Medical Scribe job finished processing.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished
// processing at 12:32 PM UTC-7 on May 4, 2022.
CompletionTime *time.Time
// The date and time the specified Medical Scribe job request was made. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
CreationTime *time.Time
// If MedicalScribeJobStatus is FAILED , FailureReason contains information about
// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
// .
FailureReason *string
// The language code used to create your Medical Scribe job. US English ( en-US )
// is the only supported language for Medical Scribe jobs.
LanguageCode MedicalScribeLanguageCode
// The name of the Medical Scribe job. Job names are case sensitive and must be
// unique within an Amazon Web Services account.
MedicalScribeJobName *string
// Provides the status of the specified Medical Scribe job. If the status is
// COMPLETED , the job is finished and you can find the results at the location
// specified in MedicalScribeOutput If the status is FAILED , FailureReason
// provides details on why your Medical Scribe job failed.
MedicalScribeJobStatus MedicalScribeJobStatus
// The date and time your Medical Scribe job began processing. Timestamps are in
// the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
StartTime *time.Time
noSmithyDocumentSerde
}
// The location of the output of your Medical Scribe job. ClinicalDocumentUri
// holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds
// the Amazon S3 URI for the Transcript.
type MedicalScribeOutput struct {
// Holds the Amazon S3 URI for the Clinical Document.
//
// This member is required.
ClinicalDocumentUri *string
// Holds the Amazon S3 URI for the Transcript.
//
// This member is required.
TranscriptFileUri *string
noSmithyDocumentSerde
}
// Makes it possible to control how your Medical Scribe job is processed using a
// MedicalScribeSettings object. Specify ChannelIdentification if
// ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification
// and ChannelDefinitions are not set. One and only one of ChannelIdentification
// and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels
// must also be set. Use Settings to specify a vocabulary or vocabulary filter or
// both using VocabularyName , VocabularyFilterName . VocabularyFilterMethod must
// be specified if VocabularyFilterName is set.
type MedicalScribeSettings struct {
// Enables channel identification in multi-channel audio. Channel identification
// transcribes the audio on each channel independently, then appends the output for
// each channel into one transcript. For more information, see Transcribing
// multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html)
// .
ChannelIdentification *bool
// Specify the maximum number of speakers you want to partition in your media.
// Note that if your media contains more speakers than the specified number,
// multiple speakers are treated as a single speaker. If you specify the
// MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
MaxSpeakerLabels *int32
// Enables speaker partitioning (diarization) in your Medical Scribe output.
// Speaker partitioning labels the speech from individual speakers in your media
// file. If you enable ShowSpeakerLabels in your request, you must also include
// MaxSpeakerLabels . For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html)
// .
ShowSpeakerLabels *bool
// Specify how you want your custom vocabulary filter applied to your transcript.
// To replace words with *** , choose mask . To delete words, choose remove . To
// flag words without changing them, choose tag .
VocabularyFilterMethod VocabularyFilterMethod
// The name of the custom vocabulary filter you want to include in your Medical
// Scribe request. Custom vocabulary filter names are case sensitive. Note that if
// you include VocabularyFilterName in your request, you must also include
// VocabularyFilterMethod .
VocabularyFilterName *string
// The name of the custom vocabulary you want to include in your Medical Scribe
// request. Custom vocabulary names are case sensitive.
VocabularyName *string
noSmithyDocumentSerde
}
// Provides you with the Amazon S3 URI you can use to access your transcript.
type MedicalTranscript struct {
// The Amazon S3 location of your transcript. You can use this URI to access or
// download your transcript. Note that this is the Amazon S3 location you specified
// in your request using the OutputBucketName parameter.
TranscriptFileUri *string
noSmithyDocumentSerde
}
// Provides detailed information about a medical transcription job. To view the
// status of the specified medical transcription job, check the
// TranscriptionJobStatus field. If the status is COMPLETED , the job is finished
// and you can find the results at the location specified in TranscriptFileUri . If
// the status is FAILED , FailureReason provides details on why your transcription
// job failed.
type MedicalTranscriptionJob struct {
// The date and time the specified medical transcription job finished processing.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
// processing at 12:33 PM UTC-7 on May 4, 2022.
CompletionTime *time.Time
// Indicates whether content identification was enabled for your transcription
// request.
ContentIdentificationType MedicalContentIdentificationType
// The date and time the specified medical transcription job request was made.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
CreationTime *time.Time
// If TranscriptionJobStatus is FAILED , FailureReason contains information about
// why the transcription job request failed. The FailureReason field contains one
// of the following values:
// - Unsupported media format . The media format specified in MediaFormat isn't
// valid. Refer to refer to the MediaFormat parameter for a list of supported
// formats.
// - The media format provided does not match the detected media format . The
// media format specified in MediaFormat doesn't match the format of the input
// file. Check the media format of your media file and correct the specified value.
//
// - Invalid sample rate for audio file . The sample rate specified in
// MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and
// 48,000 hertz.
// - The sample rate provided does not match the detected sample rate . The
// sample rate specified in MediaSampleRateHertz doesn't match the sample rate
// detected in your input media file. Check the sample rate of your media file and
// correct the specified value.
// - Invalid file size: file size too large . The size of your media file is
// larger than what Amazon Transcribe can process. For more information, refer to
// Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
// .
// - Invalid number of channels: number of channels too large . Your audio
// contains more channels than Amazon Transcribe is able to process. For more
// information, refer to Service quotas (https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe)
// .
FailureReason *string
// The language code used to create your medical transcription job. US English (
// en-US ) is the only supported language for medical transcriptions.
LanguageCode LanguageCode
// Describes the Amazon S3 location of the media file you want to use in your
// request. For information on supported media formats, refer to the MediaFormat
// parameter or the Media formats (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio)
// section in the Amazon S3 Developer Guide.
Media *Media
// The format of the input media file.
MediaFormat MediaFormat
// The sample rate, in hertz, of the audio track in your input media file.
MediaSampleRateHertz *int32
// The name of the medical transcription job. Job names are case sensitive and
// must be unique within an Amazon Web Services account.
MedicalTranscriptionJobName *string
// Provides information on any additional settings that were included in your
// request. Additional settings include channel identification, alternative
// transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary
// filters.
Settings *MedicalTranscriptionSetting
// Describes the medical specialty represented in your media.
Specialty Specialty
// The date and time the specified medical transcription job began processing.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
StartTime *time.Time
// The tags, each in the form of a key:value pair, assigned to the specified
// medical transcription job.
Tags []Tag
// Provides you with the Amazon S3 URI you can use to access your transcript.
Transcript *MedicalTranscript
// Provides the status of the specified medical transcription job. If the status
// is COMPLETED , the job is finished and you can find the results at the location
// specified in TranscriptFileUri . If the status is FAILED , FailureReason
// provides details on why your transcription job failed.
TranscriptionJobStatus TranscriptionJobStatus
// Indicates whether the input media is a dictation or a conversation, as
// specified in the StartMedicalTranscriptionJob request.
Type Type
noSmithyDocumentSerde
}
// Provides detailed information about a specific medical transcription job.
type MedicalTranscriptionJobSummary struct {
// The date and time the specified medical transcription job finished processing.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started
// processing at 12:33 PM UTC-7 on May 4, 2022.
CompletionTime *time.Time
// Labels all personal health information (PHI) identified in your transcript. For
// more information, see Identifying personal health information (PHI) in a
// transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html) .
ContentIdentificationType MedicalContentIdentificationType
// The date and time the specified medical transcription job request was made.
// Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
CreationTime *time.Time
// If TranscriptionJobStatus is FAILED , FailureReason contains information about
// why the transcription job failed. See also: Common Errors (https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html)
// .
FailureReason *string
// The language code used to create your medical transcription. US English ( en-US
// ) is the only supported language for medical transcriptions.
LanguageCode LanguageCode
// The name of the medical transcription job. Job names are case sensitive and
// must be unique within an Amazon Web Services account.
MedicalTranscriptionJobName *string
// Indicates where the specified medical transcription output is stored. If the
// value is CUSTOMER_BUCKET , the location is the Amazon S3 bucket you specified
// using the OutputBucketName parameter in your request. If you also included
// OutputKey in your request, your output is located in the path you specified in
// your request. If the value is SERVICE_BUCKET , the location is a service-managed
// Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use
// the URI shown in the TranscriptFileUri field.
OutputLocationType OutputLocationType
// Provides the medical specialty represented in your media.
Specialty Specialty
// The date and time your medical transcription job began processing. Timestamps
// are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC . For example,
// 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started
// processing at 12:32 PM UTC-7 on May 4, 2022.
StartTime *time.Time
// Provides the status of your medical transcription job. If the status is
// COMPLETED , the job is finished and you can find the results at the location
// specified in TranscriptFileUri . If the status is FAILED , FailureReason
// provides details on why your transcription job failed.