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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

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

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

Returns:



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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:



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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.



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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.



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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.



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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

#model ⇒ ::String

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

Returns:

  • (::String) —

    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)


175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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:



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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

#phrase_hints ⇒ ::Array<::String>

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:



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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:



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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.



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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:



175
176
177
178
 
# File 'proto_docs/google/cloud/dialogflow/v2/audio_config.rb', line 175

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