AdaptiveDialog class
アダプティブ ダイアログでは、イベントとイベントを使用して会話をモデル化し、変化する会話フローに動的に適応します。
- Extends
-
DialogContainer<O>
コンストラクター
| Adaptive |
新しい |
プロパティ
| $kind | |
| auto |
実行するアクションがない場合にダイアログを終了するかどうかを指定します。 |
| condition |
|
| default |
アクションと |
| generator | 随意。 言語ジェネレーターのオーバーライド。 |
| recognizer | 随意。 メッセージ発話を分析するために使用される認識エンジン。 |
| schema | ダイアログの JSON スキーマを設定します。 ダイアログの JSON スキーマを取得します。 |
| selector | 随意。 実行できるイベントを選択するためのセレクター。 |
| triggers | 実行中のプランを変更する条件に応答するようにハンドラーをトリガーします。 |
継承されたプロパティ
| dialogs | コンテナー ダイアログ セット。 |
| End |
既定のターン終了の結果を取得します。 |
| id | |
| telemetry |
メソッド
| begin |
ダイアログが開始され、ダイアログ スタックにプッシュされたときに呼び出されます。 |
| continue |
ダイアログがアクティブなダイアログであり、ユーザーが新しいアクティビティで応答 、ダイアログが続けられたときに呼び出されます。 |
| create |
指定されたコンテキストの子 DialogContext を作成します。 |
| end |
ダイアログが終了するときに呼び出されます。 |
| get |
|
| get |
ダイアログ 列挙依存関係 取得します。 |
| reprompt |
ユーザーを再プロンプトします。 |
| resume |
子ダイアログがターンを完了し、このダイアログにコントロールを返したときに呼び出されます。 |
継承されたメソッド
| configure(Record<string, unknown>) | オブジェクトを構成するための Fluent メソッド。 |
| find |
以前にコンテナーに追加された子ダイアログを検索します。 |
| get |
再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。 |
| on |
現在のダイアログまたは現在のダイアログが開始したダイアログによって、 |
コンストラクターの詳細
AdaptiveDialog(string)
新しい AdaptiveDialog インスタンスを作成します。
new AdaptiveDialog(dialogId?: string)パラメーター
- dialogId
-
string
(省略可能) 親ダイアログ セット内のコンポーネントの一意の ID。
プロパティの詳細
$kind
static $kind: stringプロパティ値
string
autoEndDialog
実行するアクションがない場合にダイアログを終了するかどうかを指定します。
autoEndDialog: BoolExpressionプロパティ値
BoolExpression
注釈
true の場合、実行するアクションがない場合、現在のダイアログは終了します。 false の場合、実行するアクションがない場合、現在のダイアログは単にターンを終了し、アクティブなままです。 既定値は true です。
conditionTracker
static conditionTracker: stringプロパティ値
string
defaultResultProperty
アクションと AutoEndDialog = trueがなくなったときにダイアログが終了したときに結果として返されるプロパティ。
defaultResultProperty: stringプロパティ値
string
注釈
既定値は dialog.resultです。
generator
recognizer
随意。 メッセージ発話を分析するために使用される認識エンジン。
recognizer?: Recognizerプロパティ値
Recognizer
schema
ダイアログの JSON スキーマを設定します。 ダイアログの JSON スキーマを取得します。
object schemaプロパティ値
object
ダイアログ スキーマ。
selector
triggers
継承されたプロパティの詳細
dialogs
コンテナー ダイアログ セット。
dialogs: DialogSetプロパティ値
DialogSet
DialogContainer.dialogs から継承された
EndOfTurn
既定のターン終了の結果を取得します。
static EndOfTurn: DialogTurnResultプロパティ値
DialogTurnResult
注釈
この結果は、ダイアログ (またはダイアログ内の論理ステップ) が現在のターンの処理を完了し、まだアクティブであり、より多くの入力を待機していることを示します。
Dialog.EndOfTurn から継承された
id
id: stringプロパティ値
string
Dialog.id から継承された
telemetryClient
telemetryClient: BotTelemetryClientプロパティ値
BotTelemetryClient
DialogContainer.telemetryClient から継承された
メソッドの詳細
beginDialog(DialogContext, O)
ダイアログが開始され、ダイアログ スタックにプッシュされたときに呼び出されます。
function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult>パラメーター
- dc
-
DialogContext
会話の現在のターンの DialogContext。
- options
-
O
オプション。ダイアログに渡す初期情報。
戻り値
Promise<DialogTurnResult>
非同期操作を表す Promise。
continueDialog(DialogContext)
ダイアログがアクティブなダイアログであり、ユーザーが新しいアクティビティで応答 、ダイアログが続けられたときに呼び出されます。
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>パラメーター
- dc
-
DialogContext
会話の現在のターンの DialogContext。
戻り値
Promise<DialogTurnResult>
非同期操作を表す Promise。
createChildContext(DialogContext)
指定されたコンテキストの子 DialogContext を作成します。
function createChildContext(dc: DialogContext): DialogContextパラメーター
- dc
-
DialogContext
会話の現在のターンの DialogContext。
戻り値
DialogContext
指定されたコンテキストに対して AdaptiveDialogState.actions が見つからない場合は、子 DialogContext または null。
endDialog(TurnContext, DialogInstance, DialogReason)
ダイアログが終了するときに呼び出されます。
function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>パラメーター
- turnContext
-
TurnContext
このターンのコンテキスト オブジェクト。
- instance
-
DialogInstance
ダイアログ スタック上のこのダイアログのインスタンスに関連付けられている状態情報。
- reason
-
DialogReason
ダイアログが終了した理由。
戻り値
Promise<void>
非同期操作を表す Promise。
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactoryパラメーター
- property
-
Object
条件付きセレクター構成のキー。
戻り値
Converter | ConverterFactory
セレクター構成のコンバーター。
getDependencies()
ダイアログ 列挙依存関係 取得します。
function getDependencies(): Dialog[]戻り値
Dialog[]
(xref:botbuilder-dialogs。ダイアログ)の列挙された依存関係。
repromptDialog(DialogContext | TurnContext, DialogInstance)
ユーザーを再プロンプトします。
function repromptDialog(context: DialogContext | TurnContext, instance: DialogInstance): Promise<void>パラメーター
- context
-
DialogContext | TurnContext
ターンのコンテキスト オブジェクト。
- instance
-
DialogInstance
このダイアログの現在の状態情報。
戻り値
Promise<void>
非同期操作を表す Promise。
resumeDialog(DialogContext, DialogReason, any)
子ダイアログがターンを完了し、このダイアログにコントロールを返したときに呼び出されます。
function resumeDialog(dc: DialogContext, _reason?: DialogReason, _result?: any): Promise<DialogTurnResult>パラメーター
- dc
-
DialogContext
会話の現在のターンのダイアログ コンテキスト。
- _reason
-
DialogReason
ダイアログが再開された理由。
- _result
-
any
オプション。呼び出されたダイアログから返される値。 返される値の型は、子ダイアログに依存します。
戻り値
Promise<DialogTurnResult>
非同期操作を表す Promise。
継承済みメソッドの詳細
configure(Record<string, unknown>)
オブジェクトを構成するための Fluent メソッド。
function configure(config: Record<string, unknown>): thisパラメーター
- config
-
Record<string, unknown>
適用する構成設定。
戻り値
this
操作が完了した後の 構成可能な。
継承 構成可能。configure
findDialog(string)
以前にコンテナーに追加された子ダイアログを検索します。
function findDialog(dialogId: string): Dialog | undefinedパラメーター
- dialogId
-
string
参照するダイアログの ID。
戻り値
Dialog | undefined
見つかった場合のダイアログ。それ以外の場合は null。
DialogContainer.findDialog から継承された
getVersion()
再デプロイ時のボットの変更の検出に役立つエンコードされた文字列。
function getVersion(): string戻り値
string
ダイアログを再起動する方法でダイアログが変更された場合にのみ変更する一意の文字列。
注釈
既定では、id versionChanged イベントが発生します。 このイベントがボットによって処理されない場合は、エラーがスローされ、ボットのエラー ハンドラー ロジックが実行されます。
空の文字列を返すと、コンポーネントのバージョン追跡がすべて無効になります。
Dialog.getVersion から継承された
onDialogEvent(DialogContext, DialogEvent)
現在のダイアログまたは現在のダイアログが開始したダイアログによって、DialogContext.emitEvent()を使用してイベントが発生したときに呼び出されます。
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>パラメーター
- dc
-
DialogContext
会話の現在のターンのダイアログ コンテキスト。
- e
-
DialogEvent
発生しているイベント。
戻り値
Promise<boolean>
True の 場合は、イベントが現在のダイアログで処理され、バブルを停止する必要があります。
DialogContainer.onDialogEvent から継承された