aws-sdk-transcribeservice 1.77.0 → 1.78.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -380,10 +380,17 @@ module Aws::TranscribeService
380
380
 
381
381
  # Creates a new Call Analytics category.
382
382
  #
383
- # All categories are automatically applied to your Call Analytics jobs.
384
- # Note that in order to apply your categories to your jobs, you must
385
- # create them before submitting your job request, as categories cannot
386
- # be applied retroactively.
383
+ # All categories are automatically applied to your Call Analytics
384
+ # transcriptions. Note that in order to apply categories to your
385
+ # transcriptions, you must create them before submitting your
386
+ # transcription request, as categories cannot be applied retroactively.
387
+ #
388
+ # When creating a new category, you can use the `InputType` parameter to
389
+ # label the category as a batch category (`POST_CALL`) or a streaming
390
+ # category (`REAL_TIME`). Batch categories can only be applied to batch
391
+ # transcriptions and streaming categories can only be applied to
392
+ # streaming transcriptions. If you do not include `InputType`, your
393
+ # category is created as a batch category by default.
387
394
  #
388
395
  # Call Analytics categories are composed of rules. For each category,
389
396
  # you must create between 1 and 20 rules. Rules can include these
@@ -391,20 +398,14 @@ module Aws::TranscribeService
391
398
  #
392
399
  # To update an existing category, see .
393
400
  #
394
- # To learn more about:
401
+ # To learn more about Call Analytics categories, see [Creating
402
+ # categories for batch transcriptions][1] and [Creating categories for
403
+ # streaming transcriptions][2].
395
404
  #
396
- # * Call Analytics categories, see [Creating categories][1]
397
405
  #
398
- # * Using rules, see [Rule criteria][2] and refer to the data type
399
406
  #
400
- # * Call Analytics, see [Analyzing call center audio with Call
401
- # Analytics][3]
402
- #
403
- #
404
- #
405
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html
406
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
407
- # [3]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html
407
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html
408
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html
408
409
  #
409
410
  # @option params [required, String] :category_name
410
411
  # A unique name, chosen by you, for your Call Analytics category. It's
@@ -416,12 +417,27 @@ module Aws::TranscribeService
416
417
  # Category names are case sensitive.
417
418
  #
418
419
  # @option params [required, Array<Types::Rule>] :rules
419
- # Rules define a Call Analytics category. When creating a new Call
420
- # Analytics category, you must create between 1 and 20 rules for that
421
- # category. For each rule, you specify a filter you want applied to the
422
- # attributes of a call. For example, you can choose a sentiment filter
423
- # that detects if a customer's sentiment was positive during the last
424
- # 30 seconds of the call.
420
+ # Rules define a Call Analytics category. When creating a new category,
421
+ # you must create between 1 and 20 rules for that category. For each
422
+ # rule, you specify a filter you want applied to the attributes of a
423
+ # call. For example, you can choose a sentiment filter that detects if a
424
+ # customer's sentiment was positive during the last 30 seconds of the
425
+ # call.
426
+ #
427
+ # @option params [String] :input_type
428
+ # Choose whether you want to create a streaming or a batch category for
429
+ # your Call Analytics transcription.
430
+ #
431
+ # Specifying `POST_CALL` assigns your category to batch transcriptions;
432
+ # categories with this input type cannot be applied to streaming
433
+ # (real-time) transcriptions.
434
+ #
435
+ # Specifying `REAL_TIME` assigns your category to streaming
436
+ # transcriptions; categories with this input type cannot be applied to
437
+ # batch (post-call) transcriptions.
438
+ #
439
+ # If you do not include `InputType`, your category is created as a batch
440
+ # category by default.
425
441
  #
426
442
  # @return [Types::CreateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
427
443
  #
@@ -503,6 +519,7 @@ module Aws::TranscribeService
503
519
  # },
504
520
  # },
505
521
  # ],
522
+ # input_type: "REAL_TIME", # accepts REAL_TIME, POST_CALL
506
523
  # })
507
524
  #
508
525
  # @example Response structure
@@ -557,6 +574,7 @@ module Aws::TranscribeService
557
574
  # resp.category_properties.rules[0].sentiment_filter.negate #=> Boolean
558
575
  # resp.category_properties.create_time #=> Time
559
576
  # resp.category_properties.last_update_time #=> Time
577
+ # resp.category_properties.input_type #=> String, one of "REAL_TIME", "POST_CALL"
560
578
  #
561
579
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategory AWS API Documentation
562
580
  #
@@ -569,7 +587,7 @@ module Aws::TranscribeService
569
587
 
570
588
  # Creates a new custom language model.
571
589
  #
572
- # When creating a new language model, you must specify:
590
+ # When creating a new custom language model, you must specify:
573
591
  #
574
592
  # * If you want a Wideband (audio sample rates over 16,000 Hz) or
575
593
  # Narrowband (audio sample rates under 16,000 Hz) base model
@@ -581,27 +599,21 @@ module Aws::TranscribeService
581
599
  #
582
600
  # * A unique name for your model
583
601
  #
584
- # For more information, see [Custom language models][1].
585
- #
586
- #
587
- #
588
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
589
- #
590
602
  # @option params [required, String] :language_code
591
603
  # The language code that represents the language of your model. Each
592
- # language model must contain terms in only one language, and the
593
- # language you select for your model must match the language of your
594
- # training and tuning data.
604
+ # custom language model must contain terms in only one language, and the
605
+ # language you select for your custom language model must match the
606
+ # language of your training and tuning data.
595
607
  #
596
608
  # For a list of supported languages and their associated language codes,
597
- # refer to the [Supported languages][1] table. Note that U.S. English
609
+ # refer to the [Supported languages][1] table. Note that US English
598
610
  # (`en-US`) is the only language supported with Amazon Transcribe
599
611
  # Medical.
600
612
  #
601
613
  # A custom language model can only be used to transcribe files in the
602
- # same language as the model. For example, if you create a language
603
- # model using US English (`en-US`), you can only apply this model to
604
- # files that contain English audio.
614
+ # same language as the model. For example, if you create a custom
615
+ # language model using US English (`en-US`), you can only apply this
616
+ # model to files that contain English audio.
605
617
  #
606
618
  #
607
619
  #
@@ -621,8 +633,8 @@ module Aws::TranscribeService
621
633
  #
622
634
  # This name is case sensitive, cannot contain spaces, and must be unique
623
635
  # within an Amazon Web Services account. If you try to create a new
624
- # language model with the same name as an existing language model, you
625
- # get a `ConflictException` error.
636
+ # custom language model with the same name as an existing custom
637
+ # language model, you get a `ConflictException` error.
626
638
  #
627
639
  # @option params [required, Types::InputDataConfig] :input_data_config
628
640
  # Contains the Amazon S3 location of the training data you want to use
@@ -697,31 +709,31 @@ module Aws::TranscribeService
697
709
 
698
710
  # Creates a new custom medical vocabulary.
699
711
  #
700
- # Prior to creating a new medical vocabulary, you must first upload a
701
- # text file that contains your new entries, phrases, and terms into an
712
+ # Before creating a new custom medical vocabulary, you must first upload
713
+ # a text file that contains your new entries, phrases, and terms into an
702
714
  # Amazon S3 bucket. Note that this differs from , where you can include
703
715
  # a list of terms within your request using the `Phrases` flag;
704
716
  # `CreateMedicalVocabulary` does not support the `Phrases` flag.
705
717
  #
706
718
  # Each language has a character set that contains all allowed characters
707
719
  # for that specific language. If you use unsupported characters, your
