Class InputAudioConfig (0.48.0)

public final class InputAudioConfig extends GeneratedMessageV3 implements InputAudioConfigOrBuilder

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

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

Static Fields

AUDIO_ENCODING_FIELD_NUMBER

public static final int AUDIO_ENCODING_FIELD_NUMBER
Field Value
TypeDescription
int

BARGE_IN_CONFIG_FIELD_NUMBER

public static final int BARGE_IN_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_WORD_INFO_FIELD_NUMBER

public static final int ENABLE_WORD_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_VARIANT_FIELD_NUMBER

public static final int MODEL_VARIANT_FIELD_NUMBER
Field Value
TypeDescription
int

OPT_OUT_CONFORMER_MODEL_MIGRATION_FIELD_NUMBER

public static final int OPT_OUT_CONFORMER_MODEL_MIGRATION_FIELD_NUMBER
Field Value
TypeDescription
int

PHRASE_HINTS_FIELD_NUMBER

public static final int PHRASE_HINTS_FIELD_NUMBER
Field Value
TypeDescription
int

SAMPLE_RATE_HERTZ_FIELD_NUMBER

public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER
Field Value
TypeDescription
int

SINGLE_UTTERANCE_FIELD_NUMBER

public static final int SINGLE_UTTERANCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InputAudioConfig getDefaultInstance()
Returns
TypeDescription
InputAudioConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static InputAudioConfig.Builder newBuilder()
Returns
TypeDescription
InputAudioConfig.Builder

newBuilder(InputAudioConfig prototype)

public static InputAudioConfig.Builder newBuilder(InputAudioConfig prototype)
Parameter
NameDescription
prototypeInputAudioConfig
Returns
TypeDescription
InputAudioConfig.Builder

parseDelimitedFrom(InputStream input)

public static InputAudioConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InputAudioConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InputAudioConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InputAudioConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InputAudioConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InputAudioConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InputAudioConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InputAudioConfig> parser()
Returns
TypeDescription
Parser<InputAudioConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAudioEncoding()

public AudioEncoding getAudioEncoding()

Required. Audio encoding of the audio content to process.

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

Returns
TypeDescription
AudioEncoding

The audioEncoding.

getAudioEncodingValue()

public int getAudioEncodingValue()

Required. Audio encoding of the audio content to process.

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

Returns
TypeDescription
int

The enum numeric value on the wire for audioEncoding.

getBargeInConfig()

public BargeInConfig getBargeInConfig()

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

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

Returns
TypeDescription
BargeInConfig

The bargeInConfig.

getBargeInConfigOrBuilder()

public BargeInConfigOrBuilder getBargeInConfigOrBuilder()

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

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

Returns
TypeDescription
BargeInConfigOrBuilder

getDefaultInstanceForType()

public InputAudioConfig getDefaultInstanceForType()
Returns
TypeDescription
InputAudioConfig

getEnableWordInfo()

public boolean getEnableWordInfo()

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

The enableWordInfo.

getModel()

public String getModel()

Optional. Which Speech model to select for the given request. For more information, see Speech models.

string model = 7;

Returns
TypeDescription
String

The model.

getModelBytes()

public ByteString getModelBytes()

Optional. Which Speech model to select for the given request. For more information, see Speech models.

string model = 7;

Returns
TypeDescription
ByteString

The bytes for model.

getModelVariant()

public SpeechModelVariant getModelVariant()

Optional. Which variant of the Speech model to use.

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

Returns
TypeDescription
SpeechModelVariant

The modelVariant.

getModelVariantValue()

public int getModelVariantValue()

Optional. Which variant of the Speech model to use.

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

Returns
TypeDescription
int

The enum numeric value on the wire for modelVariant.

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

  1. Please refer to Dialogflow CX Speech model migration.

bool opt_out_conformer_model_migration = 26;

Returns
TypeDescription
boolean

The optOutConformerModelMigration.

getParserForType()

public Parser<InputAudioConfig> getParserForType()
Returns
TypeDescription
Parser<InputAudioConfig>
Overrides

getPhraseHints(int index)

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 for more details.

repeated string phrase_hints = 4;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The phraseHints at the given index.

getPhraseHintsBytes(int index)

public 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 for more details.

repeated string phrase_hints = 4;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the phraseHints at the given index.

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 for more details.

repeated string phrase_hints = 4;

Returns
TypeDescription
int

The count of phraseHints.

getPhraseHintsList()

public 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 for more details.

repeated string phrase_hints = 4;

Returns
TypeDescription
ProtocolStringList

A list containing the phraseHints.

getSampleRateHertz()

public int getSampleRateHertz()

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;

Returns
TypeDescription
int

The sampleRateHertz.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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;

Returns
TypeDescription
boolean

The singleUtterance.

hasBargeInConfig()

public boolean hasBargeInConfig()

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

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

Returns
TypeDescription
boolean

Whether the bargeInConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public InputAudioConfig.Builder newBuilderForType()
Returns
TypeDescription
InputAudioConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InputAudioConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InputAudioConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public InputAudioConfig.Builder toBuilder()
Returns
TypeDescription
InputAudioConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException