Interface InputAudioConfigOrBuilder (4.37.0) 

public interface InputAudioConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudioEncoding()

public abstract AudioEncoding getAudioEncoding()

Required. Audio encoding of the audio content to process.

.google.cloud.dialogflow.v2.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AudioEncoding

The audioEncoding.

getAudioEncodingValue()

public abstract int getAudioEncodingValue()

Required. Audio encoding of the audio content to process.

.google.cloud.dialogflow.v2.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for audioEncoding.

getDisableNoSpeechRecognizedEvent()

public abstract boolean getDisableNoSpeechRecognizedEvent()

Only used in Participants.AnalyzeContent and Participants.StreamingAnalyzeContent. If false and recognition doesn't return any result, trigger NO_SPEECH_RECOGNIZED event to Dialogflow agent.

bool disable_no_speech_recognized_event = 14;

Returns
Type Description
boolean

The disableNoSpeechRecognizedEvent.

getEnableAutomaticPunctuation()

public abstract boolean getEnableAutomaticPunctuation()

Enable automatic punctuation option at the speech backend.

bool enable_automatic_punctuation = 17;

Returns
Type Description
boolean

The enableAutomaticPunctuation.

getEnableWordInfo()

public abstract boolean getEnableWordInfo()

If true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.

bool enable_word_info = 13;

Returns
Type Description
boolean

The enableWordInfo.

getLanguageCode()

public abstract String getLanguageCode()

Required. The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

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

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

Required. The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.

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

Returns
Type Description
ByteString

The bytes for languageCode.

getModel()

public abstract String getModel()

Which Speech 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 InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance:

  • phone_call (best for Agent Assist and telephony)
  • latest_short (best for Dialogflow non-telephony)
  • command_and_search (best for very short utterances and commands)

string model = 7;

Returns
Type Description
String

The model.

getModelBytes()

public abstract ByteString getModelBytes()

Which Speech 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 InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to Cloud Speech API documentation for more details. If you specify a model, the following models typically have the best performance:

  • phone_call (best for Agent Assist and telephony)
  • latest_short (best for Dialogflow non-telephony)
  • command_and_search (best for very short utterances and commands)

string model = 7;

Returns
Type Description
ByteString

The bytes for model.

getModelVariant()

public abstract SpeechModelVariant getModelVariant()

Which variant of the Speech model to use.

.google.cloud.dialogflow.v2.SpeechModelVariant model_variant = 10;

Returns
Type Description
SpeechModelVariant

The modelVariant.

getModelVariantValue()

public abstract int getModelVariantValue()

Which variant of the Speech model to use.

.google.cloud.dialogflow.v2.SpeechModelVariant model_variant = 10;

Returns
Type Description
int

The enum numeric value on the wire for modelVariant.

getPhraseHints(int index) (deprecated)

public abstract String getPhraseHints(int index)

Deprecated. google.cloud.dialogflow.v2.InputAudioConfig.phrase_hints is deprecated. See google/cloud/dialogflow/v2/audio_config.proto;l=129

A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

See the Cloud Speech documentation for more details.

This field is deprecated. Please use speech_contexts instead. If you specify both phrase_hints and speech_contexts, Dialogflow will treat the phrase_hints as a single additional SpeechContext.

repeated string phrase_hints = 4 [deprecated = true];

Parameter
Name Description
index int

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

The phraseHints at the given index.

getPhraseHintsBytes(int index) (deprecated)

public abstract ByteString getPhraseHintsBytes(int index)

Deprecated. google.cloud.dialogflow.v2.InputAudioConfig.phrase_hints is deprecated. See google/cloud/dialogflow/v2/audio_config.proto;l=129

A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

See the Cloud Speech documentation for more details.

This field is deprecated. Please use speech_contexts instead. If you specify both phrase_hints and speech_contexts, Dialogflow will treat the phrase_hints as a single additional SpeechContext.

repeated string phrase_hints = 4 [deprecated = true];

Parameter
Name Description
index int

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

The bytes of the phraseHints at the given index.

getPhraseHintsCount() (deprecated)

public abstract int getPhraseHintsCount()

Deprecated. google.cloud.dialogflow.v2.InputAudioConfig.phrase_hints is deprecated. See google/cloud/dialogflow/v2/audio_config.proto;l=129

A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

See the Cloud Speech documentation for more details.

This field is deprecated. Please use speech_contexts instead. If you specify both phrase_hints and speech_contexts, Dialogflow will treat the phrase_hints as a single additional SpeechContext.

repeated string phrase_hints = 4 [deprecated = true];

Returns
Type Description
int

The count of phraseHints.

getPhraseHintsList() (deprecated)

public abstract List<String> getPhraseHintsList()

Deprecated. google.cloud.dialogflow.v2.InputAudioConfig.phrase_hints is deprecated. See google/cloud/dialogflow/v2/audio_config.proto;l=129

A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood.

See the Cloud Speech documentation for more details.

This field is deprecated. Please use speech_contexts instead. If you specify both phrase_hints and speech_contexts, Dialogflow will treat the phrase_hints as a single additional SpeechContext.

repeated string phrase_hints = 4 [deprecated = true];

Returns
Type Description
List<String>

A list containing the phraseHints.

getSampleRateHertz()

public abstract int getSampleRateHertz()

Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.

int32 sample_rate_hertz = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The sampleRateHertz.

getSingleUtterance()

public abstract boolean getSingleUtterance()

If false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance.

bool single_utterance = 8;

Returns
Type Description
boolean

The singleUtterance.

getSpeechContexts(int index)

public abstract SpeechContext getSpeechContexts(int index)

Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;

Parameter
Name Description
index int
Returns
Type Description
SpeechContext

getSpeechContextsCount()

public abstract int getSpeechContextsCount()

Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;

Returns
Type Description
int

getSpeechContextsList()

public abstract List<SpeechContext> getSpeechContextsList()

Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;

Returns
Type Description
List<SpeechContext>

getSpeechContextsOrBuilder(int index)

public abstract SpeechContextOrBuilder getSpeechContextsOrBuilder(int index)

Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;

Parameter
Name Description
index int
Returns
Type Description
SpeechContextOrBuilder

getSpeechContextsOrBuilderList()

public abstract List<? extends SpeechContextOrBuilder> getSpeechContextsOrBuilderList()

Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.SpeechContextOrBuilder>