708
- # vocabulary request fails. Refer to [Character Sets for Custom
720
+ # custom vocabulary request fails. Refer to [Character Sets for Custom
709
721
  # Vocabularies][1] to get the character set for your language.
710
722
  #
711
- # For more information, see [Creating a custom vocabulary][2].
723
+ # For more information, see [Custom vocabularies][2].
712
724
  #
713
725
  #
714
726
  #
715
727
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
716
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
728
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
717
729
  #
718
730
  # @option params [required, String] :vocabulary_name
719
731
  # A unique name, chosen by you, for your new custom medical vocabulary.
720
732
  #
721
733
  # This name is case sensitive, cannot contain spaces, and must be unique
722
734
  # within an Amazon Web Services account. If you try to create a new
723
- # medical vocabulary with the same name as an existing medical
724
- # vocabulary, you get a `ConflictException` error.
735
+ # custom medical vocabulary with the same name as an existing custom
736
+ # medical vocabulary, you get a `ConflictException` error.
725
737
  #
726
738
  # @option params [required, String] :language_code
727
739
  # The language code that represents the language of the entries in your
@@ -738,7 +750,8 @@ module Aws::TranscribeService
738
750
  #
739
751
  # @option params [Array<Types::Tag>] :tags
740
752
  # Adds one or more custom tags, each in the form of a key:value pair, to
741
- # a new medical vocabulary at the time you create this new vocabulary.
753
+ # a new custom medical vocabulary at the time you create this new custom
754
+ # vocabulary.
742
755
  #
743
756
  # To learn more about using tags with Amazon Transcribe, refer to
744
757
  # [Tagging resources][1].
@@ -788,40 +801,40 @@ module Aws::TranscribeService
788
801
 
789
802
  # Creates a new custom vocabulary.
790
803
  #
791
- # When creating a new vocabulary, you can either upload a text file that
792
- # contains your new entries, phrases, and terms into an Amazon S3 bucket
793
- # and include the URI in your request, or you can include a list of
794
- # terms directly in your request using the `Phrases` flag.
804
+ # When creating a new custom vocabulary, you can either upload a text
805
+ # file that contains your new entries, phrases, and terms into an Amazon
806
+ # S3 bucket and include the URI in your request. Or you can include a
807
+ # list of terms directly in your request using the `Phrases` flag.
795
808
  #
796
809
  # Each language has a character set that contains all allowed characters
797
810
  # for that specific language. If you use unsupported characters, your
798
- # vocabulary request fails. Refer to [Character Sets for Custom
811
+ # custom vocabulary request fails. Refer to [Character Sets for Custom
799
812
  # Vocabularies][1] to get the character set for your language.
800
813
  #
801
- # For more information, see [Creating a custom vocabulary][2].
814
+ # For more information, see [Custom vocabularies][2].
802
815
  #
803
816
  #
804
817
  #
805
818
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
806
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
819
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
807
820
  #
808
821
  # @option params [required, String] :vocabulary_name
809
822
  # A unique name, chosen by you, for your new custom vocabulary.
810
823
  #
811
824
  # This name is case sensitive, cannot contain spaces, and must be unique
812
825
  # within an Amazon Web Services account. If you try to create a new
813
- # vocabulary with the same name as an existing vocabulary, you get a
814
- # `ConflictException` error.
826
+ # custom vocabulary with the same name as an existing custom vocabulary,
827
+ # you get a `ConflictException` error.
815
828
  #
816
829
  # @option params [required, String] :language_code
817
830
  # The language code that represents the language of the entries in your
818
- # custom vocabulary. Each vocabulary must contain terms in only one
819
- # language.
831
+ # custom vocabulary. Each custom vocabulary must contain terms in only
832
+ # one language.
820
833
  #
821
834
  # A custom vocabulary can only be used to transcribe files in the same
822
- # language as the vocabulary. For example, if you create a vocabulary
823
- # using US English (`en-US`), you can only apply this vocabulary to
824
- # files that contain English audio.
835
+ # language as the custom vocabulary. For example, if you create a custom
836
+ # vocabulary using US English (`en-US`), you can only apply this custom
837
+ # vocabulary to files that contain English audio.
825
838
  #
826
839
  # For a list of supported languages and their associated language codes,
827
840
  # refer to the [Supported languages][1] table.
@@ -831,19 +844,20 @@ module Aws::TranscribeService
831
844
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
832
845
  #
833
846
  # @option params [Array<String>] :phrases
834
- # Use this parameter if you want to create your vocabulary by including
835
- # all desired terms, as comma-separated values, within your request. The
836
- # other option for creating your vocabulary is to save your entries in a
837
- # text file and upload them to an Amazon S3 bucket, then specify the
838
- # location of your file using the `VocabularyFileUri` parameter.
847
+ # Use this parameter if you want to create your custom vocabulary by
848
+ # including all desired terms, as comma-separated values, within your
849
+ # request. The other option for creating your custom vocabulary is to
850
+ # save your entries in a text file and upload them to an Amazon S3
851
+ # bucket, then specify the location of your file using the
852
+ # `VocabularyFileUri` parameter.
839
853
  #
840
854
  # Note that if you include `Phrases` in your request, you cannot use
841
855
  # `VocabularyFileUri`; you must choose one or the other.
842
856
  #
843
857
  # Each language has a character set that contains all allowed characters
844
858
  # for that specific language. If you use unsupported characters, your
845
- # vocabulary filter request fails. Refer to [Character Sets for Custom
846
- # Vocabularies][1] to get the character set for your language.
859
+ # custom vocabulary filter request fails. Refer to [Character Sets for
860
+ # Custom Vocabularies][1] to get the character set for your language.
847
861
  #
848
862
  #
849
863
  #
@@ -862,7 +876,8 @@ module Aws::TranscribeService
862
876
  #
863
877
  # @option params [Array<Types::Tag>] :tags
864
878
  # Adds one or more custom tags, each in the form of a key:value pair, to
865
- # a new custom vocabulary at the time you create this new vocabulary.
879
+ # a new custom vocabulary at the time you create this new custom
880
+ # vocabulary.
866
881
  #
867
882
  # To learn more about using tags with Amazon Transcribe, refer to
868
883
  # [Tagging resources][1].
@@ -913,17 +928,16 @@ module Aws::TranscribeService
913
928
 
914
929
  # Creates a new custom vocabulary filter.
915
930
  #
916
- # You can use vocabulary filters to mask, delete, or flag specific words
917
- # from your transcript. Vocabulary filters are commonly used to mask
918
- # profanity in transcripts.
931
+ # You can use custom vocabulary filters to mask, delete, or flag
932
+ # specific words from your transcript. Custom vocabulary filters are
933
+ # commonly used to mask profanity in transcripts.
919
934
  #
920
935
  # Each language has a character set that contains all allowed characters
921
936
  # for that specific language. If you use unsupported characters, your
922
- # vocabulary filter request fails. Refer to [Character Sets for Custom
923
- # Vocabularies][1] to get the character set for your language.
937
+ # custom vocabulary filter request fails. Refer to [Character Sets for
938
+ # Custom Vocabularies][1] to get the character set for your language.
924
939
  #
925
- # For more information, see [Using vocabulary filtering with unwanted
926
- # words][2].
940
+ # For more information, see [Vocabulary filtering][2].
927
941
  #
928
942
  #
929
943
  #
@@ -935,18 +949,18 @@ module Aws::TranscribeService
935
949
  #
936
950
  # This name is case sensitive, cannot contain spaces, and must be unique
937
951
  # within an Amazon Web Services account. If you try to create a new
938
- # vocabulary filter with the same name as an existing vocabulary filter,
939
- # you get a `ConflictException` error.
952
+ # custom vocabulary filter with the same name as an existing custom
953
+ # vocabulary filter, you get a `ConflictException` error.
940
954
  #
