class Aws::TranscribeStreamingService::Types::StartStreamTranscriptionRequest

@note When making an API call, you may pass StartStreamTranscriptionRequest

data as a hash:

    {
      language_code: "en-US", # required, 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
      media_sample_rate_hertz: 1, # required
      media_encoding: "pcm", # required, accepts pcm, ogg-opus, flac
      vocabulary_name: "VocabularyName",
      session_id: "SessionId",
      input_event_stream_hander: EventStreams::AudioStream.new,
      vocabulary_filter_name: "VocabularyFilterName",
      vocabulary_filter_method: "remove", # accepts remove, mask, tag
      show_speaker_label: false,
      enable_channel_identification: false,
      number_of_channels: 1,
      enable_partial_results_stabilization: false,
      partial_results_stability: "high", # accepts high, medium, low
    }

@!attribute [rw] language_code

Indicates the source language used in the input audio stream.
@return [String]

@!attribute [rw] media_sample_rate_hertz

The sample rate, in Hertz, of the input audio. We suggest that you
use 8000 Hz for low quality audio and 16000 Hz for high quality
audio.
@return [Integer]

@!attribute [rw] media_encoding

The encoding used for the input audio.
@return [String]

@!attribute [rw] vocabulary_name

The name of the vocabulary to use when processing the transcription
job.
@return [String]

@!attribute [rw] session_id

A identifier for the transcription session. Use this parameter when
you want to retry a session. If you don't provide a session ID,
Amazon Transcribe will generate one for you and return it in the
response.
@return [String]

@!attribute [rw] audio_stream

PCM-encoded stream of audio blobs. The audio stream is encoded as an
HTTP2 data frame.
@return [Types::AudioStream]

@!attribute [rw] vocabulary_filter_name

The name of the vocabulary filter you've created that is unique to
your AWS account. Provide the name in this field to successfully use
it in a stream.
@return [String]

@!attribute [rw] vocabulary_filter_method

The manner in which you use your vocabulary filter to filter words
in your transcript. `Remove` removes filtered words from your
transcription results. `Mask` masks those words with a `***` in your
transcription results. `Tag` keeps the filtered words in your
transcription results and tags them. The tag appears as
`VocabularyFilterMatch` equal to `True`
@return [String]

@!attribute [rw] show_speaker_label

When `true`, enables speaker identification in your real-time
stream.
@return [Boolean]

@!attribute [rw] enable_channel_identification

When `true`, instructs Amazon Transcribe to process each audio
channel separately and then merge the transcription output of each
channel into a single transcription.

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

The number of channels that are in your audio stream.
@return [Integer]

@!attribute [rw] enable_partial_results_stabilization

When `true`, instructs Amazon Transcribe to present transcription
results that have the partial results stabilized. Normally, any word
or phrase from one partial result can change in a subsequent partial
result. With partial results stabilization enabled, only the last
few words of one partial result can change in another partial
result.
@return [Boolean]

@!attribute [rw] partial_results_stability

You can use this field to set the stability level of the
transcription results. A higher stability level means that the
transcription results are less likely to change. Higher stability
levels can come with lower overall transcription accuracy.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscriptionRequest AWS API Documentation

Constants

SENSITIVE