Class Settings

Inheritance

object

Settings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Glitch9.AIDevKit.AmazonAws.Transcribe

Assembly: Glitch9.AIDevKit.Provider.AmazonAws.dll

Syntax

public class Settings

Properties

ChannelIdentification

Optional. 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.

Declaration

public bool? ChannelIdentification { get; set; }

Property Value

Type	Description
bool?

MaxAlternatives

Optional. 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.

Declaration

public int? MaxAlternatives { get; set; }

Property Value

Type	Description
int?

MaxSpeakerLabels

Optional. 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.

Declaration

public int? MaxSpeakerLabels { get; set; }

Property Value

Type	Description
int?

ShowAlternatives

Optional. 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.

Declaration

public bool? ShowAlternatives { get; set; }

Property Value

Type	Description
bool?

ShowSpeakerLabels

Optional. 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.

Declaration

public bool? ShowSpeakerLabels { get; set; }

Property Value

Type	Description
bool?

VocabularyFilterMethod

Optional. 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.

Declaration

public string VocabularyFilterMethod { get; set; }

Property Value

Type	Description
string

VocabularyFilterName

Optional. 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 AWS account.

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

Declaration

public string VocabularyFilterName { get; set; }

Property Value

Type	Description
string

VocabularyName

Optional. 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 AWS account.

Declaration

public string VocabularyName { get; set; }

Property Value

Type	Description
string

Extension Methods

ArrayExtensions.ToArrayOrEmpty<T>(T)

ArrayExtensions.ToArrayOrNull<T>(T)

EventExtensions.ToDelta<T>(T, string, int, string, bool)

EventExtensions.ToDone<T>(T, string, int, string)

EventExtensions.ToEvent<T>(T)

EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)

FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)

ResponseCastingExtensions.GetResult<T>(T)

SystemExtensions.GetName(object)