941
955
  # @option params [required, String] :language_code
942
956
  # The language code that represents the language of the entries in your
943
- # vocabulary filter. Each vocabulary filter must contain terms in only
944
- # one language.
957
+ # vocabulary filter. Each custom vocabulary filter must contain terms in
958
+ # only one language.
945
959
  #
946
- # A vocabulary filter can only be used to transcribe files in the same
947
- # language as the filter. For example, if you create a vocabulary filter
948
- # using US English (`en-US`), you can only apply this filter to files
949
- # that contain English audio.
960
+ # A custom vocabulary filter can only be used to transcribe files in the
961
+ # same language as the filter. For example, if you create a custom
962
+ # vocabulary filter using US English (`en-US`), you can only apply this
963
+ # filter to files that contain English audio.
950
964
  #
951
965
  # For a list of supported languages and their associated language codes,
952
966
  # refer to the [Supported languages][1] table.
@@ -956,8 +970,8 @@ module Aws::TranscribeService
956
970
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
957
971
  #
958
972
  # @option params [Array<String>] :words
959
- # Use this parameter if you want to create your vocabulary filter by
960
- # including all desired terms, as comma-separated values, within your
973
+ # Use this parameter if you want to create your custom vocabulary filter
974
+ # by including all desired terms, as comma-separated values, within your
961
975
  # request. The other option for creating your vocabulary filter is to
962
976
  # save your entries in a text file and upload them to an Amazon S3
963
977
  # bucket, then specify the location of your file using the
@@ -968,8 +982,8 @@ module Aws::TranscribeService
968
982
  #
969
983
  # Each language has a character set that contains all allowed characters
970
984
  # for that specific language. If you use unsupported characters, your
971
- # vocabulary filter request fails. Refer to [Character Sets for Custom
972
- # Vocabularies][1] to get the character set for your language.
985
+ # custom vocabulary filter request fails. Refer to [Character Sets for
986
+ # Custom Vocabularies][1] to get the character set for your language.
973
987
  #
974
988
  #
975
989
  #
@@ -988,7 +1002,8 @@ module Aws::TranscribeService
988
1002
  #
989
1003
  # @option params [Array<Types::Tag>] :tags
990
1004
  # Adds one or more custom tags, each in the form of a key:value pair, to
991
- # a new custom vocabulary filter at the time you create this new filter.
1005
+ # a new custom vocabulary filter at the time you create this new
1006
+ # vocabulary filter.
992
1007
  #
993
1008
  # To learn more about using tags with Amazon Transcribe, refer to
994
1009
  # [Tagging resources][1].
@@ -1085,7 +1100,7 @@ module Aws::TranscribeService
1085
1100
 
1086
1101
  # Deletes a custom language model. To use this operation, specify the
1087
1102
  # name of the language model you want to delete using `ModelName`.
1088
- # Language model names are case sensitive.
1103
+ # custom language model names are case sensitive.
1089
1104
  #
1090
1105
  # @option params [required, String] :model_name
1091
1106
  # The name of the custom language model you want to delete. Model names
@@ -1134,12 +1149,12 @@ module Aws::TranscribeService
1134
1149
  end
1135
1150
 
1136
1151
  # Deletes a custom medical vocabulary. To use this operation, specify
1137
- # the name of the vocabulary you want to delete using `VocabularyName`.
1138
- # Vocabulary names are case sensitive.
1152
+ # the name of the custom vocabulary you want to delete using
1153
+ # `VocabularyName`. Custom vocabulary names are case sensitive.
1139
1154
  #
1140
1155
  # @option params [required, String] :vocabulary_name
1141
- # The name of the custom medical vocabulary you want to delete.
1142
- # Vocabulary names are case sensitive.
1156
+ # The name of the custom medical vocabulary you want to delete. Custom
1157
+ # medical vocabulary names are case sensitive.
1143
1158
  #
1144
1159
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1145
1160
  #
@@ -1184,12 +1199,12 @@ module Aws::TranscribeService
1184
1199
  end
1185
1200
 
1186
1201
  # Deletes a custom vocabulary. To use this operation, specify the name
1187
- # of the vocabulary you want to delete using `VocabularyName`.
1188
- # Vocabulary names are case sensitive.
1202
+ # of the custom vocabulary you want to delete using `VocabularyName`.
1203
+ # Custom vocabulary names are case sensitive.
1189
1204
  #
1190
1205
  # @option params [required, String] :vocabulary_name
1191
- # The name of the custom vocabulary you want to delete. Vocabulary names
1192
- # are case sensitive.
1206
+ # The name of the custom vocabulary you want to delete. Custom
1207
+ # vocabulary names are case sensitive.
1193
1208
  #
1194
1209
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1195
1210
  #
@@ -1208,13 +1223,14 @@ module Aws::TranscribeService
1208
1223
  req.send_request(options)
1209
1224
  end
1210
1225
 
1211
- # Deletes a vocabulary filter. To use this operation, specify the name
1212
- # of the vocabulary filter you want to delete using
1213
- # `VocabularyFilterName`. Vocabulary filter names are case sensitive.
1226
+ # Deletes a custom vocabulary filter. To use this operation, specify the
1227
+ # name of the custom vocabulary filter you want to delete using
1228
+ # `VocabularyFilterName`. Custom vocabulary filter names are case
1229
+ # sensitive.
1214
1230
  #
1215
1231
  # @option params [required, String] :vocabulary_filter_name
1216
- # The name of the custom vocabulary filter you want to delete.
1217
- # Vocabulary filter names are case sensitive.
1232
+ # The name of the custom vocabulary filter you want to delete. Custom
1233
+ # vocabulary filter names are case sensitive.
1218
1234
  #
1219
1235
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1220
1236
  #
@@ -1235,7 +1251,7 @@ module Aws::TranscribeService
1235
1251
 
1236
1252
  # Provides information about the specified custom language model.
1237
1253
  #
1238
- # This operation also shows if the base language model you used to
1254
+ # This operation also shows if the base language model that you used to
1239
1255
  # create your custom language model has been updated. If Amazon
1240
1256
  # Transcribe has updated the base model, you can create a new custom
1241
1257
  # language model using the updated base model.
@@ -1244,8 +1260,6 @@ module Aws::TranscribeService
1244
1260
  # wasn't successful, you can use `DescribeLanguageModel` to help
1245
1261
  # identify the reason for this failure.
1246
1262
  #
1247
- # To get a list of your custom language models, use the operation.
1248
- #
1249
1263
  # @option params [required, String] :model_name
1250
1264
  # The name of the custom language model you want information about.
1251
1265
  # Model names are case sensitive.
@@ -1353,6 +1367,7 @@ module Aws::TranscribeService
1353
1367
  # resp.category_properties.rules[0].sentiment_filter.negate #=> Boolean
1354
1368
  # resp.category_properties.create_time #=> Time
1355
1369
  # resp.category_properties.last_update_time #=> Time
1370
+ # resp.category_properties.input_type #=> String, one of "REAL_TIME", "POST_CALL"
1356
1371
  #
1357
1372
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsCategory AWS API Documentation
1358
1373
  #
@@ -1443,8 +1458,8 @@ module Aws::TranscribeService
1443
1458
  #
1444
1459
  # To view the status of the specified medical transcription job, check
1445
1460
  # the `TranscriptionJobStatus` field. If the status is `COMPLETED`, the
1446
- # job is finished and you can find the results at the location specified
1447
- # in `TranscriptFileUri`. If the status is `FAILED`, `FailureReason`
1461
+ # job is finished. You can find the results at the location specified in
1462
+ # `TranscriptFileUri`. If the status is `FAILED`, `FailureReason`
1448
1463
  # provides details on why your transcription job failed.
