Google Cloud Dialogflow Cx V3 Client - Class InputAudioConfig (0.2.1)

Version 0.2.1

• 0.5.0 (latest)
• 0.4.1
• 0.3.4
• 0.2.1
• 0.1.1

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

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

Generated from protobuf message google.cloud.dialogflow.cx.v3.InputAudioConfig

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
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 Sample rate (in Hertz) of the audio content sent in the query. Refer to Cloud Speech API documentation for more details.
↳ enable_word_info	bool 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.
↳ phrase_hints	array 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.
↳ model	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	int Optional. Which variant of the Speech model to use.
↳ single_utterance	bool 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.
↳ barge_in_config	Google\Cloud\Dialogflow\Cx\V3\BargeInConfig Configuration of barge-in behavior during the streaming of input audio.

getAudioEncoding

Required. Audio encoding of the audio content to process.

Returns
Type	Description
int

setAudioEncoding

Required. Audio encoding of the audio content to process.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSampleRateHertz

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

Refer to Cloud Speech API documentation for more details.

Returns
Type	Description
int

setSampleRateHertz

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

Refer to Cloud Speech API documentation for more details.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getEnableWordInfo

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
Type	Description
bool

setEnableWordInfo

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getPhraseHints

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

setPhraseHints

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.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getModel

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
Type	Description
string

setModel

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getModelVariant

Optional. Which variant of the Speech model to use.

Returns
Type	Description
int

setModelVariant

Optional. Which variant of the Speech model to use.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSingleUtterance

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
Type	Description
bool

setSingleUtterance

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getBargeInConfig

Configuration of barge-in behavior during the streaming of input audio.

Returns
Type	Description
Google\Cloud\Dialogflow\Cx\V3\BargeInConfig|null

hasBargeInConfig

clearBargeInConfig

setBargeInConfig

Configuration of barge-in behavior during the streaming of input audio.

Parameter
Name	Description
var	Google\Cloud\Dialogflow\Cx\V3\BargeInConfig

Returns
Type	Description
$this