Class: Google::Cloud::Dialogflow::V2::InputAudioConfig

Inherits:

Object

• Object
• Google::Cloud::Dialogflow::V2::InputAudioConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dialogflow/v2/audio_config.rb

Overview

Instructs the speech recognizer how to process the audio content.

Instance Attribute Summary

• #audio_encoding ⇒ ::Google::Cloud::Dialogflow::V2::AudioEncoding

  Required.

• #disable_no_speech_recognized_event ⇒ ::Boolean

  Only used in Participants.AnalyzeContent and Participants.StreamingAnalyzeContent.

• #enable_automatic_punctuation ⇒ ::Boolean

  Enable automatic punctuation option at the speech backend.

• #enable_word_info ⇒ ::Boolean

  If true, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g.

• #language_code ⇒ ::String

  Required.

• #model ⇒ ::String

  Optional.

• #model_variant ⇒ ::Google::Cloud::Dialogflow::V2::SpeechModelVariant

  Which variant of the [Speech model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.

• #opt_out_conformer_model_migration ⇒ ::Boolean

  If true, the request will opt out for STT conformer model migration.

• #phrase_hints ⇒ ::Array<::String> deprecated Deprecated.

  This field is deprecated and may be removed in the next major version update.

• #sample_rate_hertz ⇒ ::Integer

  Required.

• #single_utterance ⇒ ::Boolean

  If false (default), recognition does not cease until the client closes the stream.

• #speech_contexts ⇒ ::Array<::Google::Cloud::Dialogflow::V2::SpeechContext>

  Context information to assist speech recognition.

Instance Attribute Details

#audio_encoding ⇒ ::Google::Cloud::Dialogflow::V2::AudioEncoding

Returns Required. Audio encoding of the audio content to process.

Returns:

• (::Google::Cloud::Dialogflow::V2::AudioEncoding) —

  Required. Audio encoding of the audio content to process.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#disable_no_speech_recognized_event ⇒ ::Boolean

Returns 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.

Returns:

• (::Boolean) —

  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.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#enable_automatic_punctuation ⇒ ::Boolean

Returns Enable automatic punctuation option at the speech backend.

Returns:

• (::Boolean) —

  Enable automatic punctuation option at the speech backend.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#enable_word_info ⇒ ::Boolean

Returns 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.

Returns:

• (::Boolean) —

  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.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#language_code ⇒ ::String

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#model ⇒ ::String

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#model_variant ⇒ ::Google::Cloud::Dialogflow::V2::SpeechModelVariant

Returns Which variant of the [Speech model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.

Returns:

• (::Google::Cloud::Dialogflow::V2::SpeechModelVariant) —

  Which variant of the [Speech model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#opt_out_conformer_model_migration ⇒ ::Boolean

Returns If true, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June

1. Please refer to Dialogflow ES Speech model migration.

Returns:

• (::Boolean) —

  If true, the request will opt out for STT conformer model migration. This field will be deprecated once force migration takes place in June

  1. Please refer to Dialogflow ES Speech model migration.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#phrase_hints ⇒ ::Array<::String>

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sample_rate_hertz ⇒ ::Integer

Returns Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.

Returns:

• (::Integer) —

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

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#single_utterance ⇒ ::Boolean

Returns 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.

Returns:

• (::Boolean) —

  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.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#speech_contexts ⇒ ::Array<::Google::Cloud::Dialogflow::V2::SpeechContext>

Returns Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

Returns:

• (::Array<::Google::Cloud::Dialogflow::V2::SpeechContext>) —

  Context information to assist speech recognition.

  See the Cloud Speech documentation for more details.

# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 168

class InputAudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end