Class RecognitionConfig.Builder (4.50.0) 

public static final class RecognitionConfig.Builder extends GeneratedMessageV3.Builder<RecognitionConfig.Builder> implements RecognitionConfigOrBuilder

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

Protobuf type google.cloud.speech.v1p1beta1.RecognitionConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RecognitionConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAlternativeLanguageCodes(Iterable<String> values)

public RecognitionConfig.Builder addAllAlternativeLanguageCodes(Iterable<String> values)

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

repeated string alternative_language_codes = 18;

Parameter
Name Description
values Iterable<String>

The alternativeLanguageCodes to add.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

addAllSpeechContexts(Iterable<? extends SpeechContext> values)

public RecognitionConfig.Builder addAllSpeechContexts(Iterable<? extends SpeechContext> values)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameter
Name Description
values Iterable<? extends com.google.cloud.speech.v1p1beta1.SpeechContext>
Returns
Type Description
RecognitionConfig.Builder

addAlternativeLanguageCodes(String value)

public RecognitionConfig.Builder addAlternativeLanguageCodes(String value)

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

repeated string alternative_language_codes = 18;

Parameter
Name Description
value String

The alternativeLanguageCodes to add.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

addAlternativeLanguageCodesBytes(ByteString value)

public RecognitionConfig.Builder addAlternativeLanguageCodesBytes(ByteString value)

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

repeated string alternative_language_codes = 18;

Parameter
Name Description
value ByteString

The bytes of the alternativeLanguageCodes to add.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RecognitionConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecognitionConfig.Builder
Overrides

addSpeechContexts(SpeechContext value)

public RecognitionConfig.Builder addSpeechContexts(SpeechContext value)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameter
Name Description
value SpeechContext
Returns
Type Description
RecognitionConfig.Builder

addSpeechContexts(SpeechContext.Builder builderForValue)

public RecognitionConfig.Builder addSpeechContexts(SpeechContext.Builder builderForValue)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameter
Name Description
builderForValue SpeechContext.Builder
Returns
Type Description
RecognitionConfig.Builder

addSpeechContexts(int index, SpeechContext value)

public RecognitionConfig.Builder addSpeechContexts(int index, SpeechContext value)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameters
Name Description
index int
value SpeechContext
Returns
Type Description
RecognitionConfig.Builder

addSpeechContexts(int index, SpeechContext.Builder builderForValue)

public RecognitionConfig.Builder addSpeechContexts(int index, SpeechContext.Builder builderForValue)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameters
Name Description
index int
builderForValue SpeechContext.Builder
Returns
Type Description
RecognitionConfig.Builder

addSpeechContextsBuilder()

public SpeechContext.Builder addSpeechContextsBuilder()

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Returns
Type Description
SpeechContext.Builder

addSpeechContextsBuilder(int index)

public SpeechContext.Builder addSpeechContextsBuilder(int index)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameter
Name Description
index int
Returns
Type Description
SpeechContext.Builder

build()

public RecognitionConfig build()
Returns
Type Description
RecognitionConfig

buildPartial()

public RecognitionConfig buildPartial()
Returns
Type Description
RecognitionConfig

clear()

public RecognitionConfig.Builder clear()
Returns
Type Description
RecognitionConfig.Builder
Overrides

clearAdaptation()

public RecognitionConfig.Builder clearAdaptation()

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

.google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;

Returns
Type Description
RecognitionConfig.Builder

clearAlternativeLanguageCodes()

public RecognitionConfig.Builder clearAlternativeLanguageCodes()

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

repeated string alternative_language_codes = 18;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearAudioChannelCount()

public RecognitionConfig.Builder clearAudioChannelCount()

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

int32 audio_channel_count = 7;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearDiarizationConfig()

public RecognitionConfig.Builder clearDiarizationConfig()

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.

.google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;

Returns
Type Description
RecognitionConfig.Builder

clearDiarizationSpeakerCount() (deprecated)

public RecognitionConfig.Builder clearDiarizationSpeakerCount()

Deprecated. google.cloud.speech.v1p1beta1.RecognitionConfig.diarization_speaker_count is deprecated. See google/cloud/speech/v1p1beta1/cloud_speech.proto;l=406

