你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SpeechConfig class

包:

microsoft-cognitiveservices-speech-sdk

语音配置。

属性

authorizationToken	获取授权令牌。
endpointId	获取用于语音识别的自定义语音模型的终结点 ID。
outputFormat	获取简单或详细) (语音识别输出格式。 注意：此输出格式用于语音识别结果，请使用 [SpeechConfig.speechSynthesisOutputFormat] 获取合成的音频输出格式。
region
speechRecognitionLanguage	返回配置的语言。
speechSynthesisLanguage	获取语音合成器的语言。 在版本 1.11.0 中添加。
speechSynthesisOutputFormat	获取语音合成输出格式。 在版本 1.11.0 中添加。
speechSynthesisVoiceName	获取语音合成器的声音。 在版本 1.11.0 中添加。
subscriptionKey

方法

close()	关闭配置。
enableAudioLogging()	在服务中启用音频日志记录。 音频和内容日志存储在 Microsoft 拥有的存储中，或存储在链接到认知服务订阅的自己的存储帐户中， (将自己的存储 (BYOS) 启用的语音资源) 。 日志将在 30 天后删除。 在版本 1.7.0 中添加。
enableDictation()	启用听写。 仅在语音连续识别中受支持。 在版本 1.7.0 中添加。
fromAuthorizationToken(string, string)	使用指定的初始授权令牌和区域创建语音工厂的实例。 注意：调用方需要确保授权令牌有效。 在授权令牌过期之前，调用方需要使用新的有效令牌调用此资源库来刷新它。 注意：如果要使用意向识别器，请使用派生自 LanguageUnderstanding 订阅密钥的令牌。 由于在创建新的识别器时会复制配置值，因此新令牌值将不适用于已创建的识别器。 对于之前创建的识别器，需要设置相应识别器的授权令牌以刷新令牌。 否则，识别器将在识别过程中遇到错误。
fromEndpoint(URL, string)	使用指定的终结点和订阅密钥创建语音配置的实例。 此方法仅适用于使用非标准服务终结点或参数的用户。 注意：如果要使用意向识别器，请使用 LanguageUnderstanding 订阅密钥。 注意：终结点 URL 中指定的查询参数不会更改，即使它们是由任何其他 API 设置的。 例如，如果在 uri 中将 language 定义为查询参数“language=de-DE”，并且还由 SpeechConfig.speechRecognitionLanguage = “en-US”设置，则 URI 中的语言设置优先，有效语言为“de-DE”。 其他 API 只能设置终结点 URL 中未指定的参数。 注意：若要将授权令牌与 fromEndpoint 一起使用，请将空字符串传递给 fromEndpoint 方法中的 subscriptionKey，然后在创建的 SpeechConfig 实例上设置 authorizationToken=“token” 以使用授权令牌。
fromHost(URL, string)	使用指定的主机和订阅密钥创建语音配置的实例。 此方法仅适用于使用非默认服务主机的用户。 将采用标准资源路径。 对于具有非标准资源路径或根本没有路径的服务，请改用 fromEndpoint。 注意：主机 URI 中不允许使用查询参数，必须由其他 API 设置。 注意：若要将授权令牌与 fromHost 配合使用，请使用 fromHost (URL) ，然后在创建的 SpeechConfig 实例上设置 AuthorizationToken 属性。 注意：在版本 1.9.0 中添加。
fromSubscription(string, string)	通过传递 subscriptionKey 和服务区域返回的 SpeechConfig 的静态实例。 注意：如果要使用意向识别器，请使用 LanguageUnderstanding 订阅密钥。
getProperty(string, string)	返回任意属性的当前值。
requestWordLevelTimestamps()	包括单词级时间戳。 在版本 1.7.0 中添加。
setProfanity(ProfanityOption)	设置不雅内容选项。 在版本 1.7.0 中添加。
setProperty(string | PropertyId, string)	设置任意属性。
setProxy(string, number)	设置代理配置。 仅在 Node.js 环境中相关。 在版本 1.4.0 中添加。
setProxy(string, number, string, string)	设置代理配置。 仅在 Node.js 环境中相关。 在版本 1.4.0 中添加。
setServiceProperty(string, string, UriQueryParameter)	设置将使用指定通道传递给服务的属性值。 在版本 1.7.0 中添加。

属性详细信息

authorizationToken

获取授权令牌。

string authorizationToken

属性值

string

endpointId

获取用于语音识别的自定义语音模型的终结点 ID。

string endpointId

属性值

string

终结点 ID

outputFormat

获取简单或详细) (语音识别输出格式。 注意：此输出格式用于语音识别结果，请使用 [SpeechConfig.speechSynthesisOutputFormat] 获取合成的音频输出格式。

OutputFormat outputFormat

属性值

OutputFormat

返回输出格式。

region

string region

属性值

string

在配置上设置的区域。

speechRecognitionLanguage

返回配置的语言。

string speechRecognitionLanguage

属性值

string

speechSynthesisLanguage

获取语音合成器的语言。 在版本 1.11.0 中添加。

string speechSynthesisLanguage

属性值

string

返回语音合成语言。

speechSynthesisOutputFormat

获取语音合成输出格式。 在版本 1.11.0 中添加。

SpeechSynthesisOutputFormat speechSynthesisOutputFormat

属性值

SpeechSynthesisOutputFormat

返回语音合成输出格式

speechSynthesisVoiceName

获取语音合成器的声音。 在版本 1.11.0 中添加。

string speechSynthesisVoiceName

属性值

string

返回语音合成语音。

subscriptionKey

string subscriptionKey

属性值

string

在配置上设置的订阅密钥。

方法详细信息

close()

关闭配置。

function close()

enableAudioLogging()

在服务中启用音频日志记录。 音频和内容日志存储在 Microsoft 拥有的存储中，或存储在链接到认知服务订阅的自己的存储帐户中， (将自己的存储 (BYOS) 启用的语音资源) 。 日志将在 30 天后删除。 在版本 1.7.0 中添加。

function enableAudioLogging()

enableDictation()

启用听写。 仅在语音连续识别中受支持。 在版本 1.7.0 中添加。

function enableDictation()

fromAuthorizationToken(string, string)

使用指定的初始授权令牌和区域创建语音工厂的实例。 注意：调用方需要确保授权令牌有效。 在授权令牌过期之前，调用方需要使用新的有效令牌调用此资源库来刷新它。 注意：如果要使用意向识别器，请使用派生自 LanguageUnderstanding 订阅密钥的令牌。 由于在创建新的识别器时会复制配置值，因此新令牌值将不适用于已创建的识别器。 对于之前创建的识别器，需要设置相应识别器的授权令牌以刷新令牌。 否则，识别器将在识别过程中遇到错误。

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

参数

authorizationToken

string

初始授权令牌。

region

string

区域名称 (请参阅 区域页) 。

返回

SpeechConfig

语音工厂实例。

fromEndpoint(URL, string)

使用指定的终结点和订阅密钥创建语音配置的实例。 此方法仅适用于使用非标准服务终结点或参数的用户。 注意：如果要使用意向识别器，请使用 LanguageUnderstanding 订阅密钥。 注意：终结点 URL 中指定的查询参数不会更改，即使它们是由任何其他 API 设置的。 例如，如果在 uri 中将 language 定义为查询参数“language=de-DE”，并且还由 SpeechConfig.speechRecognitionLanguage = “en-US”设置，则 URI 中的语言设置优先，有效语言为“de-DE”。 其他 API 只能设置终结点 URL 中未指定的参数。 注意：若要将授权令牌与 fromEndpoint 一起使用，请将空字符串传递给 fromEndpoint 方法中的 subscriptionKey，然后在创建的 SpeechConfig 实例上设置 authorizationToken=“token” 以使用授权令牌。

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

参数

endpoint

URL

要连接到的服务终结点。

subscriptionKey

string

订阅密钥。 如果未指定订阅密钥，则必须设置授权令牌。

返回

SpeechConfig

语音工厂实例。

fromHost(URL, string)

使用指定的主机和订阅密钥创建语音配置的实例。 此方法仅适用于使用非默认服务主机的用户。 将采用标准资源路径。 对于具有非标准资源路径或根本没有路径的服务，请改用 fromEndpoint。 注意：主机 URI 中不允许使用查询参数，必须由其他 API 设置。 注意：若要将授权令牌与 fromHost 配合使用，请使用 fromHost (URL) ，然后在创建的 SpeechConfig 实例上设置 AuthorizationToken 属性。 注意：在版本 1.9.0 中添加。

static function fromHost(hostName: URL, subscriptionKey?: string): SpeechConfig

参数

hostName

URL

subscriptionKey

string

订阅密钥。 如果未指定订阅密钥，则必须设置授权令牌。

返回

SpeechConfig

语音工厂实例。

fromSubscription(string, string)

通过传递 subscriptionKey 和服务区域返回的 SpeechConfig 的静态实例。 注意：如果要使用意向识别器，请使用 LanguageUnderstanding 订阅密钥。

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

参数

subscriptionKey

string

订阅密钥。

region

string

区域名称 (请参阅 区域页) 。

返回

SpeechConfig

语音工厂

getProperty(string, string)

返回任意属性的当前值。

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

参数

name

string

要查询的属性的名称。

def

string

属性未知时要返回的值。

返回

string

给定属性的当前值或提供的默认值。

requestWordLevelTimestamps()

包括单词级时间戳。 在版本 1.7.0 中添加。

function requestWordLevelTimestamps()

setProfanity(ProfanityOption)

设置不雅内容选项。 在版本 1.7.0 中添加。

function setProfanity(profanity: ProfanityOption)

参数

profanity

ProfanityOption

setProperty(string | PropertyId, string)

设置任意属性。

function setProperty(name: string | PropertyId, value: string)

参数

name

string | PropertyId

要设置的属性的名称。

value

string

属性的新值。

setProxy(string, number)

设置代理配置。 仅在 Node.js 环境中相关。 在版本 1.4.0 中添加。

function setProxy(proxyHostName: string, proxyPort: number)

参数

proxyHostName

string

代理服务器的主机名。

proxyPort

number

代理服务器的端口号。

setProxy(string, number, string, string)

设置代理配置。 仅在 Node.js 环境中相关。 在版本 1.4.0 中添加。

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

参数

proxyHostName

string

代理服务器的主机名，不带协议方案 (http：//)

proxyPort

number

代理服务器的端口号。

proxyUserName

string

代理服务器的用户名。

proxyPassword

string

代理服务器的密码。

setServiceProperty(string, string, UriQueryParameter)

设置将使用指定通道传递给服务的属性值。 在版本 1.7.0 中添加。

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

参数

name

string

value

string

channel

UriQueryParameter