Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2InputAudioConfig

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 how to process the audio content.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2InputAudioConfig

Returns a new instance of GoogleCloudDialogflowV2InputAudioConfig.



11759
11760
11761
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11759

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) 


11667
11668
11669
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11667

def audio_encoding
  @audio_encoding
end

#disable_no_speech_recognized_event ⇒ Boolean Also known as: disable_no_speech_recognized_event?

Only used in Participants.AnalyzeContent and Participants. StreamingAnalyzeContent. If false and recognition doesn't return any result, trigger NO_SPEECH_RECOGNIZED event to Dialogflow agent. Corresponds to the JSON property disableNoSpeechRecognizedEvent

Returns:

  • (Boolean) 


11674
11675
11676
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11674

def disable_no_speech_recognized_event
  @disable_no_speech_recognized_event
end

#enable_automatic_punctuation ⇒ Boolean Also known as: enable_automatic_punctuation?

Enable automatic punctuation option at the speech backend. Corresponds to the JSON property enableAutomaticPunctuation

Returns:

  • (Boolean) 


11680
11681
11682
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11680

def enable_automatic_punctuation
  @enable_automatic_punctuation
end

#enable_word_info ⇒ Boolean Also known as: enable_word_info?

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) 


11689
11690
11691
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11689

def enable_word_info
  @enable_word_info
end

#language_code ⇒ String

Required. The language of the supplied audio. Dialogflow does not do translations. See Language Support 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. Corresponds to the JSON property languageCode

Returns:

  • (String) 


11699
11700
11701
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11699

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


11706
11707
11708
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11706

def model
  @model
end

#model_variant ⇒ String

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

Returns:

  • (String) 


11711
11712
11713
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11711

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 ES Speech model migration. Corresponds to the JSON property optOutConformerModelMigration

Returns:

  • (Boolean) 


11719
11720
11721
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11719

def opt_out_conformer_model_migration
  @opt_out_conformer_model_migration
end

#phrase_hints ⇒ Array<String>

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

Returns:

  • (Array<String>) 


11730
11731
11732
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11730

def phrase_hints
  @phrase_hints
end

#sample_rate_hertz ⇒ Fixnum

Required. 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) 


11737
11738
11739
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11737

def sample_rate_hertz
  @sample_rate_hertz
end

#single_utterance ⇒ Boolean Also known as: single_utterance?

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

Returns:

  • (Boolean) 


11749
11750
11751
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11749

def single_utterance
  @single_utterance
end

#speech_contexts ⇒ Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SpeechContext>

Context information to assist speech recognition. See the Cloud Speech documentation for more details. Corresponds to the JSON property speechContexts

Returns:



11757
11758
11759
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11757

def speech_contexts
  @speech_contexts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 11764

def update!(**args)
  @audio_encoding = args[:audio_encoding] if args.key?(:audio_encoding)
  @disable_no_speech_recognized_event = args[:disable_no_speech_recognized_event] if args.key?(:disable_no_speech_recognized_event)
  @enable_automatic_punctuation = args[:enable_automatic_punctuation] if args.key?(:enable_automatic_punctuation)
  @enable_word_info = args[:enable_word_info] if args.key?(:enable_word_info)
  @language_code = args[:language_code] if args.key?(:language_code)
  @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)
  @speech_contexts = args[:speech_contexts] if args.key?(:speech_contexts)
end