AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.

Inheritance Hierarchy

System.Object
  Amazon.TranscribeService.Model.Settings

Namespace: Amazon.TranscribeService.Model
Assembly: AWSSDK.TranscribeService.dll
Version: 3.x.y.z

Syntax

C#
public class Settings

The Settings type exposes the following members

Constructors

NameDescription
Public Method Settings()

Properties

NameTypeDescription
Public Property ChannelIdentification System.Boolean

Gets and sets the property ChannelIdentification.

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.

For more information, see Transcribing multi-channel audio.

Public Property MaxAlternatives System.Int32

Gets and sets the property MaxAlternatives.

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe to include in your transcript.

If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.

If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true.

For more information, see Alternative transcriptions.

Public Property MaxSpeakerLabels System.Int32

Gets and sets the property MaxSpeakerLabels.

Specify the maximum number of speakers you want to partition in your media.

Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

Public Property ShowAlternatives System.Boolean

Gets and sets the property ShowAlternatives.

To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request.

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

If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe to generate.

For more information, see Alternative transcriptions.

Public Property ShowSpeakerLabels System.Boolean

Gets and sets the property ShowSpeakerLabels.

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

If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

For more information, see Partitioning speakers (diarization).

Public Property VocabularyFilterMethod Amazon.TranscribeService.VocabularyFilterMethod

Gets and sets the property VocabularyFilterMethod.

Specify how you want your custom 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.

Public Property VocabularyFilterName System.String

Gets and sets the property VocabularyFilterName.

The name of the custom vocabulary filter you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

Public Property VocabularyName System.String

Gets and sets the property VocabularyName.

The name of the custom vocabulary you want to use in your transcription job request. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5