1449
1464
  #
1450
1465
  # To get a list of your medical transcription jobs, use the operation.
@@ -1501,16 +1516,16 @@ module Aws::TranscribeService
1501
1516
 
1502
1517
  # Provides information about the specified custom medical vocabulary.
1503
1518
  #
1504
- # To view the status of the specified medical vocabulary, check the
1505
- # `VocabularyState` field. If the status is `READY`, your vocabulary is
1506
- # available to use. If the status is `FAILED`, `FailureReason` provides
1507
- # details on why your vocabulary failed.
1519
+ # To view the status of the specified custom medical vocabulary, check
1520
+ # the `VocabularyState` field. If the status is `READY`, your custom
1521
+ # vocabulary is available to use. If the status is `FAILED`,
1522
+ # `FailureReason` provides details on why your vocabulary failed.
1508
1523
  #
1509
1524
  # To get a list of your custom medical vocabularies, use the operation.
1510
1525
  #
1511
1526
  # @option params [required, String] :vocabulary_name
1512
1527
  # The name of the custom medical vocabulary you want information about.
1513
- # Vocabulary names are case sensitive.
1528
+ # Custom medical vocabulary names are case sensitive.
1514
1529
  #
1515
1530
  # @return [Types::GetMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1516
1531
  #
@@ -1549,7 +1564,7 @@ module Aws::TranscribeService
1549
1564
  #
1550
1565
  # To view the status of the specified transcription job, check the
1551
1566
  # `TranscriptionJobStatus` field. If the status is `COMPLETED`, the job
1552
- # is finished and you can find the results at the location specified in
1567
+ # is finished. You can find the results at the location specified in
1553
1568
  # `TranscriptFileUri`. If the status is `FAILED`, `FailureReason`
1554
1569
  # provides details on why your transcription job failed.
1555
1570
  #
@@ -1634,16 +1649,16 @@ module Aws::TranscribeService
1634
1649
 
1635
1650
  # Provides information about the specified custom vocabulary.
1636
1651
  #
1637
- # To view the status of the specified vocabulary, check the
1638
- # `VocabularyState` field. If the status is `READY`, your vocabulary is
1639
- # available to use. If the status is `FAILED`, `FailureReason` provides
1640
- # details on why your vocabulary failed.
1652
+ # To view the status of the specified custom vocabulary, check the
1653
+ # `VocabularyState` field. If the status is `READY`, your custom
1654
+ # vocabulary is available to use. If the status is `FAILED`,
1655
+ # `FailureReason` provides details on why your custom vocabulary failed.
1641
1656
  #
1642
1657
  # To get a list of your custom vocabularies, use the operation.
1643
1658
  #
1644
1659
  # @option params [required, String] :vocabulary_name
1645
- # The name of the custom vocabulary you want information about.
1646
- # Vocabulary names are case sensitive.
1660
+ # The name of the custom vocabulary you want information about. Custom
1661
+ # vocabulary names are case sensitive.
1647
1662
  #
1648
1663
  # @return [Types::GetVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1649
1664
  #
@@ -1680,16 +1695,11 @@ module Aws::TranscribeService
1680
1695
 
1681
1696
  # Provides information about the specified custom vocabulary filter.
1682
1697
  #
1683
- # To view the status of the specified vocabulary filter, check the
1684
- # `VocabularyState` field. If the status is `READY`, your vocabulary is
1685
- # available to use. If the status is `FAILED`, `FailureReason` provides
1686
- # details on why your vocabulary filter failed.
1687
- #
1688
1698
  # To get a list of your custom vocabulary filters, use the operation.
1689
1699
  #
1690
1700
  # @option params [required, String] :vocabulary_filter_name
1691
1701
  # The name of the custom vocabulary filter you want information about.
1692
- # Vocabulary filter names are case sensitive.
1702
+ # Custom vocabulary filter names are case sensitive.
1693
1703
  #
1694
1704
  # @return [Types::GetVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1695
1705
  #
@@ -1735,9 +1745,9 @@ module Aws::TranscribeService
1735
1745
  #
1736
1746
  # @option params [Integer] :max_results
1737
1747
  # The maximum number of Call Analytics categories to return in each page
1738
- # of results. If there are fewer results than the value you specify,
1739
- # only the actual results are returned. If you don't specify a value, a
1740
- # default of 5 is used.
1748
+ # of results. If there are fewer results than the value that you
1749
+ # specify, only the actual results are returned. If you don't specify a
1750
+ # value, a default of 5 is used.
1741
1751
  #
1742
1752
  # @return [Types::ListCallAnalyticsCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1743
1753
  #
@@ -1807,6 +1817,7 @@ module Aws::TranscribeService
1807
1817
  # resp.categories[0].rules[0].sentiment_filter.negate #=> Boolean
1808
1818
  # resp.categories[0].create_time #=> Time
1809
1819
  # resp.categories[0].last_update_time #=> Time
1820
+ # resp.categories[0].input_type #=> String, one of "REAL_TIME", "POST_CALL"
1810
1821
  #
1811
1822
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsCategories AWS API Documentation
1812
1823
  #
@@ -1842,8 +1853,8 @@ module Aws::TranscribeService
1842
1853
  #
1843
1854
  # @option params [Integer] :max_results
1844
1855
  # The maximum number of Call Analytics jobs to return in each page of
1845
- # results. If there are fewer results than the value you specify, only
1846
- # the actual results are returned. If you don't specify a value, a
1856
+ # results. If there are fewer results than the value that you specify,
1857
+ # only the actual results are returned. If you don't specify a value, a
1847
1858
  # default of 5 is used.
1848
1859
  #
1849
1860
  # @return [Types::ListCallAnalyticsJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1886,7 +1897,7 @@ module Aws::TranscribeService
1886
1897
  end
1887
1898
 
1888
1899
  # Provides a list of custom language models that match the specified
1889
- # criteria. If no criteria are specified, all language models are
1900
+ # criteria. If no criteria are specified, all custom language models are
1890
1901
  # returned.
1891
1902
  #
1892
1903
  # To get detailed information about a specific custom language model,
@@ -1911,8 +1922,8 @@ module Aws::TranscribeService
1911
1922
  #
1912
1923
  # @option params [Integer] :max_results
1913
1924
  # The maximum number of custom language models to return in each page of
1914
- # results. If there are fewer results than the value you specify, only
1915
- # the actual results are returned. If you don't specify a value, a
1925
+ # results. If there are fewer results than the value that you specify,
1926
+ # only the actual results are returned. If you don't specify a value, a
1916
1927
  # default of 5 is used.
1917
1928
  #
1918
1929
  # @return [Types::ListLanguageModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1981,7 +1992,7 @@ module Aws::TranscribeService
1981
1992
  #
1982
1993
  # @option params [Integer] :max_results
1983
1994
  # The maximum number of medical transcription jobs to return in each
1984
- # page of results. If there are fewer results than the value you
1995
+ # page of results. If there are fewer results than the value that you
1985
1996
  # specify, only the actual results are returned. If you don't specify a
1986
1997
  # value, a default of 5 is used.
1987
1998
  #
@@ -2044,15 +2055,15 @@ module Aws::TranscribeService
2044
2055
  #
2045
2056
  # @option params [Integer] :max_results
2046
2057
  # The maximum number of custom medical vocabularies to return in each
2047
- # page of results. If there are fewer results than the value you
2058
+ # page of results. If there are fewer results than the value that you
2048
2059
  # specify, only the actual results are returned. If you don't specify a
