PromptConfirm class

Referenz

Paket:: botbuilder

Anpassbare Bestätigungsaufforderung.

Extends: PromptChoice

Konstruktoren

Erstellt eine neue anpassbare Instanz der Eingabeaufforderung. Ihre neue Eingabeaufforderung sollte entweder als Dialogfeld zu einem Bot oder einer Bibliothek hinzugefügt werden.

Eigenschaften

features

Die Aktuell konfigurierte Gruppe von Features wird angezeigt.

Methoden

addDialogTrigger(ActionSet, string)	Wird einmal für jedes Dialogfeld in einer Bibliothek aufgerufen, um dem Dialogfeld die Möglichkeit zu geben, dem globalen Bibliotheksaktionssatz seine `triggerAction()` hinzuzufügen. Diese Trigger werden einem `beginDialogAction()` zugeordnet, der das Dialogfeld startet, wenn die Triggerbedingung erfüllt ist.
begin<T>(Session, T)	Wird aufgerufen, wenn eine neue Dialogsitzung gestartet wird.
beginDialogAction(string, string, IBeginDialogActionOptions)	Bindet eine Aktion an das Dialogfeld, das ein weiteres Dialogfeld startet, wenn es ausgelöst wird. Das neue Dialogfeld wird auf den Stapel verschoben, sodass der aktuelle Vorgang nicht automatisch beendet wird. Die aktuelle Aufgabe wird fortgesetzt, sobald das neue Dialogfeld endet. Die integrierten Eingabeaufforderungen werden den Benutzer automatisch erneut auffordern, sobald dies geschieht, aber dieses Verhalten kann deaktiviert werden, indem das promptAfterAction Flag beim Aufrufen einer integrierten Eingabeaufforderung festgelegt wird.
cancelAction(string, TextOrMessageType, ICancelActionOptions)	Bindet eine Aktion an das Dialogfeld, das das Dialogfeld bei jedem Auslösen abbricht. Wenn der Vorgang abgebrochen wurde, werden die übergeordneten Dialogfelder mit einem fortgesetzt Code fortgesetzt, der angibt, dass es abgebrochenwurde.
clone(ActionSet)	Gibt einen Klon eines vorhandenen ActionSet zurück.
customAction(IDialogActionOptions)	Bindet eine benutzerdefinierte Aktion an das Dialogfeld, das beim Auslösen der übergebenen onSelectAction--Handlers übergeben wird.
dialogInterrupted(Session, string, any)	Wird aufgerufen, wenn ein Stammdialogfeld durch ein anderes Dialogfeld unterbrochen wird. Dadurch wird das Dialogfeld, das unterbrochen wird, die Möglichkeit gegeben, benutzerdefinierte Logik auszuführen, bevor sie aus dem Stapel entfernt wird. Das Dialogfeld selbst ist dafür verantwortlich, den Dialogstapel zu löschen und das neue Dialogfeld zu starten.
dialogResumed<T>(Session, IDialogResult<T>)	Ein untergeordnetes Dialogfeld wurde beendet, und das aktuelle Dialogfeld wird fortgesetzt.
endConversationAction(string, TextOrMessageType, ICancelActionOptions)	Bindet eine Aktion, die die Unterhaltung mit dem Benutzer beendet, wenn sie ausgelöst wird.
findActionRoutes(IRecognizeDialogContext, (err: Error, results: IRouteResult[]) => void)	Wird während des Library.findRoutes() aufgerufen, Aufruf für jedes Dialogfeld im Stapel, um festzustellen, ob eine der Dialogfeldaktionen von den Benutzern ausgelöst wird.
findChoices(IRecognizeContext, boolean, (err: Error, choices: IChoice[]) => void)	Gibt die Liste der dynamischen oder statischen Auswahlmöglichkeiten für die Eingabeaufforderung zurück. Diese Methode wird in der Regel zweimal aufgerufen, einmal, um die Liste der anzuzeigenden Optionen abzurufen, und ein zweites Mal, um die Liste der Auswahlmöglichkeiten abzurufen, um sie zu erkennen.
formatMessage(Session, ListStyle, TextType, TextType, IChoice[])	Gibt eine Nachricht zurück, die eine Liste von Auswahlmöglichkeiten enthält.
formatMessage(Session, TextType, TextType, (err: Error, msg: IMessage) => void)	Erstellt die Nachricht, die für die Eingabeaufforderung gesendet werden soll. Dies wird automatisch von sendPrompt() aufgerufen, sodass Sie in den meisten Fällen eine onFormatMessage() Handler registrieren möchten, um die gesendete Nachricht für eine Eingabeaufforderung anzupassen. Sie sollten diese Methode nur aufrufen müssen, wenn Sie Ihre eigene `sendPrompt()`-Logik implementieren.
gettext(Session, TextType, string)	Gibt den Text für eine Eingabeaufforderung zurück, die mithilfe des Namespaces des Aufforderungsaufrufers lokalisiert wurde.
matches(RegExp \| string, string \| IDialogWaterfallStep[] \| IDialogWaterfallStep, any)	Ruft einen Handler auf, wenn eine bestimmte Absicht in der Äußerung der Benutzer erkannt wird. Bei `string` basierten Absichten kann die Absicht entweder eine Absicht sein, die von einer Recognizer() zurückgegeben wird, die für die Eingabeaufforderung registriert wurde, oder es kann sich um eine Absicht sein, die von einer globalen Erkennung()fließt. HINWEIS: Die vollständigen Details der Übereinstimmung, einschließlich der Liste der erkannten Absichten & Entitäten, werden an die Args des ersten Wasserfallschritts oder dialogfelds übergeben, das gestartet wird.
matchesAny(RegExp[] \| string[], string \| IDialogWaterfallStep[] \| IDialogWaterfallStep, any)	Ruft einen Handler auf, wenn eine der angegebenen Absichten in der Äußerung der Benutzer erkannt wird. Bei `string` basierten Absichten kann die Absicht entweder eine Absicht sein, die von einer Recognizer() zurückgegeben wird, die für die Eingabeaufforderung registriert wurde, oder es kann sich um eine Absicht sein, die von einer globalen Erkennung()fließt. HINWEIS: Die vollständigen Details der Übereinstimmung, einschließlich der Liste der erkannten Absichten & Entitäten, werden an die Args des ersten Wasserfallschritts oder dialogfelds übergeben, das gestartet wird.
onChoices((context: IRecognizeContext, callback: (err: Error, choices?: IChoice[]) => void, recognizePhase?: boolean) => void)	Registriert einen Handler, um eine dynamische Auswahlliste bereitzustellen. Der Handler wird mindestens zweimal während der Lebensdauer der Eingabeaufforderung aufgerufen. Einmal, um eine Liste der Auswahlmöglichkeiten zu generieren, die dem Benutzer angezeigt werden sollen, und ein zweites Mal, um die Liste der Auswahlmöglichkeiten abzurufen, die mit der Äußerung der Benutzer verglichen werden sollen. Es erfolgt keine Zwischenspeicherung der zurückgegebenen Auswahlmöglichkeiten, und der Handler wird für jede Unterhaltung der Fähigkeit aufgerufen, sodass Sie ihre eigene Zwischenspeicherung entsprechend implementieren sollten. Mehrere Handler können registriert werden, und der erste Handler, um eine gültige (nicht `null`) Liste der Auswahlmöglichkeiten zurückzugeben.
onFormatMessage((session: Session, text: TextType, speak: TextType, callback: (err: Error, message?: IMessage) => void) => void)	Registriert einen Handler, der aufgerufen wird, um die ausgehende IMessage- zu erstellen, die für die Eingabeaufforderung gesendet wird. Dieser Handler wird nur aufgerufen, wenn die aktuelle Eingabeaufforderung/retryPrompt vom Typ `string\|string[]`ist. Wenn es sich bei der Eingabeaufforderung/wiederholungsprompt um eine `IMessage\|IIsMessage` die konfigurierte Nachricht verwendet wird, sodass der Handler nicht aufgerufen wird. Mehrere Handler können registriert werden, und der erste Handler, der `callback()` mit einer Nachricht aufruft, wird verwendet. Das Aufrufen von `callback(null, null)` führt dazu, dass die Verarbeitung zum nächsten Handler in der Kette verschoben wird.
onPrompt((session: Session, next: Function) => void)	Registriert einen Handler, der bei jeder Aufforderung aufgerufen wird, um eine Nachricht an den Benutzer zu senden. Sie können diesen Hook verwenden, um Ihre eigene benutzerdefinierte Logik zum Senden von Eingabeaufforderungen zu implementieren. Mehrere Handler können registriert und aufgerufen werden, `next()` den nächsten Handler in der Kette aufrufen. Der letzte Handler führt die Eingabeaufforderungsstandardlogik aus, die das Erstellen einer neuen Nachricht mithilfe formatMessage() und anschließendes Senden erfolgt.
onRecognize((context: IRecognizeDialogContext, callback: (err: Error, score: number, response?: any) => void) => void)	Registriert einen Handler, der jedes Mal aufgerufen wird, wenn die Eingabeaufforderung eine Antwort vom Benutzer empfängt. Die Handler `callback()` können verwendet werden, um eine Konfidenzbewertung zurückzugeben, die die Benutzereingabe verstanden hat, sowie den Wert, der an den Aufrufer der Eingabeaufforderung zurückgegeben werden soll. Das Aufrufen von `callback(null, 1.0, true);` gibt eine hohe Vertrauenswürdigkeit an, dass der Benutzer die Eingabeaufforderung beantwortet hat und eine `boolean` "true" als Antwort der Eingabeaufforderung zurückgibt. Jeder Antworttyp ist möglich, einschließlich Objekten. Das Aufrufen von `callback(null, 0.0);` gibt an, dass die Benutzereingabe überhaupt nicht verstanden wurde und dass sie erneut aufgefordert werden sollten. Mehrere Handler können registriert werden und im Gegensatz zu den anderen Handlertypen werden alle registrierten Handler aufgerufen und der Handler, der die höchste Konfidenzbewertung bereitstellt, als Gewinner ausgewählt. Beim Anpassen eines der integrierten Eingabeaufforderungstypen möchten Sie häufig die Standarderkennungslogik der Eingabeaufforderungen deaktivieren. Dies kann erreicht werden, indem sie die Features der Eingabeaufforderung festlegen, wenn Sie sie erstellen. Denken Sie nur daran, dass Sie, wenn Sie die Standarderkennungslogik der Eingabeaufforderungen vollständig deaktivieren, alle Erkennung selbst ausführen müssen.
recognize(IRecognizeDialogContext, (err: Error, result: IRecognizeResult) => void)	Analysiert die Äußerung der Benutzer und weist eine Bewertung von 0,0 - 1,0 zu, die angibt, wie sicher das Dialogfeld ist, dass er die Äußerung der Benutzer verstanden hat. Diese Methode wird immer für das aktive Dialogfeld im Stapel aufgerufen. Eine Punktzahl von 1,0 zeigt eine perfekte Übereinstimmung an und beendet jede weitere Erkennung. Wenn die Bewertung kleiner als 1,0 ist, weist jedes Dialogfeld im Stapel seine recognizeAction() Methode auf, um festzustellen, ob benannte Aktionen an das Dialogfeld gebunden sind, die den Benutzern besser entsprechen. Globale Aktionen, die auf Bot-Ebene registriert sind, werden ebenfalls ausgewertet. Wenn das Dialogfeld eine Höhere Bewertung aufweist, werden die Dialogfelder replyReceived() Methode aufgerufen, wobei das ergebnisobjekt aufgerufen wird, das vom Erkennungsaufruf zurückgegeben wird. Auf diese Weise kann das Dialogfeld zusätzliche Daten übergeben, die während der Erkennungsphase an die replyReceived()-Methode zur Behandlung gesammelt werden. Sollte eine Aktion mit einer höheren Bewertung vorhanden sein, wird die Aktion anstelle der Dialoge replyReceived()-Methode aufgerufen. Das Dialogfeld bleibt im Stapel und kann an einem bestimmten Punkt fortgesetzt werden, wenn die Aktion ein neues Dialogfeld aufruft, sodass Dialogfelder auf unerwartete Aufrufe an dialogResumed()vorbereiten sollten.
recognizer(IIntentRecognizer)	Fügt der Eingabeaufforderung ein neues Erkennungs-Plug-In hinzu, das jedes Mal ausgeführt wird, wenn der Benutzer auf die Eingabeaufforderung antwortet.
reloadAction(string, TextOrMessageType, IBeginDialogActionOptions)	Bindet eine Aktion an das Dialogfeld, das bewirkt, dass das Dialogfeld bei jedem Auslösen erneut geladen wird. Dies ist nützlich, um Logik zu implementieren, die Benutzerutterancen wie "Start over" behandelt.
replyReceived(Session, IRecognizeResult)	Verarbeitet nachrichten, die vom Benutzer empfangen wurden. Vom Dialogfeldsystem aufgerufen.
selectActionRoute(Session, IRouteResult)	Wählt die Route mit dem höchsten Konfidenzwert für die Äußerung aus.
sendPrompt(Session)	Sendet eine Eingabeaufforderung an den Benutzer für die aktuelle Drehung. Dies kann von einem [matches()][#matches]-Handler aufgerufen werden, um dem Benutzer manuell eine Eingabeaufforderung/einen erneuten Aufruf zu senden. Um das Senden der ersten Eingabeaufforderung zu erzwingen, müssen Sie `session.dialogData.turns = 0;` festlegen, bevor Sie `sendPrompt()`aufrufen.
triggerAction(ITriggerActionOptions)	Bindet eine Aktion an das Dialogfeld, das es zum aktiven Dialogfeld macht, wenn es ausgelöst wird. Das Standardverhalten besteht darin, ein vorhandenes Dialogfeld durch Löschen des Stapels und Starten des Dialogfelds am Stamm des Stapels zu interupieren. Das zu unterbrechende Dialogfeld kann diese Unterbrechung abfangen, indem ein benutzerdefinierter onInterrupted-Handler zu den Triggeraktionsoptionen hinzugefügt wird. Darüber hinaus können Sie die Art und Weise anpassen, wie das ausgelöste Dialogfeld gestartet wird, indem Sie eine benutzerdefinierte onSelectAction Handler für die Triggeraktionsoptionen bereitstellen.

Details zum Konstruktor

PromptConfirm(IPromptFeatures)

Erstellt eine neue anpassbare Instanz der Eingabeaufforderung. Ihre neue Eingabeaufforderung sollte entweder als Dialogfeld zu einem Bot oder einer Bibliothek hinzugefügt werden.

new PromptConfirm(features?: IPromptFeatures)

Parameter

features: IPromptFeatures

(Optional) Merkmale, die zum Anpassen des Eingabeaufforderungsverhaltens verwendet werden.

Details zur Eigenschaft

features

Die Aktuell konfigurierte Gruppe von Features wird angezeigt.

public features: IPromptChoiceFeatures

Eigenschaftswert

IPromptChoiceFeatures

Details zur Methode

addDialogTrigger(ActionSet, string)

Wird einmal für jedes Dialogfeld in einer Bibliothek aufgerufen, um dem Dialogfeld die Möglichkeit zu geben, dem globalen Bibliotheksaktionssatz seine triggerAction() hinzuzufügen. Diese Trigger werden einem beginDialogAction() zugeordnet, der das Dialogfeld startet, wenn die Triggerbedingung erfüllt ist.

function addDialogTrigger(actions: ActionSet, dialogId: string)

Parameter

actions: ActionSet

Globaler Aktionssatz "Bibliotheken".

dialogId: string

Die vollqualifizierte ID des auszulösenden Dialogfelds.

begin<T>(Session, T)

Wird aufgerufen, wenn eine neue Dialogsitzung gestartet wird.

function begin<T>(session: Session, args?: T)

Parameter

session: Session

Session-Objekt für die aktuelle Unterhaltung.

args: T

(Optional) Argumente, die vom übergeordneten Element an das Dialogfeld übergeben werden.

beginDialogAction(string, string, IBeginDialogActionOptions)

Bindet eine Aktion an das Dialogfeld, das ein weiteres Dialogfeld startet, wenn es ausgelöst wird. Das neue Dialogfeld wird auf den Stapel verschoben, sodass der aktuelle Vorgang nicht automatisch beendet wird. Die aktuelle Aufgabe wird fortgesetzt, sobald das neue Dialogfeld endet. Die integrierten Eingabeaufforderungen werden den Benutzer automatisch erneut auffordern, sobald dies geschieht, aber dieses Verhalten kann deaktiviert werden, indem das promptAfterAction Flag beim Aufrufen einer integrierten Eingabeaufforderung festgelegt wird.

function beginDialogAction(name: string, id: string, options?: IBeginDialogActionOptions)

Parameter

name: string

Eindeutiger Name zum Zuweisen der Aktion.

id: string

ID des zu startenden Dialogfelds.

options: IBeginDialogActionOptions

(Optional) Optionen, die zum Konfigurieren der Aktion verwendet werden. Wenn Übereinstimmungen angegeben ist, lauscht der Benutzer auf ein Wort oder einen Ausdruck, der die Aktion auslöst, andernfalls muss die Aktion mit CardAction.dialogAction() an eine Schaltfläche gebunden werden, die Aktion auszulösen. Sie können auch dialogArgs verwenden, um zusätzliche Params an das zu startende Dialogfeld zu übergeben.

Gibt zurück

Dialog

cancelAction(string, TextOrMessageType, ICancelActionOptions)

Bindet eine Aktion an das Dialogfeld, das das Dialogfeld bei jedem Auslösen abbricht. Wenn der Vorgang abgebrochen wurde, werden die übergeordneten Dialogfelder mit einem fortgesetzt Code fortgesetzt, der angibt, dass es abgebrochenwurde.

function cancelAction(name: string, msg?: TextOrMessageType, options?: ICancelActionOptions)

Parameter

name: string

Eindeutiger Name zum Zuweisen der Aktion.

msg: TextOrMessageType

(Optional) Nachricht, die dem Benutzer vor dem Abbrechen des Dialogfelds gesendet werden soll.

options: ICancelActionOptions

Gibt zurück

Dialog

clone(ActionSet)

Gibt einen Klon eines vorhandenen ActionSet zurück.

function clone(copyTo?: ActionSet)

Parameter

copyTo: ActionSet

(Optional) Instanz, in die das aktuelle Objekt kopiert werden soll. Wenn eine neue Instanz fehlt, wird eine neue Instanz erstellt.

Gibt zurück

ActionSet

customAction(IDialogActionOptions)

Bindet eine benutzerdefinierte Aktion an das Dialogfeld, das beim Auslösen der übergebenen onSelectAction--Handlers übergeben wird.

function customAction(options: IDialogActionOptions)

Parameter

options: IDialogActionOptions

Die Zum Konfigurieren der Aktion verwendeten Optionen. Wenn Übereinstimmungen angegeben ist, lauscht die Aktion dem Benutzer, um ein Wort oder einen Ausdruck zu sagen, der die Aktion auslöst. Benutzerdefinierte Abgleichslogik kann mithilfe von onFindActionbereitgestellt werden.

Gibt zurück

Library

dialogInterrupted(Session, string, any)

Wird aufgerufen, wenn ein Stammdialogfeld durch ein anderes Dialogfeld unterbrochen wird. Dadurch wird das Dialogfeld, das unterbrochen wird, die Möglichkeit gegeben, benutzerdefinierte Logik auszuführen, bevor sie aus dem Stapel entfernt wird. Das Dialogfeld selbst ist dafür verantwortlich, den Dialogstapel zu löschen und das neue Dialogfeld zu starten.

function dialogInterrupted(session: Session, dialogId: string, dialogArgs: any)

Parameter

session: Session

Session-Objekt für die aktuelle Unterhaltung.

dialogId: string

ID des Dialogfelds, das gestartet werden soll.

dialogArgs: any

Argumente, die an das neue Dialogfeld übergeben werden sollen.

dialogResumed<T>(Session, IDialogResult<T>)

Ein untergeordnetes Dialogfeld wurde beendet, und das aktuelle Dialogfeld wird fortgesetzt.

function dialogResumed<T>(session: Session, result: IDialogResult<T>)

Parameter

session: Session

Session-Objekt für die aktuelle Unterhaltung.

result: IDialogResult<T>

Vom untergeordneten Dialogfeld zurückgegebenes Ergebnis.

endConversationAction(string, TextOrMessageType, ICancelActionOptions)

Bindet eine Aktion, die die Unterhaltung mit dem Benutzer beendet, wenn sie ausgelöst wird.

function endConversationAction(name: string, msg?: TextOrMessageType, options?: ICancelActionOptions)

Parameter

name: string

Eindeutiger Name zum Zuweisen der Aktion.

msg: TextOrMessageType

(Optional) Nachricht, die den Benutzer vor dem Beenden der Unterhaltung sendet.

options: ICancelActionOptions

Gibt zurück

Dialog

findActionRoutes(IRecognizeDialogContext, (err: Error, results: IRouteResult[]) => void)

Wird während des Library.findRoutes() aufgerufen, Aufruf für jedes Dialogfeld im Stapel, um festzustellen, ob eine der Dialogfeldaktionen von den Benutzern ausgelöst wird.

function findActionRoutes(context: IRecognizeDialogContext, callback: (err: Error, results: IRouteResult[]) => void)

Parameter

context: IRecognizeDialogContext

Der Kontext der eingehenden Nachricht sowie die dialogData- für das ausgewertete Dialogfeld.

callback: (err: Error, results: IRouteResult[]) => void

Funktion, die mit den wichtigsten Kandidatenrouten aufgerufen werden soll.

findChoices(IRecognizeContext, boolean, (err: Error, choices: IChoice[]) => void)

Gibt die Liste der dynamischen oder statischen Auswahlmöglichkeiten für die Eingabeaufforderung zurück. Diese Methode wird in der Regel zweimal aufgerufen, einmal, um die Liste der anzuzeigenden Optionen abzurufen, und ein zweites Mal, um die Liste der Auswahlmöglichkeiten abzurufen, um sie zu erkennen.

function findChoices(context: IRecognizeContext, recognizePhase: boolean, callback: (err: Error, choices: IChoice[]) => void)

Parameter

context: IRecognizeContext

Schreibgeschützter Erkennungskontext für die aktuelle Unterhaltung.

recognizePhase: boolean

Wenn wahr, wird die Liste der Auswahlmöglichkeiten verwendet, um die Äußerung der Benutzer zu erkennen. Andernfalls werden sie verwendet, um eine Liste der verfügbaren Optionen für den Benutzer zu rendern.

callback: (err: Error, choices: IChoice[]) => void

Funktion, die mit der Liste der Eingabeaufforderungen aufgerufen wird.

formatMessage(Session, ListStyle, TextType, TextType, IChoice[])

Gibt eine Nachricht zurück, die eine Liste von Auswahlmöglichkeiten enthält.

static function formatMessage(session: Session, listStyle: ListStyle, text: TextType, speak?: TextType, choices?: IChoice[])

Parameter

session: Session

Aktuelle Sitzung für die Unterhaltung.

listStyle: ListStyle

Listenformat, das in die Nachricht aufgenommen werden soll.

text: TextType

Text der Nachricht.

speak: TextType

(Optional) SSML, das mit der Nachricht zurückgegeben werden soll. Dies kann null sein.

choices: IChoice[]

(Optional) Liste der Optionen, die in die Nachricht eingeschlossen werden sollen. Wenn die Nachricht nicht angegeben wird, wird die Nachricht ohne Auswahlmöglichkeiten gesendet.

Gibt zurück

IMessage

formatMessage(Session, TextType, TextType, (err: Error, msg: IMessage) => void)

Erstellt die Nachricht, die für die Eingabeaufforderung gesendet werden soll. Dies wird automatisch von sendPrompt() aufgerufen, sodass Sie in den meisten Fällen eine onFormatMessage() Handler registrieren möchten, um die gesendete Nachricht für eine Eingabeaufforderung anzupassen. Sie sollten diese Methode nur aufrufen müssen, wenn Sie Ihre eigene sendPrompt()-Logik implementieren.

function formatMessage(session: Session, text: TextType, speak: TextType, callback: (err: Error, msg: IMessage) => void)

Parameter

session: Session

Session-Objekt für die aktuelle Unterhaltung.

text: TextType

Aktueller Eingabeaufforderungs-/Wiederholungstext.

speak: TextType

Aktuelles sprechen/retrySpeak SSML. Dieser Wert kann null sein.

callback: (err: Error, msg: IMessage) => void

Funktion zum Empfangen der erstellten Nachricht.

gettext(Session, TextType, string)

Gibt den Text für eine Eingabeaufforderung zurück, die mithilfe des Namespaces des Aufforderungsaufrufers lokalisiert wurde.

static function gettext(session: Session, text: TextType, namespace?: string)

Parameter

session: Session

Aktuelle Sitzung für die Unterhaltung.

text: TextType

Aufforderung zum Lokalisieren.

namespace: string

(Optional) Bibliotheksnamespace, der zum Lokalisieren der Eingabeaufforderung verwendet werden soll. Standardmäßig wird der Namespace des Eingabeaufforderungsaufrufers verwendet.

Gibt zurück

string

matches(RegExp | string, string | IDialogWaterfallStep[] | IDialogWaterfallStep, any)

Ruft einen Handler auf, wenn eine bestimmte Absicht in der Äußerung der Benutzer erkannt wird. Bei string basierten Absichten kann die Absicht entweder eine Absicht sein, die von einer Recognizer() zurückgegeben wird, die für die Eingabeaufforderung registriert wurde, oder es kann sich um eine Absicht sein, die von einer globalen Erkennung()fließt.

HINWEIS: Die vollständigen Details der Übereinstimmung, einschließlich der Liste der erkannten Absichten & Entitäten, werden an die Args des ersten Wasserfallschritts oder dialogfelds übergeben, das gestartet wird.

function matches(intent: RegExp | string, dialogId: string | IDialogWaterfallStep[] | IDialogWaterfallStep, dialogArgs?: any)

Parameter

intent: RegExp | string

Absicht:{RegExp}- – Ein regulärer Ausdruck, der ausgewertet wird, um die Benutzerabsicht zu erkennen.
Absicht:{string}- – Eine benannte Absicht, die von einem IIntentRecognizer Plug-In zurückgegeben wird, das verwendet wird, um den Absichten der Benutzer zu entsprechen.

dialogId: string | IDialogWaterfallStep[] | IDialogWaterfallStep

dialogId: _{string} – Die ID eines Dialogfelds, das beim Abgleichen der Absicht beginnt.
dialogId:{IDialogWaterfallStep[]} – Wasserfall der auszuführenden Schritte, wenn die Absicht abgeglichen wird.
dialogId:{IDialogWaterfallStep} – Einstufiger Wasserfall, der ausgeführt werden soll, wenn die Absicht abgeglichen wird. Das Aufrufen einer integrierten Eingabeaufforderung oder das Starten eines neuen Dialogfelds führt dazu, dass das aktuelle Dialogfeld nach Abschluss der untergeordneten Eingabeaufforderung/des untergeordneten Dialogfelds endet.

dialogArgs: any

(Optional) Argumente, um das Dialogfeld zu übergeben, das gestartet wurde, wenn dialogId ein {string}-ist.

Gibt zurück

IntentDialog

matchesAny(RegExp[] | string[], string | IDialogWaterfallStep[] | IDialogWaterfallStep, any)

Ruft einen Handler auf, wenn eine der angegebenen Absichten in der Äußerung der Benutzer erkannt wird. Bei string basierten Absichten kann die Absicht entweder eine Absicht sein, die von einer Recognizer() zurückgegeben wird, die für die Eingabeaufforderung registriert wurde, oder es kann sich um eine Absicht sein, die von einer globalen Erkennung()fließt.

HINWEIS: Die vollständigen Details der Übereinstimmung, einschließlich der Liste der erkannten Absichten & Entitäten, werden an die Args des ersten Wasserfallschritts oder dialogfelds übergeben, das gestartet wird.

function matchesAny(intent: RegExp[] | string[], dialogId: string | IDialogWaterfallStep[] | IDialogWaterfallStep, dialogArgs?: any)

Parameter

intent: RegExp[] | string[]

Absicht:{RegExp[]} – Array regulärer Ausdrücke, die ausgewertet werden, um die Benutzerabsicht zu erkennen.
Absicht:{string[]} – Array mit benannten Absichten, die von einem IIntentRecognizer Plug-In zurückgegeben werden, das verwendet wird, um den Benutzerabsichten zu entsprechen.

dialogId: string | IDialogWaterfallStep[] | IDialogWaterfallStep

dialogId: _{string} – Die ID eines Dialogfelds, das beim Abgleichen der Absicht beginnt.
dialogId:{IDialogWaterfallStep[]} – Wasserfall der auszuführenden Schritte, wenn die Absicht abgeglichen wird.
dialogId:{IDialogWaterfallStep} – Einstufiger Wasserfall, der ausgeführt werden soll, wenn die Absicht abgeglichen wird. Das Aufrufen einer integrierten Eingabeaufforderung oder das Starten eines neuen Dialogfelds führt dazu, dass das aktuelle Dialogfeld nach Abschluss der untergeordneten Eingabeaufforderung/des untergeordneten Dialogfelds endet.

dialogArgs: any

(Optional) Argumente, um das Dialogfeld zu übergeben, das gestartet wurde, wenn dialogId ein {string}-ist.

Gibt zurück

IntentDialog

onChoices((context: IRecognizeContext, callback: (err: Error, choices?: IChoice[]) => void, recognizePhase?: boolean) => void)

Registriert einen Handler, um eine dynamische Auswahlliste bereitzustellen. Der Handler wird mindestens zweimal während der Lebensdauer der Eingabeaufforderung aufgerufen. Einmal, um eine Liste der Auswahlmöglichkeiten zu generieren, die dem Benutzer angezeigt werden sollen, und ein zweites Mal, um die Liste der Auswahlmöglichkeiten abzurufen, die mit der Äußerung der Benutzer verglichen werden sollen. Es erfolgt keine Zwischenspeicherung der zurückgegebenen Auswahlmöglichkeiten, und der Handler wird für jede Unterhaltung der Fähigkeit aufgerufen, sodass Sie ihre eigene Zwischenspeicherung entsprechend implementieren sollten. Mehrere Handler können registriert werden, und der erste Handler, um eine gültige (nicht null) Liste der Auswahlmöglichkeiten zurückzugeben.

function onChoices(handler: (context: IRecognizeContext, callback: (err: Error, choices?: IChoice[]) => void, recognizePhase?: boolean) => void)

Parameter

handler: (context: IRecognizeContext, callback: (err: Error, choices?: IChoice[]) => void, recognizePhase?: boolean) => void

Funktion, die aufgerufen werden soll, wenn eine Liste von Auswahlmöglichkeiten erforderlich ist. Der parameter recognizePhase ist "true", wenn die Auswahl verwendet wird, um die Antwort der Benutzer zu erkennen.

Gibt zurück

PromptChoice

onFormatMessage((session: Session, text: TextType, speak: TextType, callback: (err: Error, message?: IMessage) => void) => void)

Registriert einen Handler, der aufgerufen wird, um die ausgehende IMessage- zu erstellen, die für die Eingabeaufforderung gesendet wird. Dieser Handler wird nur aufgerufen, wenn die aktuelle Eingabeaufforderung/retryPrompt vom Typ string|string[]ist. Wenn es sich bei der Eingabeaufforderung/wiederholungsprompt um eine IMessage|IIsMessage die konfigurierte Nachricht verwendet wird, sodass der Handler nicht aufgerufen wird. Mehrere Handler können registriert werden, und der erste Handler, der callback() mit einer Nachricht aufruft, wird verwendet. Das Aufrufen von callback(null, null) führt dazu, dass die Verarbeitung zum nächsten Handler in der Kette verschoben wird.

function onFormatMessage(handler: (session: Session, text: TextType, speak: TextType, callback: (err: Error, message?: IMessage) => void) => void)

Parameter

handler: (session: Session, text: TextType, speak: TextType, callback: (err: Error, message?: IMessage) => void) => void

Funktion, die aufgerufen wird, um eine IMessage für die aktuelle Eingabeaufforderung zu erstellen. Rufen Sie callback() entweder mit einer Nachricht oder null auf, um die Verarbeitung fortzusetzen.

Gibt zurück

Prompt<any>

onPrompt((session: Session, next: Function) => void)

Registriert einen Handler, der bei jeder Aufforderung aufgerufen wird, um eine Nachricht an den Benutzer zu senden. Sie können diesen Hook verwenden, um Ihre eigene benutzerdefinierte Logik zum Senden von Eingabeaufforderungen zu implementieren. Mehrere Handler können registriert und aufgerufen werden, next() den nächsten Handler in der Kette aufrufen. Der letzte Handler führt die Eingabeaufforderungsstandardlogik aus, die das Erstellen einer neuen Nachricht mithilfe formatMessage() und anschließendes Senden erfolgt.

function onPrompt(handler: (session: Session, next: Function) => void)

Parameter

handler: (session: Session, next: Function) => void

Funktion, die jederzeit aufgerufen wird, sendPrompt() aufgerufen wird.

Gibt zurück

Prompt<any>

onRecognize((context: IRecognizeDialogContext, callback: (err: Error, score: number, response?: any) => void) => void)

Registriert einen Handler, der jedes Mal aufgerufen wird, wenn die Eingabeaufforderung eine Antwort vom Benutzer empfängt. Die Handler callback() können verwendet werden, um eine Konfidenzbewertung zurückzugeben, die die Benutzereingabe verstanden hat, sowie den Wert, der an den Aufrufer der Eingabeaufforderung zurückgegeben werden soll. Das Aufrufen von callback(null, 1.0, true); gibt eine hohe Vertrauenswürdigkeit an, dass der Benutzer die Eingabeaufforderung beantwortet hat und eine boolean "true" als Antwort der Eingabeaufforderung zurückgibt. Jeder Antworttyp ist möglich, einschließlich Objekten. Das Aufrufen von callback(null, 0.0); gibt an, dass die Benutzereingabe überhaupt nicht verstanden wurde und dass sie erneut aufgefordert werden sollten.

Mehrere Handler können registriert werden und im Gegensatz zu den anderen Handlertypen werden alle registrierten Handler aufgerufen und der Handler, der die höchste Konfidenzbewertung bereitstellt, als Gewinner ausgewählt. Beim Anpassen eines der integrierten Eingabeaufforderungstypen möchten Sie häufig die Standarderkennungslogik der Eingabeaufforderungen deaktivieren. Dies kann erreicht werden, indem sie die Features der Eingabeaufforderung festlegen, wenn Sie sie erstellen. Denken Sie nur daran, dass Sie, wenn Sie die Standarderkennungslogik der Eingabeaufforderungen vollständig deaktivieren, alle Erkennung selbst ausführen müssen.

function onRecognize(handler: (context: IRecognizeDialogContext, callback: (err: Error, score: number, response?: any) => void) => void)

Parameter

handler: (context: IRecognizeDialogContext, callback: (err: Error, score: number, response?: any) => void) => void

Funktion, die aufgerufen wird, um die Benutzer auf eine Eingabeaufforderung zu antworten.

Gibt zurück

Prompt<any>

recognize(IRecognizeDialogContext, (err: Error, result: IRecognizeResult) => void)

Analysiert die Äußerung der Benutzer und weist eine Bewertung von 0,0 - 1,0 zu, die angibt, wie sicher das Dialogfeld ist, dass er die Äußerung der Benutzer verstanden hat. Diese Methode wird immer für das aktive Dialogfeld im Stapel aufgerufen. Eine Punktzahl von 1,0 zeigt eine perfekte Übereinstimmung an und beendet jede weitere Erkennung. Wenn die Bewertung kleiner als 1,0 ist, weist jedes Dialogfeld im Stapel seine recognizeAction() Methode auf, um festzustellen, ob benannte Aktionen an das Dialogfeld gebunden sind, die den Benutzern besser entsprechen. Globale Aktionen, die auf Bot-Ebene registriert sind, werden ebenfalls ausgewertet. Wenn das Dialogfeld eine Höhere Bewertung aufweist, werden die Dialogfelder replyReceived() Methode aufgerufen, wobei das ergebnisobjekt aufgerufen wird, das vom Erkennungsaufruf zurückgegeben wird. Auf diese Weise kann das Dialogfeld zusätzliche Daten übergeben, die während der Erkennungsphase an die replyReceived()-Methode zur Behandlung gesammelt werden.

Sollte eine Aktion mit einer höheren Bewertung vorhanden sein, wird die Aktion anstelle der Dialoge replyReceived()-Methode aufgerufen. Das Dialogfeld bleibt im Stapel und kann an einem bestimmten Punkt fortgesetzt werden, wenn die Aktion ein neues Dialogfeld aufruft, sodass Dialogfelder auf unerwartete Aufrufe an dialogResumed()vorbereiten sollten.

function recognize(context: IRecognizeDialogContext, callback: (err: Error, result: IRecognizeResult) => void)

Parameter

context: IRecognizeDialogContext

Der Kontext der Anforderung.

callback: (err: Error, result: IRecognizeResult) => void

Funktion, die mit den Erkennungsergebnissen aufgerufen werden soll.

recognizer(IIntentRecognizer)

Fügt der Eingabeaufforderung ein neues Erkennungs-Plug-In hinzu, das jedes Mal ausgeführt wird, wenn der Benutzer auf die Eingabeaufforderung antwortet.

function recognizer(plugin: IIntentRecognizer)

Parameter

plugin: IIntentRecognizer

Die hinzuzufügende Erkennung.

Gibt zurück

IntentDialog

reloadAction(string, TextOrMessageType, IBeginDialogActionOptions)

Bindet eine Aktion an das Dialogfeld, das bewirkt, dass das Dialogfeld bei jedem Auslösen erneut geladen wird. Dies ist nützlich, um Logik zu implementieren, die Benutzerutterancen wie "Start over" behandelt.

function reloadAction(name: string, msg?: TextOrMessageType, options?: IBeginDialogActionOptions)

Parameter

name: string

Eindeutiger Name zum Zuweisen der Aktion.

msg: TextOrMessageType

(Optional) Nachricht, die den Benutzer vor dem Erneutladen des Dialogfelds sendet.

options: IBeginDialogActionOptions

Gibt zurück

Dialog

replyReceived(Session, IRecognizeResult)

Verarbeitet nachrichten, die vom Benutzer empfangen wurden. Vom Dialogfeldsystem aufgerufen.

function replyReceived(session: Session, recognizeResult?: IRecognizeResult)

Parameter

session: Session

Session-Objekt für die aktuelle Unterhaltung.

recognizeResult: IRecognizeResult

selectActionRoute(Session, IRouteResult)

Wählt die Route mit dem höchsten Konfidenzwert für die Äußerung aus.

function selectActionRoute(session: Session, route: IRouteResult)

Parameter

session: Session

Session-Objekt für die aktuelle Unterhaltung.

route: IRouteResult

Ergebnisse, die vom Aufruf von findActionRoutes()zurückgegeben werden.

sendPrompt(Session)

Sendet eine Eingabeaufforderung an den Benutzer für die aktuelle Drehung. Dies kann von einem [matches()][#matches]-Handler aufgerufen werden, um dem Benutzer manuell eine Eingabeaufforderung/einen erneuten Aufruf zu senden. Um das Senden der ersten Eingabeaufforderung zu erzwingen, müssen Sie session.dialogData.turns = 0; festlegen, bevor Sie sendPrompt()aufrufen.

function sendPrompt(session: Session)

Parameter

session: Session

Session-Objekt für die aktuelle Unterhaltung.

triggerAction(ITriggerActionOptions)

Bindet eine Aktion an das Dialogfeld, das es zum aktiven Dialogfeld macht, wenn es ausgelöst wird. Das Standardverhalten besteht darin, ein vorhandenes Dialogfeld durch Löschen des Stapels und Starten des Dialogfelds am Stamm des Stapels zu interupieren. Das zu unterbrechende Dialogfeld kann diese Unterbrechung abfangen, indem ein benutzerdefinierter onInterrupted-Handler zu den Triggeraktionsoptionen hinzugefügt wird. Darüber hinaus können Sie die Art und Weise anpassen, wie das ausgelöste Dialogfeld gestartet wird, indem Sie eine benutzerdefinierte onSelectAction Handler für die Triggeraktionsoptionen bereitstellen.

function triggerAction(options: ITriggerActionOptions)

Parameter

options: ITriggerActionOptions

Optionen zum Konfigurieren der Aktion.

Gibt zurück

Dialog