aws-sdk-transcribeservice 1.71.0 → 1.74.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transcribeservice/client.rb +213 -154
- data/lib/aws-sdk-transcribeservice/client_api.rb +6 -2
- data/lib/aws-sdk-transcribeservice/types.rb +222 -164
- data/lib/aws-sdk-transcribeservice.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
@@ -75,6 +76,7 @@ module Aws::TranscribeService
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
@@ -359,22 +361,27 @@ module Aws::TranscribeService
|
|
359
361
|
|
360
362
|
# @!group API Operations
|
361
363
|
|
362
|
-
# Creates
|
363
|
-
# conditions specified by your analytics categories to your call
|
364
|
-
# analytics jobs. For each analytics category, you
|
365
|
-
# rules. For example, you can
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
364
|
+
# Creates a call analytics category. Amazon Transcribe applies the
|
365
|
+
# conditions specified by your call analytics categories to your call
|
366
|
+
# analytics jobs. For each analytics category, you must create between 1
|
367
|
+
# and 20 rules. For example, you can create a 'greeting' category with
|
368
|
+
# a rule that flags calls in which your agent does not use a specified
|
369
|
+
# phrase (for example: "Please note this call may be recorded.") in
|
370
|
+
# the first 15 seconds of the call. When you start a call analytics job,
|
371
|
+
# Amazon Transcribe applies all your existing call analytics categories
|
372
|
+
# to that job.
|
369
373
|
#
|
370
374
|
# @option params [required, String] :category_name
|
371
|
-
#
|
375
|
+
# A unique name, chosen by you, for your call analytics category. For
|
376
|
+
# example, `sentiment-positive-last30seconds`.
|
372
377
|
#
|
373
378
|
# @option params [required, Array<Types::Rule>] :rules
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
379
|
+
# Rules make up a call analytics category. When creating a call
|
380
|
+
# analytics category, you must create between 1 and 20 rules for your
|
381
|
+
# category. For each rule, you specify a filter you want applied to the
|
382
|
+
# attributes of a call. For example, you can choose a sentiment filter
|
383
|
+
# that detects if a customer's sentiment was positive during the last
|
384
|
+
# 30 seconds of the call.
|
378
385
|
#
|
379
386
|
# @return [Types::CreateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
380
387
|
#
|
@@ -520,34 +527,43 @@ module Aws::TranscribeService
|
|
520
527
|
req.send_request(options)
|
521
528
|
end
|
522
529
|
|
523
|
-
# Creates a new custom language model.
|
524
|
-
#
|
525
|
-
#
|
530
|
+
# Creates a new custom language model. When creating a new language
|
531
|
+
# model, you must specify if you want a Wideband (audio sample rates
|
532
|
+
# over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz)
|
533
|
+
# base model. You then include the S3 URI location of your training and
|
534
|
+
# tuning files, the language for the model, a unique name, and any tags
|
535
|
+
# you want associated with your model.
|
526
536
|
#
|
527
537
|
# @option params [required, String] :language_code
|
528
|
-
# The language of
|
529
|
-
# language
|
538
|
+
# The language of your custom language model; note that the language
|
539
|
+
# code you select must match the language of your training and tuning
|
540
|
+
# data.
|
530
541
|
#
|
531
542
|
# @option params [required, String] :base_model_name
|
532
|
-
# The Amazon Transcribe standard language model, or base model used to
|
533
|
-
# create your custom language model.
|
543
|
+
# The Amazon Transcribe standard language model, or base model, used to
|
544
|
+
# create your custom language model. Amazon Transcribe offers two
|
545
|
+
# options for base models: Wideband and Narrowband.
|
534
546
|
#
|
535
|
-
# If you want to
|
536
|
-
#
|
537
|
-
#
|
538
|
-
# If you want to use your custom language model to transcribe audio with
|
539
|
-
# a sample rate that is less than 16,000 Hz, choose `Narrowband`.
|
547
|
+
# If the audio you want to transcribe has a sample rate of 16,000 Hz or
|
548
|
+
# greater, choose `WideBand`. To transcribe audio with a sample rate
|
549
|
+
# less than 16,000 Hz, choose `NarrowBand`.
|
540
550
|
#
|
541
551
|
# @option params [required, String] :model_name
|
542
|
-
# The name
|
552
|
+
# The name of your new custom language model.
|
553
|
+
#
|
554
|
+
# This name is case sensitive, cannot contain spaces, and must be unique
|
555
|
+
# within an Amazon Web Services account. If you try to create a language
|
556
|
+
# model with the same name as a previous language model, you get a
|
557
|
+
# `ConflictException` error.
|
543
558
|
#
|
544
559
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
545
|
-
# Contains
|
546
|
-
#
|
560
|
+
# Contains your data access role ARN (Amazon Resource Name) and the
|
561
|
+
# Amazon S3 locations of your training (`S3Uri`) and tuning
|
562
|
+
# (`TuningDataS3Uri`) data.
|
547
563
|
#
|
548
564
|
# @option params [Array<Types::Tag>] :tags
|
549
|
-
#
|
550
|
-
# language model
|
565
|
+
# Optionally add tags, each in the form of a key:value pair, to your new
|
566
|
+
# language model. See also: .
|
551
567
|
#
|
552
568
|
# @return [Types::CreateLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
553
569
|
#
|
@@ -595,48 +611,53 @@ module Aws::TranscribeService
|
|
595
611
|
req.send_request(options)
|
596
612
|
end
|
597
613
|
|
598
|
-
# Creates a new custom vocabulary
|
599
|
-
#
|
614
|
+
# Creates a new custom medical vocabulary.
|
615
|
+
#
|
616
|
+
# When creating a new medical vocabulary, you must upload a text file
|
617
|
+
# that contains your new entries, phrases, and terms into an S3 bucket.
|
618
|
+
# Note that this differs from , where you can include a list of terms
|
619
|
+
# within your request using the `Phrases` flag, as
|
620
|
+
# `CreateMedicalVocabulary` does not support the `Phrases` flag.
|
621
|
+
#
|
622
|
+
# For more information on creating a custom vocabulary text file, see
|
623
|
+
# [Creating a custom vocabulary][1].
|
624
|
+
#
|
625
|
+
#
|
626
|
+
#
|
627
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
|
600
628
|
#
|
601
629
|
# @option params [required, String] :vocabulary_name
|
602
|
-
# The name of
|
603
|
-
#
|
630
|
+
# The name of your new vocabulary.
|
631
|
+
#
|
632
|
+
# This name is case sensitive, cannot contain spaces, and must be unique
|
633
|
+
# within an Amazon Web Services account. If you try to create a
|
604
634
|
# vocabulary with the same name as a previous vocabulary, you get a
|
605
635
|
# `ConflictException` error.
|
606
636
|
#
|
607
637
|
# @option params [required, String] :language_code
|
608
|
-
# The language code
|
609
|
-
# vocabulary.
|
610
|
-
# language
|
611
|
-
# only language code available for Amazon Transcribe Medical.
|
638
|
+
# The language code that represents the language of the entries in your
|
639
|
+
# custom vocabulary. Note that U.S. English (`en-US`) is the only
|
640
|
+
# language supported with Amazon Transcribe Medical.
|
612
641
|
#
|
613
642
|
# @option params [required, String] :vocabulary_file_uri
|
614
|
-
# The
|
643
|
+
# The Amazon S3 location (URI) of the text file that contains your
|
615
644
|
# custom vocabulary. The URI must be in the same Amazon Web Services
|
616
|
-
# Region as the resource that you're calling.
|
617
|
-
# your `VocabularyFileUri` in the following format:
|
618
|
-
#
|
619
|
-
# `https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>`
|
620
|
-
#
|
621
|
-
# The following is an example URI for a vocabulary file that is stored
|
622
|
-
# in Amazon S3:
|
645
|
+
# Region as the resource that you're calling.
|
623
646
|
#
|
624
|
-
#
|
647
|
+
# Here's an example URI path:
|
625
648
|
#
|
626
|
-
#
|
627
|
-
# Keys][1] in the *Amazon S3 Developer Guide*.
|
649
|
+
# `https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt`
|
628
650
|
#
|
629
|
-
#
|
630
|
-
#
|
651
|
+
# @option params [Array<Types::Tag>] :tags
|
652
|
+
# Adds one or more tags, each in the form of a key:value pair, to a new
|
653
|
+
# medical vocabulary at the time you create the new vocabulary.
|
631
654
|
#
|
655
|
+
# To learn more about using tags with Amazon Transcribe, refer to
|
656
|
+
# [Tagging resources][1].
|
632
657
|
#
|
633
658
|
#
|
634
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
|
635
|
-
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html
|
636
659
|
#
|
637
|
-
#
|
638
|
-
# Adds one or more tags, each in the form of a key:value pair, to a new
|
639
|
-
# medical vocabulary at the time you create this new vocabulary.
|
660
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
|
640
661
|
#
|
641
662
|
# @return [Types::CreateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
642
663
|
#
|
@@ -677,50 +698,59 @@ module Aws::TranscribeService
|
|
677
698
|
req.send_request(options)
|
678
699
|
end
|
679
700
|
|
680
|
-
# Creates a new custom vocabulary
|
681
|
-
#
|
701
|
+
# Creates a new custom vocabulary.
|
702
|
+
#
|
703
|
+
# When creating a new medical vocabulary, you can either upload a text
|
704
|
+
# file that contains your new entries, phrases, and terms into an S3
|
705
|
+
# bucket or include a list of terms directly in your request using the
|
706
|
+
# `Phrases` flag.
|
707
|
+
#
|
708
|
+
# For more information on creating a custom vocabulary, see [Creating a
|
709
|
+
# custom vocabulary][1].
|
710
|
+
#
|
711
|
+
#
|
712
|
+
#
|
713
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
|
682
714
|
#
|
683
715
|
# @option params [required, String] :vocabulary_name
|
684
|
-
# The name of
|
685
|
-
# Web Services account. The name is case sensitive. If you try to create
|
686
|
-
# a vocabulary with the same name as a previous vocabulary you will
|
687
|
-
# receive a `ConflictException` error.
|
716
|
+
# The name of your new vocabulary.
|
688
717
|
#
|
689
|
-
#
|
690
|
-
#
|
691
|
-
#
|
718
|
+
# This name is case sensitive, cannot contain spaces, and must be unique
|
719
|
+
# within an Amazon Web Services account. If you try to create a
|
720
|
+
# vocabulary with the same name as a previous vocabulary, you get a
|
721
|
+
# `ConflictException` error.
|
692
722
|
#
|
693
|
-
# @option params [
|
694
|
-
#
|
723
|
+
# @option params [required, String] :language_code
|
724
|
+
# The language code that represents the language of the entries in your
|
725
|
+
# custom vocabulary. Each vocabulary must contain terms in only one
|
726
|
+
# language. For a list of languages and their corresponding language
|
727
|
+
# codes, see [Supported languages][1].
|
695
728
|
#
|
696
|
-
# @option params [String] :vocabulary_file_uri
|
697
|
-
# The S3 location of the text file that contains the definition of the
|
698
|
-
# custom vocabulary. The URI must be in the same region as the API
|
699
|
-
# endpoint that you are calling. The general form is:
|
700
729
|
#
|
701
|
-
# `https://s3.<Amazon Web
|
702
|
-
# Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
|
703
|
-
# `
|
704
730
|
#
|
705
|
-
#
|
731
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
|
706
732
|
#
|
707
|
-
#
|
733
|
+
# @option params [Array<String>] :phrases
|
734
|
+
# Use this flag to include a list of terms within your request.
|
708
735
|
#
|
709
|
-
#
|
710
|
-
#
|
736
|
+
# Note that if you include `Phrases` in your request, you cannot use
|
737
|
+
# `VocabularyFileUri`; you must choose one or the other.
|
711
738
|
#
|
712
|
-
#
|
713
|
-
#
|
739
|
+
# @option params [String] :vocabulary_file_uri
|
740
|
+
# The S3 location of the text file that contains your custom vocabulary.
|
741
|
+
# The URI must be located in the same region as the API endpoint you're
|
742
|
+
# calling.
|
714
743
|
#
|
744
|
+
# Here's an example URI path:
|
715
745
|
#
|
746
|
+
# `https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt`
|
716
747
|
#
|
717
|
-
#
|
718
|
-
#
|
748
|
+
# Note that if you include `VocabularyFileUri` in your request, you
|
749
|
+
# cannot use the `Phrases` flag; you must choose one or the other.
|
719
750
|
#
|
720
751
|
# @option params [Array<Types::Tag>] :tags
|
721
752
|
# Adds one or more tags, each in the form of a key:value pair, to a new
|
722
|
-
#
|
723
|
-
# vocabulary.
|
753
|
+
# custom vocabulary at the time you create this new vocabulary.
|
724
754
|
#
|
725
755
|
# @return [Types::CreateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
726
756
|
#
|
@@ -762,14 +792,17 @@ module Aws::TranscribeService
|
|
762
792
|
req.send_request(options)
|
763
793
|
end
|
764
794
|
|
765
|
-
# Creates a new vocabulary filter that you can use to filter words
|
766
|
-
#
|
795
|
+
# Creates a new vocabulary filter that you can use to filter words from
|
796
|
+
# your transcription output. For example, you can use this operation to
|
797
|
+
# remove profanity from your transcript.
|
767
798
|
#
|
768
799
|
# @option params [required, String] :vocabulary_filter_name
|
769
|
-
# The
|
770
|
-
#
|
771
|
-
#
|
772
|
-
#
|
800
|
+
# The name of your new vocabulary filter.
|
801
|
+
#
|
802
|
+
# This name is case sensitive, cannot contain spaces, and must be unique
|
803
|
+
# within an Amazon Web Services account. If you try to create a
|
804
|
+
# vocabulary filter with the same name as a previous vocabulary filter,
|
805
|
+
# you get a `ConflictException` error.
|
773
806
|
#
|
774
807
|
# @option params [required, String] :language_code
|
775
808
|
# The language code of the words in the vocabulary filter. All words in
|
@@ -777,12 +810,12 @@ module Aws::TranscribeService
|
|
777
810
|
# only be used with transcription jobs in the specified language.
|
778
811
|
#
|
779
812
|
# @option params [Array<String>] :words
|
780
|
-
# The words
|
781
|
-
# the
|
782
|
-
#
|
813
|
+
# The words you want in your vocabulary filter. Only use characters
|
814
|
+
# specified in the [Character sets][1] for the language you're
|
815
|
+
# transcribing.
|
783
816
|
#
|
784
|
-
#
|
785
|
-
#
|
817
|
+
# Note that if you include `Words` in your request, you cannot use
|
818
|
+
# `VocabularyFilterFileUri`; you must choose one or the other.
|
786
819
|
#
|
787
820
|
#
|
788
821
|
#
|
@@ -794,11 +827,10 @@ module Aws::TranscribeService
|
|
794
827
|
# for custom vocabularies. For a list of character sets, see [Character
|
795
828
|
# Sets for Custom Vocabularies][1].
|
796
829
|
#
|
797
|
-
#
|
830
|
+
# Your vocabulary filter file must be less than 50 KB in size.
|
798
831
|
#
|
799
|
-
#
|
800
|
-
# `
|
801
|
-
# parameter.
|
832
|
+
# Note that if you include `VocabularyFilterFileUri` in your request,
|
833
|
+
# you cannot use `Words`; you must choose one or the other.
|
802
834
|
#
|
803
835
|
#
|
804
836
|
#
|
@@ -806,8 +838,7 @@ module Aws::TranscribeService
|
|
806
838
|
#
|
807
839
|
# @option params [Array<Types::Tag>] :tags
|
808
840
|
# Adds one or more tags, each in the form of a key:value pair, to a new
|
809
|
-
#
|
810
|
-
# vocabulary filter.
|
841
|
+
# vocabulary filter at the time you create this new vocabulary filter.
|
811
842
|
#
|
812
843
|
# @return [Types::CreateVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
813
844
|
#
|
@@ -845,11 +876,12 @@ module Aws::TranscribeService
|
|
845
876
|
req.send_request(options)
|
846
877
|
end
|
847
878
|
|
848
|
-
# Deletes a call analytics category
|
879
|
+
# Deletes a call analytics category. To use this operation, specify the
|
880
|
+
# name of the category you want to delete using `CategoryName`.
|
849
881
|
#
|
850
882
|
# @option params [required, String] :category_name
|
851
|
-
# The name of the call analytics category
|
852
|
-
#
|
883
|
+
# The name of the call analytics category you want to delete. Category
|
884
|
+
# names are case-sensitive.
|
853
885
|
#
|
854
886
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
855
887
|
#
|
@@ -868,10 +900,12 @@ module Aws::TranscribeService
|
|
868
900
|
req.send_request(options)
|
869
901
|
end
|
870
902
|
|
871
|
-
# Deletes a call analytics job
|
903
|
+
# Deletes a call analytics job. To use this operation, specify the name
|
904
|
+
# of the job you want to delete using `CallAnalyticsJobName`.
|
872
905
|
#
|
873
906
|
# @option params [required, String] :call_analytics_job_name
|
874
|
-
# The name of the call analytics job you want to delete.
|
907
|
+
# The name of the call analytics job you want to delete. Job names are
|
908
|
+
# case-sensitive.
|
875
909
|
#
|
876
910
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
877
911
|
#
|
@@ -890,10 +924,12 @@ module Aws::TranscribeService
|
|
890
924
|
req.send_request(options)
|
891
925
|
end
|
892
926
|
|
893
|
-
# Deletes a custom language model
|
927
|
+
# Deletes a custom language model. To use this operation, specify the
|
928
|
+
# name of the language model you want to delete using `ModelName`.
|
894
929
|
#
|
895
930
|
# @option params [required, String] :model_name
|
896
|
-
# The name of the model you
|
931
|
+
# The name of the model you want to delete. Model names are
|
932
|
+
# case-sensitive.
|
897
933
|
#
|
898
934
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
899
935
|
#
|
@@ -912,12 +948,13 @@ module Aws::TranscribeService
|
|
912
948
|
req.send_request(options)
|
913
949
|
end
|
914
950
|
|
915
|
-
# Deletes a transcription job
|
916
|
-
#
|
951
|
+
# Deletes a medical transcription job, along with any related
|
952
|
+
# information. To use this operation, specify the name of the job you
|
953
|
+
# want to delete using `MedicalTranscriptionJobName`.
|
917
954
|
#
|
918
955
|
# @option params [required, String] :medical_transcription_job_name
|
919
|
-
# The name
|
920
|
-
#
|
956
|
+
# The name of the medical transcription job you want to delete. Job
|
957
|
+
# names are case-sensitive.
|
921
958
|
#
|
922
959
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
923
960
|
#
|
@@ -936,10 +973,12 @@ module Aws::TranscribeService
|
|
936
973
|
req.send_request(options)
|
937
974
|
end
|
938
975
|
|
939
|
-
# Deletes a vocabulary
|
976
|
+
# Deletes a custom medical vocabulary. To use this operation, specify
|
977
|
+
# the name of the vocabulary you want to delete using `VocabularyName`.
|
940
978
|
#
|
941
979
|
# @option params [required, String] :vocabulary_name
|
942
|
-
# The name of the vocabulary that you want to delete.
|
980
|
+
# The name of the vocabulary that you want to delete. Vocabulary names
|
981
|
+
# are case-sensitive.
|
943
982
|
#
|
944
983
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
945
984
|
#
|
@@ -958,11 +997,13 @@ module Aws::TranscribeService
|
|
958
997
|
req.send_request(options)
|
959
998
|
end
|
960
999
|
|
961
|
-
# Deletes a
|
962
|
-
#
|
1000
|
+
# Deletes a transcription job, along with any related information. To
|
1001
|
+
# use this operation, specify the name of the job you want to delete
|
1002
|
+
# using `TranscriptionJobName`.
|
963
1003
|
#
|
964
1004
|
# @option params [required, String] :transcription_job_name
|
965
|
-
# The name of the transcription job to
|
1005
|
+
# The name of the transcription job you want to delete. Job names are
|
1006
|
+
# case-sensitive.
|
966
1007
|
#
|
967
1008
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
968
1009
|
#
|
@@ -981,10 +1022,12 @@ module Aws::TranscribeService
|
|
981
1022
|
req.send_request(options)
|
982
1023
|
end
|
983
1024
|
|
984
|
-
# Deletes a vocabulary
|
1025
|
+
# Deletes a custom vocabulary. To use this operation, specify the name
|
1026
|
+
# of the vocabulary you want to delete using `VocabularyName`.
|
985
1027
|
#
|
986
1028
|
# @option params [required, String] :vocabulary_name
|
987
|
-
# The name of the vocabulary to delete.
|
1029
|
+
# The name of the vocabulary you want to delete. Vocabulary names are
|
1030
|
+
# case-sensitive.
|
988
1031
|
#
|
989
1032
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
990
1033
|
#
|
@@ -1003,10 +1046,13 @@ module Aws::TranscribeService
|
|
1003
1046
|
req.send_request(options)
|
1004
1047
|
end
|
1005
1048
|
|
1006
|
-
#
|
1049
|
+
# Deletes a vocabulary filter. To use this operation, specify the name
|
1050
|
+
# of the vocabulary filter you want to delete using
|
1051
|
+
# `VocabularyFilterName`.
|
1007
1052
|
#
|
1008
1053
|
# @option params [required, String] :vocabulary_filter_name
|
1009
|
-
# The name of the vocabulary filter to
|
1054
|
+
# The name of the vocabulary filter you want to delete. Vocabulary
|
1055
|
+
# filter names are case-sensitive.
|
1010
1056
|
#
|
1011
1057
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1012
1058
|
#
|
@@ -1025,18 +1071,21 @@ module Aws::TranscribeService
|
|
1025
1071
|
req.send_request(options)
|
1026
1072
|
end
|
1027
1073
|
|
1028
|
-
#
|
1029
|
-
#
|
1030
|
-
#
|
1031
|
-
#
|
1074
|
+
# Provides information about a specific custom language model in your
|
1075
|
+
# Amazon Web Services account.
|
1076
|
+
#
|
1077
|
+
# This operation also shows if the base language model you used to
|
1078
|
+
# create your custom language model has been updated. If Amazon
|
1032
1079
|
# Transcribe has updated the base model, you can create a new custom
|
1033
|
-
# language model using the updated base model.
|
1034
|
-
#
|
1035
|
-
#
|
1080
|
+
# language model using the updated base model.
|
1081
|
+
#
|
1082
|
+
# If you tried to create a new custom language model and the request
|
1083
|
+
# wasn't successful, you can use this operation to help identify the
|
1084
|
+
# reason.
|
1036
1085
|
#
|
1037
1086
|
# @option params [required, String] :model_name
|
1038
|
-
# The name of the custom language model you
|
1039
|
-
#
|
1087
|
+
# The name of the custom language model you want described. Model names
|
1088
|
+
# are case-sensitive.
|
1040
1089
|
#
|
1041
1090
|
# @return [Types::DescribeLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1042
1091
|
#
|
@@ -1074,8 +1123,8 @@ module Aws::TranscribeService
|
|
1074
1123
|
# Retrieves information about a call analytics category.
|
1075
1124
|
#
|
1076
1125
|
# @option params [required, String] :category_name
|
1077
|
-
# The name of the category you want information about.
|
1078
|
-
# case sensitive.
|
1126
|
+
# The name of the category you want information about. Category names
|
1127
|
+
# are case sensitive.
|
1079
1128
|
#
|
1080
1129
|
# @return [Types::GetCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1081
1130
|
#
|
@@ -1149,12 +1198,14 @@ module Aws::TranscribeService
|
|
1149
1198
|
req.send_request(options)
|
1150
1199
|
end
|
1151
1200
|
|
1152
|
-
#
|
1153
|
-
#
|
1154
|
-
#
|
1155
|
-
#
|
1156
|
-
#
|
1157
|
-
#
|
1201
|
+
# Retrieves information about a call analytics job.
|
1202
|
+
#
|
1203
|
+
# To view the job's status, refer to the `CallAnalyticsJobStatus`
|
1204
|
+
# field. If the status is `COMPLETED`, the job is finished. You can then
|
1205
|
+
# find your transcript at the URI specified in the `TranscriptFileUri`
|
1206
|
+
# field. If you enabled personally identifiable information (PII)
|
1207
|
+
# redaction, the redacted transcript appears in the
|
1208
|
+
# `RedactedTranscriptFileUri` field.
|
1158
1209
|
#
|
1159
1210
|
# @option params [required, String] :call_analytics_job_name
|
1160
1211
|
# The name of the analytics job you want information about. This value
|
@@ -1214,14 +1265,16 @@ module Aws::TranscribeService
|
|
1214
1265
|
req.send_request(options)
|
1215
1266
|
end
|
1216
1267
|
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
# `TranscriptFileUri`
|
1268
|
+
# Retrieves information about a medical transcription job.
|
1269
|
+
#
|
1270
|
+
# To view the job's status, refer to the `TranscriptionJobStatus`
|
1271
|
+
# field. If the status is `COMPLETED`, the job is finished. You can then
|
1272
|
+
# find your transcript at the URI specified in the `TranscriptFileUri`
|
1273
|
+
# field.
|
1222
1274
|
#
|
1223
1275
|
# @option params [required, String] :medical_transcription_job_name
|
1224
|
-
# The name of the medical transcription job.
|
1276
|
+
# The name of the medical transcription job you want information about.
|
1277
|
+
# This value is case sensitive.
|
1225
1278
|
#
|
1226
1279
|
# @return [Types::GetMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1227
1280
|
#
|
@@ -1272,8 +1325,8 @@ module Aws::TranscribeService
|
|
1272
1325
|
# Retrieves information about a medical vocabulary.
|
1273
1326
|
#
|
1274
1327
|
# @option params [required, String] :vocabulary_name
|
1275
|
-
# The name of the vocabulary
|
1276
|
-
# is case sensitive.
|
1328
|
+
# The name of the medical vocabulary you want information about. This
|
1329
|
+
# value is case sensitive.
|
1277
1330
|
#
|
1278
1331
|
# @return [Types::GetMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1279
1332
|
#
|
@@ -1369,6 +1422,7 @@ module Aws::TranscribeService
|
|
1369
1422
|
# resp.transcription_job.subtitles.formats[0] #=> String, one of "vtt", "srt"
|
1370
1423
|
# resp.transcription_job.subtitles.subtitle_file_uris #=> Array
|
1371
1424
|
# resp.transcription_job.subtitles.subtitle_file_uris[0] #=> String
|
1425
|
+
# resp.transcription_job.subtitles.output_start_index #=> Integer
|
1372
1426
|
# resp.transcription_job.language_id_settings #=> Hash
|
1373
1427
|
# resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_name #=> String
|
1374
1428
|
# resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_filter_name #=> String
|
@@ -2331,7 +2385,7 @@ module Aws::TranscribeService
|
|
2331
2385
|
# dictated speech, such as clinical notes.
|
2332
2386
|
#
|
2333
2387
|
# @option params [Array<Types::Tag>] :tags
|
2334
|
-
# Add tags to an Amazon Transcribe
|
2388
|
+
# Add tags to an Amazon Transcribe Medical transcription job.
|
2335
2389
|
#
|
2336
2390
|
# @return [Types::StartMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2337
2391
|
#
|
@@ -2419,7 +2473,9 @@ module Aws::TranscribeService
|
|
2419
2473
|
# `ConflictException` error.
|
2420
2474
|
#
|
2421
2475
|
# @option params [String] :language_code
|
2422
|
-
# The language code for the language used in the input media file.
|
2476
|
+
# The language code for the language used in the input media file. You
|
2477
|
+
# must include either `LanguageCode` or `IdentifyLanguage` in your
|
2478
|
+
# request.
|
2423
2479
|
#
|
2424
2480
|
# To transcribe speech in Modern Standard Arabic (ar-SA), your audio or
|
2425
2481
|
# video file must be encoded at a sample rate of 16,000 Hz or higher.
|
@@ -2547,6 +2603,9 @@ module Aws::TranscribeService
|
|
2547
2603
|
# a `BadRequestException` error if you enter a value for a
|
2548
2604
|
# `LanguageCode`.
|
2549
2605
|
#
|
2606
|
+
# You must include either `LanguageCode` or `IdentifyLanguage` in your
|
2607
|
+
# request.
|
2608
|
+
#
|
2550
2609
|
# @option params [Array<String>] :language_options
|
2551
2610
|
# An object containing a list of languages that might be present in your
|
2552
2611
|
# collection of audio files. Automatic language identification chooses a
|
@@ -2613,6 +2672,7 @@ module Aws::TranscribeService
|
|
2613
2672
|
# language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
2614
2673
|
# subtitles: {
|
2615
2674
|
# formats: ["vtt"], # accepts vtt, srt
|
2675
|
+
# output_start_index: 1,
|
2616
2676
|
# },
|
2617
2677
|
# tags: [
|
2618
2678
|
# {
|
@@ -2670,6 +2730,7 @@ module Aws::TranscribeService
|
|
2670
2730
|
# resp.transcription_job.subtitles.formats[0] #=> String, one of "vtt", "srt"
|
2671
2731
|
# resp.transcription_job.subtitles.subtitle_file_uris #=> Array
|
2672
2732
|
# resp.transcription_job.subtitles.subtitle_file_uris[0] #=> String
|
2733
|
+
# resp.transcription_job.subtitles.output_start_index #=> Integer
|
2673
2734
|
# resp.transcription_job.language_id_settings #=> Hash
|
2674
2735
|
# resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_name #=> String
|
2675
2736
|
# resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_filter_name #=> String
|
@@ -2935,13 +2996,11 @@ module Aws::TranscribeService
|
|
2935
2996
|
# the resource that you are calling. The following is the format for a
|
2936
2997
|
# URI:
|
2937
2998
|
#
|
2938
|
-
# `
|
2939
|
-
# https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
|
2940
|
-
# `
|
2999
|
+
# `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
|
2941
3000
|
#
|
2942
3001
|
# For example:
|
2943
3002
|
#
|
2944
|
-
# `https://s3.us-east-1.amazonaws.com/
|
3003
|
+
# `https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt`
|
2945
3004
|
#
|
2946
3005
|
# For more information about Amazon S3 object names, see [Object
|
2947
3006
|
# Keys][1] in the *Amazon S3 Developer Guide*.
|
@@ -3010,11 +3069,11 @@ module Aws::TranscribeService
|
|
3010
3069
|
# custom vocabulary. The URI must be in the same region as the API
|
3011
3070
|
# endpoint that you are calling. The general form is:
|
3012
3071
|
#
|
3013
|
-
# `https://s3
|
3072
|
+
# `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
|
3014
3073
|
#
|
3015
3074
|
# For example:
|
3016
3075
|
#
|
3017
|
-
# `https://s3.us-east-1.amazonaws.com/
|
3076
|
+
# `https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt`
|
3018
3077
|
#
|
3019
3078
|
# For more information about S3 object names, see [Object Keys][1] in
|
3020
3079
|
# the *Amazon S3 Developer Guide*.
|
@@ -3136,7 +3195,7 @@ module Aws::TranscribeService
|
|
3136
3195
|
params: params,
|
3137
3196
|
config: config)
|
3138
3197
|
context[:gem_name] = 'aws-sdk-transcribeservice'
|
3139
|
-
context[:gem_version] = '1.
|
3198
|
+
context[:gem_version] = '1.74.0'
|
3140
3199
|
Seahorse::Client::Request.new(handlers, context)
|
3141
3200
|
end
|
3142
3201
|
|