Google Cloud Dialogflow V2 Client - Class SpeechToTextConfig (1.17.1)

Version 1.17.1

• 1.17.2 (latest)
• 1.17.1
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.3
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.0
• 1.7.2
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.1

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

Configures speech transcription for ConversationProfile.

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

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ speech_model_variant	int The speech model used in speech to text. SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.
↳ model	string Which Speech model to select. 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 SpeechToTextConfig 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.
↳ phrase_sets	array List of names of Cloud Speech phrase sets that are used for transcription.
↳ audio_encoding	int 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.
↳ language_code	string 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.
↳ use_timeout_based_endpointing	bool Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.

getSpeechModelVariant

The speech model used in speech to text.

SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.

Returns
Type	Description
int

setSpeechModelVariant

The speech model used in speech to text.

SPEECH_MODEL_VARIANT_UNSPECIFIED, USE_BEST_AVAILABLE will be treated as USE_ENHANCED. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getModel

Which Speech model to select. 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 SpeechToTextConfig 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

Which Speech model to select. 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 SpeechToTextConfig 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

getPhraseSets

List of names of Cloud Speech phrase sets that are used for transcription.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setPhraseSets

List of names of Cloud Speech phrase sets that are used for transcription.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getAudioEncoding

Audio encoding of the audio content to process.

Returns
Type	Description
int

setAudioEncoding

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

getLanguageCode

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

setLanguageCode

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
Name	Description
var	string

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	bool

Returns
Type	Description
$this

getUseTimeoutBasedEndpointing

Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.

Returns
Type	Description
bool

setUseTimeoutBasedEndpointing

Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this