Class InputAudioConfig (0.43.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.v3.InputAudioConfig

Static Fields

AUDIO_ENCODING_FIELD_NUMBER

public static final int AUDIO_ENCODING_FIELD_NUMBER
Field Value
Type Description
int

BARGE_IN_CONFIG_FIELD_NUMBER

public static final int BARGE_IN_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_WORD_INFO_FIELD_NUMBER

public static final int ENABLE_WORD_INFO_FIELD_NUMBER
Field Value
Type Description
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER
Field Value
Type Description
int

MODEL_VARIANT_FIELD_NUMBER

public static final int MODEL_VARIANT_FIELD_NUMBER
Field Value
Type Description
int

PHRASE_HINTS_FIELD_NUMBER

public static final int PHRASE_HINTS_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_RATE_HERTZ_FIELD_NUMBER

public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER
Field Value
Type Description
int

SINGLE_UTTERANCE_FIELD_NUMBER

public static final int SINGLE_UTTERANCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static InputAudioConfig getDefaultInstance()
Returns
Type Description
InputAudioConfig

getDescriptor()

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

newBuilder()

public static InputAudioConfig.Builder newBuilder()
Returns
Type Description
InputAudioConfig.Builder

newBuilder(InputAudioConfig prototype)

public static InputAudioConfig.Builder newBuilder(InputAudioConfig prototype)
Parameter
Name Description
prototype InputAudioConfig
Returns
Type Description
InputAudioConfig.Builder

parseDelimitedFrom(InputStream input)

public static InputAudioConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static InputAudioConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InputAudioConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InputAudioConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static InputAudioConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static InputAudioConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InputAudioConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InputAudioConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<InputAudioConfig> parser()
Returns
Type Description
Parser<InputAudioConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

Returns
Type Description
AudioEncoding

The audioEncoding.

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

Returns
Type Description
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.v3.BargeInConfig barge_in_config = 15;

Returns
Type Description
BargeInConfig

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;

Returns
Type Description
BargeInConfigOrBuilder

getDefaultInstanceForType()

public InputAudioConfig getDefaultInstanceForType()
Returns
Type Description
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
Type Description
boolean

The enableWordInfo.

getModel()

public String getModel()

Optional. 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 Dialogflow auto-selects a model based on other parameters in the InputAudioConfig and Agent settings. 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

    Leave this field unspecified to use Agent Speech settings for model selection.

string model = 7;

Returns
Type Description
String

The model.

getModelBytes()

public ByteString getModelBytes()

Optional. 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 Dialogflow auto-selects a model based on other parameters in the InputAudioConfig and Agent settings. 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

    Leave this field unspecified to use Agent Speech settings for model selection.

string model = 7;

Returns
Type Description
ByteString

The bytes for model.

getModelVariant()

public SpeechModelVariant getModelVariant()

Optional. Which variant of the Speech model to use.

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

Returns
Type Description
SpeechModelVariant

The modelVariant.

getModelVariantValue()

public int getModelVariantValue()

Optional. Which variant of the Speech model to use.

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

Returns
Type Description
int

The enum numeric value on the wire for modelVariant.

getParserForType()

public Parser<InputAudioConfig> getParserForType()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
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()

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
Type Description
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
Type Description
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
Type Description
int

The sampleRateHertz.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

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;

Returns
Type Description
boolean

Whether the bargeInConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public InputAudioConfig.Builder newBuilderForType()
Returns
Type Description
InputAudioConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InputAudioConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
InputAudioConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public InputAudioConfig.Builder toBuilder()
Returns
Type Description
InputAudioConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException