Library class

Erstellt eine neue Instanz der Bibliothek.

new Library(name: string)

Parameter

Der eindeutige Namespace der Bibliotheken. Dies wird verwendet, um die Dialogfelder für Bibliotheken und lokalisierte Eingabeaufforderungen zu festigen.

name: string

Eigenschaftswert

Unterstützte routeType- Werte, die standardmäßig von findRoutes()zurückgegeben werden.

static RouteTypes: Object

Eigenschaftswert

Hilfsmethode, die von den verschiedenen Methoden zur Routensuche aufgerufen wird, um das Hinzufügen einer Kandidatenroute zum Resultset zu verwalten.

• Wenn die Bewertung größer ist, wird die aktuelle beste Übereinstimmung im Satz ein neues Resultset zurückgegeben, das nur die neue Übereinstimmung enthält.
• Wenn die Bewertung gleich der aktuellen besten Übereinstimmung ist, wird sie dem vorhandenen Satz hinzugefügt.
• Wenn die Bewertung kleiner als die aktuelle beste Übereinstimmung ist, wird sie ignoriert.

static function addRouteResult(route: IRouteResult, current?: IRouteResult[])

Parameter

Gibt zurück

Registriert eine globale Aktion, die ein weiteres Dialogfeld startet, wenn es ausgelöst wird. Das neue Dialogfeld wird auf den Stapel verschoben, sodass keine aktuelle Aufgabe 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?: IDialogActionOptions)

Parameter

Gibt zurück

Sucht die beste Route, die in einem Resultset verwendet werden soll, das mehrere mehrdeutige Routen enthält. Die folgende Mehrdeutigkeitsstrategie wird verwendet:

1. : Benutzerdefinierte Routentypen sind die höchste Priorität und werden bevorzugt. Auf diese Weise kann der Entwickler das Routing innerhalb eines Bots auf sehr leistungsstarke Weise außer Kraft setzen.
2. ActiveDialog-: Das aktive Dialogfeld ist die nächste höchste Priorität.
3. StackAction-: Stapelaktionen sind die nächste höchste Priorität, und die Aktion mit der tiefsten Stapelposition wird zurückgegeben.
4. GlobalAction: Globale Aktionen sind die niedrigste Priorität. Wenn ein dialogStack in den Aktionen aus der Bibliothek am weitesten auf dem Stapel vorbei ist, wird bevorzugt. Andernfalls wird der erste zurückgegeben.

static function bestRouteResult(routes: IRouteResult[], dialogStack?: IDialogState[], rootLibraryName?: string)

Parameter

Gibt zurück

Gibt einen Klon einer vorhandenen Bibliothek zurück.

function clone(copyTo?: Library, newName?: string)

Parameter

Gibt zurück

Registriert eine benutzerdefinierte globale Aktion, die den übergebenen onSelectAction--Handler beim Auslösen aufruft.

function customAction(options: IDialogActionOptions)

Parameter

Gibt zurück

Registriert oder gibt ein Dialogfeld aus der Bibliothek zurück.

function dialog(id: string, dialog?: Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep, replace?: boolean)

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

Ruft die aktive Dialogfelder konfidenz, dass sie die aktuelle Nachricht versteht. Das Dialogfeld muss Mitglied der aktuellen Bibliothek sein, andernfalls wird eine Bewertung von 0,0 zurückgegeben.

function findActiveDialogRoutes(context: IRecognizeContext, callback: (err: Error, routes: IRouteResult[]) => void, dialogStack?: IDialogState[])

Parameter

Durchsucht die Bibliothek und alle zugehörigen Abhängigkeiten nach einem bestimmten Dialogfeld. Gibt das Dialogfeld zurück, falls gefunden, andernfalls NULL.

function findDialog(libName: string, dialogId: string)

Parameter

Gibt zurück

Durchsucht die Bibliothek, um festzustellen, ob globale Aktionen ausgelöst wurden.

function findGlobalActionRoutes(context: IRecognizeContext, callback: (err: Error, routes: IRouteResult[]) => void)

Parameter

Sucht nach Kandidatenrouten, um die aktuelle Nachricht zu verarbeiten. Um die Behandlung der Nachricht tatsächlich zu initiieren, sollten Sie selectRoute() mit einem der zurückgegebenen Ergebnisse aufrufen. Die Standardmäßige Suchlogik kann mit onFindRoute()- überschrieben werden, und nur die aktuelle Bibliothek wird durchsucht, sodass Sie findRoutes() separat für jede Bibliothek innerhalb der Hierarchie aufrufen sollten.

function findRoutes(context: IRecognizeContext, callback: (err: Error, routes: IRouteResult[]) => void)

Parameter

Sucht im Dialogfeld "Sitzungen" nach, um festzustellen, ob Aktionen ausgelöst wurden.

function findStackActionRoutes(context: IRecognizeContext, callback: (err: Error, routes: IRouteResult[]) => void, dialogStack?: IDialogState[])

Parameter

Listet alle Dialogfelder für Bibliotheken auf.

function forEachDialog(callback: (dialog: Dialog, id: string) => void)

Parameter

Listet alle untergeordneten Bibliotheken auf. Der Aufrufer sollte geeignete Schritte ausführen, um Zirkelbezüge beim Aufzählen der Hierarchie zu vermeiden. In den meisten Fällen ist das Aufrufen libraryList() eine bessere Wahl, da sie bereits Logik enthält, um Zyklen zu vermeiden.

function forEachLibrary(callback: (library: Library) => void)

Parameter

Registriert oder gibt eine Bibliotheksabhängigkeit zurück.

function library(lib: Library | string)

Parameter

Gibt zurück

Gibt eine Liste eindeutiger Bibliotheken innerhalb der Hierarchie zurück. Sollte für den Stamm der Bibliothekshierarchie aufgerufen werden und verhindert, dass Zyklen erstellt werden, wenn zwei untergeordnete Bibliotheken auf dieselbe abhängige Bibliothek verweisen.

function libraryList(reverse?: boolean)

Parameter

Gibt zurück

Ruft den Pfad zum Ordner "/locale/" der Bibliotheken ab, der die lokalisierten Eingabeaufforderungen enthält, oder legt diesen fest. Die Eingabeaufforderungen für die Bibliothek sollten in einer Datei "/locale/<IETF_TAG>/.json" unter diesem Pfad gespeichert werden, wobei "<IETF_TAG>" die 2-3-stellige Sprachtage für das Gebietsschema darstellt und "" ein Dateiname ist, der dem Bibliotheksnamespace entspricht.

function localePath(path?: string)

Parameter

Gibt zurück

Ersetzt findRoutes() Standardroutensuchlogik durch eine benutzerdefinierte Implementierung.

function onFindRoutes(handler: IFindRoutesHandler)

Parameter

Ersetzt die Standardlogik für selectRoute() durch eine benutzerdefinierte Implementierung.

function onSelectRoute(handler: ISelectRouteHandler)

Parameter

Versucht, mit der Bibliothekserkennung texterkennen Absichten mit einem Benutzertext übereinzugleichen. Weitere Informationen finden Sie unter IIntentRecognizer.recognize().

function recognize(context: IRecognizeContext, callback: (err: Error, result: IIntentRecognizerResult) => void)

Parameter

Fügt der Bibliothek ein neues Erkennungs-Plug-In hinzu.

function recognizer(plugin: IIntentRecognizer)

Parameter

Gibt zurück

Leitet die aktuelle Nachricht an das aktive Dialogfeld weiter.

function selectActiveDialogRoute(session: Session, route: IRouteResult, newStack?: IDialogState[])

Parameter

Leitet die aktuelle Nachricht an eine ausgelöste globale Aktion weiter.

function selectGlobalActionRoute(session: Session, route: IRouteResult, newStack?: IDialogState[])

Parameter

Löst die Behandlung der aktuellen Nachricht mithilfe der ausgewählten Route aus. Die Standardlogik kann mit onSelectRoute()überschrieben werden.

function selectRoute(session: Session, route: IRouteResult)

Parameter

Leitet die aktuelle Nachricht an eine ausgelöste Stapelaktion weiter.

function selectStackActionRoute(session: Session, route: IRouteResult, newStack?: IDialogState[])

Parameter