次の方法で共有


BotFrameworkConfig class

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

Extends

DialogServiceConfigImpl

コンストラクター

BotFrameworkConfig()

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

プロパティ

applicationId

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

DialogTypes
outputFormat
properties

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

speechRecognitionLanguage

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

メソッド

fromAuthorizationToken(string, string, string)

指定した承認トークンとリージョンのボット フレームワーク構成インスタンスを作成します。 注: 呼び出し元は、承認トークンが有効であることを確認する必要があります。 承認トークンの有効期限が切れる前に、呼び出し元は、この構成で作成された対応する DialogServiceConnector インスタンスに authorizationToken プロパティを設定して更新する必要があります。構成オブジェクトの内容はコネクタの作成時にコピーされるため、DialogServiceConnector で authorizationToken を設定しても、元の構成の承認トークンは更新されません。 新しい構成インスタンスを作成するか、SpeechServiceAuthorization_Token プロパティを設定して既存のインスタンスを更新します (DialogServiceConnectors をさらに作成する場合)。

fromEndpoint(URL, string)

BotFrameworkConfig のインスタンスを作成します。 このメソッドは、標準以外のサービス エンドポイントまたはパラメーターを使用するユーザーのみを対象としています。 注: エンドポイント URL で指定されたクエリ パラメーターは、他の API によって設定されている場合でも変更されません。 注: fromEndpoint で承認トークンを使用するには、fromEndpoint メソッドの subscriptionKey に空の文字列を渡し、作成された BotFrameworkConfig インスタンスで authorizationToken="token" を設定して承認トークンを使用します。 注: バージョン 1.15.0 で追加されました。

fromHost(string | URL, string, string)

BotFrameworkConfig のインスタンスを作成します。 このメソッドは、既定以外のサービス ホストを使用するユーザーのみを対象としています。 標準リソース パスが想定されます。 標準以外のリソース パスを持つサービス、またはパスがまったくないサービスの場合は、代わりに fromEndpoint を使用してください。 注: クエリ パラメーターはホスト URI では許可されず、他の API で設定する必要があります。 注: fromHost で承認トークンを使用するには、fromHost(URL) を使用し、作成された BotFrameworkConfig インスタンスに AuthorizationToken プロパティを設定します。 注: バージョン 1.15.0 で追加されました。

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)

コンストラクターの詳細

BotFrameworkConfig()

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

new BotFrameworkConfig()

プロパティの詳細

applicationId

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

void applicationId

プロパティ値

void

DialogTypes

static { BotFramework: string, CustomCommands: string } DialogTypes

プロパティ値

{ BotFramework: string, CustomCommands: string }

outputFormat

OutputFormat outputFormat

プロパティ値

properties

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

PropertyCollection properties

プロパティ値

プロパティ。

speechRecognitionLanguage

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

string speechRecognitionLanguage

プロパティ値

string

メソッドの詳細

fromAuthorizationToken(string, string, string)

指定した承認トークンとリージョンのボット フレームワーク構成インスタンスを作成します。 注: 呼び出し元は、承認トークンが有効であることを確認する必要があります。 承認トークンの有効期限が切れる前に、呼び出し元は、この構成で作成された対応する DialogServiceConnector インスタンスに authorizationToken プロパティを設定して更新する必要があります。構成オブジェクトの内容はコネクタの作成時にコピーされるため、DialogServiceConnector で authorizationToken を設定しても、元の構成の承認トークンは更新されません。 新しい構成インスタンスを作成するか、SpeechServiceAuthorization_Token プロパティを設定して既存のインスタンスを更新します (DialogServiceConnectors をさらに作成する場合)。

static function fromAuthorizationToken(authorizationToken: string, region: string, botId?: string): BotFrameworkConfig

パラメーター

authorizationToken

string

ボットに関連付けられている承認トークン

region

string

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

botId

string

省略可能。 Azure リソース グループ内で特定のボットを使用するための識別子。 リソース名と同じです。

戻り値

新しいボット フレームワーク構成インスタンス。

fromEndpoint(URL, string)

BotFrameworkConfig のインスタンスを作成します。 このメソッドは、標準以外のサービス エンドポイントまたはパラメーターを使用するユーザーのみを対象としています。 注: エンドポイント URL で指定されたクエリ パラメーターは、他の API によって設定されている場合でも変更されません。 注: fromEndpoint で承認トークンを使用するには、fromEndpoint メソッドの subscriptionKey に空の文字列を渡し、作成された BotFrameworkConfig インスタンスで authorizationToken="token" を設定して承認トークンを使用します。 注: バージョン 1.15.0 で追加されました。

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

パラメーター

endpoint

URL

接続するサービス エンドポイント。

subscriptionKey

string

サブスクリプション キー。 サブスクリプション キーを指定しない場合は、承認トークンを設定する必要があります。

戻り値

  • 指定されたエンドポイントを使用する新しいボット フレームワーク構成インスタンス。

fromHost(string | URL, string, string)

BotFrameworkConfig のインスタンスを作成します。 このメソッドは、既定以外のサービス ホストを使用するユーザーのみを対象としています。 標準リソース パスが想定されます。 標準以外のリソース パスを持つサービス、またはパスがまったくないサービスの場合は、代わりに fromEndpoint を使用してください。 注: クエリ パラメーターはホスト URI では許可されず、他の API で設定する必要があります。 注: fromHost で承認トークンを使用するには、fromHost(URL) を使用し、作成された BotFrameworkConfig インスタンスに AuthorizationToken プロパティを設定します。 注: バージョン 1.15.0 で追加されました。

static function fromHost(host: string | URL, subscriptionKey?: string, botId?: string): BotFrameworkConfig

パラメーター

host

string | URL

URL が指定されている場合は、プロトコル (wss://your.host.com:1234 など) を持つ完全修飾ホストが使用されます。 文字列が指定されている場合は、wss://{host}.convai.speech.azure.us に埋め込まれます。

subscriptionKey

string

サブスクリプション キー。 サブスクリプション キーを指定しない場合は、承認トークンを設定する必要があります。

botId

string

省略可能。 Azure リソース グループ内で特定のボットを使用するための識別子。 リソース名と同じです。

戻り値

新しいボット フレームワーク構成インスタンス。

fromSubscription(string, string, string)

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

static function fromSubscription(subscription: string, region: string, botId?: string): BotFrameworkConfig

パラメーター

subscription

string

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

region

string

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

botId

string

省略可能。 Azure リソース グループ内で特定のボットを使用するための識別子。 リソース名と同じです。

戻り値

新しいボット フレームワーク構成インスタンス。

継承済みメソッドの詳細

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

継承元 DialogServiceConfigImpl.setServiceProperty