aws-sdk-transcribeservice 1.76.0 → 1.78.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.
@@ -20,11 +20,11 @@ module Aws::TranscribeService
20
20
  # if you include one, you must include both.
21
21
  #
22
22
  # You can use also `First` to search from the start of the audio until
23
- # the time you specify, or `Last` to search from the time you specify
24
- # until the end of the audio. For example, setting `First` to 50000 only
25
- # searches for your specified criteria in the audio contained between
26
- # the start of the media file to the 50,000 millisecond mark. You can
27
- # use `First` and `Last` independently of each other.
23
+ # the time that you specify, or `Last` to search from the time that you
24
+ # specify until the end of the audio. For example, setting `First` to
25
+ # 50000 only searches for your specified criteria in the audio contained
26
+ # between the start of the media file to the 50,000 millisecond mark.
27
+ # You can use `First` and `Last` independently of each other.
28
28
  #
29
29
  # If you prefer to use percentage instead of milliseconds, see .
30
30
  #
@@ -52,14 +52,14 @@ module Aws::TranscribeService
52
52
  #
53
53
  # @!attribute [rw] first
54
54
  # The time, in milliseconds, from the start of your media file until
55
- # the value you specify in which Amazon Transcribe searches for your
56
- # specified criteria.
55
+ # the specified value. Amazon Transcribe searches for your specified
56
+ # criteria in this time segment.
57
57
  # @return [Integer]
58
58
  #
59
59
  # @!attribute [rw] last
60
- # The time, in milliseconds, from the value you specify until the end
61
- # of your media file in which Amazon Transcribe searches for your
62
- # specified criteria.
60
+ # The time, in milliseconds, from the specified value until the end of
61
+ # your media file. Amazon Transcribe searches for your specified
62
+ # criteria in this time segment.
63
63
  # @return [Integer]
64
64
  #
65
65
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/AbsoluteTimeRange AWS API Documentation
@@ -137,7 +137,7 @@ module Aws::TranscribeService
137
137
  # @return [String]
138
138
  #
139
139
  # @!attribute [rw] media_sample_rate_hertz
140
- # The sample rate, in Hertz, of the audio track in your input media
140
+ # The sample rate, in hertz, of the audio track in your input media
141
141
  # file.
142
142
  # @return [Integer]
143
143
  #
@@ -146,8 +146,8 @@ module Aws::TranscribeService
146
146
  # @return [String]
147
147
  #
148
148
  # @!attribute [rw] media
149
- # Describes the Amazon S3 location of the media file you want to use
150
- # in your request.
149
+ # Provides the Amazon S3 location of the media file you used in your
150
+ # Call Analytics request.
151
151
  # @return [Types::Media]
152
152
  #
153
153
  # @!attribute [rw] transcript
@@ -204,7 +204,7 @@ module Aws::TranscribeService
204
204
  # * `Invalid sample rate for audio file`.
205
205
  #
206
206
  # The sample rate specified in `MediaSampleRateHertz` isn't valid.
207
- # The sample rate must be between 8,000 and 48,000 Hertz.
207
+ # The sample rate must be between 8,000 and 48,000 hertz.
208
208
  #
209
209
  # * `The sample rate provided does not match the detected sample
210
210
  # rate`.
@@ -231,20 +231,7 @@ module Aws::TranscribeService
231
231
  # @return [String]
232
232
  #
233
233
  # @!attribute [rw] data_access_role_arn
234
- # The Amazon Resource Name (ARN) of an IAM role that has permissions
235
- # to access the Amazon S3 bucket that contains your input files. If
236
- # the role you specify doesn’t have the appropriate permissions to
237
- # access the specified Amazon S3 location, your request fails.
238
- #
239
- # IAM role ARNs have the format
240
- # `arn:partition:iam::account:role/role-name-with-path`. For example:
241
- # `arn:aws:iam::111122223333:role/Admin`.
242
- #
243
- # For more information, see [IAM ARNs][1].
244
- #
245
- #
246
- #
247
- # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
234
+ # The Amazon Resource Name (ARN) you included in your request.
248
235
  # @return [String]
249
236
  #
250
237
  # @!attribute [rw] identified_language_score
@@ -257,18 +244,13 @@ module Aws::TranscribeService
257
244
  # @return [Float]
258
245
  #
259
246
  # @!attribute [rw] settings
260
- # Allows additional optional settings in your request, including
261
- # content redaction; allows you to apply custom language models,
262
- # vocabulary filters, and custom vocabularies to your Call Analytics
263
- # job.
247
+ # Provides information on any additional settings that were included
248
+ # in your request. Additional settings include content redaction and
249
+ # language identification settings.
264
250
  # @return [Types::CallAnalyticsJobSettings]
265
251
  #
266
252
  # @!attribute [rw] channel_definitions
267
- # Allows you to specify which speaker is on which channel in your Call
268
- # Analytics job request. For example, if your agent is the first
269
- # participant to speak, you would set `ChannelId` to `0` (to indicate
270
- # the first channel) and `ParticipantRole` to `AGENT` (to indicate
271
- # that it's the agent speaking).
253
+ # Indicates which speaker is on which channel.
272
254
  # @return [Array<Types::ChannelDefinition>]
273
255
  #
274
256
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CallAnalyticsJob AWS API Documentation
@@ -295,7 +277,7 @@ module Aws::TranscribeService
295
277
 
296
278
  # Provides additional optional settings for your request, including
297
279
  # content redaction, automatic language identification; allows you to
298
- # apply custom language models, vocabulary filters, and custom
280
+ # apply custom language models, custom vocabulary filters, and custom
299
281
  # vocabularies.
300
282
  #
301
283
  # @note When making an API call, you may pass CallAnalyticsJobSettings
@@ -323,21 +305,21 @@ module Aws::TranscribeService
323
305
  #
324
306
  # @!attribute [rw] vocabulary_name
325
307
  # The name of the custom vocabulary you want to include in your Call
326
- # Analytics transcription request. Vocabulary names are case
308
+ # Analytics transcription request. Custom vocabulary names are case
327
309
  # sensitive.
328
310
  # @return [String]
329
311
  #
330
312
  # @!attribute [rw] vocabulary_filter_name
331
313
  # The name of the custom vocabulary filter you want to include in your
332
- # Call Analytics transcription request. Vocabulary filter names are
333
- # case sensitive.
314
+ # Call Analytics transcription request. Custom vocabulary filter names
315
+ # are case sensitive.
334
316
  #
335
317
  # Note that if you include `VocabularyFilterName` in your request, you
336
318
  # must also include `VocabularyFilterMethod`.
337
319
  # @return [String]
338
320
  #
339
321
  # @!attribute [rw] vocabulary_filter_method
340
- # Specify how you want your vocabulary filter applied to your
322
+ # Specify how you want your custom vocabulary filter applied to your
341
323
  # transcript.
342
324
  #
343
325
  # To replace words with `***`, choose `mask`.
@@ -349,25 +331,25 @@ module Aws::TranscribeService
349
331
  #
350
332
  # @!attribute [rw] language_model_name
351
333
  # The name of the custom language model you want to use when
352
- # processing your Call Analytics job. Note that language model names
353
- # are case sensitive.
334
+ # processing your Call Analytics job. Note that custom language model
335
+ # names are case sensitive.
354
336
  #
355
- # The language of the specified language model must match the language
356
- # code you specify in your transcription request. If the languages
357
- # don't match, the language model isn't applied. There are no errors
358
- # or warnings associated with a language mismatch.
337
+ # The language of the specified custom language model must match the
338
+ # language code that you specify in your transcription request. If the
339
+ # languages don't match, the custom language model isn't applied.
340
+ # There are no errors or warnings associated with a language mismatch.
359
341
  # @return [String]
360
342
  #
361
343
  # @!attribute [rw] content_redaction
362
- # Allows you to redact or flag specified personally identifiable
363
- # information (PII) in your transcript. If you use `ContentRedaction`,
364
- # you must also include the sub-parameters: `PiiEntityTypes`,
365
- # `RedactionOutput`, and `RedactionType`.
344
+ # Makes it possible to redact or flag specified personally
345
+ # identifiable information (PII) in your transcript. If you use
346
+ # `ContentRedaction`, you must also include the sub-parameters:
347
+ # `PiiEntityTypes`, `RedactionOutput`, and `RedactionType`.
366
348
  # @return [Types::ContentRedaction]
367
349
  #
368
350
  # @!attribute [rw] language_options
369
351
  # You can specify two or more language codes that represent the
370
- # languages you think may be present in your media; including more
352
+ # languages you think may be present in your media. Including more
371
353
  # than five is not recommended. If you're unsure what languages are
372
354
  # present, do not include this parameter.
373
355
  #
@@ -377,40 +359,44 @@ module Aws::TranscribeService
377
359
  # For a list of languages supported with Call Analytics, refer to the
378
360
  # [Supported languages][1] table.
379
361
  #
362
+ # To transcribe speech in Modern Standard Arabic (`ar-SA`), your media
363
+ # file must be encoded at a sample rate of 16,000 Hz or higher.
364
+ #
380
365
  #
381
366
  #
382
367
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
383
368
  # @return [Array<String>]
384
369
  #
385
370
  # @!attribute [rw] language_id_settings
386
- # If using automatic language identification (`IdentifyLanguage`) in
387
- # your request and you want to apply a custom language model, a custom
388
- # vocabulary, or a custom vocabulary filter, include
389
- # `LanguageIdSettings` with the relevant sub-parameters
390
- # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
391
- #
392
- # You can specify two or more language codes that represent the
393
- # languages you think may be present in your media; including more
394
- # than five is not recommended. Each language code you include can
395
- # have an associated custom language model, custom vocabulary, and
396
- # custom vocabulary filter. The languages you specify must match the
397
- # languages of the specified custom language models, custom
398
- # vocabularies, and custom vocabulary filters.
371
+ # If using automatic language identification in your request and you
372
+ # want to apply a custom language model, a custom vocabulary, or a
373
+ # custom vocabulary filter, include `LanguageIdSettings` with the
374
+ # relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
375
+ # `VocabularyFilterName`).
399
376
  #
400
- # To include language options using `IdentifyLanguage` **without**
401
- # including a custom language model, a custom vocabulary, or a custom
402
- # vocabulary filter, use `LanguageOptions` instead of
403
- # `LanguageIdSettings`. Including language options can improve the
404
- # accuracy of automatic language identification.
377
+ # `LanguageIdSettings` supports two to five language codes. Each
378
+ # language code you include can have an associated custom language
379
+ # model, custom vocabulary, and custom vocabulary filter. The language
380
+ # codes that you specify must match the languages of the associated
381
+ # custom language models, custom vocabularies, and custom vocabulary
382
+ # filters.
405
383
  #
406
- # If you want to include a custom language model with your request but
407
- # **do not** want to use automatic language identification, use
408
- # instead the ` parameter with the LanguageModelName
409
- # sub-parameter.</p> If you want to include a custom vocabulary or a
410
- # custom vocabulary filter (or both) with your request but do not want
411
- # to use automatic language identification, use instead the parameter
412
- # with the VocabularyName or VocabularyFilterName (or both)
413
- # sub-parameter.</p>
384
+ # It's recommended that you include `LanguageOptions` when using
385
+ # `LanguageIdSettings` to ensure that the correct language dialect is
386
+ # identified. For example, if you specify a custom vocabulary that is
387
+ # in `en-US` but Amazon Transcribe determines that the language spoken
388
+ # in your media is `en-AU`, your custom vocabulary *is not* applied to
389
+ # your transcription. If you include `LanguageOptions` and include
390
+ # `en-US` as the only English language dialect, your custom vocabulary
391
+ # *is* applied to your transcription.
392
+ #
393
+ # If you want to include a custom language model, custom vocabulary,
394
+ # or custom vocabulary filter with your request but **do not** want to
395
+ # use automatic language identification, use instead the ` parameter
396
+ # with the LanguageModelName, VocabularyName, or VocabularyFilterName
397
+ # sub-parameters.</p> For a list of languages supported with Call
398
+ # Analytics, refer to Supported languages and language-specific
399
+ # features.
414
400
  # `
415
401
  # @return [Hash<String,Types::LanguageIdSettings>]
416
402
  #
@@ -532,20 +518,28 @@ module Aws::TranscribeService
532
518
  # UTC-7 on May 5, 2022.
533
519
  # @return [Time]
534
520
  #
521
+ # @!attribute [rw] input_type
522
+ # The input type associated with the specified category. `POST_CALL`
523
+ # refers to a category that is applied to batch transcriptions;
524
+ # `REAL_TIME` refers to a category that is applied to streaming
525
+ # transcriptions.
526
+ # @return [String]
527
+ #
535
528
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CategoryProperties AWS API Documentation
536
529
  #
537
530
  class CategoryProperties < Struct.new(
538
531
  :category_name,
539
532
  :rules,
540
533
  :create_time,
541
- :last_update_time)
534
+ :last_update_time,
535
+ :input_type)
542
536
  SENSITIVE = []
543
537
  include Aws::Structure
544
538
  end
545
539
 
546
- # Allows you to specify which speaker is on which channel. For example,
547
- # if your agent is the first participant to speak, you would set
548
- # `ChannelId` to `0` (to indicate the first channel) and
540
+ # Makes it possible to specify which speaker is on which channel. For
541
+ # example, if your agent is the first participant to speak, you would
542
+ # set `ChannelId` to `0` (to indicate the first channel) and
549
543
  # `ParticipantRole` to `AGENT` (to indicate that it's the agent
550
544
  # speaking).
551
545
  #
@@ -589,7 +583,7 @@ module Aws::TranscribeService
589
583
  include Aws::Structure
590
584
  end
591
585
 
592
- # Allows you to redact or flag specified personally identifiable
586
+ # Makes it possible to redact or flag specified personally identifiable
593
587
  # information (PII) in your transcript. If you use `ContentRedaction`,
594
588
  # you must also include the sub-parameters: `PiiEntityTypes`,
595
589
  # `RedactionOutput`, and `RedactionType`.
@@ -714,6 +708,7 @@ module Aws::TranscribeService
714
708
  # },
715
709
  # },
716
710
  # ],
711
+ # input_type: "REAL_TIME", # accepts REAL_TIME, POST_CALL
717
712
  # }
718
713
  #
719
714
  # @!attribute [rw] category_name
@@ -727,19 +722,36 @@ module Aws::TranscribeService
727
722
  # @return [String]
728
723
  #
729
724
  # @!attribute [rw] rules
