com.google.cloud.dialogflow.cx.v3

Class InputAudioConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.cx.v3.InputAudioConfig

All Implemented Interfaces:

InputAudioConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class InputAudioConfig
extends com.google.protobuf.GeneratedMessageV3
implements InputAudioConfigOrBuilder

 Instructs the speech recognizer on how to process the audio content.
 

Protobuf type google.cloud.dialogflow.cx.v3.InputAudioConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InputAudioConfig.Builder Instructs the speech recognizer on how to process the audio content.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUDIO_ENCODING_FIELD_NUMBER
static int	BARGE_IN_CONFIG_FIELD_NUMBER
static int	ENABLE_WORD_INFO_FIELD_NUMBER
static int	MODEL_FIELD_NUMBER
static int	MODEL_VARIANT_FIELD_NUMBER
static int	OPT_OUT_CONFORMER_MODEL_MIGRATION_FIELD_NUMBER
static int	PHRASE_HINTS_FIELD_NUMBER
static int	SAMPLE_RATE_HERTZ_FIELD_NUMBER
static int	SINGLE_UTTERANCE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
static InputAudioConfig	getDefaultInstance()
InputAudioConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<InputAudioConfig>	getParserForType()
String	getPhraseHints(int index) Optional.
com.google.protobuf.ByteString	getPhraseHintsBytes(int index) Optional.
int	getPhraseHintsCount() Optional.
com.google.protobuf.ProtocolStringList	getPhraseHintsList() Optional.
int	getSampleRateHertz() Sample rate (in Hertz) of the audio content sent in the query.
int	getSerializedSize()
boolean	getSingleUtterance() Optional.
boolean	hasBargeInConfig() Configuration of barge-in behavior during the streaming of input audio.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static InputAudioConfig.Builder	newBuilder()
static InputAudioConfig.Builder	newBuilder(InputAudioConfig prototype)
InputAudioConfig.Builder	newBuilderForType()
protected InputAudioConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static InputAudioConfig	parseDelimitedFrom(InputStream input)
static InputAudioConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InputAudioConfig	parseFrom(byte[] data)
static InputAudioConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InputAudioConfig	parseFrom(ByteBuffer data)
static InputAudioConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InputAudioConfig	parseFrom(com.google.protobuf.ByteString data)
static InputAudioConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InputAudioConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static InputAudioConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static InputAudioConfig	parseFrom(InputStream input)
static InputAudioConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<InputAudioConfig>	parser()
InputAudioConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

AUDIO_ENCODING_FIELD_NUMBER

public static final int AUDIO_ENCODING_FIELD_NUMBER

See Also:

Constant Field Values

SAMPLE_RATE_HERTZ_FIELD_NUMBER

public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_WORD_INFO_FIELD_NUMBER

public static final int ENABLE_WORD_INFO_FIELD_NUMBER

See Also:

Constant Field Values

PHRASE_HINTS_FIELD_NUMBER

public static final int PHRASE_HINTS_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER

See Also:

Constant Field Values

MODEL_VARIANT_FIELD_NUMBER

public static final int MODEL_VARIANT_FIELD_NUMBER

See Also:

Constant Field Values

SINGLE_UTTERANCE_FIELD_NUMBER

public static final int SINGLE_UTTERANCE_FIELD_NUMBER

See Also:

Constant Field Values

BARGE_IN_CONFIG_FIELD_NUMBER

public static final int BARGE_IN_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

OPT_OUT_CONFORMER_MODEL_MIGRATION_FIELD_NUMBER

public static final int OPT_OUT_CONFORMER_MODEL_MIGRATION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getAudioEncodingValue

public 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];

Specified by:

getAudioEncodingValue in interface InputAudioConfigOrBuilder

Returns:

The enum numeric value on the wire for audioEncoding.

getAudioEncoding

public 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];

Specified by:

getAudioEncoding in interface InputAudioConfigOrBuilder

Returns:

The audioEncoding.

getSampleRateHertz

public 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;

Specified by:

getSampleRateHertz in interface InputAudioConfigOrBuilder

Returns:

The sampleRateHertz.

getEnableWordInfo

public 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;

Specified by:

getEnableWordInfo in interface InputAudioConfigOrBuilder

Returns:

The enableWordInfo.

getPhraseHintsList

public com.google.protobuf.ProtocolStringList 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;

Specified by:

getPhraseHintsList in interface InputAudioConfigOrBuilder

Returns:

A list containing the phraseHints.

getPhraseHintsCount

public 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;

Specified by:

getPhraseHintsCount in interface InputAudioConfigOrBuilder

Returns:

The count of phraseHints.

getPhraseHints

public 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;

Specified by:

getPhraseHints in interface InputAudioConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The phraseHints at the given index.

getPhraseHintsBytes

public 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;

Specified by:

getPhraseHintsBytes in interface InputAudioConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the phraseHints at the given index.

getModel

public 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;

Specified by:

getModel in interface InputAudioConfigOrBuilder

Returns:

The model.

getModelBytes

public 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;

Specified by:

getModelBytes in interface InputAudioConfigOrBuilder

Returns:

The bytes for model.

getModelVariantValue

public 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;

Specified by:

getModelVariantValue in interface InputAudioConfigOrBuilder

Returns:

The enum numeric value on the wire for modelVariant.

getModelVariant

public 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;

Specified by:

getModelVariant in interface InputAudioConfigOrBuilder

Returns:

The modelVariant.

getSingleUtterance

public 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;

Specified by:

getSingleUtterance in interface InputAudioConfigOrBuilder

Returns:

The singleUtterance.

hasBargeInConfig

public boolean hasBargeInConfig()

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

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

Specified by:

hasBargeInConfig in interface InputAudioConfigOrBuilder

Returns:

Whether the bargeInConfig field is set.

getBargeInConfig

public BargeInConfig getBargeInConfig()

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

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

Specified by:

getBargeInConfig in interface InputAudioConfigOrBuilder

Returns:

The bargeInConfig.

getBargeInConfigOrBuilder

public BargeInConfigOrBuilder getBargeInConfigOrBuilder()

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

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

Specified by:

getBargeInConfigOrBuilder in interface InputAudioConfigOrBuilder

getOptOutConformerModelMigration

public 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;

Specified by:

getOptOutConformerModelMigration in interface InputAudioConfigOrBuilder

Returns:

The optOutConformerModelMigration.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static InputAudioConfig parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InputAudioConfig parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InputAudioConfig parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InputAudioConfig parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InputAudioConfig parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InputAudioConfig parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static InputAudioConfig parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static InputAudioConfig parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static InputAudioConfig parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static InputAudioConfig parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static InputAudioConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static InputAudioConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public InputAudioConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static InputAudioConfig.Builder newBuilder()

newBuilder

public static InputAudioConfig.Builder newBuilder(InputAudioConfig prototype)

toBuilder

public InputAudioConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected InputAudioConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static InputAudioConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<InputAudioConfig> parser()

getParserForType

public com.google.protobuf.Parser<InputAudioConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public InputAudioConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder