CustomCommandsConfig Class

Package:

com.microsoft.cognitiveservices.speech.dialog

Maven Artifact:

com.microsoft.cognitiveservices.speech:client-sdk:1.34.0

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.SpeechConfig
  • • com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig
    • • com.microsoft.cognitiveservices.speech.dialog.CustomCommandsConfig

public final class CustomCommandsConfig
extends DialogServiceConfig

Class that defines configurations for the dialog service connector object for using a CustomCommands backend.

Method Summary

Modifier and Type	Method and Description
static CustomCommandsConfig	fromAuthorizationToken(String appId, String authorizationToken, String region) Creates an instance of Custom Commands config with the specified Custom Commands application id, authorization token and service region.
static CustomCommandsConfig	fromSubscription(String appId, String subscription, String region) Creates an instance of Custom Commands config with the specified Custom Commands application id, subscription and region.
java.lang.String	getApplicationId() Gets the application id.
void	setApplicationId(String value) Sets the application id.

Methods inherited from SpeechConfig

enableAudioLogging enableDictation fromAuthorizationToken fromEndpoint fromEndpoint fromHost fromHost fromSubscription getAuthorizationToken getEndpointId getOutputFormat getSpeechRecognitionLanguage getSpeechSynthesisLanguage getSpeechSynthesisOutputFormat getSpeechSynthesisVoiceName requestWordLevelTimestamps setAuthorizationToken setEndpointId setOutputFormat setProfanity setSpeechRecognitionLanguage setSpeechSynthesisLanguage setSpeechSynthesisOutputFormat setSpeechSynthesisVoiceName

Methods inherited from DialogServiceConfig

close getImpl getLanguage getProperty getProperty setLanguage setProperty setProperty setProxy setServiceProperty

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

fromAuthorizationToken

public static CustomCommandsConfig fromAuthorizationToken(String appId, String authorizationToken, String region)

Creates an instance of Custom Commands config with the specified Custom Commands application id, authorization token and service region. Note: The caller needs to ensure that the authorization token is valid. Before the authorization token expires, the caller needs to refresh it by calling this setter with a new valid token. As configuration values are copied when creating a new recognizer, the new token value will not apply to recognizers that have already been created. For recognizers that have been created before, you need to set authorization token of the corresponding recognizer to refresh the token. Otherwise, the recognizers will encounter errors during recognition.

Parameters:

appId - Custom Commands Application Id.

authorizationToken - The authorization token.

region - The region name (see the region page).

Returns:

A speech config instance.

fromSubscription

public static CustomCommandsConfig fromSubscription(String appId, String subscription, String region)

Creates an instance of Custom Commands config with the specified Custom Commands application id, subscription and region.

Parameters:

appId - Custom Commands Application Id.

subscription - Service subscription key.

region - Service region key.

Returns:

The created config.

getApplicationId

public String getApplicationId()

Gets the application id.

Returns:

Identifier used to connect to the backend service.

setApplicationId

public void setApplicationId(String value)

Sets the application id.

Parameters:

value - Identifier used to connect to the backend service.