botbuilder package
クラス
| ActionSet |
"help" や "cancel" などのユーザーからのグローバル発話を処理するために、ダイアログにバインドできる名前付きアクションのサポートを実装します。 アクションはダイアログスタックの一部としてプッシュされ、会話の進行に応じてこれらのリスナーがスコープに入り、スコープ外に出ることができます。 また、名前付きアクションをボタンにバインドして、画面からスクロールしたカードのボタンクリックにボットが応答することもできます。 |
| AnimationCard |
アニメーション カードの作成を簡略化するカード ビルダー クラス。 |
| AudioCard |
メディア カードの作成を簡略化するカード ビルダー クラス。 |
| BotConnectorBot |
非推奨 |
| CardAction |
カードへのアクションの追加を簡略化する Builder クラス。 |
| CardImage |
カードへの画像の追加を簡略化する Builder クラス。 |
| CardMedia |
カードのメディア エンティティの定義 |
| ChatConnector |
Bot Framework を使用して、UniversalBot を複数のチャネルに接続します。 |
| CommandDialog |
非推奨 代わりに IntentDialog を使用してください。 |
| ConsoleConnector |
コンソール ウィンドウを使用して UniversalBot をコマンド ラインに接続します。 |
| Dialog |
すべてのダイアログの基本クラス。 ダイアログは BotBuilder フレームワークのコア コンポーネントです。 ボットはダイアログを使用して、ユーザーとの任意の複雑な会話を管理します。 |
| DialogAction |
ダイアログ アクションは、一般的なアクションを実装するための静的ショートカットを提供します。 また、"help" や "cancel" などのユーザーからのグローバル発話を処理するためにダイアログにバインドできる名前付きアクションのサポートも実装します。 アクションはダイアログスタックの一部としてプッシュされ、会話の進行に応じてこれらのリスナーがスコープに入り、スコープ外に出ることができます。 また、名前付きアクションをボタンにバインドして、画面からスクロールしたカードのボタンクリックにボットが応答することもできます。 |
| EntityRecognizer |
luis から受信した datetimes などの一般的なエンティティ & 解析に使用されるユーティリティ クラス。 |
| Fact |
領収書などのカードのファクトのリストの作成を簡略化する Builder クラス。 |
| HeroCard |
ヒーロー カードの構築を簡略化するカード ビルダー クラス。 ヒーロー カードにはサムネイル カードと同じ情報が含まれています。カードイメージのレイアウトが大きくなります。 |
| IntentDialog |
ユーザーの意図を識別し、必要に応じてユーザーの発話からエンティティを抽出します。 |
| IntentRecognizer |
すべてのコア認識エンジンの基本クラス。 認識エンジンの条件付き実行と、認識された意図の後のフィルター処理を許可します。 派生クラスは、onRecognize() メソッド |
| IntentRecognizerSet |
意図認識エンジンのセット間で recognize() 呼び出しをフェデレーションします。 |
| Keyboard |
キーボード カードの構築を簡略化するカード ビルダー クラス。 |
| Library |
ルーティング目的で使用される関連ダイアログのライブラリ。 ライブラリを連結して、複雑なボットの開発を可能にすることができます。 UniversalBot クラス自体は、このチェーンのルートを形成するライブラリです。 再利用可能なパーツのライブラリは、ボットと同様に新しいライブラリ インスタンスを作成し、ダイアログを追加することで開発できます。 ライブラリには、ライブラリ Web サイトまたは NPM モジュール名に対応する一意の名前が必要です。 その後、UniversalBot.library()を使用して、パーツ ライブラリ インスタンスをボットに追加するだけで、ボットでライブラリを再利用できます。 ライブラリ自体が他のライブラリに依存している場合は、Library.library()を使用して、ライブラリに依存関係として追加する必要があります。 ライブラリ名にバージョン番号を追加することで、ライブラリの複数のバージョンを簡単に管理できます。 ライブラリ ボット内でダイアログを呼び出すには、session.beginDialog() を ':' の形式で完全修飾ダイアログ ID で呼び出す必要があります。 通常は、ダイアログを開始するモジュールから関数を公開することで、開発者に対してこれを非表示にします。
したがって、 ダイアログは常に現在のダイアログ内で呼び出されるため、ライブラリのダイアログ内で、すべての beginDialog() がライブラリ名で呼び出す前にプレフィックスを付ける必要はありません。 ライブラリ名のプレフィックスを含める必要があるのは、あるライブラリ コンテキストから別のライブラリ コンテキストに交差する場合のみです。 |
| LocalizedRegExpRecognizer |
フレームワークのローカライズ システムを使用してローカライズされた正規表現を取得する RegExpRecognizer のバージョン。
index.json ファイル内の参照キーを指定する必要があります。新しいロケールのメッセージを受信すると、認識エンジンはローカライズされた式を取得し、新しい大文字と小文字を区別しない |
| LuisDialog |
非推奨 LuisRecognizer で IntentDialog を使用してください。 |
| LuisRecognizer |
Microsofts Language Understanding Intelligent Service (LUIS) を使用してユーザーの意図を検出する意図認識エンジン プラグイン 複数の LUIS モデル (アプリ) のサービス URL を渡して、複数の言語での認識をサポートできます。 |
| MediaCard |
メディア カードの作成を簡略化するカード ビルダー クラス。 |
| MemoryBotStorage |
ユーザー & セッション状態データを格納するためのメモリ ストレージ実装の既定値。 |
| Message |
添付ファイルを含む複雑なメッセージの作成を簡略化するメッセージ ビルダー クラス。 |
| Middleware | |
| OAuthCard |
oauth カードの構築を簡略化するカード ビルダー クラス。 |
| Prompt |
組み込みのプロンプトの基本クラス。新しいカスタム プロンプトを作成するために使用できます。 Prompt クラスは、ユーザーをプロンプトまたは再プロンプトする基本的なロジックを提供し、ユーザーの応答のプロンプト認識とユーザーに送信される出力をカスタマイズするための拡張可能なフックのセットを提供します。
プロンプトには常に少なくとも 1 つの onRecognize() ハンドラーが登録されている必要があります。また、matches() または matchesAny() ハンドラーの追加をサポートします。これは、ユーザーが開始した特別なコマンドをプロンプトに追加するために使用できます。 たとえば、組み込みのプロンプトでは、ユーザーがプロンプトを繰り返し要求するのをリッスンする |
| PromptAttachment |
カスタマイズ可能な添付ファイルプロンプト。 |
| PromptChoice |
カスタマイズ可能な選択プロンプト。 |
| PromptConfirm |
カスタマイズ可能な確認プロンプト。 |
| PromptNumber |
カスタマイズ可能な確認プロンプト。 |
| PromptText |
カスタマイズ可能なテキスト プロンプト。 |
| PromptTime |
カスタマイズ可能な時間プロンプト。 |
| ReceiptCard |
レシート カードの作成を簡略化するカード ビルダー クラス。 |
| ReceiptItem |
レシート カードへの項目の追加を簡略化する Builder クラス。 |
| RegExpRecognizer |
正規表現を使用してユーザーの意図を検出する意図認識エンジン プラグイン。 複数の言語での認識をサポートするために、複数の式を渡すことができます。 |
| RemoteSessionLogger |
デバッグ イベントを使用して、セッション アクティビティをリモート エンドポイントに記録します。 エミュレーターがボットに接続すると、リモート デバッガーが自動的に使用されます。 エミュレーター 以外のチャネルでは、エミュレーター セッションのアドレスを |
| Session |
ユーザーとのボットの会話を管理します。 |
| SessionLogger |
セッション アクティビティをコンソールに記録するために使用される既定のセッション ロガー。 |
| SigninCard |
サインイン カードの作成を簡略化するカード ビルダー クラス。 |
| SimpleDialog |
単純なクロージャに基づくカスタム ダイアログを作成できます。 これは、動的な会話フローが必要な場合や、ウォーターフォールの使用にあまり適していない状況がある場合に便利です。 留意すべき点は次のとおりです。
|
| SimplePromptRecognizer |
非推奨の v3.8 の時点ではサポートされなくなりました。 代わりにカスタム プロンプトを使用してください。 |
| SuggestedActions |
メッセージに推奨されるアクションを追加する Builder クラス |
| TextBot |
非推奨 |
| ThumbnailCard |
サムネイル カードの作成を簡略化するカード ビルダー クラス。 |
| UniversalBot |
複数のチャネルにわたるユーザーとのボットの会話を管理します。 |
| VideoCard |
ビデオ カードの作成を簡略化するカード ビルダー クラス。 |
| WaterfallDialog |
ウォーターフォールに基づくカスタム ダイアログを作成できます。 |
インターフェイス
| IActionRouteData |
トリガーされたアクションに渡される引数。 |
| IAddress |
イベントのルーティング情報をアドレス指定します。 アドレスは双方向です。つまり、受信イベントと送信イベントの両方に対処するために使用できます。 コネクタ固有のコネクタでもあります。つまり、コネクタ は、独自のフィールドをアドレスに自由に追加できます。 プロアクティブ メッセージ をユーザー ボットに送信するには、受信した メッセージのアドレスを保存する必要があります。 チャネル アドレスによっては変更される可能性があるため、ボットは特定のユーザーに格納されているアドレスを定期的に更新する必要があります。 |
| IAnimationCard |
アニメーション カードのインターフェイス定義 |
| IAttachment |
多くのメッセージング チャネルは、より豊富なオブジェクトをアタッチする機能を提供します。 Bot Builder を使用すると、これらの添付ファイルをクロス チャネルの方法で表現でき、コネクタ チャネルネイティブコンストラクトを使用して添付ファイルをレンダリングするために最善を尽くします。 メッセージのチャネル レンダリングをより詳細に制御したい場合は、IEvent.sourceEvent を使用して、チャネル ネイティブ スキーマを使用して添付ファイルを提供できます。 送信できる添付ファイルの種類はチャネルによって異なりますが、基本的な種類は次のとおりです。
|
| IAudioCard |
オーディオ カードのインターフェイス定義 |
| IBeginDialogActionOptions |
|
| IBotStateData |
エクスポートされたボット状態データ。 |
| IBotStateDataResult |
|
| IBotStorage |
UniversalBot で使用される交換可能なストレージ システム。 |
| IBotStorageContext |
IBotStorage 呼び出しに渡されるコンテキスト オブジェクト。 |
| IBotStorageData |
IBotStorage に保持されるデータ値。 |
| ICancelActionOptions |
|
| ICardAction |
カード、ボタン、またはイメージがタップされたときに実行する必要があるアクション。 |
| ICardImage |
カード上の画像。 |
| ICardMediaUrl |
カードのメディアを記述する URL 情報 |
| IChatConnectorAddress |
ChatConnector 特定のアドレスを |
| IChatConnectorEndpoint |
ChatConnector インスタンスでさまざまなエンドポイントを設定するために使用されるオプション。 これは変更しないでください。通常、IChatConnectorSettings の開発者は提供しません。 代わりに、IChatConnectorSettings の "stateEndpoint"、"openIdMetadata" の 2 つのプロパティをそこで変更する必要があります。 |
| IChatConnectorSettings |
ChatConnector インスタンスの初期化に使用するオプション。 |
| IChoice |
Prompts.choice() または [PromptRecognizers.recognizeChoices()][/en-us/node/builder/chat-reference/classes/botbuilder_d.promptrecognizers#recognizechoices] に渡すことができる選択肢。 |
| IConnector |
UniversalBot のコネクタ プラグインによって実装されます。 |
| IContactRelationUpdate |
ユーザーが連絡先リストを更新しました。 /** ユーザーが連絡先リストを更新しました。 |
| IConversationMembers |
会話内のメンバーの一覧。 |
| IConversationUpdate |
会話のプロパティが変更されました。 |
| IConversationsResult |
|
| IDefaultLocalizerSettings |
ILocalizer の実装を初期化するために使用される設定。 |
| IDialogActionOptions |
ダイアログ アクションを定義するときに渡されるオプション。 |
| IDialogResult |
session.endDialog() の呼び出しによって子ダイアログによって親に返される結果。 |
| IDialogState |
セッション ダイアログ スタック上のエントリ。 |
| IDialogVersionOptions |
Middleware.dialogVersion() に渡されるオプション。 |
| IDialogWaterfallStep |
DialogAction.waterfall()を ダイアログまたは組み込みのプロンプトがウォーターフォール ステップから呼び出されると、そのダイアログまたはプロンプトの結果は、 渡された ウォーターフォールは、
注意: ウォーターフォールには非表示の最後のステップがあり、最後のステップからプロンプトまたはダイアログを呼び出すと、現在のダイアログが自動的に終了します。 これは、ダイアログの深いスタックがあり、スタックの最後の子から session.endDialog() を |
| IDisambiguateChoices |
Prompts.disaiguate()に渡すルートの選択。
マップのキーは、ユーザーに表示するローカライズされたラベルで、値はユーザーが選択したときに選択するルートである必要があります。 ルートの |
| IDisambiguateRouteHandler |
UniversalBot.onDisambiguateRoute() |
| IEntity |
認識されたエンティティ。 |
| IEvent |
ソースから受信またはソースに送信されるイベント。 |
| IEventMiddleware |
'receive' または 'send' イベントをフックするミドルウェアの一部の関数シグネチャ。 |
| IFact | |
| IFindActionRouteContext |
|
| IFindMatchResult |
EntityRecognizer.findBestMatch() または EntityRecognizer.findAllMatches() の呼び出しから返される結果。 |
| IFindRoutesHandler |
Library.onFindRoutes()に渡されるカスタム ルート検索ロジック。 |
| IFirstRunOptions |
Middleware.firstRun() に渡されるオプション。 |
| IIdentity |
ユーザー、ボット、または会話を表します。 |
| IIntent |
認識された意図。 |
| IIntentDialogOptions |
IntentDialogの構成に使用するオプション。 |
| IIntentRecognizer |
LuisRecognizer クラスなどの意図認識エンジン プラグインによって実装されるインターフェイス。 |
| IIntentRecognizerResult |
意図認識エンジンによって返される結果。 |
| IIntentRecognizerSetOptions |
IntentRecognizerSetの構成に使用するオプション。 |
| IIsAttachment |
添付ファイルに変換できるクラスによって実装されます。 |
| IIsCardAction |
カード アクションに変換できるクラスによって実装されます。 |
| IIsCardImage |
カード イメージに変換できるクラスによって実装されます。 |
| IIsCardMedia |
カードのメディアに変換できるエンティティ |
| IIsFact |
ファクトに変換できるクラスによって実装されます。 |
| IIsMessage |
Message ビルダー クラスなど、IMessage に変換できるクラスによって実装されます。 |
| IIsReceiptItem |
レシートアイテムに変換できるクラスによって実装されます。 |
| IIsSuggestedActions |
推奨されるアクションに変換できるクラスによって実装されます |
| ILocalizer |
ボットによってユーザーに送信されたメッセージをローカライズするためのプラグイン。 |
| ILuisModelMap |
LuisRecognizer に使用する LUIS サービス URL の/ローカル マッピング。 |
| IMediaCard |
一般的な MediaCard のインターフェイス定義。具体的な形式は、オーディオ、アニメーション、またはビデオ カードにすることができます。 |
| IMediaEventValue |
メディア イベントの補助パラメーター。 |
| IMessage |
ユーザーとボットの間で送信されるチャット メッセージ。 ボットからユーザーへのメッセージには、次の 2 種類があります。
事後対応型の場合は、受信メッセージから送信メッセージに アドレス フィールドをコピーし (Message ビルダー クラスを使用し、セッションで初期化 自動的に行われる場合)、テキスト または添付ファイル を設定する必要があります。 プロアクティブ メッセージの場合は、受信メッセージから外部ストレージに 受信アドレス オブジェクトを使用してユーザーにメッセージを作成すると、既定では、現在の会話のコンテキストでユーザーに返信が送信されます。 一部のチャネルでは、ユーザーとの新しい会話を開始できます。 ユーザーとの新しいプロアクティブな会話を開始するには、送信メッセージを作成する前に、アドレス オブジェクトから conversation フィールドを削除するだけです。 |
| IMessageOptions |
プロンプトや session.say()などに送信できるオプションのメッセージ プロパティ。 |
| IMessageReaction |
メッセージの反応オブジェクト。 |
| IMessageUpdate |
メッセージのプロパティが変更されました。 |
| IMiddlewareMap |
UniversalBot.use()の呼び出しに登録できるミドルウェア フックのマップ。 |
| IOAuthCard |
OAuthCard を表すインターフェイス。 OAuth 経由でサインインを実行する要求を表すカード |
| IPagedMembersResult |
|
| IPromptArgs |
新しいプロンプト システムが IPromptOptions を使用 非推奨になりました。 |
| IPromptAttachmentFeatures |
PromptAttachment クラス |
| IPromptAttachmentOptions |
Prompts.attachment() または |
| IPromptAttachmentResult |
厳密に型指定された添付ファイル プロンプトの結果。 |
| IPromptChoiceFeatures |
PromptChoice クラス |
| IPromptChoiceOptions |
Prompts.choice() または |
| IPromptChoiceResult |
厳密に型指定された選択肢プロンプトの結果。 |
| IPromptConfirmResult |
厳密に型指定された確認プロンプトの結果。 |
| IPromptContext |
プロンプトで追跡されるコンテキスト情報。 この情報は、session.dialogDataを使用してプロンプト内でアクセスできます。 |
| IPromptFeatures |
カスタム プロンプト を作成するときに有効または無効にする必要があるオプションの機能 |
| IPromptNumberOptions |
Prompts.number() に渡されるオプション、または |
| IPromptNumberResult |
厳密に型指定された数値プロンプトの結果。 |
| IPromptOptions | |
| IPromptRecognizeChoicesOptions |
PromptRecognizers.recognizeChoices() |
| IPromptRecognizeNumbersOptions |
PromptRecognizers.recognizeNumbers() |
| IPromptRecognizeTimesOptions |
PromptRecognizers.recognizeTimes() |
| IPromptRecognizeValuesOptions |
PromptRecognizers.recognizeValues() |
| IPromptRecognizer |
非推奨の v3.8 の時点ではサポートされなくなりました。 代わりにカスタム プロンプトを使用してください。 |
| IPromptRecognizerArgs |
非推奨の v3.8 の時点ではサポートされなくなりました。 代わりにカスタム プロンプトを使用してください。 |
| IPromptRecognizerResult |
IPromptRecognizer から返される結果。 |
| IPromptResult |
システム プロンプトによって返されるダイアログの結果。 |
| IPromptTextFeatures |
PromptText クラス |
| IPromptTextOptions |
PromptText クラスに基づいて、 |
| IPromptTextResult |
厳密に型指定されたテキスト プロンプトの結果。 |
| IPromptTimeResult |
厳密に型指定された時間プロンプトの結果。 |
| IPromptsOptions |
非推奨の v3.8 の時点ではサポートされなくなりました。 代わりにカスタム プロンプトを使用してください。 |
| IReceiptCard |
購入した内容または購入を計画しているユーザーにリッチ レシートを表示します。 |
| IReceiptItem |
レシート内の個々のアイテム。 |
| IRecognizeContext |
さまざまな認識方法に渡される受信メッセージのコンテキスト。 |
| IRecognizeDialogContext |
|
| IRecognizeResult |
recognize() 関数の呼び出しの結果。 実装では、結果に追加のプロパティを自由に追加できます。 |
| IRegExpMap |
RegExpRecognizer に使用する正規表現の/ローカル マッピング。 |
| IRouteResult |
Library.findRoutes()によって返される候補ルート。 |
| ISelectRouteHandler |
Library.onSelectRoute()に渡されるカスタム ルート検索ロジック。 |
| ISemanticAction |
プログラムによるアクションへの参照を表します。 |
| ISessionMiddleware |
'botbuilder' イベントをフックするミドルウェアの一部の関数シグネチャ。 |
| ISessionOptions |
セッションのコンストラクターに渡されるオプション。 |
| ISessionState |
会話ダイアログ スタックを追跡するために使用される永続化されたセッション状態。 |
| ISigninCard |
ユーザーにサインイン カードとボタンを表示します。 一部のチャネルでは、これをテキスト プロンプトとしてレンダリングし、クリックするためのリンクを選択できます。 |
| ISourceEventMap |
送信するカスタム イベント データのソースごとのマッピング。 |
| IStartConversationAddress |
UniversalBot.beginDialog()にアドレスと共に渡すことができる追加のプロパティ。 |
| ISuggestedActions |
ユーザーに送信し、迅速な返信として表示する推奨されるアクション。 推奨されるアクションは、推奨されるアクションをサポートするチャネルにのみ表示されます。 |
| ITextHighlight |
TextHighlight を表すインターフェイス。 別のフィールド内のコンテンツの部分文字列を参照します。 |
| IThumbnailCard |
小さいサムネイル レイアウトまたは大きいヒーロー レイアウトを使用してユーザーにカードを表示します (添付ファイル contentType によって決定されます)。 すべてのカード フィールドは省略可能であるため、このカードを使用して特定のチャネルでキーボードなどを指定できます。 一部のチャネルでは、カードの忠実度の低いバージョンをレンダリングするか、代替表現を使用することを選択できます。 |
| ITokenResponse |
TokenResponse を表すインターフェイス。 ユーザー トークンを含む応答 |
| ITranscript |
歴史的なアクティビティを表すインターフェイス。 |
| ITriggerActionOptions |
|
| IUniversalBotSettings |
UniversalBot インスタンスを初期化するために使用されるオプション。 |
| IVideoCard |
ビデオ カードのインターフェイス定義 |
| IWatchableHandler |
監視対象変数の値を取得するための関数。 Session.watchable()に渡されます。 |
型エイリアス
| AttachmentType |
一部のメソッドは、JSON 形式の |
| MatchType |
ユーザーの発話を照合するためのサポートされているルール。
|
| MessageType |
ユーザーに送信できるメッセージ ベースのプロンプト。
|
| TextOrMessageType |
ユーザーに送信できる柔軟な範囲のプロンプト。
|
| TextType |
ユーザーに送信できるテキスト ベースのプロンプト。
|
| ValueListType |
テキスト値の一覧。 値は、"value1|value2|value3" や値の単純な配列などのパイプ区切り文字列として表すことができます。 |
列挙型
| ListStyle |
PromptType.choice プロンプトに表示するリストの種類。 |
| PromptType |
呼び出されたプロンプトの種類。 |
| RecognizeMode |
ユーザーテキスト発話の処理 |
| RecognizeOrder |
IntentDialogs 認識エンジンを評価する順序。 |
| ResumeReason |
ダイアログが再開された理由コード。 |