If set, specifies the estimated number of speakers in the conversation. Defaults to '2'. Ignored unless enable_speaker_diarization is set to true. Note: Use diarization_config instead.

int32 diarization_speaker_count = 17 [deprecated = true];

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearEnableAutomaticPunctuation()

public RecognitionConfig.Builder clearEnableAutomaticPunctuation()

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.

bool enable_automatic_punctuation = 11;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearEnableSeparateRecognitionPerChannel()

public RecognitionConfig.Builder clearEnableSeparateRecognitionPerChannel()

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.

bool enable_separate_recognition_per_channel = 12;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearEnableSpeakerDiarization() (deprecated)

public RecognitionConfig.Builder clearEnableSpeakerDiarization()

Deprecated. google.cloud.speech.v1p1beta1.RecognitionConfig.enable_speaker_diarization is deprecated. See google/cloud/speech/v1p1beta1/cloud_speech.proto;l=401

If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: Use diarization_config instead.

bool enable_speaker_diarization = 16 [deprecated = true];

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearEnableSpokenEmojis()

public RecognitionConfig.Builder clearEnableSpokenEmojis()

The spoken emoji behavior for the call If not set, uses default behavior based on model of choice If 'true', adds spoken emoji formatting for the request. This will replace spoken emojis with the corresponding Unicode symbols in the final transcript. If 'false', spoken emojis are not replaced.

.google.protobuf.BoolValue enable_spoken_emojis = 23;

Returns
Type Description
RecognitionConfig.Builder

clearEnableSpokenPunctuation()

public RecognitionConfig.Builder clearEnableSpokenPunctuation()

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.

.google.protobuf.BoolValue enable_spoken_punctuation = 22;

Returns
Type Description
RecognitionConfig.Builder

clearEnableWordConfidence()

public RecognitionConfig.Builder clearEnableWordConfidence()

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.

bool enable_word_confidence = 15;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearEnableWordTimeOffsets()

public RecognitionConfig.Builder clearEnableWordTimeOffsets()

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.

bool enable_word_time_offsets = 8;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearEncoding()

public RecognitionConfig.Builder clearEncoding()

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.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RecognitionConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RecognitionConfig.Builder
Overrides

clearLanguageCode()

public RecognitionConfig.Builder clearLanguageCode()

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.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearMaxAlternatives()

public RecognitionConfig.Builder clearMaxAlternatives()

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.

int32 max_alternatives = 4;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearMetadata()

public RecognitionConfig.Builder clearMetadata()

Metadata regarding this request.

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

Returns
Type Description
RecognitionConfig.Builder

clearModel()

public RecognitionConfig.Builder clearModel()

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>latest_long</code></td> <td>Best for long form content like media or conversation.</td> </tr> <tr> <td><code>latest_short</code></td> <td>Best for short form content like commands or single shot directed speech.</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> <tr> <td><code>medical_conversation</code></td> <td>Best for audio that originated from a conversation between a medical provider and patient.</td> </tr> <tr> <td><code>medical_dictation</code></td> <td>Best for audio that originated from dictation notes by a medical provider.</td> </tr> </table>

string model = 13;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RecognitionConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RecognitionConfig.Builder
Overrides

clearProfanityFilter()

public RecognitionConfig.Builder clearProfanityFilter()

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.

bool profanity_filter = 5;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearSampleRateHertz()

public RecognitionConfig.Builder clearSampleRateHertz()

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.

int32 sample_rate_hertz = 2;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clearSpeechContexts()

public RecognitionConfig.Builder clearSpeechContexts()

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Returns
Type Description
RecognitionConfig.Builder

clearTranscriptNormalization()

public RecognitionConfig.Builder clearTranscriptNormalization()

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.

.google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;

Returns
Type Description
RecognitionConfig.Builder

clearUseEnhanced()

public RecognitionConfig.Builder clearUseEnhanced()

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.

bool use_enhanced = 14;

Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

clone()

public RecognitionConfig.Builder clone()
Returns
Type Description
RecognitionConfig.Builder
Overrides

getAdaptation()

public SpeechAdaptation getAdaptation()

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

.google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;

Returns
Type Description
SpeechAdaptation

The adaptation.

getAdaptationBuilder()

public SpeechAdaptation.Builder getAdaptationBuilder()

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

