aws-sdk-transcribestreamingservice 1.41.0 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9f019103bd8b81208f3ec9ee4569e4e3a0005800a0c24a82e2769e60988448b
-  data.tar.gz: 6df9217a0f12a35a04b16481f6084c280896b661409d1ce5f21a28ebd2292b4d
+  metadata.gz: 6584e31351b0ac83d5b294ba62e3b28a9808aa355844ab409cb6dc4fea8b4975
+  data.tar.gz: de6551137336e4ec913ed02619faae6a42af4d0e473ecd45252891a26bfae349
 SHA512:
-  metadata.gz: 3a8fb95b605d461f98947a67c133f0317ba4ae9df35c1928bd515eb704040cc2f84e5ea36896b0b531218945de634066cc769cf39d3eb6434d668544fc4dec17
-  data.tar.gz: 80a07103d99ff7c52a5751116db49efe629a8ebca355301499692d5ead1deb08033e2a2a3a44e1831b714b805df9b00a771e24c0a01b576839250d05daa66e57
+  metadata.gz: 88f421c05150eaf15827793fe3b722719e0cc70b125dbada129a71eccbd6c24c211b7edb01e2395915b4fca95c5a9a50e2f12d9a9bd88b1c18fafccab93529f6
+  data.tar.gz: a829779ec423c2659333783050db8d5cc1e88476dfbbb0cbc3fe1d4ed42c605659a73ffc4128840fd227a9f1cbc268baf9442175033a1fc16d07ec2d25d123f0

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.42.0 (2022-03-11)
+------------------
+
+* Feature - Amazon Transcribe StartTranscription API now supports additional parameters for Language Identification feature: customVocabularies and customFilterVocabularies
+
 1.41.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.41.0
+1.42.0

data/lib/aws-sdk-transcribestreamingservice/async_client.rb

@@ -263,7 +263,9 @@ module Aws::TranscribeStreamingService
     #   Amazon Transcribe Medical, this is US English (en-US).
     #
     # @option params [required, Integer] :media_sample_rate_hertz
-    #   The sample rate of the input audio in Hertz.
+    #   The sample rate of the input audio (in Hertz). Amazon Transcribe
+    #   medical supports a range from 16,000 Hz to 48,000 Hz. Note that the
+    #   sample rate you specify must match that of your audio.
     #
     # @option params [required, String] :media_encoding
     #   The encoding used for the input audio.
@@ -547,16 +549,22 @@ module Aws::TranscribeStreamingService
     #   The language code of the input audio stream.
     #
     # @option params [required, Integer] :media_sample_rate_hertz
-    #   The sample rate, in Hertz (Hz), of the input audio. We suggest that
-    #   you use 8,000 Hz for low quality audio and 16,000 Hz or higher for
-    #   high quality audio.
+    #   The sample rate of the input audio (in Hertz). Low-quality audio, such
+    #   as telephone audio, is typically around 8,000 Hz. High-quality audio
+    #   typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample
+    #   rate you specify must match that of your audio.
     #
     # @option params [required, String] :media_encoding
     #   The encoding used for the input audio.
     #
     # @option params [String] :vocabulary_name
-    #   The name of the vocabulary to use when processing the transcription
-    #   job.
+    #   The name of the custom vocabulary you want to use with your
+    #   transcription.
+    #
+    #   This operation is not intended for use in conjunction with the
+    #   `IdentifyLanguage` operation. If you're using `IdentifyLanguage` in
+    #   your request and want to use one or more custom vocabularies with your
+    #   transcription, use the `VocabularyNames` operation instead.
     #
     # @option params [String] :session_id
     #   A identifier for the transcription session. Use this parameter when
@@ -565,9 +573,13 @@ module Aws::TranscribeStreamingService
     #   response.
     #
     # @option params [String] :vocabulary_filter_name
-    #   The name of the vocabulary filter you've created that is unique to
-    #   your account. Provide the name in this field to successfully use it in
-    #   a stream.
+    #   The name of the vocabulary filter you want to use with your
+    #   transcription.
+    #
+    #   This operation is not intended for use in conjunction with the
+    #   `IdentifyLanguage` operation. If you're using `IdentifyLanguage` in
+    #   your request and want to use one or more vocabulary filters with your
+    #   transcription, use the `VocabularyFilterNames` operation instead.
     #
     # @option params [String] :vocabulary_filter_method
     #   The manner in which you use your vocabulary filter to filter words in