2049
2060
  # value, a default of 5 is used.
2050
2061
  #
2051
2062
  # @option params [String] :state_equals
2052
2063
  # Returns only custom medical vocabularies with the specified state.
2053
- # Vocabularies are ordered by creation date, with the newest vocabulary
2054
- # first. If you don't include `StateEquals`, all custom medical
2055
- # vocabularies are returned.
2064
+ # Custom vocabularies are ordered by creation date, with the newest
2065
+ # vocabulary first. If you don't include `StateEquals`, all custom
2066
+ # medical vocabularies are returned.
2056
2067
  #
2057
2068
  # @option params [String] :name_contains
2058
2069
  # Returns only the custom medical vocabularies that contain the
@@ -2110,7 +2121,7 @@ module Aws::TranscribeService
2110
2121
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
2111
2122
  #
2112
2123
  # For example,
2113
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
2124
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
2114
2125
  #
2115
2126
  # Valid values for `resource-type` are: `transcription-job`,
2116
2127
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -2168,8 +2179,8 @@ module Aws::TranscribeService
2168
2179
  #
2169
2180
  # @option params [Integer] :max_results
2170
2181
  # The maximum number of transcription jobs to return in each page of
2171
- # results. If there are fewer results than the value you specify, only
2172
- # the actual results are returned. If you don't specify a value, a
2182
+ # results. If there are fewer results than the value that you specify,
2183
+ # only the actual results are returned. If you don't specify a value, a
2173
2184
  # default of 5 is used.
2174
2185
  #
2175
2186
  # @return [Types::ListTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2239,8 +2250,8 @@ module Aws::TranscribeService
2239
2250
  #
2240
2251
  # @option params [Integer] :max_results
2241
2252
  # The maximum number of custom vocabularies to return in each page of
2242
- # results. If there are fewer results than the value you specify, only
2243
- # the actual results are returned. If you don't specify a value, a
2253
+ # results. If there are fewer results than the value that you specify,
2254
+ # only the actual results are returned. If you don't specify a value, a
2244
2255
  # default of 5 is used.
2245
2256
  #
2246
2257
  # @option params [String] :state_equals
@@ -2305,9 +2316,9 @@ module Aws::TranscribeService
2305
2316
  #
2306
2317
  # @option params [Integer] :max_results
2307
2318
  # The maximum number of custom vocabulary filters to return in each page
2308
- # of results. If there are fewer results than the value you specify,
2309
- # only the actual results are returned. If you don't specify a value, a
2310
- # default of 5 is used.
2319
+ # of results. If there are fewer results than the value that you
2320
+ # specify, only the actual results are returned. If you don't specify a
2321
+ # value, a default of 5 is used.
2311
2322
  #
2312
2323
  # @option params [String] :name_contains
2313
2324
  # Returns only the custom vocabulary filters that contain the specified
@@ -2348,18 +2359,19 @@ module Aws::TranscribeService
2348
2359
  # Transcribes the audio from a customer service call and applies any
2349
2360
  # additional Request Parameters you choose to include in your request.
2350
2361
  #
2351
- # In addition to many of the standard transcription features, Call
2352
- # Analytics provides you with call characteristics, call summarization,
2353
- # speaker sentiment, and optional redaction of your text transcript and
2354
- # your audio file. You can also apply custom categories to flag
2355
- # specified conditions. To learn more about these features and insights,
2356
- # refer to [Analyzing call center audio with Call Analytics][1].
2362
+ # In addition to many standard transcription features, Call Analytics
2363
+ # provides you with call characteristics, call summarization, speaker
2364
+ # sentiment, and optional redaction of your text transcript and your
2365
+ # audio file. You can also apply custom categories to flag specified
2366
+ # conditions. To learn more about these features and insights, refer to
2367
+ # [Analyzing call center audio with Call Analytics][1].
2357
2368
  #
2358
2369
  # If you want to apply categories to your Call Analytics job, you must
2359
2370
  # create them before submitting your job request. Categories cannot be
2360
2371
  # retroactively applied to a job. To create a new category, use the
2361
2372
  # operation. To learn more about Call Analytics categories, see
2362
- # [Creating categories][2].
2373
+ # [Creating categories for batch transcriptions][2] and [Creating
2374
+ # categories for streaming transcriptions][3].
2363
2375
  #
2364
2376
  # To make a `StartCallAnalyticsJob` request, you must first upload your
2365
2377
  # media file into an Amazon S3 bucket; you can then specify the Amazon
@@ -2371,10 +2383,10 @@ module Aws::TranscribeService
2371
2383
  # * `region`\: The Amazon Web Services Region where you are making your
2372
2384
  # request. For a list of Amazon Web Services Regions supported with
2373
2385
  # Amazon Transcribe, refer to [Amazon Transcribe endpoints and
2374
- # quotas][3].
2386
+ # quotas][4].
2375
2387
  #
2376
- # * `CallAnalyticsJobName`\: A custom name you create for your
2377
- # transcription job that is unique within your Amazon Web Services
2388
+ # * `CallAnalyticsJobName`\: A custom name that you create for your
2389
+ # transcription job that's unique within your Amazon Web Services
2378
2390
  # account.
2379
2391
  #
2380
2392
  # * `DataAccessRoleArn`\: The Amazon Resource Name (ARN) of an IAM role
@@ -2395,8 +2407,9 @@ module Aws::TranscribeService
2395
2407
  #
2396
2408
  #
2397
2409
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html
2398
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html
2399
- # [3]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html
2410
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html
2411
+ # [3]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html
2412
+ # [4]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html
2400
2413
  #
2401
2414
  # @option params [required, String] :call_analytics_job_name
2402
2415
  # A unique name, chosen by you, for your Call Analytics job.
@@ -2408,7 +2421,7 @@ module Aws::TranscribeService
2408
2421
  #
2409
2422
  # @option params [required, Types::Media] :media
2410
2423
  # Describes the Amazon S3 location of the media file you want to use in
2411
- # your request.
2424
+ # your Call Analytics request.
2412
2425
  #
2413
2426
  # @option params [String] :output_location
2414
2427
  # The Amazon S3 location where you want your Call Analytics
@@ -2475,8 +2488,8 @@ module Aws::TranscribeService
2475
2488
  # @option params [String] :data_access_role_arn
2476
2489
  # The Amazon Resource Name (ARN) of an IAM role that has permissions to
2477
2490
  # access the Amazon S3 bucket that contains your input files. If the
2478
- # role you specify doesn’t have the appropriate permissions to access
2479
- # the specified Amazon S3 location, your request fails.
2491
+ # role that you specify doesn’t have the appropriate permissions to
2492
+ # access the specified Amazon S3 location, your request fails.
2480
2493
  #
2481
2494
  # IAM role ARNs have the format
2482
2495
  # `arn:partition:iam::account:role/role-name-with-path`. For example:
@@ -2495,9 +2508,9 @@ module Aws::TranscribeService
2495
2508
  # job.
2496
2509
  #
2497
2510
  # @option params [Array<Types::ChannelDefinition>] :channel_definitions
2498
- # Allows you to specify which speaker is on which channel. For example,
2499
- # if your agent is the first participant to speak, you would set
2500
- # `ChannelId` to `0` (to indicate the first channel) and
2511
+ # Makes it possible to specify which speaker is on which channel. For
2512
+ # example, if your agent is the first participant to speak, you would
2513
+ # set `ChannelId` to `0` (to indicate the first channel) and
2501
2514
  # `ParticipantRole` to `AGENT` (to indicate that it's the agent
2502
2515
  # speaking).
2503
2516
  #
@@ -2591,11 +2604,11 @@ module Aws::TranscribeService
2591
2604
  # applies any additional Request Parameters you choose to include in
2592
2605
  # your request.
2593
2606
  #
2594
- # In addition to many of the standard transcription features, Amazon
2595
- # Transcribe Medical provides you with a robust medical vocabulary and,
2596
- # optionally, content identification, which adds flags to personal
2597
- # health information (PHI). To learn more about these features, refer to
2598
- # [How Amazon Transcribe Medical works][1].
2607
+ # In addition to many standard transcription features, Amazon Transcribe
2608
+ # Medical provides you with a robust medical vocabulary and, optionally,
2609
+ # content identification, which adds flags to personal health
2610
+ # information (PHI). To learn more about these features, refer to [How
2611
+ # Amazon Transcribe Medical works][1].
2599
2612
  #
2600
2613
  # To make a `StartMedicalTranscriptionJob` request, you must first
2601
2614
  # upload your media file into an Amazon S3 bucket; you can then specify
@@ -2632,7 +2645,7 @@ module Aws::TranscribeService
2632
2645
  #
2633
2646
  # @option params [required, String] :medical_transcription_job_name
2634
2647
  # A unique name, chosen by you, for your medical transcription job. The
2635
- # name you specify is also used as the default name of your
2648
+ # name that you specify is also used as the default name of your
2636
2649
  # transcription output file. If you want to specify a different name for
2637
2650
  # your transcription output, use the `OutputKey` parameter.
2638
2651
  #
@@ -2648,15 +2661,16 @@ module Aws::TranscribeService
2648
2661
  # results in a `BadRequestException` error.
2649
2662
  #
2650
2663
  # @option params [Integer] :media_sample_rate_hertz
2651
- # The sample rate, in Hertz, of the audio track in your input media
2664
+ # The sample rate, in hertz, of the audio track in your input media
2652
2665
  # file.
2653
2666
  #
2654
2667
  # If you don't specify the media sample rate, Amazon Transcribe Medical
2655
2668
  # determines it for you. If you specify the sample rate, it must match
2656
2669
  # the rate detected by Amazon Transcribe Medical; if there's a mismatch
2657
- # between the value you specify and the value detected, your job fails.
2658
- # Therefore, in most cases, it's advised to omit `MediaSampleRateHertz`
2659
- # and let Amazon Transcribe Medical determine the sample rate.
2670
+ # between the value that you specify and the value detected, your job
2671
+ # fails. Therefore, in most cases, it's advised to omit
2672
+ # `MediaSampleRateHertz` and let Amazon Transcribe Medical determine the
2673
+ # sample rate.
2660
2674
  #
2661
2675
  # @option params [String] :media_format
2662
2676
  # Specify the format of your input media file.
@@ -2665,6 +2679,15 @@ module Aws::TranscribeService
2665
2679
  # Describes the Amazon S3 location of the media file you want to use in
2666
2680
  # your request.
2667
2681
  #
2682
+ # For information on supported media formats, refer to the
2683
+ # [MediaFormat][1] parameter or the [Media formats][2] section in the
2684
+ # Amazon S3 Developer Guide.
2685
+ #
2686
+ #
2687
+ #
2688
+ # [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
2689
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
2690
+ #
2668
2691
  # @option params [required, String] :output_bucket_name
2669
2692
  # The name of the Amazon S3 bucket where you want your medical
2670
2693
  # transcription output stored. Do not include the `S3://` prefix of the
@@ -2685,10 +2708,6 @@ module Aws::TranscribeService
2685
2708
  # Services Management Console][1]. See also [Permissions Required for
2686
2709
  # IAM User Roles][2].
2687
2710
  #
2688
- # If you don't specify `OutputBucketName`, your transcript is placed in
2689
- # a service-managed Amazon S3 bucket and you are provided with a URI to
2690
- # access your transcript.
2691
- #
2692
2711
  #
2693
2712
  #
2694
2713
  # [1]: https://console.aws.amazon.com/s3
@@ -2780,7 +2799,7 @@ module Aws::TranscribeService
2780
2799
  # @option params [Types::MedicalTranscriptionSetting] :settings
2781
2800
  # Specify additional optional settings in your request, including
2782
2801
  # channel identification, alternative transcriptions, and speaker
2783
- # labeling; allows you to apply custom vocabularies to your
2802
+ # partitioning. You can use that to apply custom vocabularies to your
2784
2803
  # transcription job.
2785
2804
  #
2786
2805
  # @option params [String] :content_identification_type
@@ -2929,10 +2948,10 @@ module Aws::TranscribeService
2929
2948
  # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2930
2949
  #
2931
2950
  # @option params [required, String] :transcription_job_name
2932
- # A unique name, chosen by you, for your transcription job. The name you
2933
- # specify is also used as the default name of your transcription output
2934
- # file. If you want to specify a different name for your transcription
2935
- # output, use the `OutputKey` parameter.
2951
+ # A unique name, chosen by you, for your transcription job. The name
2952
+ # that you specify is also used as the default name of your
2953
+ # transcription output file. If you want to specify a different name for
2954
+ # your transcription output, use the `OutputKey` parameter.
2936
2955
  #
2937
2956
  # This name is case sensitive, cannot contain spaces, and must be unique
2938
2957
  # within an Amazon Web Services account. If you try to create a new job
@@ -2964,15 +2983,15 @@ module Aws::TranscribeService
2964
2983
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2965
2984
  #
2966
2985
  # @option params [Integer] :media_sample_rate_hertz
2967
- # The sample rate, in Hertz, of the audio track in your input media
2986
+ # The sample rate, in hertz, of the audio track in your input media
2968
2987
  # file.
2969
2988
  #
2970
2989
  # If you don't specify the media sample rate, Amazon Transcribe
2971
2990
  # determines it for you. If you specify the sample rate, it must match
2972
- # the rate detected by Amazon Transcribe; if there's a mismatch between
2973
- # the value you specify and the value detected, your job fails.
2974
- # Therefore, in most cases, it's advised to omit `MediaSampleRateHertz`
2975
- # and let Amazon Transcribe determine the sample rate.
2991
+ # the rate detected by Amazon Transcribe. If there's a mismatch between
2992
+ # the value that you specify and the value detected, your job fails. In
2993
+ # most cases, you can omit `MediaSampleRateHertz` and let Amazon
2994
+ # Transcribe determine the sample rate.
2976
2995
  #
2977
2996
  # @option params [String] :media_format
2978
2997
  # Specify the format of your input media file.
@@ -3094,8 +3113,9 @@ module Aws::TranscribeService
3094
3113
  #
3095
3114
  # @option params [Types::Settings] :settings
3096
3115
  # Specify additional optional settings in your request, including
3097
- # channel identification, alternative transcriptions, speaker labeling;
3098
- # allows you to apply custom vocabularies and vocabulary filters.
3116
+ # channel identification, alternative transcriptions, speaker
3117
+ # partitioning. You can use that to apply custom vocabularies and
3118
+ # vocabulary filters.
3099
3119
  #
3100
3120
  # If you want to include a custom vocabulary or a custom vocabulary
3101
3121
  # filter (or both) with your request but **do not** want to use
@@ -3121,7 +3141,7 @@ module Aws::TranscribeService
3121
3141
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
3122
3142
  #
3123
3143
  # @option params [Types::JobExecutionSettings] :job_execution_settings
3124
- # Allows you to control how your transcription job is processed.
3144
+ # Makes it possible to control how your transcription job is processed.
3125
3145
  # Currently, the only `JobExecutionSettings` modification you can choose
3126
3146
  # is enabling job queueing using the `AllowDeferredExecution`
3127
3147
  # sub-parameter.