.google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;

Returns
Type Description
SpeechAdaptation.Builder

getAdaptationOrBuilder()

public SpeechAdaptationOrBuilder getAdaptationOrBuilder()

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

.google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;

Returns
Type Description
SpeechAdaptationOrBuilder

getAlternativeLanguageCodes(int index)

public String getAlternativeLanguageCodes(int index)

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

repeated string alternative_language_codes = 18;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The alternativeLanguageCodes at the given index.

getAlternativeLanguageCodesBytes(int index)

public ByteString getAlternativeLanguageCodesBytes(int index)

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

repeated string alternative_language_codes = 18;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the alternativeLanguageCodes at the given index.

getAlternativeLanguageCodesCount()

public int getAlternativeLanguageCodesCount()

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

repeated string alternative_language_codes = 18;

Returns
Type Description
int

The count of alternativeLanguageCodes.

getAlternativeLanguageCodesList()

public ProtocolStringList getAlternativeLanguageCodesList()

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

repeated string alternative_language_codes = 18;

Returns
Type Description
ProtocolStringList

A list containing the alternativeLanguageCodes.

getAudioChannelCount()

public int getAudioChannelCount()

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

int32 audio_channel_count = 7;

Returns
Type Description
int

The audioChannelCount.

getDefaultInstanceForType()

public RecognitionConfig getDefaultInstanceForType()
Returns
Type Description
RecognitionConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDiarizationConfig()

public SpeakerDiarizationConfig getDiarizationConfig()

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.

.google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;

Returns
Type Description
SpeakerDiarizationConfig

The diarizationConfig.

getDiarizationConfigBuilder()

public SpeakerDiarizationConfig.Builder getDiarizationConfigBuilder()

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.

.google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;

Returns
Type Description
SpeakerDiarizationConfig.Builder

getDiarizationConfigOrBuilder()

public SpeakerDiarizationConfigOrBuilder getDiarizationConfigOrBuilder()

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.

.google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;

Returns
Type Description
SpeakerDiarizationConfigOrBuilder

getDiarizationSpeakerCount() (deprecated)

public int getDiarizationSpeakerCount()

Deprecated. google.cloud.speech.v1p1beta1.RecognitionConfig.diarization_speaker_count is deprecated. See google/cloud/speech/v1p1beta1/cloud_speech.proto;l=406

If set, specifies the estimated number of speakers in the conversation. Defaults to '2'. Ignored unless enable_speaker_diarization is set to true. Note: Use diarization_config instead.

int32 diarization_speaker_count = 17 [deprecated = true];

Returns
Type Description
int

The diarizationSpeakerCount.

getEnableAutomaticPunctuation()

public boolean getEnableAutomaticPunctuation()

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.

bool enable_automatic_punctuation = 11;

Returns
Type Description
boolean

The enableAutomaticPunctuation.

getEnableSeparateRecognitionPerChannel()

public boolean getEnableSeparateRecognitionPerChannel()

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.

bool enable_separate_recognition_per_channel = 12;

Returns
Type Description
boolean

The enableSeparateRecognitionPerChannel.

getEnableSpeakerDiarization() (deprecated)

public boolean getEnableSpeakerDiarization()

Deprecated. google.cloud.speech.v1p1beta1.RecognitionConfig.enable_speaker_diarization is deprecated. See google/cloud/speech/v1p1beta1/cloud_speech.proto;l=401

If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: Use diarization_config instead.

bool enable_speaker_diarization = 16 [deprecated = true];

Returns
Type Description
boolean

The enableSpeakerDiarization.

getEnableSpokenEmojis()

public BoolValue getEnableSpokenEmojis()

The spoken emoji behavior for the call If not set, uses default behavior based on model of choice If 'true', adds spoken emoji formatting for the request. This will replace spoken emojis with the corresponding Unicode symbols in the final transcript. If 'false', spoken emojis are not replaced.

.google.protobuf.BoolValue enable_spoken_emojis = 23;

Returns
Type Description
BoolValue

The enableSpokenEmojis.

getEnableSpokenEmojisBuilder()

public BoolValue.Builder getEnableSpokenEmojisBuilder()

