Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1InputAudioConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/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.



5221
5222
5223
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5221

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) 


5141
5142
5143
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5141

def audio_encoding
  @audio_encoding
end

#barge_in_config ⇒ Google::Apis::DialogflowV2::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 fromt the the start of the input audio. The flow goes like below: --> Time without speech detection | utterance only | utterance or no-speech event | | +- ------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-

  • barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ No-speech event is a response with END_OF_UTTERANCE without any transcript following up. Corresponds to the JSON property bargeInConfig

Returns:



5164
5165
5166
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5164

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) 


5172
5173
5174
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5172

def enable_word_info
  @enable_word_info
end

#model ⇒ String

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 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) Corresponds to the JSON property model

Returns:

  • (String) 


5188
5189
5190
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5188

def model
  @model
end

#model_variant ⇒ String

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

Returns:

  • (String) 


5193
5194
5195
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5193

def model_variant
  @model_variant
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>) 


5201
5202
5203
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5201

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) 


5208
5209
5210
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5208

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) 


5218
5219
5220
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5218

def single_utterance
  @single_utterance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5226

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)
  @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