730
- # Rules define a Call Analytics category. When creating a new Call
731
- # Analytics category, you must create between 1 and 20 rules for that
732
- # category. For each rule, you specify a filter you want applied to
733
- # the attributes of a call. For example, you can choose a sentiment
734
- # filter that detects if a customer's sentiment was positive during
735
- # the last 30 seconds of the call.
725
+ # Rules define a Call Analytics category. When creating a new
726
+ # category, you must create between 1 and 20 rules for that category.
727
+ # For each rule, you specify a filter you want applied to the
728
+ # attributes of a call. For example, you can choose a sentiment filter
729
+ # that detects if a customer's sentiment was positive during the last
730
+ # 30 seconds of the call.
736
731
  # @return [Array<Types::Rule>]
737
732
  #
733
+ # @!attribute [rw] input_type
734
+ # Choose whether you want to create a streaming or a batch category
735
+ # for your Call Analytics transcription.
736
+ #
737
+ # Specifying `POST_CALL` assigns your category to batch
738
+ # transcriptions; categories with this input type cannot be applied to
739
+ # streaming (real-time) transcriptions.
740
+ #
741
+ # Specifying `REAL_TIME` assigns your category to streaming
742
+ # transcriptions; categories with this input type cannot be applied to
743
+ # batch (post-call) transcriptions.
744
+ #
745
+ # If you do not include `InputType`, your category is created as a
746
+ # batch category by default.
747
+ # @return [String]
748
+ #
738
749
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategoryRequest AWS API Documentation
739
750
  #
740
751
  class CreateCallAnalyticsCategoryRequest < Struct.new(
741
752
  :category_name,
742
- :rules)
753
+ :rules,
754
+ :input_type)
743
755
  SENSITIVE = []
744
756
  include Aws::Structure
745
757
  end
@@ -779,19 +791,19 @@ module Aws::TranscribeService
779
791
  #
780
792
  # @!attribute [rw] language_code
781
793
  # The language code that represents the language of your model. Each
782
- # language model must contain terms in only one language, and the
783
- # language you select for your model must match the language of your
784
- # training and tuning data.
794
+ # custom language model must contain terms in only one language, and
795
+ # the language you select for your custom language model must match
796
+ # the language of your training and tuning data.
785
797
  #
786
798
  # For a list of supported languages and their associated language
787
- # codes, refer to the [Supported languages][1] table. Note that U.S.
799
+ # codes, refer to the [Supported languages][1] table. Note that US
788
800
  # English (`en-US`) is the only language supported with Amazon
789
801
  # Transcribe Medical.
790
802
  #
791
803
  # A custom language model can only be used to transcribe files in the
792
- # same language as the model. For example, if you create a language
793
- # model using US English (`en-US`), you can only apply this model to
794
- # files that contain English audio.
804
+ # same language as the model. For example, if you create a custom
805
+ # language model using US English (`en-US`), you can only apply this
806
+ # model to files that contain English audio.
795
807
  #
796
808
  #
797
809
  #
@@ -813,8 +825,8 @@ module Aws::TranscribeService
813
825
  #
814
826
  # This name is case sensitive, cannot contain spaces, and must be
815
827
  # unique within an Amazon Web Services account. If you try to create a
816
- # new language model with the same name as an existing language model,
817
- # you get a `ConflictException` error.
828
+ # new custom language model with the same name as an existing custom
829
+ # language model, you get a `ConflictException` error.
818
830
  # @return [String]
819
831
  #
820
832
  # @!attribute [rw] input_data_config
@@ -914,8 +926,8 @@ module Aws::TranscribeService
914
926
  #
915
927
  # This name is case sensitive, cannot contain spaces, and must be
916
928
  # unique within an Amazon Web Services account. If you try to create a
917
- # new medical vocabulary with the same name as an existing medical
918
- # vocabulary, you get a `ConflictException` error.
929
+ # new custom medical vocabulary with the same name as an existing
930
+ # custom medical vocabulary, you get a `ConflictException` error.
919
931
  # @return [String]
920
932
  #
921
933
  # @!attribute [rw] language_code
@@ -935,8 +947,8 @@ module Aws::TranscribeService
935
947
  #
936
948
  # @!attribute [rw] tags
937
949
  # Adds one or more custom tags, each in the form of a key:value pair,
938
- # to a new medical vocabulary at the time you create this new
939
- # vocabulary.
950
+ # to a new custom medical vocabulary at the time you create this new
951
+ # custom vocabulary.
940
952
  #
941
953
  # To learn more about using tags with Amazon Transcribe, refer to
942
954
  # [Tagging resources][1].
@@ -962,14 +974,14 @@ module Aws::TranscribeService
962
974
  # @return [String]
963
975
  #
964
976
  # @!attribute [rw] language_code
965
- # The language code you selected for your medical vocabulary. US
966
- # English (`en-US`) is the only language supported with Amazon
977
+ # The language code you selected for your custom medical vocabulary.
978
+ # US English (`en-US`) is the only language supported with Amazon
967
979
  # Transcribe Medical.
968
980
  # @return [String]
969
981
  #
970
982
  # @!attribute [rw] vocabulary_state
971
983
  # The processing state of your custom medical vocabulary. If the state
972
- # is `READY`, you can use the vocabulary in a
984
+ # is `READY`, you can use the custom vocabulary in a
973
985
  # `StartMedicalTranscriptionJob` request.
974
986
  # @return [String]
975
987
  #
@@ -1024,19 +1036,19 @@ module Aws::TranscribeService
1024
1036
  #
1025
1037
  # This name is case sensitive, cannot contain spaces, and must be
1026
1038
  # unique within an Amazon Web Services account. If you try to create a
1027
- # new vocabulary filter with the same name as an existing vocabulary
1028
- # filter, you get a `ConflictException` error.
1039
+ # new custom vocabulary filter with the same name as an existing
1040
+ # custom vocabulary filter, you get a `ConflictException` error.
1029
1041
  # @return [String]
1030
1042
  #
1031
1043
  # @!attribute [rw] language_code
1032
1044
  # The language code that represents the language of the entries in
1033
- # your vocabulary filter. Each vocabulary filter must contain terms in
1034
- # only one language.
1045
+ # your vocabulary filter. Each custom vocabulary filter must contain
1046
+ # terms in only one language.
1035
1047
  #
1036
- # A vocabulary filter can only be used to transcribe files in the same
1037
- # language as the filter. For example, if you create a vocabulary
1038
- # filter using US English (`en-US`), you can only apply this filter to
1039
- # files that contain English audio.
1048
+ # A custom vocabulary filter can only be used to transcribe files in
1049
+ # the same language as the filter. For example, if you create a custom
1050
+ # vocabulary filter using US English (`en-US`), you can only apply
1051
+ # this filter to files that contain English audio.
1040
1052
  #
1041
1053
  # For a list of supported languages and their associated language
1042
1054
  # codes, refer to the [Supported languages][1] table.
@@ -1047,11 +1059,11 @@ module Aws::TranscribeService
1047
1059
  # @return [String]
1048
1060
  #
1049
1061
  # @!attribute [rw] words
1050
- # Use this parameter if you want to create your vocabulary filter by
1051
- # including all desired terms, as comma-separated values, within your
1052
- # request. The other option for creating your vocabulary filter is to
1053
- # save your entries in a text file and upload them to an Amazon S3
1054
- # bucket, then specify the location of your file using the
1062
+ # Use this parameter if you want to create your custom vocabulary
1063
+ # filter by including all desired terms, as comma-separated values,
1064
+ # within your request. The other option for creating your vocabulary
1065
+ # filter is to save your entries in a text file and upload them to an
1066
+ # Amazon S3 bucket, then specify the location of your file using the
1055
1067
  # `VocabularyFilterFileUri` parameter.
1056
1068
  #
1057
1069
  # Note that if you include `Words` in your request, you cannot use
@@ -1059,7 +1071,7 @@ module Aws::TranscribeService
1059
1071
  #
1060
1072
  # Each language has a character set that contains all allowed
1061
1073
  # characters for that specific language. If you use unsupported
1062
- # characters, your vocabulary filter request fails. Refer to
1074
+ # characters, your custom vocabulary filter request fails. Refer to
1063
1075
  # [Character Sets for Custom Vocabularies][1] to get the character set
1064
1076
  # for your language.
1065
1077
  #
@@ -1083,7 +1095,7 @@ module Aws::TranscribeService
1083
1095
  # @!attribute [rw] tags
1084
1096
  # Adds one or more custom tags, each in the form of a key:value pair,
1085
1097
  # to a new custom vocabulary filter at the time you create this new
1086
- # filter.
1098
+ # vocabulary filter.
1087
1099
  #
1088
1100
  # To learn more about using tags with Amazon Transcribe, refer to
1089
1101
  # [Tagging resources][1].
@@ -1110,11 +1122,11 @@ module Aws::TranscribeService
1110
1122
  # @return [String]
1111
1123
  #
1112
1124
  # @!attribute [rw] language_code
1113
- # The language code you selected for your vocabulary filter.
1125
+ # The language code you selected for your custom vocabulary filter.
1114
1126
  # @return [String]
1115
1127
  #
1116
1128
  # @!attribute [rw] last_modified_time
1117
- # The date and time you created your vocabulary filter.
1129
+ # The date and time you created your custom vocabulary filter.
1118
1130
  #
1119
1131
  # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
1120
1132
  # example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
@@ -1152,19 +1164,19 @@ module Aws::TranscribeService
1152
1164
  #
1153
1165
  # This name is case sensitive, cannot contain spaces, and must be
1154
1166
  # unique within an Amazon Web Services account. If you try to create a
1155
- # new vocabulary with the same name as an existing vocabulary, you get
1156
- # a `ConflictException` error.
1167
+ # new custom vocabulary with the same name as an existing custom
1168
+ # vocabulary, you get a `ConflictException` error.
1157
1169
  # @return [String]
1158
1170
  #
1159
1171
  # @!attribute [rw] language_code
1160
1172
  # The language code that represents the language of the entries in
1161
- # your custom vocabulary. Each vocabulary must contain terms in only
1162
- # one language.
1173
+ # your custom vocabulary. Each custom vocabulary must contain terms in
1174
+ # only one language.
1163
1175
  #
1164
1176
  # A custom vocabulary can only be used to transcribe files in the same
1165
- # language as the vocabulary. For example, if you create a vocabulary
1166
- # using US English (`en-US`), you can only apply this vocabulary to
1167
- # files that contain English audio.
1177
+ # language as the custom vocabulary. For example, if you create a
1178
+ # custom vocabulary using US English (`en-US`), you can only apply
1179
+ # this custom vocabulary to files that contain English audio.
1168
1180
  #
1169
1181
  # For a list of supported languages and their associated language
1170
1182
  # codes, refer to the [Supported languages][1] table.
@@ -1175,19 +1187,19 @@ module Aws::TranscribeService
1175
1187
  # @return [String]
1176
1188
  #
1177
1189
  # @!attribute [rw] phrases
1178
- # Use this parameter if you want to create your vocabulary by
1190
+ # Use this parameter if you want to create your custom vocabulary by
1179
1191
  # including all desired terms, as comma-separated values, within your
1180
- # request. The other option for creating your vocabulary is to save
1181
- # your entries in a text file and upload them to an Amazon S3 bucket,
1182
- # then specify the location of your file using the `VocabularyFileUri`
1183
- # parameter.
1192
+ # request. The other option for creating your custom vocabulary is to
1193
+ # save your entries in a text file and upload them to an Amazon S3
1194
+ # bucket, then specify the location of your file using the
1195
+ # `VocabularyFileUri` parameter.
1184
1196
  #
1185
1197
  # Note that if you include `Phrases` in your request, you cannot use
1186
1198
  # `VocabularyFileUri`; you must choose one or the other.
1187
1199
  #
1188
1200
  # Each language has a character set that contains all allowed
1189
1201
  # characters for that specific language. If you use unsupported
1190
- # characters, your vocabulary filter request fails. Refer to
1202
+ # characters, your custom vocabulary filter request fails. Refer to
1191
1203
  # [Character Sets for Custom Vocabularies][1] to get the character set
1192
1204
  # for your language.
1193
1205
  #
@@ -1210,7 +1222,7 @@ module Aws::TranscribeService
1210
1222
  #
1211
1223
  # @!attribute [rw] tags
1212
1224
  # Adds one or more custom tags, each in the form of a key:value pair,
1213
- # to a new custom vocabulary at the time you create this new
1225
+ # to a new custom vocabulary at the time you create this new custom
1214
1226
  # vocabulary.
1215
1227
  #
1216
1228
  # To learn more about using tags with Amazon Transcribe, refer to
@@ -1243,8 +1255,8 @@ module Aws::TranscribeService
1243
1255
  #
1244
1256
  # @!attribute [rw] vocabulary_state
1245
1257
  # The processing state of your custom vocabulary. If the state is
1246
- # `READY`, you can use the vocabulary in a `StartTranscriptionJob`
1247
- # request.
1258
+ # `READY`, you can use the custom vocabulary in a
1259
+ # `StartTranscriptionJob` request.
1248
1260
  # @return [String]
1249
1261
  #
1250
1262
  # @!attribute [rw] last_modified_time
@@ -1257,8 +1269,8 @@ module Aws::TranscribeService
1257
1269
  #
1258
1270
  # @!attribute [rw] failure_reason
1259
1271
  # If `VocabularyState` is `FAILED`, `FailureReason` contains
1260
- # information about why the vocabulary request failed. See also:
1261
- # [Common Errors][1].
1272
+ # information about why the custom vocabulary request failed. See
1273
+ # also: [Common Errors][1].
1262
1274
  #
1263
1275
  #
1264
1276
  #
@@ -1373,8 +1385,8 @@ module Aws::TranscribeService
1373
1385
  # }
1374
1386
  #
1375
1387
  # @!attribute [rw] vocabulary_name
1376
- # The name of the custom medical vocabulary you want to delete.
1377
- # Vocabulary names are case sensitive.
1388
+ # The name of the custom medical vocabulary you want to delete. Custom
1389
+ # medical vocabulary names are case sensitive.
1378
1390
  # @return [String]
1379
1391
  #
1380
1392
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalVocabularyRequest AWS API Documentation
@@ -1413,8 +1425,8 @@ module Aws::TranscribeService
1413
1425
  # }
1414
1426
  #
1415
1427
  # @!attribute [rw] vocabulary_filter_name