@@ -588,10 +600,6 @@ module Aws::TranscribeStreamingService
     #   Amazon Transcribe also produces a transcription of each item. An item
     #   includes the start time, end time, and any alternative transcriptions.
     #
-    #   You can't set both `ShowSpeakerLabel` and
-    #   `EnableChannelIdentification` in the same request. If you set both,
-    #   your request returns a `BadRequestException`.
-    #
     # @option params [Integer] :number_of_channels
     #   The number of channels that are in your audio stream.
     #
@@ -667,6 +675,30 @@ module Aws::TranscribeStreamingService
     #   You can only use this parameter if you've set `IdentifyLanguage` to
     #   `true`in your request.
     #
+    # @option params [String] :vocabulary_names
+    #   The names of the custom vocabularies you want to use with your
+    #   transcription.
+    #
+    #   Note that if the custom vocabularies you specify are in languages that
+    #   don't match the language identified in your media, your job fails.
+    #
+    #   This operation is only intended for use in conjunction with the
+    #   `IdentifyLanguage` operation. If you're not using `IdentifyLanguage`
+    #   in your request and want to use a custom vocabulary with your
+    #   transcription, use the `VocabularyName` operation instead.
+    #
+    # @option params [String] :vocabulary_filter_names
+    #   The names of the vocabulary filters you want to use with your
+    #   transcription.
+    #
+    #   Note that if the vocabulary filters you specify are in languages that
+    #   don't match the language identified in your media, your job fails.
+    #
+    #   This operation is only intended for use in conjunction with the
+    #   `IdentifyLanguage` operation. If you're not using `IdentifyLanguage`
+    #   in your request and want to use a vocabulary filter with your
+    #   transcription, use the `VocabularyFilterName` operation instead.
+    #
     # @return [Types::StartStreamTranscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::StartStreamTranscriptionResponse#request_id #request_id} => String
@@ -690,6 +722,8 @@ module Aws::TranscribeStreamingService
     #   * {Types::StartStreamTranscriptionResponse#identify_language #identify_language} => Boolean
     #   * {Types::StartStreamTranscriptionResponse#language_options #language_options} => String
     #   * {Types::StartStreamTranscriptionResponse#preferred_language #preferred_language} => String
+    #   * {Types::StartStreamTranscriptionResponse#vocabulary_names #vocabulary_names} => String
+    #   * {Types::StartStreamTranscriptionResponse#vocabulary_filter_names #vocabulary_filter_names} => String
     #
     # @example Bi-directional EventStream Operation Example
     #
@@ -806,6 +840,8 @@ module Aws::TranscribeStreamingService
     #     identify_language: false,
     #     language_options: "LanguageOptions",
     #     preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
+    #     vocabulary_names: "VocabularyNames",
+    #     vocabulary_filter_names: "VocabularyFilterNames",
     #   })
     #   # => Seahorse::Client::AsyncResponse
     #   async_resp.wait
@@ -883,6 +919,8 @@ module Aws::TranscribeStreamingService
     #   resp.identify_language #=> Boolean
     #   resp.language_options #=> String
     #   resp.preferred_language #=> String, one of "en-US", "en-GB", "es-US", "fr-CA", "fr-FR", "en-AU", "it-IT", "de-DE", "pt-BR", "ja-JP", "ko-KR", "zh-CN"
+    #   resp.vocabulary_names #=> String
+    #   resp.vocabulary_filter_names #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscription AWS API Documentation
     #
@@ -927,7 +965,7 @@ module Aws::TranscribeStreamingService
         http_response: Seahorse::Client::Http::AsyncResponse.new,
         config: config)
       context[:gem_name] = 'aws-sdk-transcribestreamingservice'
-      context[:gem_version] = '1.41.0'
+      context[:gem_version] = '1.42.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-transcribestreamingservice/client.rb

@@ -375,7 +375,7 @@ module Aws::TranscribeStreamingService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-transcribestreamingservice'
-      context[:gem_version] = '1.41.0'
+      context[:gem_version] = '1.42.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-transcribestreamingservice/client_api.rb

@@ -72,7 +72,9 @@ module Aws::TranscribeStreamingService
     Type = Shapes::StringShape.new(name: 'Type')
     VocabularyFilterMethod = Shapes::StringShape.new(name: 'VocabularyFilterMethod')
     VocabularyFilterName = Shapes::StringShape.new(name: 'VocabularyFilterName')
