TextPrompt クラス

  • リファレンス
パッケージ:
com.microsoft.bot.dialogs.prompts
Maven 成果物:
com.microsoft.bot:bot-dialogs:4.14.3

public class TextPrompt
extends Prompt<java.lang.String>

ユーザーにテキスト入力を求めます。

コンストラクターの概要

コンストラクター 説明
TextPrompt(String dialogId)

TextPrompt クラスの新しいインスタンスを初期化します。
TextPrompt(String dialogId, PromptValidator<String> validator)

TextPrompt クラスの新しいインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

イベントが親にバブルされる前に呼び出されます。
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

ユーザーに入力を求めます。
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<java.lang.String>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

ユーザーの入力を認識しようとします。

メソッドの継承元: Dialog

beginDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent resumeDialog run setId setTelemetryClient

メソッドの継承元: Prompt

appendChoices beginDialog continueDialog onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

コンストラクターの詳細

TextPrompt

public TextPrompt(String dialogId)

TextPrompt クラスの新しいインスタンスを初期化します。

パラメーター:

dialogId - このプロンプトに割り当てる ID。 dialogId の値は、プロンプトが追加される DialogSet または ComponentDialog 内で一意である必要があります。

TextPrompt

public TextPrompt(String dialogId, PromptValidator validator)

TextPrompt クラスの新しいインスタンスを初期化します。

パラメーター:

dialogId - このプロンプトに割り当てる ID。
validator - 省略可能。このプロンプトの追加のカスタム検証を含む {@link PromptValidator{FoundChoice}} です。 dialogId の値は、プロンプトが追加される DialogSet または ComponentDialog 内で一意である必要があります。

メソッドの詳細

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

イベントが親にバブルされる前に呼び出されます。 これは、イベントのインターセプトを実行するのに適しています。'true' を返すと、ダイアログの親にイベントがさらにバブルするのを防ぎ、子ダイアログが既定の処理を実行することもできなくなります。

上書き:

TextPrompt.onPreBubbleEvent(DialogContext dc, DialogEvent e)

パラメーター:

dc - 会話の現在のターンのダイアログ コンテキスト。
e - 発生しているイベント。

戻り値:

イベントが現在のダイアログで処理され、さらに処理が停止するかどうか。

onPrompt

protected CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options, Boolean isRetry)

ユーザーに入力を求めます。

上書き:

TextPrompt.onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

パラメーター:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。
state - ダイアログ スタック上のプロンプトの現在のインスタンスの状態を格納します。
options - プロンプト オプション オブジェクトは、prompt(String dialogId, PromptOptions options) の呼び出しで最初に指定されたオプションから作成されます。
isRetry - スタック上のこのプロンプト ダイアログ インスタンスがユーザーに入力を求めるプロンプトを初めて行う場合は true。それ以外の場合は false。

戻り値:

非同期操作を表す CompletableFuture。

onRecognize

protected CompletableFuture> onRecognize(TurnContext turnContext, Map state, PromptOptions options)

ユーザーの入力を認識しようとします。

上書き:

TextPrompt.onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

パラメーター:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。
state - ダイアログ スタック上のプロンプトの現在のインスタンスの状態を格納します。
options - プロンプト オプション オブジェクトは、prompt(String dialogId, PromptOptions options) の呼び出しで最初に指定されたオプションから作成されます。

戻り値:

非同期操作を表す CompletableFuture。 タスクが成功した場合、結果には認識の試行の結果が記述されます。

適用対象