Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1InputAudioConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1InputAudioConfig

Returns a new instance of GoogleCloudDialogflowCxV3beta1InputAudioConfig.



10601
10602
10603
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10601

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#audio_encoding ⇒ String

Required. Audio encoding of the audio content to process. Corresponds to the JSON property audioEncoding

Returns:

  • (String) 


10524
10525
10526
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10524

def audio_encoding
  @audio_encoding
end

#barge_in_config ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1BargeInConfig

Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the the start of the input audio. No-speech event is a response with END_OF_UTTERANCE without any transcript following up. Corresponds to the JSON property bargeInConfig

Returns:



10543
10544
10545
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10543

def barge_in_config
  @barge_in_config
end

#enable_word_info ⇒ Boolean Also known as: enable_word_info?

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. Corresponds to the JSON property enableWordInfo

Returns:

  • (Boolean) 


10551
10552
10553
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10551

def enable_word_info
  @enable_word_info
end

#model ⇒ String

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

Returns:

  • (String) 


10559
10560
10561
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10559

def model
  @model
end

#model_variant ⇒ String

Optional. Which variant of the Speech model to use. Corresponds to the JSON property modelVariant

Returns:

  • (String) 


10564
10565
10566
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10564

def model_variant
  @model_variant
end

#opt_out_conformer_model_migration ⇒ Boolean Also known as: opt_out_conformer_model_migration?

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. Corresponds to the JSON property optOutConformerModelMigration

Returns:

  • (Boolean) 


10572
10573
10574
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10572

def opt_out_conformer_model_migration
  @opt_out_conformer_model_migration
end

#phrase_hints ⇒ Array<String>

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. Corresponds to the JSON property phraseHints

Returns:

  • (Array<String>) 


10581
10582
10583
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10581

def phrase_hints
  @phrase_hints
end

#sample_rate_hertz ⇒ Fixnum

Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details. Corresponds to the JSON property sampleRateHertz

Returns:

  • (Fixnum) 


10588
10589
10590
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10588

def sample_rate_hertz
  @sample_rate_hertz
end

#single_utterance ⇒ Boolean Also known as: single_utterance?

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. Corresponds to the JSON property singleUtterance

Returns:

  • (Boolean) 


10598
10599
10600
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10598

def single_utterance
  @single_utterance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10606

def update!(**args)
  @audio_encoding = args[:audio_encoding] if args.key?(:audio_encoding)
  @barge_in_config = args[:barge_in_config] if args.key?(:barge_in_config)
  @enable_word_info = args[:enable_word_info] if args.key?(:enable_word_info)
  @model = args[:model] if args.key?(:model)
  @model_variant = args[:model_variant] if args.key?(:model_variant)
  @opt_out_conformer_model_migration = args[:opt_out_conformer_model_migration] if args.key?(:opt_out_conformer_model_migration)
  @phrase_hints = args[:phrase_hints] if args.key?(:phrase_hints)
  @sample_rate_hertz = args[:sample_rate_hertz] if args.key?(:sample_rate_hertz)
  @single_utterance = args[:single_utterance] if args.key?(:single_utterance)
end