The spoken emoji behavior for the call If not set, uses default behavior based on model of choice If 'true', adds spoken emoji formatting for the request. This will replace spoken emojis with the corresponding Unicode symbols in the final transcript. If 'false', spoken emojis are not replaced.

.google.protobuf.BoolValue enable_spoken_emojis = 23;

Returns
Type Description
Builder

getEnableSpokenEmojisOrBuilder()

public BoolValueOrBuilder getEnableSpokenEmojisOrBuilder()

The spoken emoji behavior for the call If not set, uses default behavior based on model of choice If 'true', adds spoken emoji formatting for the request. This will replace spoken emojis with the corresponding Unicode symbols in the final transcript. If 'false', spoken emojis are not replaced.

.google.protobuf.BoolValue enable_spoken_emojis = 23;

Returns
Type Description
BoolValueOrBuilder

getEnableSpokenPunctuation()

public BoolValue getEnableSpokenPunctuation()

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.

.google.protobuf.BoolValue enable_spoken_punctuation = 22;

Returns
Type Description
BoolValue

The enableSpokenPunctuation.

getEnableSpokenPunctuationBuilder()

public BoolValue.Builder getEnableSpokenPunctuationBuilder()

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.

.google.protobuf.BoolValue enable_spoken_punctuation = 22;

Returns
Type Description
Builder

getEnableSpokenPunctuationOrBuilder()

public BoolValueOrBuilder getEnableSpokenPunctuationOrBuilder()

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.

.google.protobuf.BoolValue enable_spoken_punctuation = 22;

Returns
Type Description
BoolValueOrBuilder

getEnableWordConfidence()

public boolean getEnableWordConfidence()

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.

bool enable_word_confidence = 15;

Returns
Type Description
boolean

The enableWordConfidence.

getEnableWordTimeOffsets()

public boolean getEnableWordTimeOffsets()

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.

bool enable_word_time_offsets = 8;

Returns
Type Description
boolean

The enableWordTimeOffsets.

getEncoding()

public RecognitionConfig.AudioEncoding getEncoding()

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.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;

Returns
Type Description
RecognitionConfig.AudioEncoding

The encoding.

getEncodingValue()

public int getEncodingValue()

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.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;

Returns
Type Description
int

The enum numeric value on the wire for encoding.

getLanguageCode()

public String getLanguageCode()

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.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

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.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for languageCode.

getMaxAlternatives()

public int getMaxAlternatives()

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.

int32 max_alternatives = 4;

Returns
Type Description
int

The maxAlternatives.

getMetadata()

public RecognitionMetadata getMetadata()

Metadata regarding this request.

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

Returns
Type Description
RecognitionMetadata

The metadata.

getMetadataBuilder()

public RecognitionMetadata.Builder getMetadataBuilder()

Metadata regarding this request.

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

Returns
Type Description
RecognitionMetadata.Builder

getMetadataOrBuilder()

public RecognitionMetadataOrBuilder getMetadataOrBuilder()

Metadata regarding this request.

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

Returns
Type Description
RecognitionMetadataOrBuilder

getModel()

public String getModel()

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>latest_long</code></td> <td>Best for long form content like media or conversation.</td> </tr> <tr> <td><code>latest_short</code></td> <td>Best for short form content like commands or single shot directed speech.</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> <tr> <td><code>medical_conversation</code></td> <td>Best for audio that originated from a conversation between a medical provider and patient.</td> </tr> <tr> <td><code>medical_dictation</code></td> <td>Best for audio that originated from dictation notes by a medical provider.</td> </tr> </table>

string model = 13;

Returns
Type Description
String

The model.

getModelBytes()

public ByteString getModelBytes()

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>latest_long</code></td> <td>Best for long form content like media or conversation.</td> </tr> <tr> <td><code>latest_short</code></td> <td>Best for short form content like commands or single shot directed speech.</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> <tr> <td><code>medical_conversation</code></td> <td>Best for audio that originated from a conversation between a medical provider and patient.</td> </tr> <tr> <td><code>medical_dictation</code></td> <td>Best for audio that originated from dictation notes by a medical provider.</td> </tr> </table>

string model = 13;

Returns
Type Description
ByteString

The bytes for model.

getProfanityFilter()

public boolean getProfanityFilter()

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.

bool profanity_filter = 5;

Returns
Type Description
boolean

The profanityFilter.