1416
- # The name of the custom vocabulary filter you want to delete.
1417
- # Vocabulary filter names are case sensitive.
1428
+ # The name of the custom vocabulary filter you want to delete. Custom
1429
+ # vocabulary filter names are case sensitive.
1418
1430
  # @return [String]
1419
1431
  #
1420
1432
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyFilterRequest AWS API Documentation
@@ -1433,8 +1445,8 @@ module Aws::TranscribeService
1433
1445
  # }
1434
1446
  #
1435
1447
  # @!attribute [rw] vocabulary_name
1436
- # The name of the custom vocabulary you want to delete. Vocabulary
1437
- # names are case sensitive.
1448
+ # The name of the custom vocabulary you want to delete. Custom
1449
+ # vocabulary names are case sensitive.
1438
1450
  # @return [String]
1439
1451
  #
1440
1452
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyRequest AWS API Documentation
@@ -1595,7 +1607,7 @@ module Aws::TranscribeService
1595
1607
  #
1596
1608
  # @!attribute [rw] vocabulary_name
1597
1609
  # The name of the custom medical vocabulary you want information
1598
- # about. Vocabulary names are case sensitive.
1610
+ # about. Custom medical vocabulary names are case sensitive.
1599
1611
  # @return [String]
1600
1612
  #
1601
1613
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabularyRequest AWS API Documentation
@@ -1612,14 +1624,14 @@ module Aws::TranscribeService
1612
1624
  # @return [String]
1613
1625
  #
1614
1626
  # @!attribute [rw] language_code
1615
- # The language code you selected for your medical vocabulary. US
1616
- # English (`en-US`) is the only language supported with Amazon
1627
+ # The language code you selected for your custom medical vocabulary.
1628
+ # US English (`en-US`) is the only language supported with Amazon
1617
1629
  # Transcribe Medical.
1618
1630
  # @return [String]
1619
1631
  #
1620
1632
  # @!attribute [rw] vocabulary_state
1621
1633
  # The processing state of your custom medical vocabulary. If the state
1622
- # is `READY`, you can use the vocabulary in a
1634
+ # is `READY`, you can use the custom vocabulary in a
1623
1635
  # `StartMedicalTranscriptionJob` request.
1624
1636
  # @return [String]
1625
1637
  #
@@ -1634,8 +1646,8 @@ module Aws::TranscribeService
1634
1646
  #
1635
1647
  # @!attribute [rw] failure_reason
1636
1648
  # If `VocabularyState` is `FAILED`, `FailureReason` contains
1637
- # information about why the medical vocabulary request failed. See
1638
- # also: [Common Errors][1].
1649
+ # information about why the custom medical vocabulary request failed.
1650
+ # See also: [Common Errors][1].
1639
1651
  #
1640
1652
  #
1641
1653
  #
@@ -1643,8 +1655,8 @@ module Aws::TranscribeService
1643
1655
  # @return [String]
1644
1656
  #
1645
1657
  # @!attribute [rw] download_uri
1646
- # The S3 location where the specified medical vocabulary is stored;
1647
- # use this URI to view or download the vocabulary.
1658
+ # The S3 location where the specified custom medical vocabulary is
1659
+ # stored; use this URI to view or download the custom vocabulary.
1648
1660
  # @return [String]
1649
1661
  #
1650
1662
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabularyResponse AWS API Documentation
@@ -1702,7 +1714,7 @@ module Aws::TranscribeService
1702
1714
  #
1703
1715
  # @!attribute [rw] vocabulary_filter_name
1704
1716
  # The name of the custom vocabulary filter you want information about.
1705
- # Vocabulary filter names are case sensitive.
1717
+ # Custom vocabulary filter names are case sensitive.
1706
1718
  # @return [String]
1707
1719
  #
1708
1720
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyFilterRequest AWS API Documentation
@@ -1719,11 +1731,12 @@ module Aws::TranscribeService
1719
1731
  # @return [String]
1720
1732
  #
1721
1733
  # @!attribute [rw] language_code
1722
- # The language code you selected for your vocabulary filter.
1734
+ # The language code you selected for your custom vocabulary filter.
1723
1735
  # @return [String]
1724
1736
  #
1725
1737
  # @!attribute [rw] last_modified_time
1726
- # The date and time the specified vocabulary filter was last modified.
1738
+ # The date and time the specified custom vocabulary filter was last
1739
+ # modified.
1727
1740
  #
1728
1741
  # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
1729
1742
  # example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
@@ -1731,8 +1744,8 @@ module Aws::TranscribeService
1731
1744
  # @return [Time]
1732
1745
  #
1733
1746
  # @!attribute [rw] download_uri
1734
- # The Amazon S3 location where the vocabulary filter is stored; use
1735
- # this URI to view or download the vocabulary filter.
1747
+ # The Amazon S3 location where the custom vocabulary filter is stored;
1748
+ # use this URI to view or download the custom vocabulary filter.
1736
1749
  # @return [String]
1737
1750
  #
1738
1751
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyFilterResponse AWS API Documentation
@@ -1754,8 +1767,8 @@ module Aws::TranscribeService
1754
1767
  # }
1755
1768
  #
1756
1769
  # @!attribute [rw] vocabulary_name
1757
- # The name of the custom vocabulary you want information about.
1758
- # Vocabulary names are case sensitive.
1770
+ # The name of the custom vocabulary you want information about. Custom
1771
+ # vocabulary names are case sensitive.
1759
1772
  # @return [String]
1760
1773
  #
1761
1774
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyRequest AWS API Documentation
@@ -1776,12 +1789,12 @@ module Aws::TranscribeService
1776
1789
  #
1777
1790
  # @!attribute [rw] vocabulary_state
1778
1791
  # The processing state of your custom vocabulary. If the state is
1779
- # `READY`, you can use the vocabulary in a `StartTranscriptionJob`
1780
- # request.
1792
+ # `READY`, you can use the custom vocabulary in a
1793
+ # `StartTranscriptionJob` request.
1781
1794
  # @return [String]
1782
1795
  #
1783
1796
  # @!attribute [rw] last_modified_time
1784
- # The date and time the specified vocabulary was last modified.
1797
+ # The date and time the specified custom vocabulary was last modified.
1785
1798
  #
1786
1799
  # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
1787
1800
  # example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
@@ -1790,8 +1803,8 @@ module Aws::TranscribeService
1790
1803
  #
1791
1804
  # @!attribute [rw] failure_reason
1792
1805
  # If `VocabularyState` is `FAILED`, `FailureReason` contains
1793
- # information about why the vocabulary request failed. See also:
1794
- # [Common Errors][1].
1806
+ # information about why the custom vocabulary request failed. See
1807
+ # also: [Common Errors][1].
1795
1808
  #
1796
1809
  #
1797
1810
  #
@@ -1799,8 +1812,8 @@ module Aws::TranscribeService
1799
1812
  # @return [String]
1800
1813
  #
1801
1814
  # @!attribute [rw] download_uri
1802
- # The S3 location where the vocabulary is stored; use this URI to view
1803
- # or download the vocabulary.
1815
+ # The S3 location where the custom vocabulary is stored; use this URI
1816
+ # to view or download the custom vocabulary.
1804
1817
  # @return [String]
1805
1818
  #
1806
1819
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyResponse AWS API Documentation
@@ -1852,8 +1865,8 @@ module Aws::TranscribeService
1852
1865
  # @!attribute [rw] data_access_role_arn
1853
1866
  # The Amazon Resource Name (ARN) of an IAM role that has permissions
1854
1867
  # to access the Amazon S3 bucket that contains your input files. If
1855
- # the role you specify doesn’t have the appropriate permissions to
1856
- # access the specified Amazon S3 location, your request fails.
1868
+ # the role that you specify doesn’t have the appropriate permissions
1869
+ # to access the specified Amazon S3 location, your request fails.
1857
1870
  #
1858
1871
  # IAM role ARNs have the format
1859
1872
  # `arn:partition:iam::account:role/role-name-with-path`. For example:
@@ -1903,11 +1916,11 @@ module Aws::TranscribeService
1903
1916
  #
1904
1917
  # * A lack of interruptions
1905
1918
  #
1906
- # See [Rule criteria][1] for usage examples.
1919
+ # See [Rule criteria for batch categories][1] for usage examples.
1907
1920
  #
1908
1921
  #
1909
1922
  #
1910
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
1923
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch
1911
1924
  #
1912
1925
  # @note When making an API call, you may pass InterruptionFilter
1913
1926
  # data as a hash:
@@ -1932,25 +1945,25 @@ module Aws::TranscribeService
1932
1945
  #
1933
1946
  # @!attribute [rw] threshold
1934
1947
  # Specify the duration of the interruptions in milliseconds. For
1935
- # example, you can flag speech that contains more than 10000
1948
+ # example, you can flag speech that contains more than 10,000
1936
1949
  # milliseconds of interruptions.
1937
1950
  # @return [Integer]
1938
1951
  #
1939
1952
  # @!attribute [rw] participant_role
1940
- # Specify the interrupter you want to flag. Omitting this parameter is
1941
- # equivalent to specifying both participants.
1953
+ # Specify the interrupter that you want to flag. Omitting this
1954
+ # parameter is equivalent to specifying both participants.
1942
1955
  # @return [String]
1943
1956
  #
1944
1957
  # @!attribute [rw] absolute_time_range
1945
- # Allows you to specify a time range (in milliseconds) in your audio,
1946
- # during which you want to search for an interruption. See for more
1947
- # detail.
1958
+ # Makes it possible to specify a time range (in milliseconds) in your
1959
+ # audio, during which you want to search for an interruption. See for
1960
+ # more detail.
1948
1961
  # @return [Types::AbsoluteTimeRange]
1949
1962
  #
1950
1963
  # @!attribute [rw] relative_time_range
1951
- # Allows you to specify a time range (in percentage) in your media
1952
- # file, during which you want to search for an interruption. See for
1953
- # more detail.
1964
+ # Makes it possible to specify a time range (in percentage) in your
1965
+ # media file, during which you want to search for an interruption. See
1966
+ # for more detail.
1954
1967
  # @return [Types::RelativeTimeRange]
1955
1968
  #
1956
1969
  # @!attribute [rw] negate
@@ -1970,7 +1983,7 @@ module Aws::TranscribeService
1970
1983
  include Aws::Structure
1971
1984
  end
1972
1985
 
1973
- # Allows you to control how your transcription job is processed.
1986
+ # Makes it possible to control how your transcription job is processed.
1974
1987
  # Currently, the only `JobExecutionSettings` modification you can choose
1975
1988
  # is enabling job queueing using the `AllowDeferredExecution`
1976
1989
  # sub-parameter.
@@ -1988,8 +2001,8 @@ module Aws::TranscribeService
1988
2001
  # }
1989
2002
  #
1990
2003
  # @!attribute [rw] allow_deferred_execution
1991
- # Allows you to enable job queuing when your concurrent request limit
1992
- # is exceeded. When `AllowDeferredExecution` is set to `true`,
2004
+ # Makes it possible to enable job queuing when your concurrent request
2005
+ # limit is exceeded. When `AllowDeferredExecution` is set to `true`,
1993
2006
  # transcription job requests are placed in a queue until the number of
1994
2007
  # jobs falls below the concurrent request limit. If
1995
2008
  # `AllowDeferredExecution` is set to `false` and the number of
@@ -2005,8 +2018,8 @@ module Aws::TranscribeService
2005
2018
  # @!attribute [rw] data_access_role_arn
2006
2019
  # The Amazon Resource Name (ARN) of an IAM role that has permissions
2007
2020
  # to access the Amazon S3 bucket that contains your input files. If
2008
- # the role you specify doesn’t have the appropriate permissions to
2009
- # access the specified Amazon S3 location, your request fails.
2021
+ # the role that you specify doesn’t have the appropriate permissions
2022
+ # to access the specified Amazon S3 location, your request fails.
2010
2023
  #
2011
2024
  # IAM role ARNs have the format
2012
2025
  # `arn:partition:iam::account:role/role-name-with-path`. For example:
@@ -2054,31 +2067,34 @@ module Aws::TranscribeService
2054
2067
  include Aws::Structure
2055
2068
  end
2056
2069
 
2057
- # If using automatic language identification (`IdentifyLanguage`) in
2058
- # your request and you want to apply a custom language model, a custom
2059
- # vocabulary, or a custom vocabulary filter, include
2060
- # `LanguageIdSettings` with the relevant sub-parameters
2061
- # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
2062
- #
2063
- # You can specify two or more language codes that represent the
2064
- # languages you think may be present in your media; including more than
2065
- # five is not recommended. Each language code you include can have an
2066
- # associated custom language model, custom vocabulary, and custom
2067
- # vocabulary filter. The languages you specify must match the languages
2068
- # of the specified custom language models, custom vocabularies, and
2069
- # custom vocabulary filters.
2070
- #
2071
- # To include language options using `IdentifyLanguage` **without**
2072
- # including a custom language model, a custom vocabulary, or a custom
2073
- # vocabulary filter, use `LanguageOptions` instead of
2074
- # `LanguageIdSettings`. Including language options can improve the
2075
- # accuracy of automatic language identification.
2070
+ # If using automatic language identification in your request and you
2071
+ # want to apply a custom language model, a custom vocabulary, or a
2072
+ # custom vocabulary filter, include `LanguageIdSettings` with the
2073
+ # relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
2074
+ # `VocabularyFilterName`). Note that multi-language identification
2075
+ # (`IdentifyMultipleLanguages`) doesn't support custom language models.
2076
+ #
2077
+ # `LanguageIdSettings` supports two to five language codes. Each
2078
+ # language code you include can have an associated custom language
2079
+ # model, custom vocabulary, and custom vocabulary filter. The language
2080
+ # codes that you specify must match the languages of the associated
2081
+ # custom language models, custom vocabularies, and custom vocabulary
2082
+ # filters.
2083
+ #
2084
+ # It's recommended that you include `LanguageOptions` when using
2085
+ # `LanguageIdSettings` to ensure that the correct language dialect is
2086
+ # identified. For example, if you specify a custom vocabulary that is in
2087
+ # `en-US` but Amazon Transcribe determines that the language spoken in
2088
+ # your media is `en-AU`, your custom vocabulary *is not* applied to your
2089
+ # transcription. If you include `LanguageOptions` and include `en-US` as
2090
+ # the only English language dialect, your custom vocabulary *is* applied
2091
+ # to your transcription.
2076
2092
  #
2077
2093
  # If you want to include a custom language model with your request but
2078
2094
  # **do not** want to use automatic language identification, use instead
