Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::InputAudioConfig (v0.27.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::InputAudioConfig.

Instructs the speech recognizer how to process the audio content.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#audio_encoding

def audio_encoding() -> ::Google::Cloud::Dialogflow::V2::AudioEncoding

Returns

(::Google::Cloud::Dialogflow::V2::AudioEncoding) — Required. Audio encoding of the audio content to process.

#audio_encoding=

def audio_encoding=(value) -> ::Google::Cloud::Dialogflow::V2::AudioEncoding

Parameter

value (::Google::Cloud::Dialogflow::V2::AudioEncoding) — Required. Audio encoding of the audio content to process.

Returns

(::Google::Cloud::Dialogflow::V2::AudioEncoding) — Required. Audio encoding of the audio content to process.

#disable_no_speech_recognized_event

def disable_no_speech_recognized_event() -> ::Boolean

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.

#disable_no_speech_recognized_event=

def disable_no_speech_recognized_event=(value) -> ::Boolean

Parameter

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

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.

#enable_automatic_punctuation

def enable_automatic_punctuation() -> ::Boolean

Returns

(::Boolean) — Enable automatic punctuation option at the speech backend.

#enable_automatic_punctuation=

def enable_automatic_punctuation=(value) -> ::Boolean

Parameter

value (::Boolean) — Enable automatic punctuation option at the speech backend.

Returns

(::Boolean) — Enable automatic punctuation option at the speech backend.

#enable_word_info

def enable_word_info() -> ::Boolean

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.

#enable_word_info=

def enable_word_info=(value) -> ::Boolean

Parameter

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

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.

#language_code

def language_code() -> ::String

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.

#language_code=

def language_code=(value) -> ::String

Parameter

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

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.

#model

def model() -> ::String

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)

#model=

def model=(value) -> ::String

Parameter

value (::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)

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)

#model_variant

def model_variant() -> ::Google::Cloud::Dialogflow::V2::SpeechModelVariant

Returns

(::Google::Cloud::Dialogflow::V2::SpeechModelVariant) — Which variant of the [Speech model][google.cloud.dialogflow.v2.InputAudioConfig.model] to use.

#model_variant=

def model_variant=(value) -> ::Google::Cloud::Dialogflow::V2::SpeechModelVariant

Parameter

value (::Google::Cloud::Dialogflow::V2::SpeechModelVariant) — 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.

#phrase_hints

def phrase_hints() -> ::Array<::String>

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.

#phrase_hints=

def phrase_hints=(value) -> ::Array<::String>

Parameter

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

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.

#sample_rate_hertz

def sample_rate_hertz() -> ::Integer

Returns

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

#sample_rate_hertz=

def sample_rate_hertz=(value) -> ::Integer

Parameter

value (::Integer) — 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.

#single_utterance

def single_utterance() -> ::Boolean

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.

#single_utterance=

def single_utterance=(value) -> ::Boolean

Parameter

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

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.

#speech_contexts

def speech_contexts() -> ::Array<::Google::Cloud::Dialogflow::V2::SpeechContext>

Returns

(::Array<::Google::Cloud::Dialogflow::V2::SpeechContext>) — Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

#speech_contexts=

def speech_contexts=(value) -> ::Array<::Google::Cloud::Dialogflow::V2::SpeechContext>

Parameter

value (::Array<::Google::Cloud::Dialogflow::V2::SpeechContext>) — 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.