getSampleRateHertz()

public int getSampleRateHertz()

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.

int32 sample_rate_hertz = 2;

Returns
Type Description
int

The sampleRateHertz.

getSpeechContexts(int index)

public SpeechContext getSpeechContexts(int index)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameter
Name Description
index int
Returns
Type Description
SpeechContext

getSpeechContextsBuilder(int index)

public SpeechContext.Builder getSpeechContextsBuilder(int index)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameter
Name Description
index int
Returns
Type Description
SpeechContext.Builder

getSpeechContextsBuilderList()

public List<SpeechContext.Builder> getSpeechContextsBuilderList()

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Returns
Type Description
List<Builder>

getSpeechContextsCount()

public int getSpeechContextsCount()

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Returns
Type Description
int

getSpeechContextsList()

public List<SpeechContext> getSpeechContextsList()

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Returns
Type Description
List<SpeechContext>

getSpeechContextsOrBuilder(int index)

public SpeechContextOrBuilder getSpeechContextsOrBuilder(int index)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameter
Name Description
index int
Returns
Type Description
SpeechContextOrBuilder

getSpeechContextsOrBuilderList()

public List<? extends SpeechContextOrBuilder> getSpeechContextsOrBuilderList()

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Returns
Type Description
List<? extends com.google.cloud.speech.v1p1beta1.SpeechContextOrBuilder>

getTranscriptNormalization()

public TranscriptNormalization getTranscriptNormalization()

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.

.google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;

Returns
Type Description
TranscriptNormalization

The transcriptNormalization.

getTranscriptNormalizationBuilder()

public TranscriptNormalization.Builder getTranscriptNormalizationBuilder()

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.

.google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;

Returns
Type Description
TranscriptNormalization.Builder

getTranscriptNormalizationOrBuilder()

public TranscriptNormalizationOrBuilder getTranscriptNormalizationOrBuilder()

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.

.google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;

Returns
Type Description
TranscriptNormalizationOrBuilder

getUseEnhanced()

public boolean getUseEnhanced()

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.

bool use_enhanced = 14;

Returns
Type Description
boolean

The useEnhanced.

hasAdaptation()

public boolean hasAdaptation()

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

.google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;

Returns
Type Description
boolean

Whether the adaptation field is set.

hasDiarizationConfig()

public boolean hasDiarizationConfig()

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.

.google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;

Returns
Type Description
boolean

Whether the diarizationConfig field is set.

hasEnableSpokenEmojis()

public boolean hasEnableSpokenEmojis()

The spoken emoji behavior for the call If not set, uses default behavior based on model of choice If 'true', adds spoken emoji formatting for the request. This will replace spoken emojis with the corresponding Unicode symbols in the final transcript. If 'false', spoken emojis are not replaced.

.google.protobuf.BoolValue enable_spoken_emojis = 23;

Returns
Type Description
boolean

Whether the enableSpokenEmojis field is set.

hasEnableSpokenPunctuation()

public boolean hasEnableSpokenPunctuation()

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.

.google.protobuf.BoolValue enable_spoken_punctuation = 22;

Returns
Type Description
boolean

Whether the enableSpokenPunctuation field is set.

hasMetadata()

public boolean hasMetadata()

Metadata regarding this request.

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

Returns
Type Description
boolean

Whether the metadata field is set.

hasTranscriptNormalization()

public boolean hasTranscriptNormalization()

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.

.google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;

Returns
Type Description
boolean

Whether the transcriptNormalization field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdaptation(SpeechAdaptation value)

public RecognitionConfig.Builder mergeAdaptation(SpeechAdaptation value)

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

.google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;

Parameter
Name Description
value SpeechAdaptation
Returns
Type Description
RecognitionConfig.Builder

mergeDiarizationConfig(SpeakerDiarizationConfig value)

public RecognitionConfig.Builder mergeDiarizationConfig(SpeakerDiarizationConfig value)

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.

.google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;

Parameter
Name Description
value SpeakerDiarizationConfig
Returns
Type Description
RecognitionConfig.Builder

mergeEnableSpokenEmojis(BoolValue value)

public RecognitionConfig.Builder mergeEnableSpokenEmojis(BoolValue value)

