botbuilder package

Klassen

ActionSet

Implementieren Sie Unterstützung für benannte Aktionen, die an ein Dialogfeld gebunden werden können, um globale Äußerungen vom Benutzer wie "Hilfe" oder "Abbrechen" zu behandeln. Aktionen werden als Teil von Dialogfeldern in den Dialogstapel verschoben, sodass diese Listener während des Fortschritts der Unterhaltung in den Gültigkeitsbereich gelangen können. Sie können auch benannte Aktionen an Schaltflächen binden, mit denen Ihr Bot auf Schaltflächenklicks auf Karten reagieren kann, die möglicherweise vom Bildschirm gescrollt wurden.

AnimationCard

Karten-Generator-Klasse, die das Erstellen von Animationskarten vereinfacht.

AudioCard

Karten-Generator-Klasse, die das Erstellen von Medienkarten vereinfacht.

BotConnectorBot

veraltete stattdessen UniversalBot und einen ChatConnector- verwenden.

CardAction

Builder-Klasse zum Vereinfachen des Hinzufügens von Aktionen zu einer Karte.

CardImage

Builder-Klasse zum Vereinfachen des Hinzufügens von Bildern zu einer Karte.

CardMedia

Definition einer Medienentität für eine Karte

ChatConnector

Verbindet einen UniversalBot mit mehreren Kanälen über das Bot Framework.

CommandDialog

veraltete stattdessen ein IntentDialog- verwenden.

ConsoleConnector

Verbindet einen UniversalBot über ein Konsolenfenster mit der Befehlszeile.

Dialog

Basisklasse für alle Dialogfelder. Dialoge sind die Kernkomponente des BotBuilder-Frameworks. Bots verwenden Dialoge, um willkürlich komplexe Unterhaltungen mit einem Benutzer zu verwalten.

DialogAction

Dialogaktionen bieten statische Verknüpfungen zur Implementierung allgemeiner Aktionen. Sie implementieren auch Unterstützung für benannte Aktionen, die an ein Dialogfeld gebunden werden können, um globale Äußerungen des Benutzers wie "Hilfe" oder "Abbrechen" zu behandeln. Aktionen werden als Teil von Dialogfeldern in den Dialogstapel verschoben, sodass diese Listener während des Fortschritts der Unterhaltung in den Gültigkeitsbereich gelangen können. Sie können auch benannte Aktionen an Schaltflächen binden, mit denen Ihr Bot auf Schaltflächenklicks auf Karten reagieren kann, die möglicherweise vom Bildschirm gescrollt wurden.

EntityRecognizer

Hilfsklasse, die zum Analysieren & auflösen gängige Entitäten wie datetimes, die von LUIS empfangen wurden.

Fact

Builder-Klasse, um das Erstellen einer Liste von Fakten für eine Karte wie einen Beleg zu vereinfachen.

HeroCard

Karten-Generator-Klasse, die das Erstellen von Herokarten vereinfacht. Hero-Karten enthalten dieselben Informationen wie eine Miniaturansichtskarte, nur mit einem größeren, ausgeprägteren Layout für die Kartenbilder.

IntentDialog

Identifiziert eine Benutzerabsicht und extrahiert optional Entitäten aus einer Benutzerausdrücke.

IntentRecognizer

Basisklasse für alle Kernerkennungen. Ermöglicht die bedingte Ausführung einer Erkennung und nach der Filterung erkannter Absichten. Abgeleitete Klasse sollte die abstrakte onRecognize()-Methode überschreiben.

IntentRecognizerSet

Partnerverbunden eines Erkennungsaufrufs über eine Reihe von Absichtserkennungen hinweg.

Keyboard

Karten-Generator-Klasse, die das Erstellen von Tastaturkarten vereinfacht.

Library

Eine Bibliothek verwandter Dialogfelder, die für Routingzwecke verwendet werden. Bibliotheken können miteinander verkettet werden, um die Entwicklung komplexer Bots zu ermöglichen. Die UniversalBot Klasse ist selbst eine Bibliothek, die den Stamm dieser Kette bildet. Bibliotheken wiederverwendbarer Teile können entwickelt werden, indem eine neue Bibliotheksinstanz erstellt und Dialogfelder hinzugefügt werden, genau wie sie einem Bot hinzugefügt werden. Ihre Bibliothek sollte einen eindeutigen Namen haben, der entweder Ihrer Bibliothekswebsite oder dem NPM-Modulnamen entspricht. Bots können Dann Ihre Bibliothek wiederverwenden, indem Sie einfach Ihre Parts Library-Instanz zu ihrem Bot hinzufügen, indem sie UniversalBot.library(). Wenn Ihre Bibliothek selbst von anderen Bibliotheken abhängt, sollten Sie sie ihrer Bibliothek als Abhängigkeit mit Library.library()hinzufügen. Sie können ganz einfach mehrere Versionen Ihrer Bibliothek verwalten, indem Sie ihrem Bibliotheksnamen eine Versionsnummer hinzufügen.

