Google Cloud Dialogflow V2 Client - Class InputAudioConfig (1.8.0)

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

Instructs the speech recognizer how to process the audio content.

Generated from protobuf message google.cloud.dialogflow.v2.InputAudioConfig

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ audio_encoding int

Required. Audio encoding of the audio content to process.

↳ sample_rate_hertz int

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

↳ language_code 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.

↳ enable_word_info bool

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.

↳ phrase_hints array

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.

↳ speech_contexts array<Google\Cloud\Dialogflow\V2\SpeechContext>

Context information to assist speech recognition. See the Cloud Speech documentation for more details.

↳ model 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 int

Which variant of the Speech model to use.

↳ single_utterance bool

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.

↳ disable_no_speech_recognized_event bool

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 bool

Enable automatic punctuation option at the speech backend.

getAudioEncoding

Required. Audio encoding of the audio content to process.

Returns
TypeDescription
int

setAudioEncoding

Required. Audio encoding of the audio content to process.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSampleRateHertz

Required. Sample rate (in Hertz) of the audio content sent in the query.

Refer to Cloud Speech API documentation for more details.

Returns
TypeDescription
int

setSampleRateHertz

Required. Sample rate (in Hertz) of the audio content sent in the query.

Refer to Cloud Speech API documentation for more details.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLanguageCode

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
TypeDescription
string

setLanguageCode

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEnableWordInfo

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
TypeDescription
bool

setEnableWordInfo

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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getPhraseHints

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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPhraseHints

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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getSpeechContexts

Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSpeechContexts

Context information to assist speech recognition.

See the Cloud Speech documentation for more details.

Parameter
NameDescription
var array<Google\Cloud\Dialogflow\V2\SpeechContext>
Returns
TypeDescription
$this

getModel

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
TypeDescription
string

setModel

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)
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getModelVariant

Which variant of the Speech model to use.

Returns
TypeDescription
int

setModelVariant

Which variant of the Speech model to use.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSingleUtterance

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
TypeDescription
bool

setSingleUtterance

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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDisableNoSpeechRecognizedEvent

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
TypeDescription
bool

setDisableNoSpeechRecognizedEvent

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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getEnableAutomaticPunctuation

Enable automatic punctuation option at the speech backend.

Returns
TypeDescription
bool

setEnableAutomaticPunctuation

Enable automatic punctuation option at the speech backend.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this