Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3InputAudioConfig

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) ⇒ GoogleCloudDialogflowCxV3InputAudioConfig

Returns a new instance of GoogleCloudDialogflowCxV3InputAudioConfig.



2688
2689
2690
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2688

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) 


2631
2632
2633
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2631

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


2639
2640
2641
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2639

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) 


2655
2656
2657
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2655

def model
  @model
end

#model_variant ⇒ String

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

Returns:

  • (String) 


2660
2661
2662
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2660

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


2668
2669
2670
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2668

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) 


2675
2676
2677
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2675

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) 


2685
2686
2687
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2685

def single_utterance
  @single_utterance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2693
2694
2695
2696
2697
2698
2699
2700
2701
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2693

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