2079
- # the ` parameter with the LanguageModelName sub-parameter.</p> If you
2080
- # want to include a custom vocabulary or a custom vocabulary filter (or
2081
- # both) with your request but do not want to use automatic language
2095
+ # the ` parameter with the LanguageModelName sub-parameter. If you want
2096
+ # to include a custom vocabulary or a custom vocabulary filter (or both)
2097
+ # with your request but do not want to use automatic language
2082
2098
  # identification, use instead the parameter with the VocabularyName or
2083
2099
  # VocabularyFilterName (or both) sub-parameter.</p>
2084
2100
  # `
@@ -2094,23 +2110,24 @@ module Aws::TranscribeService
2094
2110
  #
2095
2111
  # @!attribute [rw] vocabulary_name
2096
2112
  # The name of the custom vocabulary you want to use when processing
2097
- # your transcription job. Vocabulary names are case sensitive.
2113
+ # your transcription job. Custom vocabulary names are case sensitive.
2098
2114
  #
2099
- # The language of the specified vocabulary must match the language
2100
- # code you specify in your transcription request. If the languages
2101
- # don't match, the vocabulary isn't applied. There are no errors or
2102
- # warnings associated with a language mismatch.
2115
+ # The language of the specified custom vocabulary must match the
2116
+ # language code that you specify in your transcription request. If the
2117
+ # languages don't match, the custom vocabulary isn't applied. There
2118
+ # are no errors or warnings associated with a language mismatch.
2103
2119
  # @return [String]
2104
2120
  #
2105
2121
  # @!attribute [rw] vocabulary_filter_name
2106
2122
  # The name of the custom vocabulary filter you want to use when
2107
- # processing your transcription job. Vocabulary filter names are case
2108
- # sensitive.
2123
+ # processing your transcription job. Custom vocabulary filter names
2124
+ # are case sensitive.
2109
2125
  #
2110
- # The language of the specified vocabulary filter must match the
2111
- # language code you specify in your transcription request. If the
2112
- # languages don't match, the vocabulary filter isn't applied. There
2113
- # are no errors or warnings associated with a language mismatch.
2126
+ # The language of the specified custom vocabulary filter must match
2127
+ # the language code that you specify in your transcription request. If
2128
+ # the languages don't match, the custom vocabulary filter isn't
2129
+ # applied. There are no errors or warnings associated with a language
2130
+ # mismatch.
2114
2131
  #
2115
2132
  # Note that if you include `VocabularyFilterName` in your request, you
2116
2133
  # must also include `VocabularyFilterMethod`.
@@ -2118,13 +2135,13 @@ module Aws::TranscribeService
2118
2135
  #
2119
2136
  # @!attribute [rw] language_model_name
2120
2137
  # The name of the custom language model you want to use when
2121
- # processing your transcription job. Note that language model names
2122
- # are case sensitive.
2138
+ # processing your transcription job. Note that custom language model
2139
+ # names are case sensitive.
2123
2140
  #
2124
- # The language of the specified language model must match the language
2125
- # code you specify in your transcription request. If the languages
2126
- # don't match, the language model isn't applied. There are no errors
2127
- # or warnings associated with a language mismatch.
2141
+ # The language of the specified custom language model must match the
2142
+ # language code that you specify in your transcription request. If the
2143
+ # languages don't match, the custom language model isn't applied.
2144
+ # There are no errors or warnings associated with a language mismatch.
2128
2145
  # @return [String]
2129
2146
  #
2130
2147
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/LanguageIdSettings AWS API Documentation
@@ -2159,7 +2176,8 @@ module Aws::TranscribeService
2159
2176
  # @return [Time]
2160
2177
  #
2161
2178
  # @!attribute [rw] last_modified_time
2162
- # The date and time the specified language model was last modified.
2179
+ # The date and time the specified custom language model was last
2180
+ # modified.
2163
2181
  #
2164
2182
  # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
2165
2183
  # example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
@@ -2168,9 +2186,9 @@ module Aws::TranscribeService
2168
2186
  #
2169
2187
  # @!attribute [rw] language_code
2170
2188
  # The language code used to create your custom language model. Each
2171
- # language model must contain terms in only one language, and the
2172
- # language you select for your model must match the language of your
2173
- # training and tuning data.
2189
+ # custom language model must contain terms in only one language, and
2190
+ # the language you select for your custom language model must match
2191
+ # the language of your training and tuning data.
2174
2192
  #
2175
2193
  # For a list of supported languages and their associated language
2176
2194
  # codes, refer to the [Supported languages][1] table. Note that U.S.
@@ -2196,8 +2214,8 @@ module Aws::TranscribeService
2196
2214
  # Shows if a more current base model is available for use with the
2197
2215
  # specified custom language model.
2198
2216
  #
2199
- # If `false`, your language model is using the most up-to-date base
2200
- # model.
2217
+ # If `false`, your custom language model is using the most up-to-date
2218
+ # base model.
2201
2219
  #
2202
2220
  # If `true`, there is a newer base model available than the one your
2203
2221
  # language model is using.
@@ -2272,7 +2290,7 @@ module Aws::TranscribeService
2272
2290
  #
2273
2291
  # @!attribute [rw] max_results
2274
2292
  # The maximum number of Call Analytics categories to return in each
2275
- # page of results. If there are fewer results than the value you
2293
+ # page of results. If there are fewer results than the value that you
2276
2294
  # specify, only the actual results are returned. If you don't specify
2277
2295
  # a value, a default of 5 is used.
2278
2296
  # @return [Integer]
@@ -2340,9 +2358,9 @@ module Aws::TranscribeService
2340
2358
  #
2341
2359
  # @!attribute [rw] max_results
2342
2360
  # The maximum number of Call Analytics jobs to return in each page of
2343
- # results. If there are fewer results than the value you specify, only
2344
- # the actual results are returned. If you don't specify a value, a
2345
- # default of 5 is used.
2361
+ # results. If there are fewer results than the value that you specify,
2362
+ # only the actual results are returned. If you don't specify a value,
2363
+ # a default of 5 is used.
2346
2364
  # @return [Integer]
2347
2365
  #
2348
2366
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsJobsRequest AWS API Documentation
@@ -2417,9 +2435,9 @@ module Aws::TranscribeService
2417
2435
  #
2418
2436
  # @!attribute [rw] max_results
2419
2437
  # The maximum number of custom language models to return in each page
2420
- # of results. If there are fewer results than the value you specify,
2421
- # only the actual results are returned. If you don't specify a value,
2422
- # a default of 5 is used.
2438
+ # of results. If there are fewer results than the value that you
2439
+ # specify, only the actual results are returned. If you don't specify
2440
+ # a value, a default of 5 is used.
2423
2441
  # @return [Integer]
2424
2442
  #
2425
2443
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListLanguageModelsRequest AWS API Documentation
@@ -2488,7 +2506,7 @@ module Aws::TranscribeService
2488
2506
  #
2489
2507
  # @!attribute [rw] max_results
2490
2508
  # The maximum number of medical transcription jobs to return in each
2491
- # page of results. If there are fewer results than the value you
2509
+ # page of results. If there are fewer results than the value that you
2492
2510
  # specify, only the actual results are returned. If you don't specify
2493
2511
  # a value, a default of 5 is used.
2494
2512
  # @return [Integer]
@@ -2553,14 +2571,14 @@ module Aws::TranscribeService
2553
2571
  #
2554
2572
  # @!attribute [rw] max_results
2555
2573
  # The maximum number of custom medical vocabularies to return in each
2556
- # page of results. If there are fewer results than the value you
2574
+ # page of results. If there are fewer results than the value that you
2557
2575
  # specify, only the actual results are returned. If you don't specify
2558
2576
  # a value, a default of 5 is used.
2559
2577
  # @return [Integer]
2560
2578
  #
2561
2579
  # @!attribute [rw] state_equals
2562
2580
  # Returns only custom medical vocabularies with the specified state.
2563
- # Vocabularies are ordered by creation date, with the newest
2581
+ # Custom vocabularies are ordered by creation date, with the newest
2564
2582
  # vocabulary first. If you don't include `StateEquals`, all custom
2565
2583
  # medical vocabularies are returned.
2566
2584
  # @return [String]
@@ -2583,8 +2601,8 @@ module Aws::TranscribeService
2583
2601
 
2584
2602
  # @!attribute [rw] status
2585
2603
  # Lists all custom medical vocabularies that have the status specified
2586
- # in your request. Vocabularies are ordered by creation date, with the
2587
- # newest vocabulary first.
2604
+ # in your request. Custom vocabularies are ordered by creation date,
2605
+ # with the newest vocabulary first.
2588
2606
  # @return [String]
2589
2607
  #
2590
2608
  # @!attribute [rw] next_token
@@ -2624,7 +2642,7 @@ module Aws::TranscribeService
2624
2642
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
2625
2643
  #
2626
2644
  # For example,
2627
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
2645
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
2628
2646
  #
2629
2647
  # Valid values for `resource-type` are: `transcription-job`,
2630
2648
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -2688,9 +2706,9 @@ module Aws::TranscribeService
2688
2706
  #
2689
2707
  # @!attribute [rw] max_results
2690
2708
  # The maximum number of transcription jobs to return in each page of
2691
- # results. If there are fewer results than the value you specify, only
2692
- # the actual results are returned. If you don't specify a value, a
2693
- # default of 5 is used.
2709
+ # results. If there are fewer results than the value that you specify,
2710
+ # only the actual results are returned. If you don't specify a value,
2711
+ # a default of 5 is used.
2694
2712
  # @return [Integer]
2695
2713
  #
2696
2714
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobsRequest AWS API Documentation
@@ -2753,9 +2771,9 @@ module Aws::TranscribeService
2753
2771
  #
2754
2772
  # @!attribute [rw] max_results
2755
2773
  # The maximum number of custom vocabularies to return in each page of
2756
- # results. If there are fewer results than the value you specify, only
2757
- # the actual results are returned. If you don't specify a value, a
2758
- # default of 5 is used.
2774
+ # results. If there are fewer results than the value that you specify,
2775
+ # only the actual results are returned. If you don't specify a value,
2776
+ # a default of 5 is used.
2759
2777
  # @return [Integer]
2760
2778
  #
2761
2779
  # @!attribute [rw] state_equals
@@ -2830,7 +2848,7 @@ module Aws::TranscribeService
2830
2848
  #
2831
2849
  # @!attribute [rw] max_results
2832
2850
  # The maximum number of custom vocabulary filters to return in each
2833
- # page of results. If there are fewer results than the value you
2851
+ # page of results. If there are fewer results than the value that you
2834
2852
  # specify, only the actual results are returned. If you don't specify
2835
2853
  # a value, a default of 5 is used.
2836
2854
  # @return [Integer]
@@ -2876,6 +2894,15 @@ module Aws::TranscribeService
2876
2894
  # Describes the Amazon S3 location of the media file you want to use in
2877
2895
  # your request.
2878
2896
  #
2897
+ # For information on supported media formats, refer to the
2898
+ # [MediaFormat][1] parameter or the [Media formats][2] section in the
2899
+ # Amazon S3 Developer Guide.
2900
+ #
2901
+ #
2902
+ #
2903
+ # [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
2904
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
2905
+ #
2879
2906
  # @note When making an API call, you may pass Media
2880
2907
  # data as a hash:
2881
2908
  #
@@ -2909,7 +2936,8 @@ module Aws::TranscribeService
2909
2936
  # be located in the same Amazon Web Services Region where you're
2910
2937
  # making your transcription request.
2911
2938
  #
2912
- # `RedactedMediaFileUri` is only supported for Call Analytics
2939
+ # `RedactedMediaFileUri` produces a redacted audio file in addition to
2940
+ # a redacted transcript. It is only supported for Call Analytics
2913
2941
  # (`StartCallAnalyticsJob`) transcription requests.
2914
2942
  # @return [String]
2915
2943
  #
@@ -2929,22 +2957,8 @@ module Aws::TranscribeService
2929
2957
  # The Amazon S3 location of your transcript. You can use this URI to
2930
2958
  # access or download your transcript.
2931
2959
  #
2932
- # If you included `OutputBucketName` in your transcription job
2933
- # request, this is the URI of that bucket. If you also included
2934
- # `OutputKey` in your request, your output is located in the path you
2935
- # specified in your request.
2936
- #
2937
- # If you didn't include `OutputBucketName` in your transcription job
2938
- # request, your transcript is stored in a service-managed bucket, and
2939
- # `TranscriptFileUri` provides you with a temporary URI you can use
2940
- # for secure access to your transcript.
2941
- #
2942
- # <note markdown="1"> Temporary URIs for service-managed Amazon S3 buckets are only valid
2943
- # for 15 minutes. If you get an `AccesDenied` error, you can get a new
2944
- # temporary URI by running a `GetTranscriptionJob` or
2945
- # `ListTranscriptionJob` request.
2946
- #
2947
- # </note>
2960
+ # Note that this is the Amazon S3 location you specified in your
2961
+ # request using the `OutputBucketName` parameter.
2948
2962
  # @return [String]
2949
2963
  #
2950
2964
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscript AWS API Documentation
@@ -2984,7 +2998,7 @@ module Aws::TranscribeService
2984
2998
  # @return [String]
2985
2999
  #
2986
3000
  # @!attribute [rw] media_sample_rate_hertz
2987
- # The sample rate, in Hertz, of the audio track in your input media
3001
+ # The sample rate, in hertz, of the audio track in your input media
2988
3002
  # file.
2989
3003
  # @return [Integer]
2990
3004
  #
@@ -2995,6 +3009,15 @@ module Aws::TranscribeService
2995
3009
  # @!attribute [rw] media
2996
3010
  # Describes the Amazon S3 location of the media file you want to use
2997
3011
  # in your request.
3012
+ #
3013
+ # For information on supported media formats, refer to the
3014
+ # [MediaFormat][1] parameter or the [Media formats][2] section in the
3015
+ # Amazon S3 Developer Guide.
3016
+ #
3017
+ #
3018
+ #
3019
+ # [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
3020
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
2998
3021
  # @return [Types::Media]
2999
3022
  #
3000
3023
  # @!attribute [rw] transcript
@@ -3053,7 +3076,7 @@ module Aws::TranscribeService
3053
3076
  # * `Invalid sample rate for audio file`.
3054
3077
  #
3055
3078
  # The sample rate specified in `MediaSampleRateHertz` isn't valid.
3056
- # The sample rate must be between 16,000 and 48,000 Hertz.
3079
+ # The sample rate must be between 16,000 and 48,000 hertz.
3057
3080
  #
