共用方式為

SpeechConfig class

  • 參考
套件:
microsoft-cognitiveservices-speech-sdk

語音設定。

屬性

authorizationToken

取得授權權杖。
endpointId

取得用於語音辨識之自訂語音模型的端點識別碼。
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)

使用指定的初始授權權杖和區域，建立語音處理站的實例。 注意：呼叫端必須確定授權權杖有效。 授權權杖到期之前，呼叫端必須使用新的有效權杖呼叫這個 setter 來重新整理它。 注意：如果您想要使用意圖辨識器，請使用衍生自 LanguageUnder understanding 訂用帳戶金鑰的權杖。 當建立新的辨識器時複製組態值時，新的權杖值將不會套用至已建立的辨識器。 針對先前建立的辨識器，您必須設定對應辨識器的授權權杖以重新整理權杖。 否則，辨識器會在辨識期間發生錯誤。
fromEndpoint(URL, string)

使用指定的端點和訂用帳戶金鑰，建立語音設定的實例。 這個方法僅適用于使用非標準服務端點或參數的使用者。 注意：如果您想要使用意圖辨識器，請使用您的 LanguageUnder understanding 訂用帳戶金鑰。 注意：端點 URL 中指定的查詢參數不會變更，即使這些參數是由任何其他 API 設定也一樣。 例如，如果在 uri 中定義語言作為查詢參數 「language=de-DE」，而且也會由 SpeechConfig.speechRecognitionLanguage = 「en-US」 設定，URI 中的語言設定會優先，且有效語言為 「de-DE」。 只有未在端點 URL 中指定的參數，才能由其他 API 設定。 注意：若要搭配 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 靜態實例。 注意：如果您想要使用意圖辨識器，請使用您的 LanguageUnder understanding 訂用帳戶金鑰。
getProperty(string, string)

傳回任意屬性的目前值。
requestWordLevelTimestamps()

包含文字層級時間戳記。 已在 1.7.0 版中新增。
setProfanity(ProfanityOption)

設定不雅內容選項。 已在 1.7.0 版中新增。
setProperty(string | PropertyId, string)

設定任意屬性。
setProxy(string, number)

設定 Proxy 組態。 僅適用于 Node.js 環境。 已在 1.4.0 版中新增。
setProxy(string, number, string, string)

設定 Proxy 組態。 僅適用于 Node.js 環境。 已在 1.4.0 版中新增。
setServiceProperty(string, string, UriQueryParameter)

設定將使用指定通道傳遞至服務的屬性值。 已在 1.7.0 版中新增。

屬性詳細資料

authorizationToken

取得授權權杖。

string authorizationToken

屬性值

string

endpointId

取得用於語音辨識之自訂語音模型的端點識別碼。

string endpointId

屬性值

string

端點識別碼

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)

使用指定的初始授權權杖和區域，建立語音處理站的實例。 注意：呼叫端必須確定授權權杖有效。 授權權杖到期之前，呼叫端必須使用新的有效權杖呼叫這個 setter 來重新整理它。 注意：如果您想要使用意圖辨識器，請使用衍生自 LanguageUnder understanding 訂用帳戶金鑰的權杖。 當建立新的辨識器時複製組態值時，新的權杖值將不會套用至已建立的辨識器。 針對先前建立的辨識器，您必須設定對應辨識器的授權權杖以重新整理權杖。 否則，辨識器會在辨識期間發生錯誤。

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

參數

authorizationToken

string

初始授權權杖。

region

string

區功能變數名稱稱 (請參閱 區域頁面) 。

傳回

SpeechConfig

語音處理站實例。

fromEndpoint(URL, string)

使用指定的端點和訂用帳戶金鑰，建立語音設定的實例。 這個方法僅適用于使用非標準服務端點或參數的使用者。 注意：如果您想要使用意圖辨識器，請使用您的 LanguageUnder understanding 訂用帳戶金鑰。 注意：端點 URL 中指定的查詢參數不會變更，即使這些參數是由任何其他 API 設定也一樣。 例如，如果在 uri 中定義語言作為查詢參數 「language=de-DE」，而且也會由 SpeechConfig.speechRecognitionLanguage = 「en-US」 設定，URI 中的語言設定會優先，且有效語言為 「de-DE」。 只有未在端點 URL 中指定的參數，才能由其他 API 設定。 注意：若要搭配 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 靜態實例。 注意：如果您想要使用意圖辨識器，請使用您的 LanguageUnder understanding 訂用帳戶金鑰。

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)

設定 Proxy 組態。 僅適用于 Node.js 環境。 已在 1.4.0 版中新增。

function setProxy(proxyHostName: string, proxyPort: number)

參數

proxyHostName

string

Proxy 伺服器的主機名稱。

proxyPort

number

Proxy 伺服器的埠號碼。

setProxy(string, number, string, string)

設定 Proxy 組態。 僅適用于 Node.js 環境。 已在 1.4.0 版中新增。

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

參數

proxyHostName

string

Proxy 伺服器的主機名稱，不含通訊協定配置 (HTTP：//)

proxyPort

number

Proxy 伺服器的埠號碼。

proxyUserName

string

Proxy 伺服器的使用者名稱。

proxyPassword

string

Proxy 伺服器的密碼。

setServiceProperty(string, string, UriQueryParameter)

設定將使用指定通道傳遞至服務的屬性值。 已在 1.7.0 版中新增。

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

參數

name

string

value

string

channel
UriQueryParameter