com.google.cloud.dialogflow.cx.v3

Interface InputAudioConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

InputAudioConfig, InputAudioConfig.Builder

public interface InputAudioConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AudioEncoding	getAudioEncoding() Required.
int	getAudioEncodingValue() Required.
BargeInConfig	getBargeInConfig() Configuration of barge-in behavior during the streaming of input audio.
BargeInConfigOrBuilder	getBargeInConfigOrBuilder() Configuration of barge-in behavior during the streaming of input audio.
boolean	getEnableWordInfo() Optional.
String	getModel() Optional.
com.google.protobuf.ByteString	getModelBytes() Optional.
SpeechModelVariant	getModelVariant() Optional.
int	getModelVariantValue() Optional.
boolean	getOptOutConformerModelMigration() If `true`, the request will opt out for STT conformer model migration.
String	getPhraseHints(int index) Optional.
com.google.protobuf.ByteString	getPhraseHintsBytes(int index) Optional.
int	getPhraseHintsCount() Optional.
List<String>	getPhraseHintsList() Optional.
int	getSampleRateHertz() Sample rate (in Hertz) of the audio content sent in the query.
boolean	getSingleUtterance() Optional.
boolean	hasBargeInConfig() Configuration of barge-in behavior during the streaming of input audio.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getAudioEncodingValue

int getAudioEncodingValue()

 Required. Audio encoding of the audio content to process.
 

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

Returns:

The enum numeric value on the wire for audioEncoding.

getAudioEncoding

AudioEncoding getAudioEncoding()

 Required. Audio encoding of the audio content to process.
 

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

Returns:

The audioEncoding.

getSampleRateHertz

int getSampleRateHertz()

 Sample rate (in Hertz) of the audio content sent in the query.
 Refer to
 [Cloud Speech API
 documentation](https://cloud.google.com/speech-to-text/docs/basics) for
 more details.
 

int32 sample_rate_hertz = 2;

Returns:

The sampleRateHertz.

getEnableWordInfo

boolean getEnableWordInfo()

 Optional. If `true`, Dialogflow returns
 [SpeechWordInfo][google.cloud.dialogflow.cx.v3.SpeechWordInfo] in
 [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3.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:

The enableWordInfo.

getPhraseHintsList

List<String> getPhraseHintsList()

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

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
 

repeated string phrase_hints = 4;

Returns:

A list containing the phraseHints.

getPhraseHintsCount

int getPhraseHintsCount()

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

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
 

repeated string phrase_hints = 4;

Returns:

The count of phraseHints.

getPhraseHints

String getPhraseHints(int index)

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

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
 

repeated string phrase_hints = 4;

Parameters:

index - The index of the element to return.

Returns:

The phraseHints at the given index.

getPhraseHintsBytes

com.google.protobuf.ByteString getPhraseHintsBytes(int index)

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

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
 

repeated string phrase_hints = 4;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the phraseHints at the given index.

getModel

String getModel()

 Optional. Which Speech model to select for the given request.
 For more information, see
 [Speech
 models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
 

string model = 7;

Returns:

The model.

getModelBytes

com.google.protobuf.ByteString getModelBytes()

 Optional. Which Speech model to select for the given request.
 For more information, see
 [Speech
 models](https://cloud.google.com/dialogflow/cx/docs/concept/speech-models).
 

string model = 7;

Returns:

The bytes for model.

getModelVariantValue

int getModelVariantValue()

 Optional. Which variant of the [Speech
 model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
 

.google.cloud.dialogflow.cx.v3.SpeechModelVariant model_variant = 10;

Returns:

The enum numeric value on the wire for modelVariant.

getModelVariant

SpeechModelVariant getModelVariant()

 Optional. Which variant of the [Speech
 model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.
 

.google.cloud.dialogflow.cx.v3.SpeechModelVariant model_variant = 10;

Returns:

The modelVariant.

getSingleUtterance

boolean getSingleUtterance()

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

bool single_utterance = 8;

Returns:

The singleUtterance.

hasBargeInConfig

boolean hasBargeInConfig()

 Configuration of barge-in behavior during the streaming of input audio.
 

.google.cloud.dialogflow.cx.v3.BargeInConfig barge_in_config = 15;

Returns:

Whether the bargeInConfig field is set.

getBargeInConfig

BargeInConfig getBargeInConfig()

 Configuration of barge-in behavior during the streaming of input audio.
 

.google.cloud.dialogflow.cx.v3.BargeInConfig barge_in_config = 15;

Returns:

The bargeInConfig.

getBargeInConfigOrBuilder

BargeInConfigOrBuilder getBargeInConfigOrBuilder()

 Configuration of barge-in behavior during the streaming of input audio.
 

.google.cloud.dialogflow.cx.v3.BargeInConfig barge_in_config = 15;

getOptOutConformerModelMigration

boolean getOptOutConformerModelMigration()

 If `true`, the request will opt out for STT conformer model migration.
 This field will be deprecated once force migration takes place in June
 2024. Please refer to [Dialogflow CX Speech model
 migration](https://cloud.google.com/dialogflow/cx/docs/concept/speech-model-migration).
 

bool opt_out_conformer_model_migration = 26;

Returns:

The optOutConformerModelMigration.