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

Class InputAudioConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<InputAudioConfig.Builder>
com.google.cloud.dialogflow.cx.v3beta1.InputAudioConfig.Builder
All Implemented Interfaces:
InputAudioConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
InputAudioConfig
public static final class InputAudioConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<InputAudioConfig.Builder> implements InputAudioConfigOrBuilder
 Instructs the speech recognizer on how to process the audio content.
Protobuf type google.cloud.dialogflow.cx.v3beta1.InputAudioConfig

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<InputAudioConfig.Builder>

    • clear

      public InputAudioConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<InputAudioConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<InputAudioConfig.Builder>

    • getDefaultInstanceForType

      public InputAudioConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public InputAudioConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public InputAudioConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public InputAudioConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<InputAudioConfig.Builder>

    • mergeFrom

      public InputAudioConfig.Builder mergeFrom(InputAudioConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<InputAudioConfig.Builder>

    • mergeFrom

      public InputAudioConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<InputAudioConfig.Builder>
      Throws:
      IOException

    • 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];
      Specified by:
      getAudioEncodingValue in interface InputAudioConfigOrBuilder
      Returns:
      The enum numeric value on the wire for audioEncoding.

    • setAudioEncodingValue

      public InputAudioConfig.Builder setAudioEncodingValue(int value)
       Required. Audio encoding of the audio content to process.
      .google.cloud.dialogflow.cx.v3beta1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for audioEncoding to set.
      Returns:
      This builder for chaining.

    • 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];
      Specified by:
      getAudioEncoding in interface InputAudioConfigOrBuilder
      Returns:
      The audioEncoding.

    • setAudioEncoding

      public InputAudioConfig.Builder setAudioEncoding(AudioEncoding value)
       Required. Audio encoding of the audio content to process.
      .google.cloud.dialogflow.cx.v3beta1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The audioEncoding to set.
      Returns:
      This builder for chaining.

    • clearAudioEncoding

      public InputAudioConfig.Builder clearAudioEncoding()
       Required. Audio encoding of the audio content to process.
      .google.cloud.dialogflow.cx.v3beta1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • 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.

    • setSampleRateHertz

      public InputAudioConfig.Builder setSampleRateHertz(int value)
       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;
      Parameters:
      value - The sampleRateHertz to set.
      Returns:
      This builder for chaining.

    • clearSampleRateHertz

      public InputAudioConfig.Builder clearSampleRateHertz()
       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:
      This builder for chaining.

    • getEnableWordInfo

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

    • setEnableWordInfo

      public InputAudioConfig.Builder setEnableWordInfo(boolean value)
       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;
      Parameters:
      value - The enableWordInfo to set.
      Returns:
      This builder for chaining.

    • clearEnableWordInfo

      public InputAudioConfig.Builder clearEnableWordInfo()
       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:
      This builder for chaining.

    • 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.

    • setPhraseHints

      public InputAudioConfig.Builder setPhraseHints(int index, String value)
       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 to set the value at.
      value - The phraseHints to set.
      Returns:
      This builder for chaining.

    • addPhraseHints

      public InputAudioConfig.Builder addPhraseHints(String value)
       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:
      value - The phraseHints to add.
      Returns:
      This builder for chaining.

    • addAllPhraseHints

      public InputAudioConfig.Builder addAllPhraseHints(Iterable<String> values)
       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:
      values - The phraseHints to add.
      Returns:
      This builder for chaining.

    • clearPhraseHints

      public InputAudioConfig.Builder clearPhraseHints()
       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:
      This builder for chaining.

    • addPhraseHintsBytes

      public InputAudioConfig.Builder addPhraseHintsBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the phraseHints to add.
      Returns:
      This builder for chaining.

    • 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.

    • setModel

      public InputAudioConfig.Builder setModel(String value)
       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;
      Parameters:
      value - The model to set.
      Returns:
      This builder for chaining.

    • clearModel

      public InputAudioConfig.Builder clearModel()
       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;
      Returns:
      This builder for chaining.

    • setModelBytes

      public InputAudioConfig.Builder setModelBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for model to set.
      Returns:
      This builder for chaining.

    • getModelVariantValue

      public 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;
      Specified by:
      getModelVariantValue in interface InputAudioConfigOrBuilder
      Returns:
      The enum numeric value on the wire for modelVariant.

    • setModelVariantValue

      public InputAudioConfig.Builder setModelVariantValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for modelVariant to set.
      Returns:
      This builder for chaining.

    • getModelVariant

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

    • setModelVariant

      public InputAudioConfig.Builder setModelVariant(SpeechModelVariant value)
       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;
      Parameters:
      value - The modelVariant to set.
      Returns:
      This builder for chaining.

    • clearModelVariant

      public InputAudioConfig.Builder clearModelVariant()
       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:
      This builder for chaining.

    • 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.

    • setSingleUtterance

      public InputAudioConfig.Builder setSingleUtterance(boolean value)
       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;
      Parameters:
      value - The singleUtterance to set.
      Returns:
      This builder for chaining.

    • clearSingleUtterance

      public InputAudioConfig.Builder clearSingleUtterance()
       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:
      This builder for chaining.

    • 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;
      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.v3beta1.BargeInConfig barge_in_config = 15;
      Specified by:
      getBargeInConfig in interface InputAudioConfigOrBuilder
      Returns:
      The bargeInConfig.

    • setBargeInConfig

      public InputAudioConfig.Builder setBargeInConfig(BargeInConfig value)
       Configuration of barge-in behavior during the streaming of input audio.
      .google.cloud.dialogflow.cx.v3beta1.BargeInConfig barge_in_config = 15;

    • setBargeInConfig

      public InputAudioConfig.Builder setBargeInConfig(BargeInConfig.Builder builderForValue)
       Configuration of barge-in behavior during the streaming of input audio.
      .google.cloud.dialogflow.cx.v3beta1.BargeInConfig barge_in_config = 15;

    • mergeBargeInConfig

      public InputAudioConfig.Builder mergeBargeInConfig(BargeInConfig value)
       Configuration of barge-in behavior during the streaming of input audio.
      .google.cloud.dialogflow.cx.v3beta1.BargeInConfig barge_in_config = 15;

    • clearBargeInConfig

      public InputAudioConfig.Builder clearBargeInConfig()
       Configuration of barge-in behavior during the streaming of input audio.
      .google.cloud.dialogflow.cx.v3beta1.BargeInConfig barge_in_config = 15;

    • getBargeInConfigBuilder

      public BargeInConfig.Builder getBargeInConfigBuilder()
       Configuration of barge-in behavior during the streaming of input audio.
      .google.cloud.dialogflow.cx.v3beta1.BargeInConfig barge_in_config = 15;

    • 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;
      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.

    • setOptOutConformerModelMigration

      public InputAudioConfig.Builder setOptOutConformerModelMigration(boolean value)
       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;
      Parameters:
      value - The optOutConformerModelMigration to set.
      Returns:
      This builder for chaining.

    • clearOptOutConformerModelMigration

      public InputAudioConfig.Builder clearOptOutConformerModelMigration()
       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;
      Returns:
      This builder for chaining.