3058
3081
  # * `The sample rate provided does not match the detected sample
3059
3082
  # rate`.
@@ -3080,20 +3103,15 @@ module Aws::TranscribeService
3080
3103
  # @return [String]
3081
3104
  #
3082
3105
  # @!attribute [rw] settings
3083
- # Specify additional optional settings in your request, including
3084
- # channel identification, alternative transcriptions, and speaker
3085
- # labeling; allows you to apply custom vocabularies to your medical
3086
- # transcription job.
3106
+ # Provides information on any additional settings that were included
3107
+ # in your request. Additional settings include channel identification,
3108
+ # alternative transcriptions, speaker partitioning, custom
3109
+ # vocabularies, and custom vocabulary filters.
3087
3110
  # @return [Types::MedicalTranscriptionSetting]
3088
3111
  #
3089
3112
  # @!attribute [rw] content_identification_type
3090
- # Labels all personal health information (PHI) identified in your
3091
- # transcript. For more information, see [Identifying personal health
3092
- # information (PHI) in a transcription][1].
3093
- #
3094
- #
3095
- #
3096
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html
3113
+ # Indicates whether content identification was enabled for your
3114
+ # transcription request.
3097
3115
  # @return [String]
3098
3116
  #
3099
3117
  # @!attribute [rw] specialty
@@ -3247,9 +3265,9 @@ module Aws::TranscribeService
3247
3265
  end
3248
3266
 
3249
3267
  # Allows additional optional settings in your request, including channel
3250
- # identification, alternative transcriptions, and speaker labeling;
3251
- # allows you to apply custom vocabularies to your medical transcription
3252
- # job.
3268
+ # identification, alternative transcriptions, and speaker partitioning.
3269
+ # You can use that to apply custom vocabularies to your medical
3270
+ # transcription job.
3253
3271
  #
3254
3272
  # @note When making an API call, you may pass MedicalTranscriptionSetting
3255
3273
  # data as a hash:
@@ -3264,18 +3282,18 @@ module Aws::TranscribeService
3264
3282
  # }
3265
3283
  #
3266
3284
  # @!attribute [rw] show_speaker_labels
3267
- # Enables speaker identification (diarization) in your transcription
3268
- # output. Speaker identification labels the speech from individual
3285
+ # Enables speaker partitioning (diarization) in your transcription
3286
+ # output. Speaker partitioning labels the speech from individual
3269
3287
  # speakers in your media file.
3270
3288
  #
3271
3289
  # If you enable `ShowSpeakerLabels` in your request, you must also
3272
3290
  # include `MaxSpeakerLabels`.
3273
3291
  #
3274
- # You can't include both `ShowSpeakerLabels` and
3275
- # `ChannelIdentification` in the same request. Including both
3276
- # parameters returns a `BadRequestException`.
3292
+ # You can't include `ShowSpeakerLabels` and `ChannelIdentification`
3293
+ # in the same request. Including both parameters returns a
3294
+ # `BadRequestException`.
3277
3295
  #
3278
- # For more information, see [Identifying speakers (diarization)][1].
3296
+ # For more information, see [Partitioning speakers (diarization)][1].
3279
3297
  #
3280
3298
  #
3281
3299
  #
@@ -3283,11 +3301,11 @@ module Aws::TranscribeService
3283
3301
  # @return [Boolean]
3284
3302
  #
3285
3303
  # @!attribute [rw] max_speaker_labels
3286
- # Specify the maximum number of speakers you want to identify in your
3304
+ # Specify the maximum number of speakers you want to partition in your
3287
3305
  # media.
3288
3306
  #
3289
3307
  # Note that if your media contains more speakers than the specified
3290
- # number, multiple speakers will be identified as a single speaker.
3308
+ # number, multiple speakers are treated as a single speaker.
3291
3309
  #
3292
3310
  # If you specify the `MaxSpeakerLabels` field, you must set the
3293
3311
  # `ShowSpeakerLabels` field to true.
@@ -3350,13 +3368,15 @@ module Aws::TranscribeService
3350
3368
  #
3351
3369
  # @!attribute [rw] vocabulary_name
3352
3370
  # The name of the custom vocabulary you want to use when processing
3353
- # your medical transcription job. Vocabulary names are case sensitive.
3371
+ # your medical transcription job. Custom vocabulary names are case
3372
+ # sensitive.
3354
3373
  #
3355
- # The language of the specified vocabulary must match the language
3356
- # code you specify in your transcription request. If the languages
3357
- # don't match, the vocabulary isn't applied. There are no errors or
3358
- # warnings associated with a language mismatch. US English (`en-US`)
3359
- # is the only valid language for Amazon Transcribe Medical.
3374
+ # The language of the specified custom vocabulary must match the
3375
+ # language code that you specify in your transcription request. If the
3376
+ # languages don't match, the custom vocabulary isn't applied. There
3377
+ # are no errors or warnings associated with a language mismatch. US
3378
+ # English (`en-US`) is the only valid language for Amazon Transcribe
3379
+ # Medical.
3360
3380
  # @return [String]
3361
3381
  #
3362
3382
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionSetting AWS API Documentation
@@ -3390,13 +3410,13 @@ module Aws::TranscribeService
3390
3410
  #
3391
3411
  # @!attribute [rw] language_model_name
3392
3412
  # The name of the custom language model you want to use when
3393
- # processing your transcription job. Note that language model names
3394
- # are case sensitive.
3413
+ # processing your transcription job. Note that custom language model
3414
+ # names are case sensitive.
3395
3415
  #
3396
- # The language of the specified language model must match the language
3397
- # code you specify in your transcription request. If the languages
3398
- # don't match, the language model isn't applied. There are no errors
3399
- # or warnings associated with a language mismatch.
3416
+ # The language of the specified custom language model must match the
3417
+ # language code that you specify in your transcription request. If the
3418
+ # languages don't match, the custom language model isn't applied.
3419
+ # There are no errors or warnings associated with a language mismatch.
3400
3420
  # @return [String]
3401
3421
  #
3402
3422
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ModelSettings AWS API Documentation
@@ -3416,11 +3436,11 @@ module Aws::TranscribeService
3416
3436
  #
3417
3437
  # * The presence of speech at specified periods throughout the call
3418
3438
  #
3419
- # See [Rule criteria][1] for usage examples.
3439
+ # See [Rule criteria for batch categories][1] for usage examples.
3420
3440
  #
3421
3441
  #
3422
3442
  #
3423
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
3443
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch
3424
3444
  #
3425
3445
  # @note When making an API call, you may pass NonTalkTimeFilter
3426
3446
  # data as a hash:
@@ -3443,21 +3463,21 @@ module Aws::TranscribeService
3443
3463
  # }
3444
3464
  #
3445
3465
  # @!attribute [rw] threshold
3446
- # Specify the duration, in milliseconds, of the period of silence you
3447
- # want to flag. For example, you can flag a silent period that lasts
3448
- # 30000 milliseconds.
3466
+ # Specify the duration, in milliseconds, of the period of silence that
3467
+ # you want to flag. For example, you can flag a silent period that
3468
+ # lasts 30,000 milliseconds.
3449
3469
  # @return [Integer]
3450
3470
  #
3451
3471
  # @!attribute [rw] absolute_time_range
3452
- # Allows you to specify a time range (in milliseconds) in your audio,
3453
- # during which you want to search for a period of silence. See for
3454
- # more detail.
3472
+ # Makes it possible to specify a time range (in milliseconds) in your
3473
+ # audio, during which you want to search for a period of silence. See
3474
+ # for more detail.
3455
3475
  # @return [Types::AbsoluteTimeRange]
3456
3476
  #
3457
3477
  # @!attribute [rw] relative_time_range
3458
- # Allows you to specify a time range (in percentage) in your media
3459
- # file, during which you want to search for a period of silence. See
3460
- # for more detail.
3478
+ # Makes it possible to specify a time range (in percentage) in your
3479
+ # media file, during which you want to search for a period of silence.
3480
+ # See for more detail.
3461
3481
  # @return [Types::RelativeTimeRange]
3462
3482
  #
3463
3483
  # @!attribute [rw] negate
@@ -3499,10 +3519,10 @@ module Aws::TranscribeService
3499
3519
  # your media file.
3500
3520
  #
3501
3521
  # You can use also `First` to search from the start of the media file
3502
- # until the time you specify, or `Last` to search from the time you
3503
- # specify until the end of the media file. For example, setting `First`
3504
- # to 10 only searches for your specified criteria in the audio contained
3505
- # in the first 10 percent of the media file.
3522
+ # until the time that you specify. Or use `Last` to search from the time
3523
+ # that you specify until the end of the media file. For example, setting
3524
+ # `First` to 10 only searches for your specified criteria in the audio
3525
+ # contained in the first 10 percent of the media file.
3506
3526
  #
3507
3527
  # If you prefer to use milliseconds instead of percentage, see .
3508
3528
  #
@@ -3532,14 +3552,14 @@ module Aws::TranscribeService
3532
3552
  #
3533
3553
  # @!attribute [rw] first
3534
3554
  # The time, in percentage, from the start of your media file until the
3535
- # value you specify in which Amazon Transcribe searches for your
3536
- # specified criteria.
3555
+ # specified value. Amazon Transcribe searches for your specified
3556
+ # criteria in this time segment.
3537
3557
  # @return [Integer]
3538
3558
  #
3539
3559
  # @!attribute [rw] last
3540
- # The time, in percentage, from the value you specify until the end of
3541
- # your media file in which Amazon Transcribe searches for your
3542
- # specified criteria.
3560
+ # The time, in percentage, from the specified value until the end of
3561
+ # your media file. Amazon Transcribe searches for your specified
3562
+ # criteria in this time segment.
3543
3563
  # @return [Integer]
3544
3564
  #
3545
3565
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/RelativeTimeRange AWS API Documentation
@@ -3553,22 +3573,22 @@ module Aws::TranscribeService
3553
3573
  include Aws::Structure
3554
3574
  end
3555
3575
 
3556
- # A rule is a set of criteria you can specify to flag an attribute in
3557
- # your Call Analytics output. Rules define a Call Analytics category.
3576
+ # A rule is a set of criteria that you can specify to flag an attribute
3577
+ # in your Call Analytics output. Rules define a Call Analytics category.
3558
3578
  #
3559
- # Rules can include these parameters: , , , and . To learn more about
3560
- # these parameters, refer to [Rule criteria][1].
3579
+ # Rules can include these parameters: , , , and .
3561
3580
  #
3562
- # To learn more about Call Analytics categories, see [Creating
3563
- # categories][2].
3581
+ # To learn more about Call Analytics rules and categories, see [Creating
3582
+ # categories for batch transcriptions][1] and [Creating categories for
3583
+ # streaming transcriptions][2].
3564
3584
  #
3565
3585
  # To learn more about Call Analytics, see [Analyzing call center audio
3566
3586
  # with Call Analytics][3].
3567
3587
  #
3568
3588
  #
3569
3589
  #
3570
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
3571
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html
3590
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html
3591
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html
3572
3592
  # [3]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html
3573
3593
  #
3574
3594
  # @note Rule is a union - when making an API calls you must set exactly one of the members.
@@ -3631,11 +3651,11 @@ module Aws::TranscribeService
3631
3651
  # * The presence or absence of a mixed sentiment felt by the customer,
3632
3652
  # the agent, or both at specified points in the call
3633
3653
  #
3634
- # See [Rule criteria][1] for examples.
3654
+ # See [Rule criteria for batch categories][1] for usage examples.
3635
3655
  #
3636
3656
  #
3637
3657
  #
3638
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
3658
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch
3639
3659
  #
3640
3660
  # @note When making an API call, you may pass SentimentFilter
3641
3661
  # data as a hash:
@@ -3659,30 +3679,30 @@ module Aws::TranscribeService
3659
3679
  # }
3660
3680
  #
3661
3681
  # @!attribute [rw] sentiments
3662
- # Specify the sentiments you want to flag.
3682
+ # Specify the sentiments that you want to flag.
3663
3683
  # @return [Array<String>]
3664
3684
  #
3665
3685
  # @!attribute [rw] absolute_time_range
3666
- # Allows you to specify a time range (in milliseconds) in your audio,
3667
- # during which you want to search for the specified sentiments. See
3668
- # for more detail.
3686
+ # Makes it possible to specify a time range (in milliseconds) in your
3687
+ # audio, during which you want to search for the specified sentiments.
3688
+ # See for more detail.
3669
3689
  # @return [Types::AbsoluteTimeRange]
3670
3690
  #
3671
3691
  # @!attribute [rw] relative_time_range
3672
- # Allows you to specify a time range (in percentage) in your media
3673
- # file, during which you want to search for the specified sentiments.
3674
- # See for more detail.
3692
+ # Makes it possible to specify a time range (in percentage) in your
3693
+ # media file, during which you want to search for the specified
3694
+ # sentiments. See for more detail.
3675
3695
  # @return [Types::RelativeTimeRange]
3676
3696
  #
3677
3697
  # @!attribute [rw] participant_role
3678
- # Specify the participant you want to flag. Omitting this parameter is
3679
- # equivalent to specifying both participants.
3698
+ # Specify the participant that you want to flag. Omitting this
3699
+ # parameter is equivalent to specifying both participants.
3680
3700
  # @return [String]
3681
3701
  #
3682
3702
  # @!attribute [rw] negate
3683
- # Set to `TRUE` to flag the sentiments you didn't include in your
3684
- # request. Set to `FALSE` to flag the sentiments you specified in your
3685
- # request.
3703
+ # Set to `TRUE` to flag the sentiments that you didn't include in
3704
+ # your request. Set to `FALSE` to flag the sentiments that you
3705
+ # specified in your request.
3686
3706
  # @return [Boolean]
3687
3707
  #
3688
3708
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/SentimentFilter AWS API Documentation
@@ -3698,8 +3718,9 @@ module Aws::TranscribeService
3698
3718
  end
3699
3719
 
3700
3720
  # Allows additional optional settings in your request, including channel
3701
- # identification, alternative transcriptions, and speaker labeling;
3702
- # allows you to apply custom vocabularies to your transcription job.
3721
+ # identification, alternative transcriptions, and speaker partitioning.
3722
+ # You can use that to apply custom vocabularies to your transcription
3723
+ # job.
3703
3724
  #
3704
3725
  # @note When making an API call, you may pass Settings
3705
3726
  # data as a hash:
@@ -3723,8 +3744,8 @@ module Aws::TranscribeService
3723
3744
  # @return [String]
3724
3745
  #