@@ -3131,24 +3151,28 @@ module Aws::TranscribeService
3131
3151
  # `DataAccessRoleArn`.
3132
3152
  #
3133
3153
  # @option params [Types::ContentRedaction] :content_redaction
3134
- # Allows you to redact or flag specified personally identifiable
3154
+ # Makes it possible to redact or flag specified personally identifiable
3135
3155
  # information (PII) in your transcript. If you use `ContentRedaction`,
3136
3156
  # you must also include the sub-parameters: `PiiEntityTypes`,
3137
3157
  # `RedactionOutput`, and `RedactionType`.
3138
3158
  #
3139
3159
  # @option params [Boolean] :identify_language
3140
3160
  # Enables automatic language identification in your transcription job
3141
- # request.
3161
+ # request. Use this parameter if your media file contains only one
3162
+ # language. If your media contains multiple languages, use
3163
+ # `IdentifyMultipleLanguages` instead.
3142
3164
  #
3143
3165
  # If you include `IdentifyLanguage`, you can optionally include a list
3144
3166
  # of language codes, using `LanguageOptions`, that you think may be
3145
- # present in your media file. Including language options can improve
3146
- # transcription accuracy.
3167
+ # present in your media file. Including `LanguageOptions` restricts
3168
+ # `IdentifyLanguage` to only the language options that you specify,
3169
+ # which can improve transcription accuracy.
3147
3170
  #
3148
3171
  # If you want to apply a custom language model, a custom vocabulary, or
3149
3172
  # a custom vocabulary filter to your automatic language identification
3150
3173
  # request, include `LanguageIdSettings` with the relevant sub-parameters
3151
3174
  # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
3175
+ # If you include `LanguageIdSettings`, also include `LanguageOptions`.
3152
3176
  #
3153
3177
  # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
3154
3178
  # or `IdentifyMultipleLanguages` in your request. If you include more
@@ -3157,17 +3181,20 @@ module Aws::TranscribeService
3157
3181
  # @option params [Boolean] :identify_multiple_languages
3158
3182
  # Enables automatic multi-language identification in your transcription
3159
3183
  # job request. Use this parameter if your media file contains more than
3160
- # one language.
3184
+ # one language. If your media contains only one language, use
3185
+ # `IdentifyLanguage` instead.
3161
3186
  #
3162
3187
  # If you include `IdentifyMultipleLanguages`, you can optionally include
3163
3188
  # a list of language codes, using `LanguageOptions`, that you think may
3164
- # be present in your media file. Including language options can improve
3165
- # transcription accuracy.
3189
+ # be present in your media file. Including `LanguageOptions` restricts
3190
+ # `IdentifyLanguage` to only the language options that you specify,
3191
+ # which can improve transcription accuracy.
3166
3192
  #
3167
3193
  # If you want to apply a custom vocabulary or a custom vocabulary filter
3168
3194
  # to your automatic language identification request, include
3169
3195
  # `LanguageIdSettings` with the relevant sub-parameters
3170
- # (`VocabularyName` and `VocabularyFilterName`).
3196
+ # (`VocabularyName` and `VocabularyFilterName`). If you include
3197
+ # `LanguageIdSettings`, also include `LanguageOptions`.
3171
3198
  #
3172
3199
  # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
3173
3200
  # or `IdentifyMultipleLanguages` in your request. If you include more
@@ -3175,7 +3202,7 @@ module Aws::TranscribeService
3175
3202
  #
3176
3203
  # @option params [Array<String>] :language_options
3177
3204
  # You can specify two or more language codes that represent the
3178
- # languages you think may be present in your media; including more than
3205
+ # languages you think may be present in your media. Including more than
3179
3206
  # five is not recommended. If you're unsure what languages are present,
3180
3207
  # do not include this parameter.
3181
3208
  #
@@ -3207,31 +3234,34 @@ module Aws::TranscribeService
3207
3234
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
3208
3235
  #
3209
3236
  # @option params [Hash<String,Types::LanguageIdSettings>] :language_id_settings
3210
- # If using automatic language identification (`IdentifyLanguage`) in
3211
- # your request and you want to apply a custom language model, a custom
3212
- # vocabulary, or a custom vocabulary filter, include
3213
- # `LanguageIdSettings` with the relevant sub-parameters
3214
- # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
3215
- #
3216
- # You can specify two or more language codes that represent the
3217
- # languages you think may be present in your media; including more than
3218
- # five is not recommended. Each language code you include can have an
3219
- # associated custom language model, custom vocabulary, and custom
3220
- # vocabulary filter. The languages you specify must match the languages
3221
- # of the specified custom language models, custom vocabularies, and
3222
- # custom vocabulary filters.
3223
- #
3224
- # To include language options using `IdentifyLanguage` **without**
3225
- # including a custom language model, a custom vocabulary, or a custom
3226
- # vocabulary filter, use `LanguageOptions` instead of
3227
- # `LanguageIdSettings`. Including language options can improve the
3228
- # accuracy of automatic language identification.
3237
+ # If using automatic language identification in your request and you
3238
+ # want to apply a custom language model, a custom vocabulary, or a
3239
+ # custom vocabulary filter, include `LanguageIdSettings` with the
3240
+ # relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
3241
+ # `VocabularyFilterName`). Note that multi-language identification
3242
+ # (`IdentifyMultipleLanguages`) doesn't support custom language models.
3243
+ #
3244
+ # `LanguageIdSettings` supports two to five language codes. Each
3245
+ # language code you include can have an associated custom language
3246
+ # model, custom vocabulary, and custom vocabulary filter. The language
3247
+ # codes that you specify must match the languages of the associated
3248
+ # custom language models, custom vocabularies, and custom vocabulary
3249
+ # filters.
3250
+ #
3251
+ # It's recommended that you include `LanguageOptions` when using
3252
+ # `LanguageIdSettings` to ensure that the correct language dialect is
3253
+ # identified. For example, if you specify a custom vocabulary that is in
3254
+ # `en-US` but Amazon Transcribe determines that the language spoken in
3255
+ # your media is `en-AU`, your custom vocabulary *is not* applied to your
3256
+ # transcription. If you include `LanguageOptions` and include `en-US` as
3257
+ # the only English language dialect, your custom vocabulary *is* applied
3258
+ # to your transcription.
3229
3259
  #
3230
3260
  # If you want to include a custom language model with your request but
3231
3261
  # **do not** want to use automatic language identification, use instead
3232
- # the ` parameter with the LanguageModelName sub-parameter.</p> If you
3233
- # want to include a custom vocabulary or a custom vocabulary filter (or
3234
- # both) with your request but do not want to use automatic language
3262
+ # the ` parameter with the LanguageModelName sub-parameter. If you want
3263
+ # to include a custom vocabulary or a custom vocabulary filter (or both)
3264
+ # with your request but do not want to use automatic language
3235
3265
  # identification, use instead the parameter with the VocabularyName or
3236
3266
  # VocabularyFilterName (or both) sub-parameter.</p>
3237
3267
  # `
@@ -3377,7 +3407,7 @@ module Aws::TranscribeService
3377
3407
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
3378
3408
  #
3379
3409
  # For example,
3380
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
3410
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
3381
3411
  #
3382
3412
  # Valid values for `resource-type` are: `transcription-job`,
3383
3413
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -3429,7 +3459,7 @@ module Aws::TranscribeService
3429
3459
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
3430
3460
  #
3431
3461
  # For example,
3432
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
3462
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
3433
3463
  #
3434
3464
  # Valid values for `resource-type` are: `transcription-job`,
3435
3465
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -3473,6 +3503,13 @@ module Aws::TranscribeService
3473
3503
  # provide in this field replace the ones that are currently being used