+    VocabularyFilterNames = Shapes::StringShape.new(name: 'VocabularyFilterNames')
     VocabularyName = Shapes::StringShape.new(name: 'VocabularyName')
+    VocabularyNames = Shapes::StringShape.new(name: 'VocabularyNames')
 
     Alternative.add_member(:transcript, Shapes::ShapeRef.new(shape: String, location_name: "Transcript"))
     Alternative.add_member(:items, Shapes::ShapeRef.new(shape: ItemList, location_name: "Items"))
@@ -245,6 +247,8 @@ module Aws::TranscribeStreamingService
     StartStreamTranscriptionRequest.add_member(:identify_language, Shapes::ShapeRef.new(shape: Boolean, location: "header", location_name: "x-amzn-transcribe-identify-language"))
     StartStreamTranscriptionRequest.add_member(:language_options, Shapes::ShapeRef.new(shape: LanguageOptions, location: "header", location_name: "x-amzn-transcribe-language-options"))
     StartStreamTranscriptionRequest.add_member(:preferred_language, Shapes::ShapeRef.new(shape: LanguageCode, location: "header", location_name: "x-amzn-transcribe-preferred-language"))
+    StartStreamTranscriptionRequest.add_member(:vocabulary_names, Shapes::ShapeRef.new(shape: VocabularyNames, location: "header", location_name: "x-amzn-transcribe-vocabulary-names"))
+    StartStreamTranscriptionRequest.add_member(:vocabulary_filter_names, Shapes::ShapeRef.new(shape: VocabularyFilterNames, location: "header", location_name: "x-amzn-transcribe-vocabulary-filter-names"))
     StartStreamTranscriptionRequest.struct_class = Types::StartStreamTranscriptionRequest
     StartStreamTranscriptionRequest[:payload] = :audio_stream
     StartStreamTranscriptionRequest[:payload_member] = StartStreamTranscriptionRequest.member(:audio_stream)
@@ -270,6 +274,8 @@ module Aws::TranscribeStreamingService
     StartStreamTranscriptionResponse.add_member(:identify_language, Shapes::ShapeRef.new(shape: Boolean, location: "header", location_name: "x-amzn-transcribe-identify-language"))
     StartStreamTranscriptionResponse.add_member(:language_options, Shapes::ShapeRef.new(shape: LanguageOptions, location: "header", location_name: "x-amzn-transcribe-language-options"))
     StartStreamTranscriptionResponse.add_member(:preferred_language, Shapes::ShapeRef.new(shape: LanguageCode, location: "header", location_name: "x-amzn-transcribe-preferred-language"))
+    StartStreamTranscriptionResponse.add_member(:vocabulary_names, Shapes::ShapeRef.new(shape: VocabularyNames, location: "header", location_name: "x-amzn-transcribe-vocabulary-names"))
+    StartStreamTranscriptionResponse.add_member(:vocabulary_filter_names, Shapes::ShapeRef.new(shape: VocabularyFilterNames, location: "header", location_name: "x-amzn-transcribe-vocabulary-filter-names"))
     StartStreamTranscriptionResponse.struct_class = Types::StartStreamTranscriptionResponse
     StartStreamTranscriptionResponse[:payload] = :transcript_result_stream
     StartStreamTranscriptionResponse[:payload_member] = StartStreamTranscriptionResponse.member(:transcript_result_stream)

data/lib/aws-sdk-transcribestreamingservice/types.rb

@@ -567,7 +567,9 @@ module Aws::TranscribeStreamingService
     #   @return [String]
     #
     # @!attribute [rw] media_sample_rate_hertz
-    #   The sample rate of the input audio in Hertz.
+    #   The sample rate of the input audio (in Hertz). Amazon Transcribe
+    #   medical supports a range from 16,000 Hz to 48,000 Hz. Note that the
+    #   sample rate you specify must match that of your audio.
     #   @return [Integer]
     #
     # @!attribute [rw] media_encoding
@@ -657,7 +659,7 @@ module Aws::TranscribeStreamingService
     #   @return [String]
     #
     # @!attribute [rw] media_sample_rate_hertz
-    #   The sample rate of the input audio in Hertz.
+    #   The sample rate of the input audio, in Hertz (Hz).
     #   @return [Integer]
     #
     # @!attribute [rw] media_encoding