3725
3746
  # @!attribute [rw] show_speaker_labels
3726
- # Enables speaker identification (diarization) in your transcription
3727
- # output. Speaker identification labels the speech from individual
3747
+ # Enables speaker partitioning (diarization) in your transcription
3748
+ # output. Speaker partitioning labels the speech from individual
3728
3749
  # speakers in your media file.
3729
3750
  #
3730
3751
  # If you enable `ShowSpeakerLabels` in your request, you must also
@@ -3734,7 +3755,7 @@ module Aws::TranscribeService
3734
3755
  # `ChannelIdentification` in the same request. Including both
3735
3756
  # parameters returns a `BadRequestException`.
3736
3757
  #
3737
- # For more information, see [Identifying speakers (diarization)][1].
3758
+ # For more information, see [Partitioning speakers (diarization)][1].
3738
3759
  #
3739
3760
  #
3740
3761
  #
@@ -3742,11 +3763,11 @@ module Aws::TranscribeService
3742
3763
  # @return [Boolean]
3743
3764
  #
3744
3765
  # @!attribute [rw] max_speaker_labels
3745
- # Specify the maximum number of speakers you want to identify in your
3766
+ # Specify the maximum number of speakers you want to partition in your
3746
3767
  # media.
3747
3768
  #
3748
3769
  # Note that if your media contains more speakers than the specified
3749
- # number, multiple speakers will be identified as a single speaker.
3770
+ # number, multiple speakers are treated as a single speaker.
3750
3771
  #
3751
3772
  # If you specify the `MaxSpeakerLabels` field, you must set the
3752
3773
  # `ShowSpeakerLabels` field to true.
@@ -3818,7 +3839,7 @@ module Aws::TranscribeService
3818
3839
  # @return [String]
3819
3840
  #
3820
3841
  # @!attribute [rw] vocabulary_filter_method
3821
- # Specify how you want your vocabulary filter applied to your
3842
+ # Specify how you want your custom vocabulary filter applied to your
3822
3843
  # transcript.
3823
3844
  #
3824
3845
  # To replace words with `***`, choose `mask`.
@@ -3893,7 +3914,7 @@ module Aws::TranscribeService
3893
3914
  #
3894
3915
  # @!attribute [rw] media
3895
3916
  # Describes the Amazon S3 location of the media file you want to use
3896
- # in your request.
3917
+ # in your Call Analytics request.
3897
3918
  # @return [Types::Media]
3898
3919
  #
3899
3920
  # @!attribute [rw] output_location
@@ -3963,8 +3984,8 @@ module Aws::TranscribeService
3963
3984
  # @!attribute [rw] data_access_role_arn
3964
3985
  # The Amazon Resource Name (ARN) of an IAM role that has permissions
3965
3986
  # to access the Amazon S3 bucket that contains your input files. If
3966
- # the role you specify doesn’t have the appropriate permissions to
3967
- # access the specified Amazon S3 location, your request fails.
3987
+ # the role that you specify doesn’t have the appropriate permissions
3988
+ # to access the specified Amazon S3 location, your request fails.
3968
3989
  #
3969
3990
  # IAM role ARNs have the format
3970
3991
  # `arn:partition:iam::account:role/role-name-with-path`. For example:
@@ -3985,7 +4006,7 @@ module Aws::TranscribeService
3985
4006
  # @return [Types::CallAnalyticsJobSettings]
3986
4007
  #
3987
4008
  # @!attribute [rw] channel_definitions
3988
- # Allows you to specify which speaker is on which channel. For
4009
+ # Makes it possible to specify which speaker is on which channel. For
3989
4010
  # example, if your agent is the first participant to speak, you would
3990
4011
  # set `ChannelId` to `0` (to indicate the first channel) and
3991
4012
  # `ParticipantRole` to `AGENT` (to indicate that it's the agent
@@ -4058,7 +4079,7 @@ module Aws::TranscribeService
4058
4079
  #
4059
4080
  # @!attribute [rw] medical_transcription_job_name
4060
4081
  # A unique name, chosen by you, for your medical transcription job.
4061
- # The name you specify is also used as the default name of your
4082
+ # The name that you specify is also used as the default name of your
4062
4083
  # transcription output file. If you want to specify a different name
4063
4084
  # for your transcription output, use the `OutputKey` parameter.
4064
4085
  #
@@ -4076,13 +4097,13 @@ module Aws::TranscribeService
4076
4097
  # @return [String]
4077
4098
  #
4078
4099
  # @!attribute [rw] media_sample_rate_hertz
4079
- # The sample rate, in Hertz, of the audio track in your input media
4100
+ # The sample rate, in hertz, of the audio track in your input media
4080
4101
  # file.
4081
4102
  #
4082
4103
  # If you don't specify the media sample rate, Amazon Transcribe
4083
4104
  # Medical determines it for you. If you specify the sample rate, it
4084
4105
  # must match the rate detected by Amazon Transcribe Medical; if
4085
- # there's a mismatch between the value you specify and the value
4106
+ # there's a mismatch between the value that you specify and the value
4086
4107
  # detected, your job fails. Therefore, in most cases, it's advised to
4087
4108
  # omit `MediaSampleRateHertz` and let Amazon Transcribe Medical
4088
4109
  # determine the sample rate.
@@ -4095,6 +4116,15 @@ module Aws::TranscribeService
4095
4116
  # @!attribute [rw] media
4096
4117
  # Describes the Amazon S3 location of the media file you want to use
4097
4118
  # in your request.
4119
+ #
4120
+ # For information on supported media formats, refer to the
4121
+ # [MediaFormat][1] parameter or the [Media formats][2] section in the
4122
+ # Amazon S3 Developer Guide.
4123
+ #
4124
+ #
4125
+ #
4126
+ # [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
4127
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
4098
4128
  # @return [Types::Media]
4099
4129
  #
4100
4130
  # @!attribute [rw] output_bucket_name
@@ -4117,10 +4147,6 @@ module Aws::TranscribeService
4117
4147
  # [Amazon Web Services Management Console][1]. See also [Permissions
4118
4148
  # Required for IAM User Roles][2].
4119
4149
  #
4120
- # If you don't specify `OutputBucketName`, your transcript is placed
4121
- # in a service-managed Amazon S3 bucket and you are provided with a
4122
- # URI to access your transcript.
4123
- #
4124
4150
  #
4125
4151
  #
4126
4152
  # [1]: https://console.aws.amazon.com/s3
@@ -4216,7 +4242,7 @@ module Aws::TranscribeService
4216
4242
  # @!attribute [rw] settings
4217
4243
  # Specify additional optional settings in your request, including
4218
4244
  # channel identification, alternative transcriptions, and speaker
4219
- # labeling; allows you to apply custom vocabularies to your
4245
+ # partitioning. You can use that to apply custom vocabularies to your
4220
4246
  # transcription job.
4221
4247
  # @return [Types::MedicalTranscriptionSetting]
4222
4248
  #
@@ -4359,9 +4385,9 @@ module Aws::TranscribeService
4359
4385
  #
4360
4386
  # @!attribute [rw] transcription_job_name
4361
4387
  # A unique name, chosen by you, for your transcription job. The name
4362
- # you specify is also used as the default name of your transcription
4363
- # output file. If you want to specify a different name for your
4364
- # transcription output, use the `OutputKey` parameter.
4388
+ # that you specify is also used as the default name of your
4389
+ # transcription output file. If you want to specify a different name
4390
+ # for your transcription output, use the `OutputKey` parameter.
4365
4391
  #
4366
4392
  # This name is case sensitive, cannot contain spaces, and must be
4367
4393
  # unique within an Amazon Web Services account. If you try to create a
@@ -4396,16 +4422,15 @@ module Aws::TranscribeService
4396
4422
  # @return [String]
4397
4423
  #
4398
4424
  # @!attribute [rw] media_sample_rate_hertz
4399
- # The sample rate, in Hertz, of the audio track in your input media
4425
+ # The sample rate, in hertz, of the audio track in your input media
4400
4426
  # file.
4401
4427
  #
4402
4428
  # If you don't specify the media sample rate, Amazon Transcribe
4403
4429
  # determines it for you. If you specify the sample rate, it must match
4404
- # the rate detected by Amazon Transcribe; if there's a mismatch
4405
- # between the value you specify and the value detected, your job
4406
- # fails. Therefore, in most cases, it's advised to omit
4407
- # `MediaSampleRateHertz` and let Amazon Transcribe determine the
4408
- # sample rate.
4430
+ # the rate detected by Amazon Transcribe. If there's a mismatch
4431
+ # between the value that you specify and the value detected, your job
4432
+ # fails. In most cases, you can omit `MediaSampleRateHertz` and let
4433
+ # Amazon Transcribe determine the sample rate.
4409
4434
  # @return [Integer]
4410
4435
  #
4411
4436
  # @!attribute [rw] media_format
@@ -4535,8 +4560,8 @@ module Aws::TranscribeService
4535
4560
  # @!attribute [rw] settings
4536
4561
  # Specify additional optional settings in your request, including
4537
4562
  # channel identification, alternative transcriptions, speaker
4538
- # labeling; allows you to apply custom vocabularies and vocabulary
4539
- # filters.
4563
+ # partitioning. You can use that to apply custom vocabularies and
4564
+ # vocabulary filters.
4540
4565
  #
4541
4566
  # If you want to include a custom vocabulary or a custom vocabulary
4542
4567
  # filter (or both) with your request but **do not** want to use
@@ -4564,10 +4589,10 @@ module Aws::TranscribeService
4564
4589
  # @return [Types::ModelSettings]
4565
4590
  #
4566
4591
  # @!attribute [rw] job_execution_settings
4567
- # Allows you to control how your transcription job is processed.
4568
- # Currently, the only `JobExecutionSettings` modification you can
4569
- # choose is enabling job queueing using the `AllowDeferredExecution`
4570
- # sub-parameter.
4592
+ # Makes it possible to control how your transcription job is
4593
+ # processed. Currently, the only `JobExecutionSettings` modification
4594
+ # you can choose is enabling job queueing using the
4595
+ # `AllowDeferredExecution` sub-parameter.
4571
4596
  #
4572
4597
  # If you include `JobExecutionSettings` in your request, you must also
4573
4598
  # include the sub-parameters: `AllowDeferredExecution` and
@@ -4575,26 +4600,30 @@ module Aws::TranscribeService
4575
4600
  # @return [Types::JobExecutionSettings]
4576
4601
  #
4577
4602
  # @!attribute [rw] content_redaction
4578
- # Allows you to redact or flag specified personally identifiable
4579
- # information (PII) in your transcript. If you use `ContentRedaction`,
4580
- # you must also include the sub-parameters: `PiiEntityTypes`,
4581
- # `RedactionOutput`, and `RedactionType`.
4603
+ # Makes it possible to redact or flag specified personally
4604
+ # identifiable information (PII) in your transcript. If you use
4605
+ # `ContentRedaction`, you must also include the sub-parameters:
4606
+ # `PiiEntityTypes`, `RedactionOutput`, and `RedactionType`.
4582
4607
  # @return [Types::ContentRedaction]
4583
4608
  #
4584
4609
  # @!attribute [rw] identify_language
4585
4610
  # Enables automatic language identification in your transcription job
4586
- # request.
4611
+ # request. Use this parameter if your media file contains only one
4612
+ # language. If your media contains multiple languages, use
4613
+ # `IdentifyMultipleLanguages` instead.
4587
4614
  #
4588
4615
  # If you include `IdentifyLanguage`, you can optionally include a list
4589
4616
  # of language codes, using `LanguageOptions`, that you think may be
4590
- # present in your media file. Including language options can improve
4591
- # transcription accuracy.
4617
+ # present in your media file. Including `LanguageOptions` restricts
4618
+ # `IdentifyLanguage` to only the language options that you specify,
4619
+ # which can improve transcription accuracy.
4592
4620
  #
4593
4621
  # If you want to apply a custom language model, a custom vocabulary,
4594
4622
  # or a custom vocabulary filter to your automatic language
4595
4623
  # identification request, include `LanguageIdSettings` with the
4596
4624
  # relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
4597
- # `VocabularyFilterName`).
4625
+ # `VocabularyFilterName`). If you include `LanguageIdSettings`, also
4626
+ # include `LanguageOptions`.
4598
4627
  #
4599
4628
  # Note that you must include one of `LanguageCode`,
4600
4629
  # `IdentifyLanguage`, or `IdentifyMultipleLanguages` in your request.
@@ -4605,17 +4634,20 @@ module Aws::TranscribeService
4605
4634
  # @!attribute [rw] identify_multiple_languages
4606
4635
  # Enables automatic multi-language identification in your
4607
4636
  # transcription job request. Use this parameter if your media file
4608
- # contains more than one language.
4637
+ # contains more than one language. If your media contains only one
4638
+ # language, use `IdentifyLanguage` instead.
4609
4639
  #
4610
4640
  # If you include `IdentifyMultipleLanguages`, you can optionally
4611
4641
  # include a list of language codes, using `LanguageOptions`, that you
4612
- # think may be present in your media file. Including language options
4613
- # can improve transcription accuracy.
4642
+ # think may be present in your media file. Including `LanguageOptions`
4643
+ # restricts `IdentifyLanguage` to only the language options that you
4644
+ # specify, which can improve transcription accuracy.
4614
4645
  #
4615
4646
  # If you want to apply a custom vocabulary or a custom vocabulary
4616
4647
  # filter to your automatic language identification request, include
4617
4648
  # `LanguageIdSettings` with the relevant sub-parameters
4618
- # (`VocabularyName` and `VocabularyFilterName`).
4649
+ # (`VocabularyName` and `VocabularyFilterName`). If you include
4650
+ # `LanguageIdSettings`, also include `LanguageOptions`.
4619
4651
  #
4620
4652
  # Note that you must include one of `LanguageCode`,
4621
4653
  # `IdentifyLanguage`, or `IdentifyMultipleLanguages` in your request.
@@ -4625,7 +4657,7 @@ module Aws::TranscribeService
4625
4657
  #
4626
4658
  # @!attribute [rw] language_options
4627
4659
  # You can specify two or more language codes that represent the
4628
- # languages you think may be present in your media; including more
4660
+ # languages you think may be present in your media. Including more
4629
4661
  # than five is not recommended. If you're unsure what languages are
4630
4662
  # present, do not include this parameter.
4631
4663
  #
@@ -4660,34 +4692,37 @@ module Aws::TranscribeService
4660
4692
  # @return [Array<Types::Tag>]
4661
4693
  #