Um Dialogfelder in Ihren Bibliotheks-Bots aufzurufen, müssen Sie session.beginDialog() mit einer vollqualifizierten Dialogfeld-ID in Form von ":" aufrufen. Normalerweise blenden Sie dies vom Entwickler aus, indem Sie eine Funktion aus ihrem Modul verfügbar machen, die das Dialogfeld für sie startet. Das Aufrufen von etwas wie myLib.someDialog(session, { arg: '' }); würde also dazu führen, session.beginDialog('myLib:someDialog', args); unter den Deckeln anzurufen.

Es lohnt sich zu beachten, dass Dialogfelder immer im aktuellen Dialogfeld aufgerufen werden, sodass Sie nicht jedes "beginDialog()"-Präfix in einem Dialogfeld aus Ihrer Bibliothek mit dem Namen Ihrer Bibliotheken voranstellen müssen. Dies gilt nur, wenn Sie den Bibliothekskontext in einen anderen durchqueren, der das Präfix für den Bibliotheksnamen enthalten muss.

LocalizedRegExpRecognizer

Version der RegExpRecognizer-, die das Framework-Lokalisierungssystem verwendet, um einen lokalisierten regulären Ausdruck abzurufen. Der Nachschlageschlüssel in der datei index.json sollte bereitgestellt werden, und wenn eine Nachricht für ein neues Gebietsschema empfangen wird, ruft die Erkennung den lokalisierten Ausdruck ab, und es wird eine neue Groß-/Kleinschreibung beachtet, RegExp erstellt und verwendet wird, um die Absicht zu erkennen. Bibliotheken können dieses Feature verwenden, damit ein Bot seine Standardausdrücke außer Kraft setzen kann. Erstellen Sie einfach Instanzen der Erkennung mithilfe des Namespaces Ihrer Bibliothek und Bot-Entwickler können Ihre übereinstimmenden Ausdrücke mithilfe einer <namespace>.json Datei in ihrem Gebietsschemaverzeichnis anpassen.

LuisDialog

DEPRECATED stattdessen ein IntentDialog- mit einem LuisRecognizer- verwenden.

LuisRecognizer

Intent-Erkennungs-Plug-In, das benutzerabsichtig mit Microsofts Language Understanding Intelligent Service (LUIS) Die Dienst-URLs für mehrere LUIS-Modelle (Apps) können übergeben werden, um die Erkennung in mehreren Sprachen zu unterstützen.

MediaCard

Karten-Generator-Klasse, die das Erstellen von Medienkarten vereinfacht.

MemoryBotStorage

Standard in der Speicherimplementierung zum Speichern von Benutzer-& Sitzungszustandsdaten.

Message

Nachrichten-Generator-Klasse, die das Erstellen komplexer Nachrichten mit Anlagen vereinfacht.

Middleware
OAuthCard

Karten-Generator-Klasse, die das Erstellen von OAuth-Karten vereinfacht.

Prompt

Basisklasse für integrierte Eingabeaufforderungen und kann zum Erstellen neuer benutzerdefinierter Eingabeaufforderungen verwendet werden. Die Prompt-Klasse bietet die grundlegende Logik zum Auffordern/Erneuten Auffordern eines Benutzers und stellt eine Reihe erweiterbarer Hooks bereit, um die Eingabeaufforderungserkennung der Benutzerantwort sowie die an den Benutzer gesendete Ausgabe anzupassen. Eingabeaufforderungen sollten immer mindestens eine onRecognize() Handler registriert haben und unterstützen das Hinzufügen einer beliebigen Anzahl von matches() oder matchesAny()-Handlern, die verwendet werden können, um der Eingabeaufforderung spezielle vom Benutzer initiierte Befehle hinzuzufügen. Beispielsweise fügen die integrierten Eingabeaufforderungen eine matches('BotBuilder.RepeatIntent') hinzu, um zu hören, dass ein Benutzer eine Eingabeaufforderung wiederholt, wodurch die Eingabeaufforderung erneut gesendet wird.

PromptAttachment

Anpassbare Anlagenaufforderung.

PromptChoice

Anpassbare Auswahlaufforderung.

PromptConfirm

Anpassbare Bestätigungsaufforderung.

PromptNumber

Anpassbare Bestätigungsaufforderung.

PromptText

Anpassbare Textaufforderung.

PromptTime

