SpeechConfig class

Speech configuration.

Properties

authorizationToken

Gets/Sets the authorization token. 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.

endpointId

Gets/Sets the endpoint ID of a customized speech model that is used for speech recognition.

outputFormat

Gets/Sets the output format.

region
speechRecognitionLanguage

Gets/Sets the input language.

subscriptionKey

Methods

close()

Closes the configuration.

enableAudioLogging()
enableDictation()
fromAuthorizationToken(string, string)

Creates an instance of the speech factory with specified initial authorization token and 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. Note: Please use a token derived from your LanguageUnderstanding subscription key in case you want to use the Intent recognizer. 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.

fromEndpoint(URL, string)

Creates an instance of the speech config with specified endpoint and subscription key. This method is intended only for users who use a non-standard service endpoint or parameters. Note: Please use your LanguageUnderstanding subscription key in case you want to use the Intent recognizer. Note: The query parameters specified in the endpoint URL are not changed, even if they are set by any other APIs. For example, if language is defined in the uri as query parameter "language=de-DE", and also set by SpeechConfig.speechRecognitionLanguage = "en-US", the language setting in uri takes precedence, and the effective language is "de-DE". Only the parameters that are not specified in the endpoint URL can be set by other APIs. Note: To use authorization token with fromEndpoint, pass an empty string to the subscriptionKey in the fromEndpoint method, and then set authorizationToken="token" on the created SpeechConfig instance to use the authorization token.

fromSubscription(string, string)

Static instance of SpeechConfig returned by passing subscriptionKey and service region. Note: Please use your LanguageUnderstanding subscription key in case you want to use the Intent recognizer.

getProperty(string, string)

Returns the current value of an arbitrary property.

requestWordLevelTimestamps()
setProfanity(ProfanityOption)
setProperty(string, string)

Sets an arbitrary property.

setProxy(string, number)

Sets the proxy configuration. Only relevant in Node.js environments. Added in version 1.4.0.

setProxy(string, number, string, string)

Sets the proxy configuration. Only relevant in Node.js environments. Added in version 1.4.0.

setServiceProperty(string, string, ServicePropertyChannel)

Property Details

authorizationToken

Gets/Sets the authorization token. 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.

public authorizationToken: string

Property Value

string

endpointId

Gets/Sets the endpoint ID of a customized speech model that is used for speech recognition.

public endpointId: string

Property Value

string

outputFormat

Gets/Sets the output format.

public outputFormat: OutputFormat

Property Value

region

public region: string

Property Value

string

speechRecognitionLanguage

Gets/Sets the input language.

public speechRecognitionLanguage: string

Property Value

string

subscriptionKey

public subscriptionKey: string

Property Value

string

Method Details

close()

Closes the configuration.

function close()

enableAudioLogging()

function enableAudioLogging()

enableDictation()

function enableDictation()

fromAuthorizationToken(string, string)

Creates an instance of the speech factory with specified initial authorization token and 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. Note: Please use a token derived from your LanguageUnderstanding subscription key in case you want to use the Intent recognizer. 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.

static function fromAuthorizationToken(authorizationToken: string, region: string)

Parameters

authorizationToken
string

The initial authorization token.

region
string

The region name (see the region page).

Returns

A speech factory instance.

fromEndpoint(URL, string)

Creates an instance of the speech config with specified endpoint and subscription key. This method is intended only for users who use a non-standard service endpoint or parameters. Note: Please use your LanguageUnderstanding subscription key in case you want to use the Intent recognizer. Note: The query parameters specified in the endpoint URL are not changed, even if they are set by any other APIs. For example, if language is defined in the uri as query parameter "language=de-DE", and also set by SpeechConfig.speechRecognitionLanguage = "en-US", the language setting in uri takes precedence, and the effective language is "de-DE". Only the parameters that are not specified in the endpoint URL can be set by other APIs. Note: To use authorization token with fromEndpoint, pass an empty string to the subscriptionKey in the fromEndpoint method, and then set authorizationToken="token" on the created SpeechConfig instance to use the authorization token.

static function fromEndpoint(endpoint: URL, subscriptionKey?: string)

Parameters

endpoint
URL

The service endpoint to connect to.

subscriptionKey
string

The subscription key. If a subscription key is not specified, an authorization token must be set.

Returns

A speech factory instance.

fromSubscription(string, string)

Static instance of SpeechConfig returned by passing subscriptionKey and service region. Note: Please use your LanguageUnderstanding subscription key in case you want to use the Intent recognizer.

static function fromSubscription(subscriptionKey: string, region: string)

Parameters

subscriptionKey
string

The subscription key.

region
string

The region name (see the region page).

Returns

The speech factory

getProperty(string, string)

Returns the current value of an arbitrary property.

function getProperty(name: string, def?: string)

Parameters

name
string

The name of the property to query.

def
string

The value to return in case the property is not known.

Returns

string

The current value, or provided default, of the given property.

requestWordLevelTimestamps()

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

function setProfanity(profanity: ProfanityOption)

Parameters

profanity
ProfanityOption

setProperty(string, string)

Sets an arbitrary property.

function setProperty(name: string, value: string)

Parameters

name
string

The name of the property to set.

value
string

The new value of the property.

setProxy(string, number)

Sets the proxy configuration. Only relevant in Node.js environments. Added in version 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number)

Parameters

proxyHostName
string

The host name of the proxy server.

proxyPort
number

The port number of the proxy server.

setProxy(string, number, string, string)

Sets the proxy configuration. Only relevant in Node.js environments. Added in version 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number, proxyUserName: string, proxyPassword: string)

Parameters

proxyHostName
string

The host name of the proxy server, without the protocol scheme (http://)

proxyPort
number
proxyUserName
string

The user name of the proxy server.

proxyPassword
string

The password of the proxy server.

setServiceProperty(string, string, ServicePropertyChannel)

function setServiceProperty(name: string, value: string, channel: ServicePropertyChannel)

Parameters

name
string
value
string