The spoken emoji behavior for the call If not set, uses default behavior based on model of choice If 'true', adds spoken emoji formatting for the request. This will replace spoken emojis with the corresponding Unicode symbols in the final transcript. If 'false', spoken emojis are not replaced.

.google.protobuf.BoolValue enable_spoken_emojis = 23;

Parameter
Name Description
value BoolValue
Returns
Type Description
RecognitionConfig.Builder

mergeEnableSpokenPunctuation(BoolValue value)

public RecognitionConfig.Builder mergeEnableSpokenPunctuation(BoolValue value)

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.

.google.protobuf.BoolValue enable_spoken_punctuation = 22;

Parameter
Name Description
value BoolValue
Returns
Type Description
RecognitionConfig.Builder

mergeFrom(RecognitionConfig other)

public RecognitionConfig.Builder mergeFrom(RecognitionConfig other)
Parameter
Name Description
other RecognitionConfig
Returns
Type Description
RecognitionConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RecognitionConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RecognitionConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RecognitionConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RecognitionConfig.Builder
Overrides

mergeMetadata(RecognitionMetadata value)

public RecognitionConfig.Builder mergeMetadata(RecognitionMetadata value)

Metadata regarding this request.

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

Parameter
Name Description
value RecognitionMetadata
Returns
Type Description
RecognitionConfig.Builder

mergeTranscriptNormalization(TranscriptNormalization value)

public RecognitionConfig.Builder mergeTranscriptNormalization(TranscriptNormalization value)

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.

.google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;

Parameter
Name Description
value TranscriptNormalization
Returns
Type Description
RecognitionConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RecognitionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RecognitionConfig.Builder
Overrides

removeSpeechContexts(int index)

public RecognitionConfig.Builder removeSpeechContexts(int index)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameter
Name Description
index int
Returns
Type Description
RecognitionConfig.Builder

setAdaptation(SpeechAdaptation value)

public RecognitionConfig.Builder setAdaptation(SpeechAdaptation value)

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

.google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;

Parameter
Name Description
value SpeechAdaptation
Returns
Type Description
RecognitionConfig.Builder

setAdaptation(SpeechAdaptation.Builder builderForValue)

public RecognitionConfig.Builder setAdaptation(SpeechAdaptation.Builder builderForValue)

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

.google.cloud.speech.v1p1beta1.SpeechAdaptation adaptation = 20;

Parameter
Name Description
builderForValue SpeechAdaptation.Builder
Returns
Type Description
RecognitionConfig.Builder

setAlternativeLanguageCodes(int index, String value)

public RecognitionConfig.Builder setAlternativeLanguageCodes(int index, String value)

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

repeated string alternative_language_codes = 18;

Parameters
Name Description
index int

The index to set the value at.
value String

The alternativeLanguageCodes to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setAudioChannelCount(int value)

public RecognitionConfig.Builder setAudioChannelCount(int value)

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

int32 audio_channel_count = 7;

Parameter
Name Description
value int

The audioChannelCount to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setDiarizationConfig(SpeakerDiarizationConfig value)

public RecognitionConfig.Builder setDiarizationConfig(SpeakerDiarizationConfig value)

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.

.google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;

Parameter
Name Description
value SpeakerDiarizationConfig
Returns
Type Description
RecognitionConfig.Builder

setDiarizationConfig(SpeakerDiarizationConfig.Builder builderForValue)

public RecognitionConfig.Builder setDiarizationConfig(SpeakerDiarizationConfig.Builder builderForValue)

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.

.google.cloud.speech.v1p1beta1.SpeakerDiarizationConfig diarization_config = 19;

Parameter
Name Description
builderForValue SpeakerDiarizationConfig.Builder
Returns
Type Description
RecognitionConfig.Builder

setDiarizationSpeakerCount(int value) (deprecated)

public RecognitionConfig.Builder setDiarizationSpeakerCount(int value)

Deprecated. google.cloud.speech.v1p1beta1.RecognitionConfig.diarization_speaker_count is deprecated. See google/cloud/speech/v1p1beta1/cloud_speech.proto;l=406

If set, specifies the estimated number of speakers in the conversation. Defaults to '2'. Ignored unless enable_speaker_diarization is set to true. Note: Use diarization_config instead.

int32 diarization_speaker_count = 17 [deprecated = true];