4662
4694
  # @!attribute [rw] language_id_settings
4663
- # If using automatic language identification (`IdentifyLanguage`) in
4664
- # your request and you want to apply a custom language model, a custom
4665
- # vocabulary, or a custom vocabulary filter, include
4666
- # `LanguageIdSettings` with the relevant sub-parameters
4667
- # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
4668
- #
4669
- # You can specify two or more language codes that represent the
4670
- # languages you think may be present in your media; including more
4671
- # than five is not recommended. Each language code you include can
4672
- # have an associated custom language model, custom vocabulary, and
4673
- # custom vocabulary filter. The languages you specify must match the
4674
- # languages of the specified custom language models, custom
4675
- # vocabularies, and custom vocabulary filters.
4695
+ # If using automatic language identification in your request and you
4696
+ # want to apply a custom language model, a custom vocabulary, or a
4697
+ # custom vocabulary filter, include `LanguageIdSettings` with the
4698
+ # relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
4699
+ # `VocabularyFilterName`). Note that multi-language identification
4700
+ # (`IdentifyMultipleLanguages`) doesn't support custom language
4701
+ # models.
4702
+ #
4703
+ # `LanguageIdSettings` supports two to five language codes. Each
4704
+ # language code you include can have an associated custom language
4705
+ # model, custom vocabulary, and custom vocabulary filter. The language
4706
+ # codes that you specify must match the languages of the associated
4707
+ # custom language models, custom vocabularies, and custom vocabulary
4708
+ # filters.
4676
4709
  #
4677
- # To include language options using `IdentifyLanguage` **without**
4678
- # including a custom language model, a custom vocabulary, or a custom
4679
- # vocabulary filter, use `LanguageOptions` instead of
4680
- # `LanguageIdSettings`. Including language options can improve the
4681
- # accuracy of automatic language identification.
4710
+ # It's recommended that you include `LanguageOptions` when using
4711
+ # `LanguageIdSettings` to ensure that the correct language dialect is
4712
+ # identified. For example, if you specify a custom vocabulary that is
4713
+ # in `en-US` but Amazon Transcribe determines that the language spoken
4714
+ # in your media is `en-AU`, your custom vocabulary *is not* applied to
4715
+ # your transcription. If you include `LanguageOptions` and include
4716
+ # `en-US` as the only English language dialect, your custom vocabulary
4717
+ # *is* applied to your transcription.
4682
4718
  #
4683
4719
  # If you want to include a custom language model with your request but
4684
4720
  # **do not** want to use automatic language identification, use
4685
- # instead the ` parameter with the LanguageModelName
4686
- # sub-parameter.</p> If you want to include a custom vocabulary or a
4687
- # custom vocabulary filter (or both) with your request but do not want
4688
- # to use automatic language identification, use instead the parameter
4689
- # with the VocabularyName or VocabularyFilterName (or both)
4690
- # sub-parameter.</p>
4721
+ # instead the ` parameter with the LanguageModelName sub-parameter. If
4722
+ # you want to include a custom vocabulary or a custom vocabulary
4723
+ # filter (or both) with your request but do not want to use automatic
4724
+ # language identification, use instead the parameter with the
4725
+ # VocabularyName or VocabularyFilterName (or both) sub-parameter.</p>
4691
4726
  # `
4692
4727
  # @return [Hash<String,Types::LanguageIdSettings>]
4693
4728
  #
@@ -4886,7 +4921,7 @@ module Aws::TranscribeService
4886
4921
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
4887
4922
  #
4888
4923
  # For example,
4889
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
4924
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
4890
4925
  #
4891
4926
  # Valid values for `resource-type` are: `transcription-job`,
4892
4927
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -4986,11 +5021,13 @@ module Aws::TranscribeService
4986
5021
  #
4987
5022
  # * Custom words or phrases that occur at a specific time frame
4988
5023
  #
4989
- # See [Rule criteria][1] for examples.
5024
+ # See [Rule criteria for batch categories][1] and [Rule criteria for
5025
+ # streaming categories][2] for usage examples.
4990
5026
  #
4991
5027
  #
4992
5028
  #
4993
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
5029
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch
5030
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream
4994
5031
  #
4995
5032
  # @note When making an API call, you may pass TranscriptFilter
4996
5033
  # data as a hash:
@@ -5015,8 +5052,8 @@ module Aws::TranscribeService
5015
5052
  # }
5016
5053
  #
5017
5054
  # @!attribute [rw] transcript_filter_type
5018
- # Flag the presence or absence of an exact match to the phrases you
5019
- # specify. For example, if you specify the phrase "speak to a
5055
+ # Flag the presence or absence of an exact match to the phrases that
5056
+ # you specify. For example, if you specify the phrase "speak to a
5020
5057
  # manager" as your `Targets` value, only that exact phrase is
5021
5058
  # flagged.
5022
5059
  #
@@ -5026,30 +5063,30 @@ module Aws::TranscribeService
5026
5063
  # @return [String]
5027
5064
  #
5028
5065
  # @!attribute [rw] absolute_time_range
5029
- # Allows you to specify a time range (in milliseconds) in your audio,
5030
- # during which you want to search for the specified key words or
5031
- # phrases. See for more detail.
5066
+ # Makes it possible to specify a time range (in milliseconds) in your
5067
+ # audio, during which you want to search for the specified key words
5068
+ # or phrases. See for more detail.
5032
5069
  # @return [Types::AbsoluteTimeRange]
5033
5070
  #
5034
5071
  # @!attribute [rw] relative_time_range
5035
- # Allows you to specify a time range (in percentage) in your media
5036
- # file, during which you want to search for the specified key words or
5037
- # phrases. See for more detail.
5072
+ # Makes it possible to specify a time range (in percentage) in your
5073
+ # media file, during which you want to search for the specified key
5074
+ # words or phrases. See for more detail.
5038
5075
  # @return [Types::RelativeTimeRange]
5039
5076
  #
5040
5077
  # @!attribute [rw] participant_role
5041
- # Specify the participant you want to flag. Omitting this parameter is
5042
- # equivalent to specifying both participants.
5078
+ # Specify the participant that you want to flag. Omitting this
5079
+ # parameter is equivalent to specifying both participants.
5043
5080
  # @return [String]
5044
5081
  #
5045
5082
  # @!attribute [rw] negate
5046
- # Set to `TRUE` to flag the absence of the phrase you specified in
5047
- # your request. Set to `FALSE` to flag the presence of the phrase you
5048
- # specified in your request.
5083
+ # Set to `TRUE` to flag the absence of the phrase that you specified
5084
+ # in your request. Set to `FALSE` to flag the presence of the phrase
5085
+ # that you specified in your request.
5049
5086
  # @return [Boolean]
5050
5087
  #
5051
5088
  # @!attribute [rw] targets
5052
- # Specify the phrases you want to flag.
5089
+ # Specify the phrases that you want to flag.
5053
5090
  # @return [Array<String>]
5054
5091
  #
5055
5092
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptFilter AWS API Documentation
@@ -5092,22 +5129,14 @@ module Aws::TranscribeService
5092
5129
  # @return [String]
5093
5130
  #
5094
5131
  # @!attribute [rw] language_code
5095
- # The language code used to create your transcription job. For a list
5096
- # of supported languages and their associated language codes, refer to
5097
- # the [Supported languages][1] table.
5098
- #
5099
- # Note that you must include one of `LanguageCode`,
5100
- # `IdentifyLanguage`, or `IdentifyMultipleLanguages` in your request.
5101
- # If you include more than one of these parameters, your transcription
5102
- # job fails.
5103
- #
5104
- #
5105
- #
5106
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
5132
+ # The language code used to create your transcription job. This
5133
+ # parameter is used with single-language identification. For
5134
+ # multi-language identification requests, refer to the plural version
5135
+ # of this parameter, `LanguageCodes`.
5107
5136
  # @return [String]
5108
5137
  #
5109
5138
  # @!attribute [rw] media_sample_rate_hertz
5110
- # The sample rate, in Hertz, of the audio track in your input media
5139
+ # The sample rate, in hertz, of the audio track in your input media
5111
5140
  # file.
5112
5141
  # @return [Integer]
5113
5142
  #
@@ -5116,8 +5145,8 @@ module Aws::TranscribeService
5116
5145
  # @return [String]
5117
5146
  #
5118
5147
  # @!attribute [rw] media
5119
- # Describes the Amazon S3 location of the media file you want to use
5120
- # in your request.
5148
+ # Provides the Amazon S3 location of the media file you used in your
5149
+ # request.
5121
5150
  # @return [Types::Media]
5122
5151
  #
5123
5152
  # @!attribute [rw] transcript
@@ -5174,7 +5203,7 @@ module Aws::TranscribeService
5174
5203
  # * `Invalid sample rate for audio file`.
5175
5204
  #
5176
5205
  # The sample rate specified in `MediaSampleRateHertz` isn't valid.
5177
- # The sample rate must be between 8,000 and 48,000 Hertz.
5206
+ # The sample rate must be between 8,000 and 48,000 hertz.
5178
5207
  #
5179
5208
  # * `The sample rate provided does not match the detected sample
5180
5209
  # rate`.
@@ -5201,39 +5230,25 @@ module Aws::TranscribeService
5201
5230
  # @return [String]
5202
5231
  #
5203
5232
  # @!attribute [rw] settings
5204
- # Specify additional optional settings in your request, including
5205
- # channel identification, alternative transcriptions, speaker
5206
- # labeling; allows you to apply custom vocabularies and vocabulary
5207
- # filters.
5208
- #
5209
- # If you want to include a custom vocabulary or a custom vocabulary
5210
- # filter (or both) with your request but **do not** want to use
5211
- # automatic language identification, use `Settings` with the
5212
- # `VocabularyName` or `VocabularyFilterName` (or both) sub-parameter.
5213
- #
5214
- # If you're using automatic language identification with your request
5215
- # and want to include a custom language model, a custom vocabulary, or
5216
- # a custom vocabulary filter, do not use the `Settings` parameter; use
5217
- # instead the ` parameter with the LanguageModelName, VocabularyName
5218
- # or VocabularyFilterName sub-parameters.</p>
5219
- # `
5233
+ # Provides information on any additional settings that were included
5234
+ # in your request. Additional settings include channel identification,
5235
+ # alternative transcriptions, speaker partitioning, custom
5236
+ # vocabularies, and custom vocabulary filters.
5220
5237
  # @return [Types::Settings]
5221
5238
  #
5222
5239
  # @!attribute [rw] model_settings
5223
- # The custom language model you want to include with your
5224
- # transcription job. If you include `ModelSettings` in your request,
5225
- # you must include the `LanguageModelName` sub-parameter.
5240
+ # Provides information on the custom language model you included in
5241
+ # your request.
5226
5242
  # @return [Types::ModelSettings]
5227
5243
  #
5228
5244
  # @!attribute [rw] job_execution_settings
5229
- # Provides information about how your transcription job is being
5230
- # processed. This parameter shows if your request is queued and what
5231
- # data access role is being used.
5245
+ # Provides information about how your transcription job was processed.
5246
+ # This parameter shows if your request was queued and what data access
5247
+ # role was used.
5232
5248
  # @return [Types::JobExecutionSettings]
5233
5249
  #
5234
5250
  # @!attribute [rw] content_redaction
5235
- # Redacts or flags specified personally identifiable information (PII)
5236
- # in your transcript.
5251
+ # Indicates whether redaction was enabled in your transcript.
5237
5252
  # @return [Types::ContentRedaction]
5238
5253
  #
5239
5254
  # @!attribute [rw] identify_language
@@ -5247,22 +5262,7 @@ module Aws::TranscribeService
5247
5262
  # @return [Boolean]
5248
5263
  #
5249
5264
  # @!attribute [rw] language_options
5250
- # You can specify two or more language codes that represent the
5251
- # languages you think may be present in your media; including more
5252
- # than five is not recommended. If you're unsure what languages are
5253
- # present, do not include this parameter.
5254
- #
5255
- # If you include `LanguageOptions` in your request, you must also
5256
- # include `IdentifyLanguage`.
5257
- #
5258
- # For more information, refer to [Supported languages][1].
5259
- #
5260
- # To transcribe speech in Modern Standard Arabic (`ar-SA`), your media
5261
- # file must be encoded at a sample rate of 16,000 Hz or higher.
5262
- #
5263
- #
5264
- #
5265
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
5265
+ # Provides the language codes you specified in your request.
5266
5266
  # @return [Array<String>]
5267
5267
  #
5268
5268
  # @!attribute [rw] identified_language_score
@@ -5279,62 +5279,21 @@ module Aws::TranscribeService
5279
5279
  # parameter is used with multi-language identification. For
5280
5280
  # single-language identification requests, refer to the singular
5281
5281
  # version of this parameter, `LanguageCode`.
5282
- #
5283
- # For a list of supported languages and their associated language
5284
- # codes, refer to the [Supported languages][1] table.
5285
- #
5286
- #
5287
- #
5288
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
5289
5282
  # @return [Array<Types::LanguageCodeItem>]
5290
5283
  #
5291
5284
  # @!attribute [rw] tags
5292
- # Adds one or more custom tags, each in the form of a key:value pair,
5293
- # to a new transcription job at the time you start this new job.
5294
- #
5295
- # To learn more about using tags with Amazon Transcribe, refer to
5296
- # [Tagging resources][1].
5297
- #
5298
- #
5299
- #
5300
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
5285
+ # The tags, each in the form of a key:value pair, assigned to the
5286
+ # specified transcription job.
5301
5287
  # @return [Array<Types::Tag>]
5302
5288
  #
5303
5289
  # @!attribute [rw] subtitles
5304
- # Generate subtitles for your media file with your transcription
5305
- # request.
5290
+ # Indicates whether subtitles were generated with your transcription.
5306
5291
  # @return [Types::SubtitlesOutput]
5307
5292
  #
5308
5293
  # @!attribute [rw] language_id_settings