Anpassbare Zeitaufforderung.

ReceiptCard

Karten-Generator-Klasse, die das Erstellen von Belegkarten vereinfacht.

ReceiptItem

Builder-Klasse zum Vereinfachen des Hinzufügens von Elementen zu einer Belegkarte.

RegExpRecognizer

Intent-Erkennungs-Plug-In, das eine Benutzerabsicht mithilfe eines regulären Ausdrucks erkennt. Mehrere Ausdrücke können übergeben werden, um die Erkennung über mehrere Sprachen hinweg zu unterstützen.

RemoteSessionLogger

Protokolliert Sitzungsaktivitäten mit einem Remoteendpunkt mithilfe von Debugereignissen. Der Remotedebugger wird automatisch verwendet, wenn der Emulator eine Verbindung mit Ihrem Bot herstellt. Nicht-Emulatorkanäle können ihre Aktivitäten an den Emulator streamen, indem sie die Adresse der Emulatorsitzung in session.privateConversationData["BotBuilder.Data.DebugSession"]speichern.

Session

Verwaltet die Bots-Unterhaltung mit einem Benutzer.

SessionLogger

Standardsitzungsprotokollierer, der zum Protokollieren der Sitzungsaktivität in der Konsole verwendet wird.

SigninCard

Karten-Generator-Klasse, die das Erstellen von Anmeldekarten vereinfacht.

SimpleDialog

Ermöglicht die Erstellung von benutzerdefinierten Dialogfeldern, die auf einem einfachen Schließen basieren. Dies ist nützlich für Fälle, in denen Sie einen dynamischen Unterhaltungsfluss wünschen oder eine Situation haben, die nur nicht sehr gut zu einem Wasserfall passt. Die Dinge, die Sie beachten sollten:

  • Das Schließen von Dialogfeldern kann in zwei verschiedenen Kontexten aufgerufen werden, auf die Sie möglicherweise testen müssen. Er wird wie erwartet aufgerufen, wenn der Benutzer Ihr Dialogfeld sendet, aber wenn Sie eine andere Eingabeaufforderung oder ein anderes Dialogfeld aus dem Schließen aufrufen, wird er ein zweites Mal mit den Ergebnissen aus der Eingabeaufforderung/dem Dialogfeld aufgerufen. Sie können diesen zweiten Fall in der Regel testen, indem Sie nach dem Vorhandensein einer args.resumed-Eigenschaft suchen. Es ist wichtig, sich nicht in eine endlose Schleife zu versetzen, die leicht zu erledigen ist.
  • Im Gegensatz zu einem Wasserfall endet Ihr Dialogfeld nicht automatisch. Es bleibt das aktive Dialogfeld, bis Sie session.endDialog()aufrufen.
SimplePromptRecognizer

VERALTETe ab v3.8 nicht mehr unterstützt. Verwenden Sie stattdessen benutzerdefinierte Eingabeaufforderungen.

SuggestedActions

Generatorklasse zum Hinzufügen vorgeschlagener Aktionen zu einer Nachricht

TextBot

veraltete verwenden stattdessen UniversalBot und ein ConsoleConnector-.

ThumbnailCard

Karten-Generator-Klasse, die das Erstellen von Miniaturansichten vereinfacht.

UniversalBot

Verwaltet Ihre Bots-Unterhaltungen mit Benutzern über mehrere Kanäle hinweg.

VideoCard

Karten-Generator-Klasse, die das Erstellen von Grafikkarten vereinfacht.

WaterfallDialog

Ermöglicht die Erstellung von benutzerdefinierten Dialogfeldern, die auf einem Wasserfall basieren.

Schnittstellen

IActionRouteData

Argumente, die an eine ausgelöste Aktion übergeben werden.

IAddress

Adressroutinginformationen für ein Ereignis. Adressen sind bidirektional, d. h. sie können verwendet werden, um eingehende und ausgehende Ereignisse zu adressieren. Sie sind auch verbinderspezifisch, was bedeutet, dass Connectors ihre eigenen Felder zur Adresse hinzufügen können. Um eine proaktive Nachricht an benutzerbots zu senden, sollte die Adresse von einer empfangenen Nachrichtgespeichert werden. Je nach Kanaladressen kann sich dies ändern, sodass Bots die für einen bestimmten Benutzer gespeicherte Adresse regelmäßig aktualisieren sollten.

IAnimationCard

Schnittstellendefinition für eine Animationskarte

IAttachment