@@ -748,6 +750,8 @@ module Aws::TranscribeStreamingService
     #         identify_language: false,
     #         language_options: "LanguageOptions",
     #         preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
+    #         vocabulary_names: "VocabularyNames",
+    #         vocabulary_filter_names: "VocabularyFilterNames",
     #       }
     #
     # @!attribute [rw] language_code
@@ -755,9 +759,10 @@ module Aws::TranscribeStreamingService
     #   @return [String]
     #
     # @!attribute [rw] media_sample_rate_hertz
-    #   The sample rate, in Hertz (Hz), of the input audio. We suggest that
-    #   you use 8,000 Hz for low quality audio and 16,000 Hz or higher for
-    #   high quality audio.
+    #   The sample rate of the input audio (in Hertz). Low-quality audio,
+    #   such as telephone audio, is typically around 8,000 Hz. High-quality
+    #   audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the
+    #   sample rate you specify must match that of your audio.
     #   @return [Integer]
     #
     # @!attribute [rw] media_encoding
@@ -765,8 +770,13 @@ module Aws::TranscribeStreamingService
     #   @return [String]
     #
     # @!attribute [rw] vocabulary_name
-    #   The name of the vocabulary to use when processing the transcription
-    #   job.
+    #   The name of the custom vocabulary you want to use with your
+    #   transcription.
+    #
+    #   This operation is not intended for use in conjunction with the
+    #   `IdentifyLanguage` operation. If you're using `IdentifyLanguage` in
+    #   your request and want to use one or more custom vocabularies with
+    #   your transcription, use the `VocabularyNames` operation instead.
     #   @return [String]
     #
     # @!attribute [rw] session_id
@@ -782,9 +792,14 @@ module Aws::TranscribeStreamingService
     #   @return [Types::AudioStream]
     #
     # @!attribute [rw] vocabulary_filter_name
-    #   The name of the vocabulary filter you've created that is unique to
-    #   your account. Provide the name in this field to successfully use it
-    #   in a stream.
+    #   The name of the vocabulary filter you want to use with your
+    #   transcription.
+    #
+    #   This operation is not intended for use in conjunction with the
+    #   `IdentifyLanguage` operation. If you're using `IdentifyLanguage` in
+    #   your request and want to use one or more vocabulary filters with
+    #   your transcription, use the `VocabularyFilterNames` operation
+    #   instead.
     #   @return [String]
     #
     # @!attribute [rw] vocabulary_filter_method
@@ -808,10 +823,6 @@ module Aws::TranscribeStreamingService
     #   Amazon Transcribe also produces a transcription of each item. An
     #   item includes the start time, end time, and any alternative
     #   transcriptions.
-    #
-    #   You can't set both `ShowSpeakerLabel` and
-    #   `EnableChannelIdentification` in the same request. If you set both,
-    #   your request returns a `BadRequestException`.
     #   @return [Boolean]
     #
     # @!attribute [rw] number_of_channels
@@ -901,6 +912,36 @@ module Aws::TranscribeStreamingService
     #   `true`in your request.
     #   @return [String]
     #
+    # @!attribute [rw] vocabulary_names
+    #   The names of the custom vocabularies you want to use with your
+    #   transcription.
+    #
+    #   Note that if the custom vocabularies you specify are in languages
+    #   that don't match the language identified in your media, your job
+    #   fails.
+    #
+    #   This operation is only intended for use in conjunction with the
+    #   `IdentifyLanguage` operation. If you're not using
+    #   `IdentifyLanguage` in your request and want to use a custom
+    #   vocabulary with your transcription, use the `VocabularyName`
+    #   operation instead.
+    #   @return [String]
+    #
+    # @!attribute [rw] vocabulary_filter_names
+    #   The names of the vocabulary filters you want to use with your
+    #   transcription.
+    #
+    #   Note that if the vocabulary filters you specify are in languages
+    #   that don't match the language identified in your media, your job
+    #   fails.
+    #
+    #   This operation is only intended for use in conjunction with the
+    #   `IdentifyLanguage` operation. If you're not using
+    #   `IdentifyLanguage` in your request and want to use a vocabulary
+    #   filter with your transcription, use the `VocabularyFilterName`
+    #   operation instead.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscriptionRequest AWS API Documentation
     #
     class StartStreamTranscriptionRequest < Struct.new(
@@ -923,13 +964,15 @@ module Aws::TranscribeStreamingService
       :language_model_name,
       :identify_language,
       :language_options,
-      :preferred_language)
+      :preferred_language,
+      :vocabulary_names,
+      :vocabulary_filter_names)
       SENSITIVE = []
       include Aws::Structure
     end
 
     # @!attribute [rw] request_id