Parameter
Name Description
value int

The diarizationSpeakerCount to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setEnableAutomaticPunctuation(boolean value)

public RecognitionConfig.Builder setEnableAutomaticPunctuation(boolean value)

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.

bool enable_automatic_punctuation = 11;

Parameter
Name Description
value boolean

The enableAutomaticPunctuation to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setEnableSeparateRecognitionPerChannel(boolean value)

public RecognitionConfig.Builder setEnableSeparateRecognitionPerChannel(boolean value)

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.

bool enable_separate_recognition_per_channel = 12;

Parameter
Name Description
value boolean

The enableSeparateRecognitionPerChannel to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setEnableSpeakerDiarization(boolean value) (deprecated)

public RecognitionConfig.Builder setEnableSpeakerDiarization(boolean value)

Deprecated. google.cloud.speech.v1p1beta1.RecognitionConfig.enable_speaker_diarization is deprecated. See google/cloud/speech/v1p1beta1/cloud_speech.proto;l=401

If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: Use diarization_config instead.

bool enable_speaker_diarization = 16 [deprecated = true];

Parameter
Name Description
value boolean

The enableSpeakerDiarization to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setEnableSpokenEmojis(BoolValue value)

public RecognitionConfig.Builder setEnableSpokenEmojis(BoolValue value)

The spoken emoji behavior for the call If not set, uses default behavior based on model of choice If 'true', adds spoken emoji formatting for the request. This will replace spoken emojis with the corresponding Unicode symbols in the final transcript. If 'false', spoken emojis are not replaced.

.google.protobuf.BoolValue enable_spoken_emojis = 23;

Parameter
Name Description
value BoolValue
Returns
Type Description
RecognitionConfig.Builder

setEnableSpokenEmojis(BoolValue.Builder builderForValue)

public RecognitionConfig.Builder setEnableSpokenEmojis(BoolValue.Builder builderForValue)

The spoken emoji behavior for the call If not set, uses default behavior based on model of choice If 'true', adds spoken emoji formatting for the request. This will replace spoken emojis with the corresponding Unicode symbols in the final transcript. If 'false', spoken emojis are not replaced.

.google.protobuf.BoolValue enable_spoken_emojis = 23;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RecognitionConfig.Builder

setEnableSpokenPunctuation(BoolValue value)

public RecognitionConfig.Builder setEnableSpokenPunctuation(BoolValue value)

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.

.google.protobuf.BoolValue enable_spoken_punctuation = 22;

Parameter
Name Description
value BoolValue
Returns
Type Description
RecognitionConfig.Builder

setEnableSpokenPunctuation(BoolValue.Builder builderForValue)

public RecognitionConfig.Builder setEnableSpokenPunctuation(BoolValue.Builder builderForValue)

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.

.google.protobuf.BoolValue enable_spoken_punctuation = 22;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RecognitionConfig.Builder

setEnableWordConfidence(boolean value)

public RecognitionConfig.Builder setEnableWordConfidence(boolean value)

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.

bool enable_word_confidence = 15;

Parameter
Name Description
value boolean

The enableWordConfidence to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setEnableWordTimeOffsets(boolean value)

public RecognitionConfig.Builder setEnableWordTimeOffsets(boolean value)

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.

bool enable_word_time_offsets = 8;

Parameter
Name Description
value boolean

The enableWordTimeOffsets to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setEncoding(RecognitionConfig.AudioEncoding value)

public RecognitionConfig.Builder setEncoding(RecognitionConfig.AudioEncoding value)

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.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;

Parameter
Name Description
value RecognitionConfig.AudioEncoding

The encoding to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setEncodingValue(int value)

public RecognitionConfig.Builder setEncodingValue(int value)

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.v1p1beta1.RecognitionConfig.AudioEncoding encoding = 1;

Parameter
Name Description
value int

The enum numeric value on the wire for encoding to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RecognitionConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecognitionConfig.Builder
Overrides

setLanguageCode(String value)

public RecognitionConfig.Builder setLanguageCode(String value)

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.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The languageCode to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setLanguageCodeBytes(ByteString value)

public RecognitionConfig.Builder setLanguageCodeBytes(ByteString value)

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.

string language_code = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for languageCode to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setMaxAlternatives(int value)

