RecognitionConfigBeta class
Constructors
-
RecognitionConfigBeta({required AudioEncoding encoding, required String languageCode, int? sampleRateHertz, int audioChannelCount = 1, bool enableSeparateRecognitionPerChannel = false, int maxAlternatives = 1, bool profanityFilter = false, List<String> alternativeLanguageCodes = const [], List<SpeechContextBeta> speechContexts = const [], bool enableWordTimeOffsets = false, bool enableWordConfidence = false, bool enableAutomaticPunctuation = false, SpeakerDiarizationConfig? diarizationConfig, RecognitionMetadata? recognitionMetadata, RecognitionModel model = RecognitionModel.basic, bool useEnhanced = false})
-
Provides information to the recognizer
that specifies how to process the request.
Properties
-
alternativeLanguageCodes
→ List<String>
-
A list of up to 3 additional BCP-47 language tags, listing possible
alternative languages of the supplied audio. See Language Support for a
list of the currently supported language codes. If alternative languages
are listed, recognition result will contain recognition in the most likely
language detected including the main language_code. The recognition result
will include the language tag of the language detected in the audio. Note:
This feature is only supported for Voice Command and Voice Search use
cases and performance may vary for other use cases
(e.g., phone call transcription).
final
-
audioChannelCount
↔ int
-
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).
getter/setter pair
-
diarizationConfig
→ SpeakerDiarizationConfig?
-
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.
final
-
enableAutomaticPunctuation
↔ bool
-
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.
getter/setter pair
-
enableSeparateRecognitionPerChannel
↔ bool
-
This needs to be set to true explicitly and audioChannelCount > 1 to get
each channel recognized separately. The recognition result will contain a
channelTag 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:
audioChannelCount multiplied by the length of the audio.
getter/setter pair
-
enableWordConfidence
→ bool
-
If true, the top result includes a list of words and the confidence for
those words. If false, no word-level confidence information is returned.
The default is false.
final
-
enableWordTimeOffsets
↔ bool
-
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.
getter/setter pair
-
encoding
↔ AudioEncoding
-
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.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
languageCode
↔ String
-
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.
getter/setter pair
-
maxAlternatives
↔ int
-
Maximum number of recognition hypotheses to be returned.
Specifically, the maximum number of SpeechRecognitionAlternative
messages within each SpeechRecognitionResult.
The server may return fewer than maxAlternatives.
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.
getter/setter pair
-
model
↔ RecognitionModel
-
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.
getter/setter pair
-
profanityFilter
↔ bool
-
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.
getter/setter pair
-
recognitionMetadata
→ RecognitionMetadata?
-
Metadata regarding this request.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
sampleRateHertz
↔ int?
-
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.
getter/setter pair
-
speechContexts
→ List<SpeechContextBeta>
-
List of SpeechContext. A means to provide context to assist the
speech recognition. For more information,
see speech adaptation.
final
-
useEnhanced
↔ bool
-
Set to true to use an enhanced model for speech recognition.
If useEnhanced 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.
getter/setter pair
