Class: Google::Cloud::Dialogflow::CX::V3::InputAudioConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb

Overview

Instructs the speech recognizer on how to process the audio content.

Instance Attribute Summary collapse

Instance Attribute Details

#audio_encoding ⇒ ::Google::Cloud::Dialogflow::CX::V3::AudioEncoding

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

Returns:



113
114
115
116
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb', line 113

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

#enable_word_info ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



113
114
115
116
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb', line 113

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

    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)


113
114
115
116
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb', line 113

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

#model_variant ⇒ ::Google::Cloud::Dialogflow::CX::V3::SpeechModelVariant

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

Returns:



113
114
115
116
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb', line 113

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

#phrase_hints ⇒ ::Array<::String>

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

Returns:

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



113
114
115
116
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb', line 113

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

#sample_rate_hertz ⇒ ::Integer

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

Returns:



113
114
115
116
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb', line 113

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

#single_utterance ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



113
114
115
116
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/audio_config.rb', line 113

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