public RecognitionConfig.Builder setMaxAlternatives(int value)

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.

int32 max_alternatives = 4;

Parameter
Name Description
value int

The maxAlternatives to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setMetadata(RecognitionMetadata value)

public RecognitionConfig.Builder setMetadata(RecognitionMetadata value)

Metadata regarding this request.

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

Parameter
Name Description
value RecognitionMetadata
Returns
Type Description
RecognitionConfig.Builder

setMetadata(RecognitionMetadata.Builder builderForValue)

public RecognitionConfig.Builder setMetadata(RecognitionMetadata.Builder builderForValue)

Metadata regarding this request.

.google.cloud.speech.v1p1beta1.RecognitionMetadata metadata = 9;

Parameter
Name Description
builderForValue RecognitionMetadata.Builder
Returns
Type Description
RecognitionConfig.Builder

setModel(String value)

public RecognitionConfig.Builder setModel(String value)

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>latest_long</code></td> <td>Best for long form content like media or conversation.</td> </tr> <tr> <td><code>latest_short</code></td> <td>Best for short form content like commands or single shot directed speech.</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> <tr> <td><code>medical_conversation</code></td> <td>Best for audio that originated from a conversation between a medical provider and patient.</td> </tr> <tr> <td><code>medical_dictation</code></td> <td>Best for audio that originated from dictation notes by a medical provider.</td> </tr> </table>

string model = 13;

Parameter
Name Description
value String

The model to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setModelBytes(ByteString value)

public RecognitionConfig.Builder setModelBytes(ByteString value)

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>latest_long</code></td> <td>Best for long form content like media or conversation.</td> </tr> <tr> <td><code>latest_short</code></td> <td>Best for short form content like commands or single shot directed speech.</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> <tr> <td><code>medical_conversation</code></td> <td>Best for audio that originated from a conversation between a medical provider and patient.</td> </tr> <tr> <td><code>medical_dictation</code></td> <td>Best for audio that originated from dictation notes by a medical provider.</td> </tr> </table>

string model = 13;

Parameter
Name Description
value ByteString

The bytes for model to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setProfanityFilter(boolean value)

public RecognitionConfig.Builder setProfanityFilter(boolean value)

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.

bool profanity_filter = 5;

Parameter
Name Description
value boolean

The profanityFilter to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RecognitionConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RecognitionConfig.Builder
Overrides

setSampleRateHertz(int value)

public RecognitionConfig.Builder setSampleRateHertz(int value)

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.

int32 sample_rate_hertz = 2;

Parameter
Name Description
value int

The sampleRateHertz to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.

setSpeechContexts(int index, SpeechContext value)

public RecognitionConfig.Builder setSpeechContexts(int index, SpeechContext value)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameters
Name Description
index int
value SpeechContext
Returns
Type Description
RecognitionConfig.Builder

setSpeechContexts(int index, SpeechContext.Builder builderForValue)

public RecognitionConfig.Builder setSpeechContexts(int index, SpeechContext.Builder builderForValue)

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

repeated .google.cloud.speech.v1p1beta1.SpeechContext speech_contexts = 6;

Parameters
Name Description
index int
builderForValue SpeechContext.Builder
Returns
Type Description
RecognitionConfig.Builder

setTranscriptNormalization(TranscriptNormalization value)

public RecognitionConfig.Builder setTranscriptNormalization(TranscriptNormalization value)

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.

.google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;

Parameter
Name Description
value TranscriptNormalization
Returns
Type Description
RecognitionConfig.Builder

setTranscriptNormalization(TranscriptNormalization.Builder builderForValue)

public RecognitionConfig.Builder setTranscriptNormalization(TranscriptNormalization.Builder builderForValue)

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.

.google.cloud.speech.v1p1beta1.TranscriptNormalization transcript_normalization = 24;

Parameter
Name Description
builderForValue TranscriptNormalization.Builder
Returns
Type Description
RecognitionConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RecognitionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RecognitionConfig.Builder
Overrides

setUseEnhanced(boolean value)

public RecognitionConfig.Builder setUseEnhanced(boolean value)

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.

bool use_enhanced = 14;

Parameter
Name Description
value boolean

The useEnhanced to set.
Returns
Type Description
RecognitionConfig.Builder

This builder for chaining.