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

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

#audio_encoding=

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

#barge_in_config

def barge_in_config() -> ::Google::Cloud::Dialogflow::CX::V3::BargeInConfig
Returns

#barge_in_config=

def barge_in_config=(value) -> ::Google::Cloud::Dialogflow::CX::V3::BargeInConfig
Parameter
Returns

#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 Dialogflow auto-selects a model based on other parameters in the InputAudioConfig and Agent settings. 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

    Leave this field unspecified to use Agent Speech settings for model selection.

#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 Dialogflow auto-selects a model based on other parameters in the InputAudioConfig and Agent settings. 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

    Leave this field unspecified to use Agent Speech settings for model selection.

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 Dialogflow auto-selects a model based on other parameters in the InputAudioConfig and Agent settings. 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

    Leave this field unspecified to use Agent Speech settings for model selection.

#model_variant

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

#model_variant=

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

#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

#sample_rate_hertz=

def sample_rate_hertz=(value) -> ::Integer
Parameter
Returns

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