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 所有のストレージ、または Cognitive Services サブスクリプションにリンクされた独自のストレージ アカウント (Bring Your Own Storage (BYOS) 対応 Speech リソース) に格納されます。 ログは 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 所有のストレージ、または Cognitive Services サブスクリプションにリンクされた独自のストレージ アカウント (Bring Your Own Storage (BYOS) 対応 Speech リソース) に格納されます。 ログは 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

Speech Factory インスタンス。

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

Speech Factory インスタンス。

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

Speech Factory インスタンス。

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