CustomCommandsConfig class

  • リファレンス
パッケージ:
microsoft-cognitiveservices-speech-sdk

CustomCommands バックエンドを使用するためのダイアログ サービス コネクタ オブジェクトの構成を定義するクラス。

Extends

DialogServiceConfigImpl

コンストラクター

CustomCommandsConfig()

CustomCommandsConfig のインスタンスを作成します。

プロパティ

applicationId

対応するバックエンド アプリケーション識別子を取得します。
DialogTypes
outputFormat
properties

カスタム プロパティへのアクセスを提供します。
speechRecognitionLanguage

音声認識言語を取得します。

メソッド

fromAuthorizationToken(string, string, string)

指定した Speech Commands アプリケーション ID、承認トークン、およびリージョンを使用して、ボット フレームワーク構成のインスタンスを作成します。 注: 呼び出し元は、承認トークンが有効であることを確認する必要があります。 認証トークンの有効期限が切れる前に、呼び出し元は、新しい有効なトークンを使用してこのセッターを呼び出すことによって、認証トークンを更新する必要があります。 新しい認識エンジンの作成時に構成値がコピーされるため、新しいトークン値は既に作成されている認識エンジンには適用されません。 以前に作成された認識エンジンの場合、トークンを更新するには、対応する認識エンジンの承認トークンを設定する必要があります。 それ以外の場合、認識中に認識エンジンでエラーが発生します。
fromSubscription(string, string, string)

指定したサブスクリプションとリージョンを使用して、ボット フレームワーク構成のインスタンスを作成します。

継承されたメソッド

close()

関連付けられているリソースを破棄します。
getProperty(string | PropertyId, string)

名前付きプロパティを値として設定します
setProperty(string | PropertyId, string)

名前付きプロパティを値として設定します
setProxy(string, number, string, string)

プロキシ構成を設定します。 Node.js環境でのみ関連します。 バージョン 1.4.0 で追加されました。
setServiceProperty(string, string, UriQueryParameter)

コンストラクターの詳細

CustomCommandsConfig()

CustomCommandsConfig のインスタンスを作成します。

new CustomCommandsConfig()

プロパティの詳細

applicationId

対応するバックエンド アプリケーション識別子を取得します。

string applicationId

プロパティ値

string

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

プロパティ値

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

プロパティ値

OutputFormat

properties

カスタム プロパティへのアクセスを提供します。

PropertyCollection properties

プロパティ値

PropertyCollection

プロパティ。

speechRecognitionLanguage

音声認識言語を取得します。

string speechRecognitionLanguage

プロパティ値

string

メソッドの詳細

fromAuthorizationToken(string, string, string)

指定した Speech Commands アプリケーション ID、承認トークン、およびリージョンを使用して、ボット フレームワーク構成のインスタンスを作成します。 注: 呼び出し元は、承認トークンが有効であることを確認する必要があります。 認証トークンの有効期限が切れる前に、呼び出し元は、新しい有効なトークンを使用してこのセッターを呼び出すことによって、認証トークンを更新する必要があります。 新しい認識エンジンの作成時に構成値がコピーされるため、新しいトークン値は既に作成されている認識エンジンには適用されません。 以前に作成された認識エンジンの場合、トークンを更新するには、対応する認識エンジンの承認トークンを設定する必要があります。 それ以外の場合、認識中に認識エンジンでエラーが発生します。

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

パラメーター

applicationId

string

Speech Commands アプリケーション ID。

authorizationToken

string

アプリケーションに関連付けられている承認トークン。

region

string

リージョン名 (リージョン ページを参照)。

戻り値

CustomCommandsConfig

新しい音声コマンドの構成。

fromSubscription(string, string, string)

指定したサブスクリプションとリージョンを使用して、ボット フレームワーク構成のインスタンスを作成します。

static function fromSubscription(applicationId: string, subscription: string, region: string): CustomCommandsConfig

パラメーター

applicationId

string

Speech Commands アプリケーション ID。

subscription

string

ボットに関連付けられているサブスクリプション キー

region

string

リージョン名 (リージョン ページを参照)。

戻り値

CustomCommandsConfig

新しいボット フレームワークの構成。

継承済みメソッドの詳細

close()

関連付けられているリソースを破棄します。

function close()

継承元 DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

名前付きプロパティを値として設定します

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

パラメーター

name

string | PropertyId

取得するプロパティ。

def

string

プロパティが不明な場合に返される既定値。

戻り値

string

指定されたプロパティの現在の値 (指定された既定値)。

継承元 DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

名前付きプロパティを値として設定します

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

パラメーター

name

string | PropertyId

設定するプロパティ。

value

string

値。

継承元 DialogServiceConfigImpl.setProperty

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

プロキシ サーバーのパスワード。

継承元 DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

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

パラメーター

name

string

value

string

channel
UriQueryParameter

継承元 DialogServiceConfigImpl.setServiceProperty