你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
SpeechTranslationConfig class
语音翻译配置。
- 扩展
属性
authorization |
获取/设置授权令牌。 注意:调用方需要确保授权令牌有效。 在授权令牌过期之前,调用方需要使用新的有效令牌调用此 setter 来刷新它。 |
endpoint |
获取用于语音识别的自定义语音模型的终结点 ID。 |
output |
获取语音识别输出格式(简单或详细)。 注意:此输出格式用于语音识别结果,请使用 [SpeechConfig.speechSynthesisOutputFormat] 获取合成的音频输出格式。 |
region | |
speech |
获取/设置语音识别语言。 |
speech |
获取语音合成器的语言。 在版本 1.11.0 中添加。 |
speech |
获取语音合成输出格式。 在版本 1.11.0 中添加。 |
speech |
获取语音合成器的声音。 在版本 1.11.0 中添加。 |
subscription |
|
target |
获取要翻译到的 (text) 目标语言。 |
voice |
获取所选的语音名称。 |
方法
add |
添加要翻译的(文本)目标语言。 |
close() | 释放关联的资源。 |
from |
传递授权令牌和服务区域返回的 SpeechTranslationConfig 的静态实例。 注意:调用方需要确保授权令牌有效。 在授权令牌过期之前,调用方需要使用新的有效令牌设置属性 authorizationToken 来刷新它。 否则,此 SpeechTranslationConfig 实例创建的所有识别器都将在识别过程中遇到错误。 创建新识别器时复制配置值时,新令牌值将不适用于已创建的识别器。 对于以前创建的识别器,需要设置相应识别器的授权令牌以刷新令牌。 否则,识别器会在识别过程中遇到错误。 |
from |
使用指定的终结点和订阅密钥创建语音翻译配置的实例。 此方法仅适用于使用非标准服务终结点或参数的用户。 注意:终结点 URL 中指定的查询属性不会更改,即使这些属性是由任何其他 API 设置的。 例如,如果在 uri 中将语言定义为查询参数“language=de-DE”,并且还由 speechRecognitionLanguage 属性设置,则 uri 中的语言设置优先,并且有效语言为“de-DE”。 只有未在终结点 URL 中指定的属性才能由其他 API 设置。 注意:若要将授权令牌与 fromEndpoint 配合使用,请在 fromEndpoint 方法中将空字符串传递给 subscriptionKey,然后在创建的 SpeechConfig 实例上设置 authorizationToken=“token”以使用授权令牌。 |
from |
使用指定的主机和订阅密钥创建语音配置的实例。 此方法仅适用于使用非默认服务主机的用户。 将假定标准资源路径。 对于具有非标准资源路径或根本没有路径的服务,请改用 fromEndpoint。 注意:主机 URI 中不允许查询参数,并且必须由其他 API 设置。 注意:若要将授权令牌用于 fromHost,请使用 fromHost(URL),然后在创建的 SpeechConfig 实例上设置 AuthorizationToken 属性。 注意:在版本 1.9.0 中添加。 |
from |
传递订阅密钥和服务区域返回的 SpeechTranslationConfig 的静态实例。 |
set |
将命名属性设置为值 |
继承的方法
enable |
在服务中启用音频日志记录。 音频和内容日志存储在Microsoft拥有的存储中,或存储在链接到认知服务订阅(启用自带存储(BYOS)的语音资源)的自己的存储帐户中。 日志将在 30 天后删除。 在版本 1.7.0 中添加。 |
enable |
启用听写。 仅在语音识别中受支持。 在版本 1.7.0 中添加。 |
get |
返回任意属性的当前值。 |
request |
包括字级时间戳。 在版本 1.7.0 中添加。 |
set |
设置不雅内容选项。 在版本 1.7.0 中添加。 |
set |
设置代理配置。 仅在 Node.js 环境中相关。 在版本 1.4.0 中添加。 |
set |
设置代理配置。 仅在 Node.js 环境中相关。 在版本 1.4.0 中添加。 |
set |
设置将使用指定通道传递给服务的属性值。 在版本 1.7.0 中添加。 |
属性详细信息
authorizationToken
获取/设置授权令牌。 注意:调用方需要确保授权令牌有效。 在授权令牌过期之前,调用方需要使用新的有效令牌调用此 setter 来刷新它。
void authorizationToken
属性值
void
endpointId
获取用于语音识别的自定义语音模型的终结点 ID。
string endpointId
属性值
string
终结点 ID
outputFormat
获取语音识别输出格式(简单或详细)。 注意:此输出格式用于语音识别结果,请使用 [SpeechConfig.speechSynthesisOutputFormat] 获取合成的音频输出格式。
OutputFormat outputFormat
属性值
返回输出格式。
region
string region
属性值
string
配置上设置的区域。
speechRecognitionLanguage
获取/设置语音识别语言。
void speechRecognitionLanguage
属性值
void
speechSynthesisLanguage
获取语音合成器的语言。 在版本 1.11.0 中添加。
string speechSynthesisLanguage
属性值
string
返回语音合成语言。
speechSynthesisOutputFormat
获取语音合成输出格式。 在版本 1.11.0 中添加。
SpeechSynthesisOutputFormat speechSynthesisOutputFormat
属性值
返回语音合成输出格式
speechSynthesisVoiceName
获取语音合成器的声音。 在版本 1.11.0 中添加。
string speechSynthesisVoiceName
属性值
string
返回语音合成语音。
subscriptionKey
string subscriptionKey
属性值
string
配置上设置的订阅密钥。
targetLanguages
获取要翻译到的 (text) 目标语言。
string[] targetLanguages
属性值
string[]
voiceName
获取所选的语音名称。
string voiceName
属性值
string
语音名称。
方法详细信息
addTargetLanguage(string)
添加要翻译的(文本)目标语言。
function addTargetLanguage(value: string)
参数
- value
-
string
de-DE 等语言
close()
释放关联的资源。
function close()
fromAuthorizationToken(string, string)
传递授权令牌和服务区域返回的 SpeechTranslationConfig 的静态实例。 注意:调用方需要确保授权令牌有效。 在授权令牌过期之前,调用方需要使用新的有效令牌设置属性 authorizationToken 来刷新它。 否则,此 SpeechTranslationConfig 实例创建的所有识别器都将在识别过程中遇到错误。 创建新识别器时复制配置值时,新令牌值将不适用于已创建的识别器。 对于以前创建的识别器,需要设置相应识别器的授权令牌以刷新令牌。 否则,识别器会在识别过程中遇到错误。
static function fromAuthorizationToken(authorizationToken: string, region: string): SpeechTranslationConfig
参数
- authorizationToken
-
string
授权令牌。
- region
-
string
区域名称(请参阅 区域页)。
返回
语音翻译配置。
fromEndpoint(URL, string)
使用指定的终结点和订阅密钥创建语音翻译配置的实例。 此方法仅适用于使用非标准服务终结点或参数的用户。 注意:终结点 URL 中指定的查询属性不会更改,即使这些属性是由任何其他 API 设置的。 例如,如果在 uri 中将语言定义为查询参数“language=de-DE”,并且还由 speechRecognitionLanguage 属性设置,则 uri 中的语言设置优先,并且有效语言为“de-DE”。 只有未在终结点 URL 中指定的属性才能由其他 API 设置。 注意:若要将授权令牌与 fromEndpoint 配合使用,请在 fromEndpoint 方法中将空字符串传递给 subscriptionKey,然后在创建的 SpeechConfig 实例上设置 authorizationToken=“token”以使用授权令牌。
static function fromEndpoint(endpoint: URL, subscriptionKey: string): SpeechTranslationConfig
参数
- endpoint
-
URL
要连接到的服务终结点。
- subscriptionKey
-
string
订阅密钥。
返回
语音配置实例。
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
订阅密钥。 如果未指定订阅密钥,则必须设置授权令牌。
返回
语音工厂实例。
fromSubscription(string, string)
传递订阅密钥和服务区域返回的 SpeechTranslationConfig 的静态实例。
static function fromSubscription(subscriptionKey: string, region: string): SpeechTranslationConfig
参数
- subscriptionKey
-
string
订阅密钥。
- region
-
string
区域名称(请参阅 区域页)。
返回
语音翻译配置。
setProperty(string | PropertyId, string)
将命名属性设置为值
function setProperty(name: string | PropertyId, value: string)
参数
- name
-
string | PropertyId
要设置的属性的名称。
- value
-
string
属性的新值。
继承的方法详细信息
enableAudioLogging()
在服务中启用音频日志记录。 音频和内容日志存储在Microsoft拥有的存储中,或存储在链接到认知服务订阅(启用自带存储(BYOS)的语音资源)的自己的存储帐户中。 日志将在 30 天后删除。 在版本 1.7.0 中添加。
function enableAudioLogging()
enableDictation()
getProperty(string, string)
返回任意属性的当前值。
function getProperty(name: string, def?: string): string
参数
- name
-
string
要查询的属性的名称。
- def
-
string
如果属性未知,则返回的值。
返回
string
给定属性的当前值或提供的默认值。
继承自 SpeechConfig.getProperty 的
requestWordLevelTimestamps()
包括字级时间戳。 在版本 1.7.0 中添加。
function requestWordLevelTimestamps()
setProfanity(ProfanityOption)
设置不雅内容选项。 在版本 1.7.0 中添加。
function setProfanity(profanity: ProfanityOption)
参数
- profanity
- ProfanityOption
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