Class RecognitionConfig (2.5.0)

public sealed class RecognitionConfig : IMessage<RecognitionConfig>, IEquatable<RecognitionConfig>, IDeepCloneable<RecognitionConfig>, IBufferMessage, IMessage

Provides information to the recognizer that specifies how to process the request.

Inheritance

Object > RecognitionConfig

Namespace

Google.Cloud.Speech.V1

Assembly

Google.Cloud.Speech.V1.dll

Constructors

RecognitionConfig()

public RecognitionConfig()

RecognitionConfig(RecognitionConfig)

public RecognitionConfig(RecognitionConfig other)
Parameter
NameDescription
otherRecognitionConfig

Properties

AudioChannelCount

public int AudioChannelCount { get; set; }

The number of channels in the input audio data. ONLY set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are 1-8. Valid values for OGG_OPUS are '1'-'254'. Valid value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only 1. If 0 or omitted, defaults to one channel (mono). Note: We only recognize the first channel by default. To perform independent recognition on each channel set enable_separate_recognition_per_channel to 'true'.

Property Value
TypeDescription
Int32

DiarizationConfig

public SpeakerDiarizationConfig DiarizationConfig { get; set; }

Config to enable speaker diarization and set additional parameters to make diarization better suited for your application. Note: When this is enabled, we send all the words from the beginning of the audio for the top alternative in every consecutive STREAMING responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. For non-streaming requests, the diarization results will be provided only in the top alternative of the FINAL SpeechRecognitionResult.

Property Value
TypeDescription
SpeakerDiarizationConfig

EnableAutomaticPunctuation

public bool EnableAutomaticPunctuation { get; set; }

If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses.

Property Value
TypeDescription
Boolean

EnableSeparateRecognitionPerChannel

public bool EnableSeparateRecognitionPerChannel { get; set; }

This needs to be set to true explicitly and audio_channel_count > 1 to get each channel recognized separately. The recognition result will contain a channel_tag field to state which channel that result belongs to. If this is not true, we will only recognize the first channel. The request is billed cumulatively for all channels recognized: audio_channel_count multiplied by the length of the audio.

Property Value
TypeDescription
Boolean

EnableWordTimeOffsets

public bool EnableWordTimeOffsets { get; set; }

If true, the top result includes a list of words and the start and end time offsets (timestamps) for those words. If false, no word-level time offset information is returned. The default is false.

Property Value
TypeDescription
Boolean

Encoding

public RecognitionConfig.Types.AudioEncoding Encoding { get; set; }

Encoding of audio data sent in all RecognitionAudio messages. This field is optional for FLAC and WAV audio files and required for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding].

Property Value
TypeDescription
RecognitionConfig.Types.AudioEncoding

LanguageCode

public string LanguageCode { get; set; }

Required. The language of the supplied audio as a BCP-47 language tag. Example: "en-US". See Language Support for a list of the currently supported language codes.

Property Value
TypeDescription
String

MaxAlternatives

public int MaxAlternatives { get; set; }

Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of SpeechRecognitionAlternative messages within each SpeechRecognitionResult. The server may return fewer than max_alternatives. Valid values are 0-30. A value of 0 or 1 will return a maximum of one. If omitted, will return a maximum of one.

Property Value
TypeDescription
Int32

Metadata

public RecognitionMetadata Metadata { get; set; }

Metadata regarding this request.

Property Value
TypeDescription
RecognitionMetadata

Model

public string Model { get; set; }

Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig. <table> <tr> <td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr> <td><code>command_and_search</code></td> <td>Best for short queries such as voice commands or voice search.</td> </tr> <tr> <td><code>phone_call</code></td> <td>Best for audio that originated from a phone call (typically recorded at an 8khz sampling rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best for audio that originated from video or includes multiple speakers. Ideally the audio is recorded at a 16khz or greater sampling rate. This is a premium model that costs more than the standard rate.</td> </tr> <tr> <td><code>default</code></td> <td>Best for audio that is not one of the specific audio models. For example, long-form audio. Ideally the audio is high-fidelity, recorded at a 16khz or greater sampling rate.</td> </tr> </table>

Property Value
TypeDescription
String

ProfanityFilter

public bool ProfanityFilter { get; set; }

If set to true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to false or omitted, profanities won't be filtered out.

Property Value
TypeDescription
Boolean

SampleRateHertz

public int SampleRateHertz { get; set; }

Sample rate in Hertz of the audio data sent in all RecognitionAudio messages. Valid values are: 8000-48000. 16000 is optimal. For best results, set the sampling rate of the audio source to 16000 Hz. If that's not possible, use the native sample rate of the audio source (instead of re-sampling). This field is optional for FLAC and WAV audio files, but is required for all other audio formats. For details, see [AudioEncoding][google.cloud.speech.v1.RecognitionConfig.AudioEncoding].

Property Value
TypeDescription
Int32

SpeechContexts

public RepeatedField<SpeechContext> SpeechContexts { get; }

Array of [SpeechContext][google.cloud.speech.v1.SpeechContext]. A means to provide context to assist the speech recognition. For more information, see speech adaptation.

Property Value
TypeDescription
RepeatedField<SpeechContext>

UseEnhanced

public bool UseEnhanced { get; set; }

Set to true to use an enhanced model for speech recognition. If use_enhanced is set to true and the model field is not set, then an appropriate enhanced model is chosen if an enhanced model exists for the audio.

If use_enhanced is true and an enhanced version of the specified model does not exist, then the speech is recognized using the standard version of the specified model.

Property Value
TypeDescription
Boolean