3474
3504
  # in the specified category.
3475
3505
  #
3506
+ # @option params [String] :input_type
3507
+ # Choose whether you want to update a streaming or a batch Call
3508
+ # Analytics category. The input type you specify must match the input
3509
+ # type specified when the category was created. For example, if you
3510
+ # created a category with the `POST_CALL` input type, you must use
3511
+ # `POST_CALL` as the input type when updating this category.
3512
+ #
3476
3513
  # @return [Types::UpdateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3477
3514
  #
3478
3515
  # * {Types::UpdateCallAnalyticsCategoryResponse#category_properties #category_properties} => Types::CategoryProperties
@@ -3553,6 +3590,7 @@ module Aws::TranscribeService
3553
3590
  # },
3554
3591
  # },
3555
3592
  # ],
3593
+ # input_type: "REAL_TIME", # accepts REAL_TIME, POST_CALL
3556
3594
  # })
3557
3595
  #
3558
3596
  # @example Response structure
@@ -3607,6 +3645,7 @@ module Aws::TranscribeService
3607
3645
  # resp.category_properties.rules[0].sentiment_filter.negate #=> Boolean
3608
3646
  # resp.category_properties.create_time #=> Time
3609
3647
  # resp.category_properties.last_update_time #=> Time
3648
+ # resp.category_properties.input_type #=> String, one of "REAL_TIME", "POST_CALL"
3610
3649
  #
3611
3650
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategory AWS API Documentation
3612
3651
  #
@@ -3619,11 +3658,11 @@ module Aws::TranscribeService
3619
3658
 
3620
3659
  # Updates an existing custom medical vocabulary with new values. This
3621
3660
  # operation overwrites all existing information with your new values;
3622
- # you cannot append new terms onto an existing vocabulary.
3661
+ # you cannot append new terms onto an existing custom vocabulary.
3623
3662
  #
3624
3663
  # @option params [required, String] :vocabulary_name
3625
- # The name of the custom medical vocabulary you want to update.
3626
- # Vocabulary names are case sensitive.
3664
+ # The name of the custom medical vocabulary you want to update. Custom
3665
+ # medical vocabulary names are case sensitive.
3627
3666
  #
3628
3667
  # @option params [required, String] :language_code
3629
3668
  # The language code that represents the language of the entries in the
@@ -3671,21 +3710,21 @@ module Aws::TranscribeService
3671
3710
 
3672
3711
  # Updates an existing custom vocabulary with new values. This operation
3673
3712
  # overwrites all existing information with your new values; you cannot
3674
- # append new terms onto an existing vocabulary.
3713
+ # append new terms onto an existing custom vocabulary.
3675
3714
  #
3676
3715
  # @option params [required, String] :vocabulary_name
3677
- # The name of the custom vocabulary you want to update. Vocabulary names
3678
- # are case sensitive.
3716
+ # The name of the custom vocabulary you want to update. Custom
3717
+ # vocabulary names are case sensitive.
3679
3718
  #
3680
3719
  # @option params [required, String] :language_code
3681
3720
  # The language code that represents the language of the entries in the
3682
- # custom vocabulary you want to update. Each vocabulary must contain
3683
- # terms in only one language.
3721
+ # custom vocabulary you want to update. Each custom vocabulary must
3722
+ # contain terms in only one language.
3684
3723
  #
3685
3724
  # A custom vocabulary can only be used to transcribe files in the same
3686
- # language as the vocabulary. For example, if you create a vocabulary
3687
- # using US English (`en-US`), you can only apply this vocabulary to
3688
- # files that contain English audio.
3725
+ # language as the custom vocabulary. For example, if you create a custom
3726
+ # vocabulary using US English (`en-US`), you can only apply this custom
3727
+ # vocabulary to files that contain English audio.
3689
3728
  #
3690
3729
  # For a list of supported languages and their associated language codes,
3691
3730
  # refer to the [Supported languages][1] table.
@@ -3695,19 +3734,20 @@ module Aws::TranscribeService
3695
3734
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
3696
3735
  #
3697
3736
  # @option params [Array<String>] :phrases
3698
- # Use this parameter if you want to update your vocabulary by including
3699
- # all desired terms, as comma-separated values, within your request. The
3700
- # other option for updating your vocabulary is to save your entries in a
3701
- # text file and upload them to an Amazon S3 bucket, then specify the
3702
- # location of your file using the `VocabularyFileUri` parameter.
3737
+ # Use this parameter if you want to update your custom vocabulary by
3738
+ # including all desired terms, as comma-separated values, within your
3739
+ # request. The other option for updating your custom vocabulary is to
3740
+ # save your entries in a text file and upload them to an Amazon S3
3741
+ # bucket, then specify the location of your file using the
3742
+ # `VocabularyFileUri` parameter.
3703
3743
  #
3704
3744
  # Note that if you include `Phrases` in your request, you cannot use
3705
3745
  # `VocabularyFileUri`; you must choose one or the other.
3706
3746
  #
3707
3747
  # Each language has a character set that contains all allowed characters
3708
3748
  # for that specific language. If you use unsupported characters, your
3709
- # vocabulary filter request fails. Refer to [Character Sets for Custom
3710
- # Vocabularies][1] to get the character set for your language.
3749
+ # custom vocabulary filter request fails. Refer to [Character Sets for
3750
+ # Custom Vocabularies][1] to get the character set for your language.
3711
3751
  #
3712
3752
  #
3713
3753
  #
@@ -3758,15 +3798,15 @@ module Aws::TranscribeService
3758
3798
 
3759
3799
  # Updates an existing custom vocabulary filter with a new list of words.
3760
3800
  # The new list you provide overwrites all previous entries; you cannot
3761
- # append new terms onto an existing vocabulary filter.
3801
+ # append new terms onto an existing custom vocabulary filter.
3762
3802
  #
3763
3803
  # @option params [required, String] :vocabulary_filter_name
3764
- # The name of the custom vocabulary filter you want to update.
3765
- # Vocabulary filter names are case sensitive.
3804
+ # The name of the custom vocabulary filter you want to update. Custom
3805
+ # vocabulary filter names are case sensitive.
3766
3806
  #
3767
3807
  # @option params [Array<String>] :words
3768
- # Use this parameter if you want to update your vocabulary filter by
3769
- # including all desired terms, as comma-separated values, within your
3808
+ # Use this parameter if you want to update your custom vocabulary filter
3809
+ # by including all desired terms, as comma-separated values, within your
3770
3810
  # request. The other option for updating your vocabulary filter is to
3771
3811
  # save your entries in a text file and upload them to an Amazon S3
3772
3812
  # bucket, then specify the location of your file using the
@@ -3777,8 +3817,8 @@ module Aws::TranscribeService
3777
3817
  #
3778
3818
  # Each language has a character set that contains all allowed characters
3779
3819
  # for that specific language. If you use unsupported characters, your
3780
- # vocabulary filter request fails. Refer to [Character Sets for Custom
3781
- # Vocabularies][1] to get the character set for your language.
3820
+ # custom vocabulary filter request fails. Refer to [Character Sets for
3821
+ # Custom Vocabularies][1] to get the character set for your language.
3782
3822
  #
3783
3823
  #
3784
3824
  #
@@ -3837,7 +3877,7 @@ module Aws::TranscribeService
3837
3877
  params: params,
3838
3878
  config: config)
3839
3879
  context[:gem_name] = 'aws-sdk-transcribeservice'
3840
- context[:gem_version] = '1.77.0'
3880
+ context[:gem_version] = '1.78.0'
3841
3881
  Seahorse::Client::Request.new(handlers, context)
3842
3882
  end
3843
3883