Class: Aws::TranscribeStreamingService::Types::StartStreamTranscriptionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribestreamingservice/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audio_streamTypes::AudioStream

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.

For more information, see [Transcribing streaming audio].

[1]: docs.aws.amazon.com/transcribe/latest/dg/streaming.html

Returns:



1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#content_identification_typeString

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in ‘PiiEntityTypes` is flagged upon complete transcription of an audio segment.

You can’t set ‘ContentIdentificationType` and `ContentRedactionType` in the same request. If you set both, your request returns a `BadRequestException`.

For more information, see [Redacting or identifying personally identifiable information].

[1]: docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#content_redaction_typeString

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in ‘PiiEntityTypes` is redacted upon complete transcription of an audio segment.

You can’t set ‘ContentRedactionType` and `ContentIdentificationType` in the same request. If you set both, your request returns a `BadRequestException`.

For more information, see [Redacting or identifying personally identifiable information].

[1]: docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#enable_channel_identificationBoolean

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

For more information, see [Transcribing multi-channel audio].

[1]: docs.aws.amazon.com/transcribe/latest/dg/channel-id.html

Returns:

  • (Boolean)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#enable_partial_results_stabilizationBoolean

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see [Partial-result stabilization].

[1]: docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization

Returns:

  • (Boolean)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#identify_languageBoolean

Enables automatic language identification for your transcription.

If you include ‘IdentifyLanguage`, you can optionally include a list of language codes, using `LanguageOptions`, that you think may be present in your audio stream. Including language options can improve transcription accuracy.

You can also include a preferred language using ‘PreferredLanguage`. Adding a preferred language can help Amazon Transcribe identify the language faster than if you omit this parameter.

If you have multi-channel audio that contains different languages on each channel, and you’ve enabled channel identification, automatic language identification identifies the dominant language on each audio channel.

Note that you must include either ‘LanguageCode` or `IdentifyLanguage` or `IdentifyMultipleLanguages` in your request. If you include more than one of these parameters, your transcription job fails.

Streaming language identification can’t be combined with custom language models or redaction.

Returns:

  • (Boolean)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#identify_multiple_languagesBoolean

Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.

If you include ‘IdentifyMultipleLanguages`, you can optionally include a list of language codes, using `LanguageOptions`, that you think may be present in your stream. Including `LanguageOptions` restricts `IdentifyMultipleLanguages` to only the language options that you specify, which can improve transcription accuracy.

If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include ‘VocabularyNames` or `VocabularyFilterNames`.

Note that you must include one of ‘LanguageCode`, `IdentifyLanguage`, or `IdentifyMultipleLanguages` in your request. If you include more than one of these parameters, your transcription job fails.

Returns:

  • (Boolean)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

Specify the language code that represents the language spoken in your audio.

If you’re unsure of the language spoken in your audio, consider using ‘IdentifyLanguage` to enable automatic language identification.

For a list of languages supported with Amazon Transcribe streaming, refer to the [Supported languages] table.

[1]: docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#language_model_nameString

Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code you specify in your transcription request. If the languages don’t match, the custom language model isn’t applied. There are no errors or warnings associated with a language mismatch.

For more information, see [Custom language models].

[1]: docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#language_optionsString

Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you’re unsure what languages are present, do not include this parameter.

Including language options can improve the accuracy of language identification.

If you include ‘LanguageOptions` in your request, you must also include `IdentifyLanguage`.

For a list of languages supported with Amazon Transcribe streaming, refer to the [Supported languages] table.

You can only include one language dialect per language per stream. For example, you cannot include ‘en-US` and `en-AU` in the same request.

[1]: docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#media_encodingString

Specify the encoding of your input audio. Supported formats are:

  • FLAC

  • OPUS-encoded audio in an Ogg container

  • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see [Media formats].

[1]: docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#media_sample_rate_hertzInteger

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.

Returns:

  • (Integer)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_channelsInteger

Specify the number of channels in your audio stream. Up to two channels are supported.

Returns:

  • (Integer)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#partial_results_stabilityString

Specify the level of stability to use when you enable partial results stabilization (‘EnablePartialResultsStabilization`).

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

For more information, see [Partial-result stabilization].

[1]: docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#pii_entity_typesString

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you’d like, or you can select ‘ALL`.

To include ‘PiiEntityTypes` in your request, you must also include either `ContentIdentificationType` or `ContentRedactionType`.

Values must be comma-separated and can include: ‘BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_NUMBER`, `CREDIT_DEBIT_CVV`, `CREDIT_DEBIT_EXPIRY`, `PIN`, `EMAIL`, `ADDRESS`, `NAME`, `PHONE`, `SSN`, or `ALL`.

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_languageString

Specify a preferred language from the subset of languages codes you specified in ‘LanguageOptions`.

You can only use this parameter if you’ve included ‘IdentifyLanguage` and `LanguageOptions` in your request.

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#session_idString

Specify a name for your transcription session. If you don’t include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.

You can use a session ID to retry a streaming session.

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#show_speaker_labelBoolean

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see [Partitioning speakers (diarization)].

[1]: docs.aws.amazon.com/transcribe/latest/dg/diarization.html

Returns:

  • (Boolean)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_methodString

Specify how you want your vocabulary filter applied to your transcript.

To replace words with ‘***`, choose `mask`.

To delete words, choose ‘remove`.

To flag words without changing them, choose ‘tag`.

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_nameString

Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If the language of the specified custom vocabulary filter doesn’t match the language identified in your media, the vocabulary filter is not applied to your transcription.

This parameter is not intended for use with the ‘IdentifyLanguage` parameter. If you’re including ‘IdentifyLanguage` in your request and want to use one or more vocabulary filters with your transcription, use the `VocabularyFilterNames` parameter instead.

For more information, see [Using vocabulary filtering with unwanted words].

[1]: docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_namesString

Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If none of the languages of the specified custom vocabulary filters match the language identified in your media, your job fails.

This parameter is only intended for use with the ‘IdentifyLanguage` parameter. If you’re not including ‘IdentifyLanguage` in your request and want to use a custom vocabulary filter with your transcription, use the `VocabularyFilterName` parameter instead.

For more information, see [Using vocabulary filtering with unwanted words].

[1]: docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_nameString

Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If the language of the specified custom vocabulary doesn’t match the language identified in your media, the custom vocabulary is not applied to your transcription.

This parameter is not intended for use with the ‘IdentifyLanguage` parameter. If you’re including ‘IdentifyLanguage` in your request and want to use one or more custom vocabularies with your transcription, use the `VocabularyNames` parameter instead.

For more information, see [Custom vocabularies].

[1]: docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_namesString

Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If none of the languages of the specified custom vocabularies match the language identified in your media, your job fails.

This parameter is only intended for use with the ‘IdentifyLanguage` parameter. If you’re not including ‘IdentifyLanguage` in your request and want to use a custom vocabulary with your transcription, use the `VocabularyName` parameter instead.

For more information, see [Custom vocabularies].

[1]: docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html

Returns:

  • (String)


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1785

class StartStreamTranscriptionRequest < Struct.new(
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :vocabulary_name,
  :session_id,
  :audio_stream,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :show_speaker_label,
  :enable_channel_identification,
  :number_of_channels,
  :enable_partial_results_stabilization,
  :partial_results_stability,
  :content_identification_type,
  :content_redaction_type,
  :pii_entity_types,
  :language_model_name,
  :identify_language,
  :language_options,
  :preferred_language,
  :identify_multiple_languages,
  :vocabulary_names,
  :vocabulary_filter_names)
  SENSITIVE = []
  include Aws::Structure
end