次の方法で共有


ITriggerActionOptions interface

triggerAction()を定義するときに渡されるオプション。

Extends

プロパティ

confirmPrompt

指定した場合、ユーザーは、現在完了していないタスクを取り消しても問題ないかどうかを確認するメッセージが表示されます。

dialogArgs

(省略可能) アクションがトリガーされたときに生成されたダイアログに渡す引数。

intentThreshold

(省略可能) に一致するの値を使用してアクションをトリガーするために必要な最小スコア。 既定値は 0.1 です。

matches

(省略可能) アクションのトリガーに使用される意図。 正規表現または名前付き意図のいずれかを指定でき、複数の意図を指定できます。 名前付き意図が指定されると、Library.recognizer()を使用して、ライブラリ/ボットに割り当てられた認識エンジンを使用してアクションが照合されます。 一致するオプションが指定されていない場合、アクションは、onFindAction ハンドラーが指定されている場合にのみ照合できます。

onFindAction

(省略可能) アクションがトリガーされる必要があるかどうかを確認するためにチェックされるたびに呼び出されるカスタム ハンドラー。 ハンドラーには、受信したメッセージと検出された意図を含むコンテキスト オブジェクトが渡されます。 ハンドラーは、0.0 から 1.0 の信頼度スコアと、selectActionRoute 呼び出し中に渡す必要がある routeData を返す必要があります。

onInterrupted

(省略可能) ルート ダイアログが別のルート ダイアログによって中断されているときに呼び出されるカスタム ハンドラー。 これにより、ダイアログでカスタム クリーンアップ ロジックを実行したり、中断が意図されたことを確認するようにユーザーに求めたりできるようになります。 これはウォーターフォールではないため、アクションの既定の動作を実行する場合は next() を呼び出す必要があることに注意してください。

onSelectAction

(省略可能) アクションがトリガーされるたびに呼び出されるカスタム ハンドラー。 これにより、アクションの動作をカスタマイズできます。 たとえば、新しいダイアログが開始される前にダイアログ スタックをクリアし、新しいダイアログをスタックの末尾にプッシュするだけの既定の動作を変更できます。 これはウォーターフォールではないため、アクションの既定の動作を実行する場合は next() を呼び出す必要があることに注意してください。

プロパティの詳細

confirmPrompt

指定した場合、ユーザーは、現在完了していないタスクを取り消しても問題ないかどうかを確認するメッセージが表示されます。

confirmPrompt?: TextOrMessageType

プロパティ値

dialogArgs

(省略可能) アクションがトリガーされたときに生成されたダイアログに渡す引数。

dialogArgs?: any

プロパティ値

any

intentThreshold

(省略可能) に一致するの値を使用してアクションをトリガーするために必要な最小スコア。 既定値は 0.1 です。

intentThreshold?: number

プロパティ値

number

matches

(省略可能) アクションのトリガーに使用される意図。 正規表現または名前付き意図のいずれかを指定でき、複数の意図を指定できます。 名前付き意図が指定されると、Library.recognizer()を使用して、ライブラリ/ボットに割り当てられた認識エンジンを使用してアクションが照合されます。 一致するオプションが指定されていない場合、アクションは、onFindAction ハンドラーが指定されている場合にのみ照合できます。

matches?: MatchType

プロパティ値

onFindAction

(省略可能) アクションがトリガーされる必要があるかどうかを確認するためにチェックされるたびに呼び出されるカスタム ハンドラー。 ハンドラーには、受信したメッセージと検出された意図を含むコンテキスト オブジェクトが渡されます。 ハンドラーは、0.0 から 1.0 の信頼度スコアと、selectActionRoute 呼び出し中に渡す必要がある routeData を返す必要があります。

onFindAction?: (context: IFindActionRouteContext, callback: (err: Error, score: number, routeData?: IActionRouteData) => void) => void

プロパティ値

(context: IFindActionRouteContext, callback: (err: Error, score: number, routeData?: IActionRouteData) => void) => void

onInterrupted

(省略可能) ルート ダイアログが別のルート ダイアログによって中断されているときに呼び出されるカスタム ハンドラー。 これにより、ダイアログでカスタム クリーンアップ ロジックを実行したり、中断が意図されたことを確認するようにユーザーに求めたりできるようになります。 これはウォーターフォールではないため、アクションの既定の動作を実行する場合は next() を呼び出す必要があることに注意してください。

onInterrupted?: (session: Session, dialogId: string, dialogArgs?: any, next?: Function) => void

プロパティ値

(session: Session, dialogId: string, dialogArgs?: any, next?: Function) => void

onSelectAction

(省略可能) アクションがトリガーされるたびに呼び出されるカスタム ハンドラー。 これにより、アクションの動作をカスタマイズできます。 たとえば、新しいダイアログが開始される前にダイアログ スタックをクリアし、新しいダイアログをスタックの末尾にプッシュするだけの既定の動作を変更できます。 これはウォーターフォールではないため、アクションの既定の動作を実行する場合は next() を呼び出す必要があることに注意してください。

onSelectAction?: (session: Session, args?: IActionRouteData, next?: Function) => void

プロパティ値

(session: Session, args?: IActionRouteData, next?: Function) => void