Package com.google.cloud.dialogflow.v2

Class 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 how to process the audio content.
    Protobuf type google.cloud.dialogflow.v2.InputAudioConfig
    See Also:
    Serialized Form

    • 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

      • LANGUAGE_CODE_FIELD_NUMBER

        public static final int LANGUAGE_CODE_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

      • SPEECH_CONTEXTS_FIELD_NUMBER

        public static final int SPEECH_CONTEXTS_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

      • DISABLE_NO_SPEECH_RECOGNIZED_EVENT_FIELD_NUMBER

        public static final int DISABLE_NO_SPEECH_RECOGNIZED_EVENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_AUTOMATIC_PUNCTUATION_FIELD_NUMBER

        public static final int ENABLE_AUTOMATIC_PUNCTUATION_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.v2.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.v2.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAudioEncoding in interface InputAudioConfigOrBuilder
        Returns:
        The audioEncoding.

      • getSampleRateHertz

        public int getSampleRateHertz()
         Required. 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 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSampleRateHertz in interface InputAudioConfigOrBuilder
        Returns:
        The sampleRateHertz.

      • getLanguageCode

        public String getLanguageCode()
         Required. The language of the supplied audio. Dialogflow does not do
 translations. See [Language
 Support](https://cloud.google.com/dialogflow/docs/reference/language)
 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];
        Specified by:
        getLanguageCode in interface InputAudioConfigOrBuilder
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        public com.google.protobuf.ByteString getLanguageCodeBytes()
         Required. The language of the supplied audio. Dialogflow does not do
 translations. See [Language
 Support](https://cloud.google.com/dialogflow/docs/reference/language)
 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];
        Specified by:
        getLanguageCodeBytes in interface InputAudioConfigOrBuilder
        Returns:
        The bytes for languageCode.

      • getEnableWordInfo

        public boolean getEnableWordInfo()
         If `true`, Dialogflow returns
 [SpeechWordInfo][google.cloud.dialogflow.v2.SpeechWordInfo] in
 [StreamingRecognitionResult][google.cloud.dialogflow.v2.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

        @Deprecated
public com.google.protobuf.ProtocolStringList 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](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 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];
        Specified by:
        getPhraseHintsList in interface InputAudioConfigOrBuilder
        Returns:
        A list containing the phraseHints.

      • getPhraseHintsCount

        @Deprecated
public 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](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 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];
        Specified by:
        getPhraseHintsCount in interface InputAudioConfigOrBuilder
        Returns:
        The count of phraseHints.

      • getPhraseHints

        @Deprecated
public 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](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 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];
        Specified by:
        getPhraseHints in interface InputAudioConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The phraseHints at the given index.

      • getPhraseHintsBytes

        @Deprecated
public com.google.protobuf.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](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 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];
        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.

      • getSpeechContextsList

        public List<SpeechContext> getSpeechContextsList()
         Context information to assist speech recognition.

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
        repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;
        Specified by:
        getSpeechContextsList in interface InputAudioConfigOrBuilder

      • getSpeechContextsOrBuilderList

        public List<? extends SpeechContextOrBuilder> getSpeechContextsOrBuilderList()
         Context information to assist speech recognition.

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
        repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;
        Specified by:
        getSpeechContextsOrBuilderList in interface InputAudioConfigOrBuilder

      • getSpeechContextsCount

        public int getSpeechContextsCount()
         Context information to assist speech recognition.

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
        repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;
        Specified by:
        getSpeechContextsCount in interface InputAudioConfigOrBuilder

      • getSpeechContexts

        public SpeechContext getSpeechContexts​(int index)
         Context information to assist speech recognition.

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
        repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;
        Specified by:
        getSpeechContexts in interface InputAudioConfigOrBuilder

      • getSpeechContextsOrBuilder

        public SpeechContextOrBuilder getSpeechContextsOrBuilder​(int index)
         Context information to assist speech recognition.

 See [the Cloud Speech
 documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints)
 for more details.
        repeated .google.cloud.dialogflow.v2.SpeechContext speech_contexts = 11;
        Specified by:
        getSpeechContextsOrBuilder in interface InputAudioConfigOrBuilder

      • getModel

        public 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](https://cloud.google.com/speech-to-text/docs/basics#select-model)
 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;
        Specified by:
        getModel in interface InputAudioConfigOrBuilder
        Returns:
        The model.

      • getModelBytes

        public com.google.protobuf.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](https://cloud.google.com/speech-to-text/docs/basics#select-model)
 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;
        Specified by:
        getModelBytes in interface InputAudioConfigOrBuilder
        Returns:
        The bytes for model.

      • getModelVariantValue

        public int getModelVariantValue()
         Which variant of the [Speech
 model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.
        .google.cloud.dialogflow.v2.SpeechModelVariant model_variant = 10;
        Specified by:
        getModelVariantValue in interface InputAudioConfigOrBuilder
        Returns:
        The enum numeric value on the wire for modelVariant.

      • getModelVariant

        public SpeechModelVariant getModelVariant()
         Which variant of the [Speech
 model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.
        .google.cloud.dialogflow.v2.SpeechModelVariant model_variant = 10;
        Specified by:
        getModelVariant in interface InputAudioConfigOrBuilder
        Returns:
        The modelVariant.

      • getSingleUtterance

        public 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;
        Specified by:
        getSingleUtterance in interface InputAudioConfigOrBuilder
        Returns:
        The singleUtterance.

      • getDisableNoSpeechRecognizedEvent

        public boolean getDisableNoSpeechRecognizedEvent()
         Only used in
 [Participants.AnalyzeContent][google.cloud.dialogflow.v2.Participants.AnalyzeContent]
 and
 [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2.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;
        Specified by:
        getDisableNoSpeechRecognizedEvent in interface InputAudioConfigOrBuilder
        Returns:
        The disableNoSpeechRecognizedEvent.

      • getEnableAutomaticPunctuation

        public boolean getEnableAutomaticPunctuation()
         Enable automatic punctuation option at the speech backend.
        bool enable_automatic_punctuation = 17;
        Specified by:
        getEnableAutomaticPunctuation in interface InputAudioConfigOrBuilder
        Returns:
        The enableAutomaticPunctuation.

      • 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​(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

      • 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

      • 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