Package com.google.cloud.dialogflow.cx.v3beta1

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 Detail

      • getAudioEncodingValue

        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:
        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.v3beta1.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.v3beta1.SpeechWordInfo] in
 [StreamingRecognitionResult][google.cloud.dialogflow.cx.v3beta1.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. 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;
        Returns:
        The model.

      • getModelBytes

        com.google.protobuf.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 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;
        Returns:
        The bytes for model.

      • getModelVariantValue

        int getModelVariantValue()
         Optional. Which variant of the [Speech
 model][google.cloud.dialogflow.cx.v3beta1.InputAudioConfig.model] to use.
        .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.InputAudioConfig.model] to use.
        .google.cloud.dialogflow.cx.v3beta1.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.