Viele Messagingkanäle bieten die Möglichkeit, umfangreichere Objekte anzufügen. Mit Bot Builder können Sie diese Anlagen auf kanalübergreifende Weise ausdrücken, und Connectors die Anlagen mithilfe der systemeigenen Kanäle rendern. Wenn Sie mehr Kontrolle über das Rendern von Kanälen einer Nachricht wünschen, können Sie IEvent.sourceEvent- verwenden, um Anlagen mithilfe des systemeigenen Schemas der Kanäle bereitzustellen. Die Typen von Anlagen, die gesendet werden können, variieren je nach Kanal, aber dies sind die grundlegenden Typen:

  • Medien und Dateien: Basic-Dateien können gesendet werden, indem sie contentType- auf den MIME-Typ der Datei festlegen und dann einen Link zur Datei in contentUrlübergeben.
  • Karten: Ein umfangreicher Satz visueller Karten kann durch Festlegen contentType- auf den Kartentyp festgelegt und dann den JSON-Code für die Karte in Inhaltübergeben. Wenn Sie eine der Rich-Karten-Generator-Klassen wie HeroCard verwenden, wird die Anlage automatisch für Sie ausgefüllt.
IAudioCard

Schnittstellendefinition für eine Audiokarte

IBeginDialogActionOptions

Optionen, die beim Definieren einer beginDialogAction()übergeben werden.

IBotStateData

Exportierte Botstatusdaten.

IBotStateDataResult

Ergebnisobjekt, das von ChatConnector.exportBotStateData()zurückgegeben wird.

IBotStorage

Austauschbares Speichersystem, das von UniversalBot verwendet wird.

IBotStorageContext

Kontextobjekt, das an IBotStorage-Aufrufe übergeben wird.

IBotStorageData

Datenwerte bleiben in IBotStorage erhalten.

ICancelActionOptions

Optionen, die beim Definieren einer cancelAction()übergeben werden.

ICardAction

Die Aktion, die ausgeführt werden soll, wenn auf eine Karte, eine Schaltfläche oder ein Bild getippt wird.

ICardImage

Ein Bild auf einer Karte.

ICardMediaUrl

URL-Informationen zur Beschreibung von Medien für eine Karte

IChatConnectorAddress

ChatConnector spezifische Adresse.

IChatConnectorEndpoint

Optionen zum Festlegen verschiedener Endpunkte in einer ChatConnector-Instanz. Dies sollte nicht geändert werden und wird normalerweise nicht von Entwicklern in IChatConnectorSettings bereitgestellt. Stattdessen sollten die beiden Eigenschaften in "IChatConnectorSettings", "stateEndpoint" und "openIdMetadata" dort geändert werden.

IChatConnectorSettings

Optionen zum Initialisieren einer ChatConnector-Instanz.

IChoice