-    #   An identifier for the streaming transcription.
+    #   An identifier for the transcription.
     #   @return [String]
     #
     # @!attribute [rw] language_code
@@ -937,9 +980,7 @@ module Aws::TranscribeStreamingService
     #   @return [String]
     #
     # @!attribute [rw] media_sample_rate_hertz
-    #   The sample rate, in Hertz (Hz), for the input audio stream. Use
-    #   8,000 Hz for low quality audio and 16,000 Hz or higher for high
-    #   quality audio.
+    #   The sample rate, in Hertz (Hz), for the input audio stream.
     #   @return [Integer]
     #
     # @!attribute [rw] media_encoding
@@ -947,7 +988,7 @@ module Aws::TranscribeStreamingService
     #   @return [String]
     #
     # @!attribute [rw] vocabulary_name
-    #   The name of the vocabulary used when processing the stream.
+    #   The name of the custom vocabulary used when processing the stream.
     #   @return [String]
     #
     # @!attribute [rw] session_id
@@ -960,19 +1001,20 @@ module Aws::TranscribeStreamingService
     #   @return [Types::TranscriptResultStream]
     #
     # @!attribute [rw] vocabulary_filter_name
-    #   The name of the vocabulary filter used in your media stream.
+    #   The name of the vocabulary filter used when processing the stream.
     #   @return [String]
     #
     # @!attribute [rw] vocabulary_filter_method
-    #   The vocabulary filtering method used in the media stream.
+    #   The vocabulary filtering method used when processing the stream.
     #   @return [String]
     #
     # @!attribute [rw] show_speaker_label
-    #   Shows whether speaker identification was enabled in the stream.
+    #   Shows whether speaker identification was enabled in the
+    #   transcription.
     #   @return [Boolean]
     #
     # @!attribute [rw] enable_channel_identification
-    #   Shows whether channel identification has been enabled in the stream.
+    #   Shows whether channel identification was enabled in the stream.
     #   @return [Boolean]
     #
     # @!attribute [rw] number_of_channels
@@ -980,8 +1022,8 @@ module Aws::TranscribeStreamingService
     #   @return [Integer]
     #
     # @!attribute [rw] enable_partial_results_stabilization
-    #   Shows whether partial results stabilization has been enabled in the
-    #   stream.
+    #   Shows whether partial results stabilization was enabled in the
+    #   transcription.
     #   @return [Boolean]
     #
     # @!attribute [rw] partial_results_stability
@@ -1002,7 +1044,7 @@ module Aws::TranscribeStreamingService
     #   @return [String]
     #
     # @!attribute [rw] language_model_name
-    #   The name of the language model used in your media stream.
+    #   The name of the custom language model used in the transcription.
     #   @return [String]
     #
     # @!attribute [rw] identify_language
@@ -1018,6 +1060,14 @@ module Aws::TranscribeStreamingService
     #   The preferred language you specified in your request.
     #   @return [String]
     #
+    # @!attribute [rw] vocabulary_names
+    #   The name of the custom vocabulary used when processing the stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] vocabulary_filter_names
+    #   The name of the vocabulary filter used when processing the stream.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscriptionResponse AWS API Documentation
     #
     class StartStreamTranscriptionResponse < Struct.new(
@@ -1041,7 +1091,9 @@ module Aws::TranscribeStreamingService
       :language_model_name,
       :identify_language,
       :language_options,
-      :preferred_language)
+      :preferred_language,
+      :vocabulary_names,
+      :vocabulary_filter_names)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-transcribestreamingservice.rb

@@ -50,6 +50,6 @@ require_relative 'aws-sdk-transcribestreamingservice/event_streams'
 # @!group service
 module Aws::TranscribeStreamingService
 
-  GEM_VERSION = '1.41.0'
+  GEM_VERSION = '1.42.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-transcribestreamingservice
 version: !ruby/object:Gem::Version
-  version: 1.41.0
+  version: 1.42.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core