5309
- # If using automatic language identification (`IdentifyLanguage`) in
5310
- # your request and you want to apply a custom language model, a custom
5311
- # vocabulary, or a custom vocabulary filter, include
5312
- # `LanguageIdSettings` with the relevant sub-parameters
5313
- # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
5314
- #
5315
- # You can specify two or more language codes that represent the
5316
- # languages you think may be present in your media; including more
5317
- # than five is not recommended. Each language code you include can
5318
- # have an associated custom language model, custom vocabulary, and
5319
- # custom vocabulary filter. The languages you specify must match the
5320
- # languages of the specified custom language models, custom
5321
- # vocabularies, and custom vocabulary filters.
5322
- #
5323
- # To include language options using `IdentifyLanguage` **without**
5324
- # including a custom language model, a custom vocabulary, or a custom
5325
- # vocabulary filter, use `LanguageOptions` instead of
5326
- # `LanguageIdSettings`. Including language options can improve the
5327
- # accuracy of automatic language identification.
5328
- #
5329
- # If you want to include a custom language model with your request but
5330
- # **do not** want to use automatic language identification, use
5331
- # instead the ` parameter with the LanguageModelName
5332
- # sub-parameter.</p> If you want to include a custom vocabulary or a
5333
- # custom vocabulary filter (or both) with your request but do not want
5334
- # to use automatic language identification, use instead the parameter
5335
- # with the VocabularyName or VocabularyFilterName (or both)
5336
- # sub-parameter.</p>
5337
- # `
5294
+ # Provides the name and language of all custom language models, custom
5295
+ # vocabularies, and custom vocabulary filters that you included in
5296
+ # your request.
5338
5297
  # @return [Hash<String,Types::LanguageIdSettings>]
5339
5298
  #
5340
5299
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJob AWS API Documentation
@@ -5516,7 +5475,7 @@ module Aws::TranscribeService
5516
5475
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
5517
5476
  #
5518
5477
  # For example,
5519
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
5478
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
5520
5479
  #
5521
5480
  # Valid values for `resource-type` are: `transcription-job`,
5522
5481
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -5618,6 +5577,7 @@ module Aws::TranscribeService
5618
5577
  # },
5619
5578
  # },
5620
5579
  # ],
5580
+ # input_type: "REAL_TIME", # accepts REAL_TIME, POST_CALL
5621
5581
  # }
5622
5582
  #
5623
5583
  # @!attribute [rw] category_name
@@ -5631,11 +5591,20 @@ module Aws::TranscribeService
5631
5591
  # used in the specified category.
5632
5592
  # @return [Array<Types::Rule>]
5633
5593
  #
5594
+ # @!attribute [rw] input_type
5595
+ # Choose whether you want to update a streaming or a batch Call
5596
+ # Analytics category. The input type you specify must match the input
5597
+ # type specified when the category was created. For example, if you
5598
+ # created a category with the `POST_CALL` input type, you must use
5599
+ # `POST_CALL` as the input type when updating this category.
5600
+ # @return [String]
5601
+ #
5634
5602
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategoryRequest AWS API Documentation
5635
5603
  #
5636
5604
  class UpdateCallAnalyticsCategoryRequest < Struct.new(
5637
5605
  :category_name,
5638
- :rules)
5606
+ :rules,
5607
+ :input_type)
5639
5608
  SENSITIVE = []
5640
5609
  include Aws::Structure
5641
5610
  end
@@ -5663,8 +5632,8 @@ module Aws::TranscribeService
5663
5632
  # }
5664
5633
  #
5665
5634
  # @!attribute [rw] vocabulary_name
5666
- # The name of the custom medical vocabulary you want to update.
5667
- # Vocabulary names are case sensitive.
5635
+ # The name of the custom medical vocabulary you want to update. Custom
5636
+ # medical vocabulary names are case sensitive.
5668
5637
  # @return [String]
5669
5638
  #
5670
5639
  # @!attribute [rw] language_code
@@ -5697,8 +5666,8 @@ module Aws::TranscribeService
5697
5666
  # @return [String]
5698
5667
  #
5699
5668
  # @!attribute [rw] language_code
5700
- # The language code you selected for your medical vocabulary. US
5701
- # English (`en-US`) is the only language supported with Amazon
5669
+ # The language code you selected for your custom medical vocabulary.
5670
+ # US English (`en-US`) is the only language supported with Amazon
5702
5671
  # Transcribe Medical.
5703
5672
  # @return [String]
5704
5673
  #
@@ -5713,7 +5682,7 @@ module Aws::TranscribeService
5713
5682
  #
5714
5683
  # @!attribute [rw] vocabulary_state
5715
5684
  # The processing state of your custom medical vocabulary. If the state
5716
- # is `READY`, you can use the vocabulary in a
5685
+ # is `READY`, you can use the custom vocabulary in a
5717
5686
  # `StartMedicalTranscriptionJob` request.
5718
5687
  # @return [String]
5719
5688
  #
@@ -5738,16 +5707,16 @@ module Aws::TranscribeService
5738
5707
  # }
5739
5708
  #
5740
5709
  # @!attribute [rw] vocabulary_filter_name
5741
- # The name of the custom vocabulary filter you want to update.
5742
- # Vocabulary filter names are case sensitive.
5710
+ # The name of the custom vocabulary filter you want to update. Custom
5711
+ # vocabulary filter names are case sensitive.
5743
5712
  # @return [String]
5744
5713
  #
5745
5714
  # @!attribute [rw] words
5746
- # Use this parameter if you want to update your vocabulary filter by
5747
- # including all desired terms, as comma-separated values, within your
5748
- # request. The other option for updating your vocabulary filter is to
5749
- # save your entries in a text file and upload them to an Amazon S3
5750
- # bucket, then specify the location of your file using the
5715
+ # Use this parameter if you want to update your custom vocabulary
5716
+ # filter by including all desired terms, as comma-separated values,
5717
+ # within your request. The other option for updating your vocabulary
5718
+ # filter is to save your entries in a text file and upload them to an
5719
+ # Amazon S3 bucket, then specify the location of your file using the
5751
5720
  # `VocabularyFilterFileUri` parameter.
5752
5721
  #
5753
5722
  # Note that if you include `Words` in your request, you cannot use
@@ -5755,7 +5724,7 @@ module Aws::TranscribeService
5755
5724
  #
5756
5725
  # Each language has a character set that contains all allowed
5757
5726
  # characters for that specific language. If you use unsupported
5758
- # characters, your vocabulary filter request fails. Refer to
5727
+ # characters, your custom vocabulary filter request fails. Refer to
5759
5728
  # [Character Sets for Custom Vocabularies][1] to get the character set
5760
5729
  # for your language.
5761
5730
  #
@@ -5791,11 +5760,12 @@ module Aws::TranscribeService
5791
5760
  # @return [String]
5792
5761
  #
5793
5762
  # @!attribute [rw] language_code
5794
- # The language code you selected for your vocabulary filter.
5763
+ # The language code you selected for your custom vocabulary filter.
5795
5764
  # @return [String]
5796
5765
  #
5797
5766
  # @!attribute [rw] last_modified_time
5798
- # The date and time the specified vocabulary filter was last updated.
5767
+ # The date and time the specified custom vocabulary filter was last
5768
+ # updated.
5799
5769
  #
5800
5770
  # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
5801
5771
  # example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
@@ -5823,19 +5793,19 @@ module Aws::TranscribeService
5823
5793
  # }
5824
5794
  #
5825
5795
  # @!attribute [rw] vocabulary_name
5826
- # The name of the custom vocabulary you want to update. Vocabulary
5827
- # names are case sensitive.
5796
+ # The name of the custom vocabulary you want to update. Custom
5797
+ # vocabulary names are case sensitive.
5828
5798
  # @return [String]
5829
5799
  #
5830
5800
  # @!attribute [rw] language_code
5831
5801
  # The language code that represents the language of the entries in the
5832
- # custom vocabulary you want to update. Each vocabulary must contain
5833
- # terms in only one language.
5802
+ # custom vocabulary you want to update. Each custom vocabulary must
5803
+ # contain terms in only one language.
5834
5804
  #
5835
5805
  # A custom vocabulary can only be used to transcribe files in the same
5836
- # language as the vocabulary. For example, if you create a vocabulary
5837
- # using US English (`en-US`), you can only apply this vocabulary to
5838
- # files that contain English audio.
5806
+ # language as the custom vocabulary. For example, if you create a
5807
+ # custom vocabulary using US English (`en-US`), you can only apply
5808
+ # this custom vocabulary to files that contain English audio.
5839
5809
  #
5840
5810
  # For a list of supported languages and their associated language
5841
5811
  # codes, refer to the [Supported languages][1] table.
@@ -5846,19 +5816,19 @@ module Aws::TranscribeService
5846
5816
  # @return [String]
5847
5817
  #
5848
5818
  # @!attribute [rw] phrases
5849
- # Use this parameter if you want to update your vocabulary by
5819
+ # Use this parameter if you want to update your custom vocabulary by
5850
5820
  # including all desired terms, as comma-separated values, within your
5851
- # request. The other option for updating your vocabulary is to save
5852
- # your entries in a text file and upload them to an Amazon S3 bucket,
5853
- # then specify the location of your file using the `VocabularyFileUri`
5854
- # parameter.
5821
+ # request. The other option for updating your custom vocabulary is to
5822
+ # save your entries in a text file and upload them to an Amazon S3
5823
+ # bucket, then specify the location of your file using the
5824
+ # `VocabularyFileUri` parameter.
5855
5825
  #
5856
5826
  # Note that if you include `Phrases` in your request, you cannot use
5857
5827
  # `VocabularyFileUri`; you must choose one or the other.
5858
5828
  #
5859
5829
  # Each language has a character set that contains all allowed
5860
5830
  # characters for that specific language. If you use unsupported
5861
- # characters, your vocabulary filter request fails. Refer to
5831
+ # characters, your custom vocabulary filter request fails. Refer to
5862
5832
  # [Character Sets for Custom Vocabularies][1] to get the character set
5863
5833
  # for your language.
5864
5834
  #
@@ -5899,7 +5869,7 @@ module Aws::TranscribeService
5899
5869
  # @return [String]
5900
5870
  #
5901
5871
  # @!attribute [rw] last_modified_time
5902
- # The date and time the specified vocabulary was last updated.
5872
+ # The date and time the specified custom vocabulary was last updated.
5903
5873
  #
5904
5874
  # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
5905
5875
  # example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
@@ -5908,8 +5878,8 @@ module Aws::TranscribeService
5908
5878
  #
5909
5879
  # @!attribute [rw] vocabulary_state
5910
5880
  # The processing state of your custom vocabulary. If the state is
5911
- # `READY`, you can use the vocabulary in a `StartTranscriptionJob`
5912
- # request.
5881
+ # `READY`, you can use the custom vocabulary in a
5882
+ # `StartTranscriptionJob` request.
5913
5883
  # @return [String]
5914
5884
  #
5915
5885
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyResponse AWS API Documentation
@@ -5923,8 +5893,8 @@ module Aws::TranscribeService
5923
5893
  include Aws::Structure
5924
5894
  end
5925
5895
 
5926
- # Provides information about a vocabulary filter, including the language
5927
- # of the filter, when it was last modified, and its name.
5896
+ # Provides information about a custom vocabulary filter, including the
5897
+ # language of the filter, when it was last modified, and its name.
5928
5898
  #
5929
5899
  # @!attribute [rw] vocabulary_filter_name
5930
5900
  # A unique name, chosen by you, for your custom vocabulary filter.
@@ -5934,13 +5904,13 @@ module Aws::TranscribeService
5934
5904
  #
5935
5905
  # @!attribute [rw] language_code
5936
5906
  # The language code that represents the language of the entries in
5937
- # your vocabulary filter. Each vocabulary filter must contain terms in
5938
- # only one language.
5907
+ # your vocabulary filter. Each custom vocabulary filter must contain
5908
+ # terms in only one language.
5939
5909
  #
5940
- # A vocabulary filter can only be used to transcribe files in the same
5941
- # language as the filter. For example, if you create a vocabulary
5942
- # filter using US English (`en-US`), you can only apply this filter to
5943
- # files that contain English audio.
5910
+ # A custom vocabulary filter can only be used to transcribe files in
5911
+ # the same language as the filter. For example, if you create a custom
5912
+ # vocabulary filter using US English (`en-US`), you can only apply
5913
+ # this filter to files that contain English audio.
5944
5914
  #
5945
5915
  # For a list of supported languages and their associated language
5946
5916
  # codes, refer to the [Supported languages][1] table.
@@ -5951,7 +5921,8 @@ module Aws::TranscribeService
5951
5921
  # @return [String]
5952
5922
  #
5953
5923
  # @!attribute [rw] last_modified_time
5954
- # The date and time the specified vocabulary filter was last modified.
5924
+ # The date and time the specified custom vocabulary filter was last
5925
+ # modified.
5955
5926
  #
5956
5927
  # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
5957
5928
  # example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
@@ -5969,7 +5940,7 @@ module Aws::TranscribeService
5969
5940
  end
5970
5941
 
5971
5942
  # Provides information about a custom vocabulary, including the language
5972
- # of the vocabulary, when it was last modified, its name, and the
5943
+ # of the custom vocabulary, when it was last modified, its name, and the
5973
5944
  # processing state.
5974
5945
  #
5975
5946
  # @!attribute [rw] vocabulary_name
@@ -5979,17 +5950,17 @@ module Aws::TranscribeService
5979
5950
  # @return [String]
5980
5951
  #
5981
5952
  # @!attribute [rw] language_code
5982
- # The language code used to create your custom vocabulary. Each
5953
+ # The language code used to create your custom vocabulary. Each custom
5983
5954
  # vocabulary must contain terms in only one language.
5984
5955
  #
5985
5956
  # A custom vocabulary can only be used to transcribe files in the same
5986
- # language as the vocabulary. For example, if you create a vocabulary
5987
- # using US English (`en-US`), you can only apply this vocabulary to
5988
- # files that contain English audio.
5957
+ # language as the custom vocabulary. For example, if you create a
5958
+ # custom vocabulary using US English (`en-US`), you can only apply
5959
+ # this custom vocabulary to files that contain English audio.
5989
5960
  # @return [String]
5990
5961
  #
5991
5962
  # @!attribute [rw] last_modified_time
5992
- # The date and time the specified vocabulary was last modified.
5963
+ # The date and time the specified custom vocabulary was last modified.
5993
5964
  #
5994
5965
  # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
5995
5966
  # example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
@@ -5998,8 +5969,8 @@ module Aws::TranscribeService
5998
5969
  #
5999
5970
  # @!attribute [rw] vocabulary_state
6000
5971
  # The processing state of your custom vocabulary. If the state is
6001
- # `READY`, you can use the vocabulary in a `StartTranscriptionJob`
6002
- # request.
5972
+ # `READY`, you can use the custom vocabulary in a
5973
+ # `StartTranscriptionJob` request.
6003
5974
  # @return [String]
6004
5975
  #
6005
5976
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/VocabularyInfo AWS API Documentation