RecognitionConfig

encode

enum (audioencode)

Encoding of audio data sent in all RecognitionAudio message . This field is is is optional forFLAC and wav audio files and required for all other audio formats. For details, see audioencode.

sampleRateHertz

integer

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

audioChannelCount

integer

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

enableSeparateRecognitionPerChannel

boolean

This is needs need to be set totrue 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.

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.

alternativelanguagecode [ ]

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 languagecode. 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).

maxAlternatives

integer

maximum number of recognition hypothesis to be return . specifically , the maximum number ofSpeechRecognitionAlternative message within eachSpeechRecognitionResult. The server may return fewer than maxAlternatives. valid values is are are0–30. A value of 0 or 1 will return a maximum of one. If omitted, will return a maximum of one.

profanityFilter

boolean

If set totrue, 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 tofalse or omit , profanity wo n’t be filter out .

adaptation

object (SpeechAdaptation)

speech adaptation configuration is improves improve the accuracy of speech recognition . For more information , see the speech adaptation documentation . When speech adaptation is set it is supersedes supersede thespeechContexts field .

transcriptNormalization

object (TranscriptNormalization)

Use transcription normalization to automatically replace parts of the transcript with phrases of your choosing. For StreamingRecognize, this normalization only applies to stable partial transcripts (stability > 0.8) and final transcripts.

speechContexts[]

object (SpeechContext)

Array of SpeechContext. A means to provide context to assist the speech recognition. For more information, see speech adaptation.

enablewordtimeoffset

boolean

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.

enableWordConfidence

boolean

If true, the top result is includes include a list of word and the confidence for those word . Iffalse, no word-level confidence information is returned. The default is false.

enableAutomaticPunctuation

boolean

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.

enableSpokenPunctuation

boolean

The spoken punctuation behavior for the call If not set, uses default behavior based on model of choice e.g. command_and_search will enable spoken punctuation by default If ‘true’, replaces spoken punctuation with the corresponding symbols in the request. For example, “how are you question mark” becomes “how are you?”. See https://cloud.google.com/speech-to-text/docs/spoken-punctuation for support. If ‘false’, spoken punctuation is not replaced.

enableSpokenEmojis

boolean

The speak emoji behavior for the call If not set , use default behavior base on model of choice If ‘ true ‘ , add speak emoji format for the request . This is replace will replace speak emoji with the corresponding unicode symbol in the final transcript . If ‘ false ‘ , speak emoji are not replace .

enablespeakerdiarization
( deprecate )

boolean

If ‘true’, enables speaker detection for each recognized word in the top alternative of the recognition result using a speakerTag provided in the WordInfo. Note: Use diarizationConfig instead.

diarizationSpeakerCount
( deprecate )

integer

If set, specifies the estimated number of speakers in the conversation. Defaults to ‘2’. Ignored unless enablespeakerdiarization is set to true. Note: Use diarizationConfig instead.

diarizationConfig

object (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.

metadata

object (RecognitionMetadata)

Metadata regarding this request.

model

string

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.

Model	Description
latest_long	Best for long form content like media or conversation.
latest_short	Best for short form content like commands or single shot directed speech.
command_and_search	Best for short queries such as voice commands or voice search.
phone_call	good for audio that originate from a phone call ( typically record at an 8khz sampling rate ) .
video	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.
default	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.
medical_conversation	Best for audio that originated from a conversation between a medical provider and patient.
medical_dictation	good for audio that originate from dictation note by a medical provider .

useenhanced

boolean

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.

If useenhanced 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.