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.



2158
2159
2160
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2158

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

Instance Attribute Details

#audio_encodingString

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

Returns:

  • (String)


2104
2105
2106
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2104

def audio_encoding
  @audio_encoding
end

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


2112
2113
2114
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2112

def enable_word_info
  @enable_word_info
end

#modelString

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

Returns:

  • (String)


2125
2126
2127
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2125

def model
  @model
end

#model_variantString

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

Returns:

  • (String)


2130
2131
2132
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2130

def model_variant
  @model_variant
end

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


2138
2139
2140
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2138

def phrase_hints
  @phrase_hints
end

#sample_rate_hertzFixnum

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)


2145
2146
2147
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2145

def sample_rate_hertz
  @sample_rate_hertz
end

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


2155
2156
2157
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2155

def single_utterance
  @single_utterance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2163
2164
2165
2166
2167
2168
2169
2170
2171
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 2163

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