Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::InputAudioConfig (v0.22.0)

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

Instructs the speech recognizer on 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::CX::V3::AudioEncoding

Returns

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

#audio_encoding=

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

Parameter

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

Returns

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

#enable_word_info

def enable_word_info() -> ::Boolean

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.

#enable_word_info=

def enable_word_info=(value) -> ::Boolean

Parameter

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

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.

#model

def model() -> ::String

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)

#model=

def model=(value) -> ::String

Parameter

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

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)

#model_variant

def model_variant() -> ::Google::Cloud::Dialogflow::CX::V3::SpeechModelVariant

Returns

(::Google::Cloud::Dialogflow::CX::V3::SpeechModelVariant) — Optional. Which variant of the [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.

#model_variant=

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

Parameter

value (::Google::Cloud::Dialogflow::CX::V3::SpeechModelVariant) — Optional. Which variant of the [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.

Returns

(::Google::Cloud::Dialogflow::CX::V3::SpeechModelVariant) — Optional. Which variant of the [Speech model][google.cloud.dialogflow.cx.v3.InputAudioConfig.model] to use.

#phrase_hints

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

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.

#phrase_hints=

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

Parameter

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

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.

#sample_rate_hertz

def sample_rate_hertz() -> ::Integer

Returns

(::Integer) — 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) — Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.

Returns

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

#single_utterance=

def single_utterance=(value) -> ::Boolean

Parameter

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

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.