Eine Auswahl, die an Prompts.choice() oder [PromptRecognizers.recognizeChoices()][/en-us/node/builder/chat-reference/classes/botbuilder_d.promptrecognizers#recognizechoices] übergeben werden kann.

IConnector

Implementiert durch Connector-Plug-Ins für universalBot.

IContactRelationUpdate

Ein Benutzer hat seine Kontaktliste aktualisiert. /** Ein Benutzer hat seine Kontaktliste aktualisiert.

IConversationMembers

Liste der Mitglieder in einer Unterhaltung.

IConversationUpdate

Die Eigenschaften einer Unterhaltung wurden geändert.

IConversationsResult

Ergebnisobjekt, das von ChatConnector.getConversations()zurückgegeben wird.

IDefaultLocalizerSettings

Einstellungen, die zum Initialisieren einer ILocalizer-Implementierung verwendet werden.

IDialogActionOptions

Beim Definieren einer Dialogfeldaktion übergebene Optionen.

IDialogResult

Ergebnisse, die von einem untergeordneten Dialogfeld über einen Aufruf von session.endDialog() an das übergeordnete Element zurückgegeben werden.

IDialogState

Ein Eintrag im Dialogfeld "Sitzungen".

IDialogVersionOptions

An Middleware.dialogVersion() übergebene Optionen.

IDialogWaterfallStep

Signatur für Funktionen, die als Schritte an DialogAction.waterfall()übergeben werden. Mithilfe von Wasserfällen können Sie einen Benutzer zur Eingabe von Informationen auffordern, indem Sie eine Abfolge von Fragen verwenden. Jeder Schritt des Wasserfalls kann entweder eine der integrierten Aufforderungenausführen, ein neues Dialogfeld starten, indem sie session.beginDialog()aufrufen, zum nächsten Schritt des Wasserfalls manuell mit skip()wechseln oder den Wasserfall beenden.

Wenn entweder ein Dialogfeld oder eine integrierte Eingabeaufforderung aus einem Wasserfallschritt aufgerufen wird, werden die Ergebnisse dieses Dialogfelds oder der Eingabeaufforderung über den parameter results an den nächsten Schritt des Wasserfalls übergeben. Benutzer können dinge wie "nie daran" sagen, um die integrierten Eingabeaufforderungen abzubrechen, damit Sie vor diesem Schutz schützen sollten, indem Sie zumindest auf results.response überprüfen, bevor Sie fortfahren. Eine ausführlichere Erläuterung, warum der Wasserfall fortgesetzt wird, kann bestimmt werden, indem sie den Code für results.resumedzurückgegeben.

Sie können mit der übergebenen skip()-Funktion manuell zum nächsten Schritt des Wasserfalls wechseln. Wenn Sie skip({ response: "some text" }) mit einem IDialogResult- aufrufen, können Sie die Ergebnisse einer integrierten Eingabeaufforderung genauer nachahmen und Ihre allgemeine Wasserfalllogik vereinfachen.

Sie können einen Wasserfall frühzeitig beenden, indem Sie entweder durch jeden Schritt des Wasserfalls fallen, indem Sie Anrufe an skip() oder einfach keine weitere Eingabeaufforderung oder ein anderes Dialogfeld starten.

Hinweis: Wasserfälle haben einen ausgeblendeten letzten Schritt, der das aktuelle Dialogfeld automatisch beendet, wenn Sie eine Eingabeaufforderung oder ein Dialogfeld aus dem letzten Schritt aufrufen. Dies ist hilfreich, wenn Sie über einen tiefen Stapel von Dialogfeldern verfügen und einen Aufruf session.endDialog() vom letzten untergeordneten Element im Stapel zum Beenden des gesamten Stapels wünschen. Der Schließen des letzten Kindes löst alle übergeordneten Elemente aus, um zu diesem ausgeblendeten Schritt zu wechseln, der die Nähe bis zum Stapel überlappen wird. Dies ist in der Regel ein gewünschtes Verhalten, aber wenn Sie es vermeiden oder an einer beliebigen Stelle in der Mitte beenden möchten, müssen Sie am Ende Ihres Wasserfalls einen Schritt hinzufügen, der entweder nichts tut oder etwas wie session.send() aufruft, das den Wasserfall nicht vorwärts voranschreiten wird.

IDisambiguateChoices

Route choices to pass to Prompts.disambiguate(). Der Schlüssel für die Karte sollte die lokalisierte Beschriftung sein, die dem Benutzer angezeigt werden soll, und der Wert sollte die Route sein, die beim Auswählen durch den Benutzer ausgewählt werden soll. Sie können null für die Route übergeben, um dem Benutzer die Möglichkeit zum Abbrechen zu geben.

IDisambiguateRouteHandler

Benutzerdefinierte Routendeutigkeitslogik, die an UniversalBot.onDisambiguateRoute()übergeben wird.

IEntity

Eine erkannte Entität.

IEvent

Ein Ereignis, das von einer Quelle empfangen oder an eine Quelle gesendet wird.

IEventMiddleware

Funktionssignatur für eine Middleware, die die Ereignisse "Empfangen" oder "Senden" einschließt.

IFact

Eine Tatsache, die auf einer Karte wie einem Belegangezeigt wird.

IFindActionRouteContext

Kontext, der an ActionSet.findActionRoutes()übergeben wird.

IFindMatchResult

Von einem Aufruf von EntityRecognizer.findBestMatch() oder EntityRecognizer.findAllMatches() zurückgegebenes Ergebnis.

IFindRoutesHandler

Benutzerdefinierte Routensuchlogik, die an Library.onFindRoutes()übergeben wird.

IFirstRunOptions

An Middleware.firstRun() übergebene Optionen.

IIdentity

Stellt einen Benutzer, Bot oder eine Unterhaltung dar.

IIntent

Eine erkannte Absicht.

IIntentDialogOptions

Optionen zum Konfigurieren eines IntentDialog-.

IIntentRecognizer

Schnittstelle, die von Intent-Erkennungs-Plug-Ins wie der LuisRecognizer Klasse implementiert wird.

IIntentRecognizerResult

Von einer Absichtserkennung zurückgegebene Ergebnisse.

IIntentRecognizerSetOptions

Optionen zum Konfigurieren eines IntentRecognizerSet-.

IIsAttachment

Implementiert durch Klassen, die in eine Anlage konvertiert werden können.

IIsCardAction

Implementiert durch Klassen, die in eine Kartenaktion konvertiert werden können.

IIsCardImage

Implementiert durch Klassen, die in ein Kartenbild konvertiert werden können.

IIsCardMedia

Entitäten, die für Karten in Medien konvertiert werden können

IIsFact

Implementiert durch Klassen, die in eine Tatsache konvertiert werden können.

IIsMessage

Implementiert durch Klassen, die in eine IMessage konvertiert werden können, z. B. die Message Builder-Klasse.

IIsReceiptItem

Implementiert durch Klassen, die in ein Belegelement konvertiert werden können.

IIsSuggestedActions

Implementiert durch Klassen, die in vorgeschlagene Aktionen konvertiert werden können

ILocalizer

Plug-In zum Lokalisieren von Nachrichten, die von einem Bot an den Benutzer gesendet werden.

ILuisModelMap

Eine pro/lokale Zuordnung der LUIS-Dienst-URL, die für einen LuisRecognizer verwendet werden soll.

IMediaCard

Schnittstellendefinition einer generischen MediaCard, die in konkreter Form eine Audio-, Animations- oder Videokarte sein kann

IMediaEventValue

Zusätzlicher Parameter für Medienereignisse.

IMessage

Eine Chatnachricht, die zwischen einem Benutzer und einem Bot gesendet wurde. Nachrichten vom Bot an den Benutzer kommen in zwei Varianten:

  • reaktiven Nachrichten sind Nachrichten, die vom Bot an den Benutzer gesendet werden, als Antwort auf eine eingehende Nachricht des Benutzers.
  • proaktive Nachrichten sind Nachrichten, die vom Bot an den Benutzer als Reaktion auf ein externes Ereignis gesendet werden, z. B. ein Alarm, der ausgelöst wird.

Im reaktiven Fall sollten Sie die Adresse Feld aus der eingehenden Nachricht in die ausgehende Nachricht kopieren (wenn Sie die Message Builder-Klasse verwenden und mit der Sitzung initialisieren, dies automatisch geschieht) und dann den Text oder Anlagenfestlegen. Für proaktive Nachrichten müssen Sie die Adresse aus der eingehenden Nachricht an einem externen Speicher speichern. Sie können dies später an UniversalBot.beginDialog() übergeben oder in eine ausgehende Nachricht kopieren, die an UniversalBot.send()übergeben wird.

Durch das Verfassen einer Nachricht an den Benutzer mithilfe des eingehenden Adressobjekts wird standardmäßig eine Antwort an den Benutzer im Kontext der aktuellen Unterhaltung gesendet. Einige Kanäle ermöglichen das Starten neuer Unterhaltungen mit dem Benutzer. Um eine neue proaktive Unterhaltung mit dem Benutzer zu beginnen, löschen Sie einfach die Unterhaltung Feld aus dem Adressobjekt, bevor Sie die ausgehende Nachricht verfassen.

IMessageOptions

Optionale Nachrichteneigenschaften, die an Elemente wie Eingabeaufforderungen oder session.say()gesendet werden können.

IMessageReaction

Nachrichtenreaktionsobjekt.

IMessageUpdate

Die Eigenschaften einer Nachricht wurden geändert.

IMiddlewareMap

Karte von Middleware-Hooks, die in einem Aufruf von UniversalBot.use()registriert werden können.

IOAuthCard

Eine Schnittstelle, die OAuthCard darstellt. Eine Karte, die eine Anforderung darstellt, eine Anmeldung über OAuth zu erstellen

IPagedMembersResult

Ergebnisobjekt, das von ChatConnector.getConversationPagedMembers()zurückgegeben wird.

IPromptArgs

DEPRECATED das neue Eingabeaufforderungssystem verwendet nur IPromptOptions.

IPromptAttachmentFeatures

Optionale Features für PromptAttachment Klasse.

IPromptAttachmentOptions

Optionen, die an Prompts.attachment() oder in einem session.beginDialog() Aufruf einer benutzerdefinierten Eingabeaufforderung basierend auf der PromptAttachment Klasse übergeben werden.

IPromptAttachmentResult

Eingabeaufforderungsergebnis mit starkem Typ.

IPromptChoiceFeatures

Optionale Features für PromptChoice Klasse.

IPromptChoiceOptions

Optionen, die an Prompts.choice() oder in einem session.beginDialog() Aufruf einer benutzerdefinierten Eingabeaufforderung basierend auf der PromptChoice Klasse übergeben werden.

IPromptChoiceResult

Auswahlaufforderungsergebnis mit starkem Typ.

IPromptConfirmResult

Stark eingegebenes Bestätigungsaufforderungsergebnis.

IPromptContext

Kontextbezogene Informationen, die für eine Aufforderungnachverfolgt werden. Auf diese Informationen kann innerhalb einer Eingabeaufforderung über session.dialogDatazugegriffen werden.

IPromptFeatures

Optionale Features, die beim Erstellen eines benutzerdefinierten Eingabeaufforderungs- aktiviert/deaktiviert werden sollen

IPromptNumberOptions

Optionen, die an Prompts.number() oder in einem session.beginDialog() Aufruf einer benutzerdefinierten Eingabeaufforderung basierend auf der PromptNumber Klasse übergeben werden.

IPromptNumberResult

Stark typiertes Zahlenaufforderungsergebnis.

IPromptOptions

Optionen, die an die integrierten Eingabeaufforderungenübergeben werden.

IPromptRecognizeChoicesOptions

Optionen, die an PromptRecognizers.recognizeChoices()übergeben werden.

IPromptRecognizeNumbersOptions

Optionen, die an PromptRecognizers.recognizeNumbers()übergeben werden.

IPromptRecognizeTimesOptions

Optionen, die an PromptRecognizers.recognizeTimes()übergeben werden.

IPromptRecognizeValuesOptions

Optionen, die an PromptRecognizers.recognizeValues()übergeben werden.

IPromptRecognizer

VERALTETe ab v3.8 nicht mehr unterstützt. Verwenden Sie stattdessen benutzerdefinierte Eingabeaufforderungen.

IPromptRecognizerArgs

VERALTETe ab v3.8 nicht mehr unterstützt. Verwenden Sie stattdessen benutzerdefinierte Eingabeaufforderungen.

IPromptRecognizerResult

Von einem IPromptRecognizer zurückgegebenes Ergebnis.

IPromptResult

Von einer Systemaufforderung zurückgegebenes Dialogfeldergebnis.

IPromptTextFeatures

Optionale Features für PromptText- Klasse.

IPromptTextOptions

Optionen, die an Prompts.text() oder in einem session.beginDialog() Aufruf einer benutzerdefinierten Eingabeaufforderung basierend auf der PromptText Klasse übergeben werden.

IPromptTextResult

Stark typiertes Textaufforderungsergebnis.

IPromptTimeResult

Stark typiertes Zeitaufforderungsergebnis.

IPromptsOptions

VERALTETe ab v3.8 nicht mehr unterstützt. Verwenden Sie stattdessen benutzerdefinierte Eingabeaufforderungen.

IReceiptCard

Zeigt einem Benutzer eine umfangreiche Bestätigung für etwas an, das er gekauft hat oder plant, es zu kaufen.

IReceiptItem

Ein einzelnes Element innerhalb eines Belegs.

IRecognizeContext

Kontext der empfangenen Nachricht, die an verschiedene Erkennungsmethoden übergeben wird.

IRecognizeDialogContext

Kontext, der an Dialog.recognize()übergeben wird.

IRecognizeResult

Ergebnisse eines Aufrufs einer Erkennungsfunktion.Results from a call to a recognize() function. Die Implementierung kann dem Ergebnis alle zusätzlichen Eigenschaften hinzufügen.

IRegExpMap

Eine lokale Zuordnung regulärer Ausdrücke, die für einen RegExpRecognizer verwendet werden sollen.

IRouteResult

Kandidatenroute, die von Library.findRoutes()zurückgegeben wird.

ISelectRouteHandler

Benutzerdefinierte Routensuchlogik, die an Library.onSelectRoute()übergeben wird.

ISemanticAction

Stellt einen Verweis auf eine programmgesteuerte Aktion dar.

ISessionMiddleware

Funktionssignatur für eine Middleware, die das Ereignis "botbuilder" einfügt.

ISessionOptions

Optionen, die an den Konstruktor einer Sitzung übergeben werden.

ISessionState

Beibehaltener Sitzungszustand, der zum Nachverfolgen eines Dialogstapels für Unterhaltungen verwendet wird.

ISigninCard

Zeigt dem Benutzer eine Anmeldekarte und eine Schaltfläche an. Einige Kanäle können dies als Textaufforderung rendern und einen Link zum Klicken erstellen.

ISourceEventMap

Eine Zuordnung pro/Quelle von zu sendenden benutzerdefinierten Ereignisdaten.

IStartConversationAddress

Zusätzliche Eigenschaften, die mit der Adresse an UniversalBot.beginDialog()übergeben werden können.

ISuggestedActions

Vorgeschlagene Aktionen, die an den Benutzer gesendet und als schnelle Antworten angezeigt werden. Vorgeschlagene Aktionen werden nur auf den Kanälen angezeigt, die vorgeschlagene Aktionen unterstützen.

ITextHighlight

Eine Schnittstelle, die TextHighlight darstellt. Bezieht sich auf eine Teilzeichenfolge von Inhalt innerhalb eines anderen Felds.

IThumbnailCard

Zeigt dem Benutzer entweder ein kleineres Miniaturansichtslayout oder ein größeres Hero-Layout an (die Anlagen contentType bestimmt, welches). Alle Kartenfelder sind optional, sodass diese Karte verwendet werden kann, um Elemente wie eine Tastatur auf bestimmten Kanälen anzugeben. Einige Kanäle können eine niedrigere Genauigkeitsversion der Karte rendern oder eine alternative Darstellung verwenden.

ITokenResponse

Eine Schnittstelle, die TokenResponse darstellt. Eine Antwort, die ein Benutzertoken enthält

ITranscript

Eine Schnittstelle, die historische Aktivitäten darstellt.

ITriggerActionOptions

Optionen, die beim Definieren einer triggerAction()übergeben werden.

IUniversalBotSettings

Optionen zum Initialisieren einer UniversalBot-Instanz.

IVideoCard

Schnittstellendefinition für eine Grafikkarte

IWatchableHandler

Funktion zum Abrufen des Werts einer überwachten Variablen. Wird an Session.watchable()übergeben.

Typaliase

AttachmentType

Einige Methoden können entweder eine IAttachment in JSON-Form oder eine der verschiedenen Karten-Generator-Klassen verwenden, die IIsAttachmentimplementieren.

MatchType

Unterstützte Regeln für den Abgleich mit der Äußerung eines Benutzers.

  • {RegExp}- – Ein regulärer Ausdruck wird verwendet, um mit der Äußerung der Benutzer übereinzugleichen.
  • {string}- – Eine benannte Absicht, die von einer Erkennung zurückgegeben wird, wird verwendet, um mit der Äußerung der Benutzer übereinzugleichen.
  • {(RegExp|string)[]} – Ein Array von regulären Ausdrücken oder benannten Absichten kann übergeben werden, um die Äußerung der Benutzer auf verschiedene Arten abzugleichen. Die Regel, die den höchsten Punkt (beste Übereinstimmung) generiert, wird für Bewertungszwecke verwendet.
MessageType

Nachrichtenbasierte Eingabeaufforderungen, die an einen Benutzer gesendet werden können.

  • {IMessage}- – Nachricht, die den Benutzer mithilfe von JSON ausgedrückt hat. Die Nachricht kann Anlagen und vorgeschlagene Aktionen enthalten. Nicht alle Kanäle unterstützen nativ alle Nachrichteneigenschaften, aber die meisten Kanäle rendern nicht unterstützte Felder.
  • {IIsMessage}- – Eine Instanz der Message Builder-Klasse. Mit dieser Klasse können Sie Ihre Nachrichten lokalisieren und Hilfsprogramme zum Formatieren der Textabschnitte Ihrer Nachricht bieten.
TextOrMessageType

Flexibler Bereich möglicher Eingabeaufforderungen, die an einen Benutzer gesendet werden können.

  • {string}- – Eine einfache Nachricht, die dem Benutzer gesendet werden soll.
  • {string[]} – Array möglicher Nachrichten, die dem Benutzer gesendet werden sollen. Eine wird nach dem Zufallsprinzip ausgewählt.
  • {IMessage}- – Nachricht, die den Benutzer mithilfe von JSON ausgedrückt hat. Die Nachricht kann Anlagen und vorgeschlagene Aktionen enthalten. Nicht alle Kanäle unterstützen nativ alle Nachrichteneigenschaften, aber die meisten Kanäle rendern nicht unterstützte Felder.
  • {IIsMessage}- – Eine Instanz der Message Builder-Klasse. Mit dieser Klasse können Sie Ihre Nachrichten lokalisieren und Hilfsprogramme zum Formatieren der Textabschnitte Ihrer Nachricht bieten.
TextType

Textbasierte Eingabeaufforderungen, die an einen Benutzer gesendet werden können.

  • {string}- – Eine einfache Nachricht, die dem Benutzer gesendet werden soll.
  • {string[]} – Array möglicher Nachrichten, die dem Benutzer gesendet werden sollen. Eine wird nach dem Zufallsprinzip ausgewählt.
ValueListType

Liste der Textwerte. Die Werte können als durch Pipe getrennte Zeichenfolge wie "Value1|value2|value3" oder einfaches Array von Werten ausgedrückt werden.

Enumerationen

ListStyle

Typ der Liste, die für promptType.choice gerendert werden soll.

PromptType

Typ der aufgerufenen Eingabeaufforderung.

RecognizeMode

Steuert eine IntentDialogs Verarbeitung der Texttexteingaben des Benutzers.

RecognizeOrder

Reihenfolge, in der eine IntentDialogs- Erkennung ausgewertet werden soll.

ResumeReason

Grundcodes dafür, warum ein Dialogfeld fortgesetzt wurde.