Partager via


botbuilder package

Classes

ActionSet

Implémentez la prise en charge des actions nommées qui peuvent être liées à une boîte de dialogue pour gérer les énoncés globaux de l’utilisateur comme « aide » ou « annuler ». Les actions sont envoyées sur et hors de la pile de dialogues dans le cadre de dialogues afin que ces écouteurs puissent entrer et sortir de l’étendue à mesure que la conversation progresse. Vous pouvez également lier des actions nommées à des boutons qui permettent à votre bot de répondre aux clics de bouton sur les cartes qui ont peut-être fait défiler l’écran.

AnimationCard

Classe générateur de cartes qui simplifie la création de cartes d’animation.

AudioCard

Classe de générateur de cartes qui simplifie la création de cartes multimédias.

BotConnectorBot

déprécié utiliser universalBot et un ChatConnector à la place.

CardAction

Classe Builder pour simplifier l’ajout d’actions à une carte.

CardImage

Classe Builder pour simplifier l’ajout d’images à une carte.

CardMedia

Définition d’une entité multimédia pour une carte

ChatConnector

Connecte un UniversalBot à plusieurs canaux via Bot Framework.

CommandDialog

DÉCONSEILLÉ utilisez une IntentDialog à la place.

ConsoleConnector

Connecte un UniversalBot à la ligne de commande via une fenêtre de console.

Dialog

Classe de base pour tous les dialogues. Les dialogues sont le composant principal de l’infrastructure BotBuilder. Les bots utilisent des dialogues pour gérer des conversations arbitrairement complexes avec un utilisateur.

DialogAction

Les actions de boîte de dialogue offrent des raccourcis statiques pour implémenter des actions courantes. Ils implémentent également la prise en charge des actions nommées qui peuvent être liées à une boîte de dialogue pour gérer les énoncés globaux de l’utilisateur comme « aide » ou « annuler ». Les actions sont envoyées sur et hors de la pile de dialogues dans le cadre de dialogues afin que ces écouteurs puissent entrer et sortir de l’étendue à mesure que la conversation progresse. Vous pouvez également lier des actions nommées à des boutons qui permettent à votre bot de répondre aux clics de bouton sur les cartes qui ont peut-être fait défiler l’écran.

EntityRecognizer

Classe utilitaire utilisée pour analyser & résoudre les entités courantes telles que les datetimes reçues de LUIS.

Fact

Classe Builder pour simplifier la création d’une liste de faits pour une carte comme un reçu.

HeroCard

Classe générateur de cartes qui simplifie la création de cartes héros. Les cartes héros contiennent les mêmes informations qu’une carte miniature, juste avec une disposition plus prononcée pour les images de cartes.

IntentDialog

Identifie une intention des utilisateurs et extrait éventuellement des entités d’un énoncé d’utilisateurs.

IntentRecognizer

Classe de base pour tous les modules de reconnaissance principaux. Permet l’exécution conditionnelle d’un module de reconnaissance et de post-filtrage des intentions reconnues. La classe dérivée doit remplacer la méthode abstraite onRecognize().

IntentRecognizerSet

Fédère un appel recognize() sur un ensemble de modules de reconnaissance d’intention.

Keyboard

Classe générateur de cartes qui simplifie la création de cartes clavier.

Library

Bibliothèque de dialogues connexes utilisées à des fins de routage. Les bibliothèques peuvent être chaînées pour permettre le développement de bots complexes. La classe UniversalBot est elle-même une bibliothèque qui forme la racine de cette chaîne. Les bibliothèques de parties réutilisables peuvent être développées en créant une nouvelle instance de bibliothèque et en ajoutant des dialogues comme vous le feriez à un bot. Votre bibliothèque doit avoir un nom unique qui correspond à votre site web de bibliothèques ou au nom du module NPM. Les bots peuvent ensuite réutiliser votre bibliothèque en ajoutant simplement votre instance de bibliothèque de composants à leur bot à l’aide de UniversalBot.library(). Si votre bibliothèque dépend d’autres bibliothèques, vous devez les ajouter à votre bibliothèque en tant que dépendance à l’aide de Library.library(). Vous pouvez facilement gérer plusieurs versions de votre bibliothèque en ajoutant un numéro de version à votre nom de bibliothèque.

Pour appeler des dialogues au sein de vos bots de bibliothèque, vous devez appeler session.beginDialog() avec un ID de dialogue complet sous la forme « : ». Vous le masquerez généralement auprès du développeur en exposant une fonction de son module qui démarre la boîte de dialogue pour eux. Ainsi, appeler quelque chose comme myLib.someDialog(session, { arg: '' }); finirait par appeler session.beginDialog('myLib:someDialog', args); sous les couvertures.

Il est important de noter que les dialogues sont toujours appelés dans la boîte de dialogue active. Par conséquent, une fois que vous êtes dans une boîte de dialogue de votre bibliothèque, vous n’avez pas besoin de préfixer chaque beginDialog() appelez votre nom de bibliothèque. Ce n’est que lorsque vous passez d’un contexte de bibliothèque à un autre que vous devez inclure le préfixe du nom de la bibliothèque.

LocalizedRegExpRecognizer

Version du RegExpRecognizer qui utilise le système de localisation des frameworks pour récupérer une expression régulière localisée. La clé de recherche dans le fichier index.json doit être fournie et lors de la réception d’un message pour un nouveau paramètre régional, le module de reconnaissance récupère l’expression localisée et une nouvelle RegExp ne respectant pas la casse sera créée et utilisée pour reconnaître l’intention. Les bibliothèques peuvent utiliser cette fonctionnalité pour permettre à un bot de remplacer leurs expressions correspondantes par défaut. créez simplement des instances du module de reconnaissance à l’aide de l’espace de noms de votre bibliothèque et des développeurs de bots peuvent personnaliser vos expressions correspondantes à l’aide d’un fichier <namespace>.json dans leur répertoire de paramètres régionaux.

LuisDialog

DÉPRÉCIÉ utiliser un IntentDialog avec un LuisRecognizer à la place.

LuisRecognizer

Le plug-in Intent recognizer qui détecte une intention d’utilisateur à l’aide de Microsofts Language Understanding Intelligent Service (LUIS) Les URL de service pour plusieurs modèles LUIS (applications) peuvent être transmises pour prendre en charge la reconnaissance entre plusieurs langues.

MediaCard

Classe de générateur de cartes qui simplifie la création de cartes multimédias.

MemoryBotStorage

Valeur par défaut dans l’implémentation du stockage de mémoire pour le stockage des données d’état de session & utilisateur.

Message

Classe générateur de messages qui simplifie la création de messages complexes avec des pièces jointes.

Middleware
OAuthCard

Classe de générateur de cartes qui simplifie la création de cartes oauth.

Prompt

Classe de base pour les invites intégrées et peut être utilisée pour générer de nouvelles invites personnalisées. La classe Prompt fournit la logique de base pour inviter/réinscrire un utilisateur et fournit un ensemble de hooks extensibles pour personnaliser la reconnaissance des invites des utilisateurs et la sortie envoyée à l’utilisateur. Les invites doivent toujours avoir au moins un onRecognize() gestionnaire inscrit et prennent en charge l’ajout de n’importe quel nombre de correspondances () ou de matchesAny() gestionnaires qui peuvent être utilisés pour ajouter des commandes spéciales lancées par l’utilisateur à l’invite. Par exemple, les invites intégrées ajoutent une matches('BotBuilder.RepeatIntent') pour écouter un utilisateur afin de demander à un utilisateur de répéter une invite, ce qui entraîne l’envoi de l’invite initiale à nouveau.

PromptAttachment

Invite de pièces jointes personnalisables.

PromptChoice

Invite de choix personnalisable.

PromptConfirm

Invite de confirmation personnalisable.

PromptNumber

Invite de confirmation personnalisable.

PromptText

Invite de texte personnalisable.

PromptTime

Invite de temps personnalisable.

ReceiptCard

Classe générateur de cartes qui simplifie la création de cartes de reçu.

ReceiptItem

Classe Builder pour simplifier l’ajout d’éléments à une carte de reçu.

RegExpRecognizer

Plug-in De reconnaissance d’intention qui détecte une intention d’utilisateur à l’aide d’une expression régulière. Plusieurs expressions peuvent être transmises pour prendre en charge la reconnaissance entre plusieurs langues.

RemoteSessionLogger

Consigne l’activité de session vers un point de terminaison distant à l’aide d’événements de débogage. Le débogueur distant est automatiquement utilisé lorsque l’émulateur se connecte à votre bot. Les canaux non-émulateurs peuvent diffuser leur activité vers l’émulateur en enregistrant l’adresse de la session de l’émulateur sur session.privateConversationData["BotBuilder.Data.DebugSession"].

Session

Gère la conversation entre les bots et un utilisateur.

SessionLogger

Enregistreur d’événements de session par défaut utilisé pour journaliser l’activité de session dans la console.

SigninCard

Classe de générateur de cartes qui simplifie la création de cartes de connexion.

SimpleDialog

Permet la création de dialogues personnalisés basés sur une fermeture simple. Cela est utile pour les cas où vous souhaitez un flux de conversation dynamique ou si vous avez une situation qui n’est pas très bien mappée à l’utilisation d’une cascade. Les points à garder à l’esprit :

  • La fermeture de vos boîtes de dialogue peut être appelée dans deux contextes différents que vous avez potentiellement besoin de tester. Elle est appelée comme prévu lorsque l’utilisateur envoie votre boîte de dialogue un message, mais si vous appelez une autre invite ou boîte de dialogue à partir de votre fermeture, elle est appelée une deuxième fois avec les résultats de l’invite/boîte de dialogue. Vous pouvez généralement tester ce deuxième cas en vérifiant l’existant d’une propriété args.resumed. Il est important d’éviter de vous rendre dans une boucle infinie qui peut être facile à faire.
  • Contrairement à une cascade, votre dialogue ne se termine pas automatiquement. Il reste la boîte de dialogue active jusqu’à ce que vous appeliez session.endDialog().
SimplePromptRecognizer

DÉCONSEILLÉ plus pris en charge à partir de la version 3.8. Utilisez plutôt des invites personnalisées.

SuggestedActions

Classe Builder pour ajouter des actions suggérées à un message

TextBot

DÉPRÉCIÉ utilisez UniversalBot et un ConsoleConnector à la place.

ThumbnailCard

Classe générateur de cartes qui simplifie la génération de cartes miniatures.

UniversalBot

Gère vos conversations de bots avec des utilisateurs sur plusieurs canaux.

VideoCard

Classe de générateur de cartes qui simplifie la création de cartes vidéo.

WaterfallDialog

Permet la création de dialogues personnalisés basés sur une cascade.

Interfaces

IActionRouteData

Arguments passés à une action déclenchée.

IAddress

Adressez les informations de routage d’un événement . Les adresses sont bidirectionnelles, ce qui signifie qu’elles peuvent être utilisées pour traiter à la fois les événements entrants et sortants. Ils sont également spécifiques au connecteur, ce qui signifie que connecteurs sont libres d’ajouter leurs propres champs à l’adresse. Pour envoyer un message proactif à un bot utilisateur, enregistrez l’adresse d’un message reçu. Selon les adresses de canal peuvent changer, les bots doivent donc régulièrement mettre à jour l’adresse stockée pour un utilisateur donné.

IAnimationCard

Définition d’interface pour une carte d’animation

IAttachment

De nombreux canaux de messagerie permettent d’attacher des objets plus riches. Bot Builder vous permet d’exprimer ces pièces jointes de manière croisée et de connecteurs feront leur mieux pour afficher les pièces jointes à l’aide des constructions natives des canaux. Si vous souhaitez contrôler davantage le rendu des canaux d’un message, vous pouvez utiliser IEvent.sourceEvent pour fournir des pièces jointes à l’aide du schéma natif des canaux. Les types de pièces jointes qui peuvent être envoyés varient selon le canal, mais il s’agit des types de base :

  • Media and Files : Fichiers de base peuvent être envoyés en définissant contentType sur le type MIME du fichier, puis en passant un lien vers le fichier dans contentUrl.
  • Cartes : Un ensemble complet de cartes visuelles peut en définissant contentType sur le type de cartes, puis en passant le json de la carte dans contenu. Si vous utilisez l’une des classes de générateur de cartes enrichies comme HeroCard la pièce jointe est automatiquement renseignée pour vous.
IAudioCard

Définition d’interface pour une carte audio

IBeginDialogActionOptions

Options passées lors de la définition d’un beginDialogAction().

IBotStateData

Données d’état du bot exportées.

IBotStateDataResult

Objet result retourné par ChatConnector.exportBotStateData().

IBotStorage

Système de stockage remplaçable utilisé par UniversalBot.

IBotStorageContext

Objet de contexte passé aux appels IBotStorage.

IBotStorageData

Les valeurs de données sont conservées dans IBotStorage.

ICancelActionOptions

Options passées lors de la définition d’un cancelAction().

ICardAction

Action à effectuer lorsqu’une carte, un bouton ou une image est appuyé.

ICardImage

Image sur une carte.

ICardMediaUrl

Informations d’URL décrivant le média pour une carte

IChatConnectorAddress

ChatConnector adresse spécifique.

IChatConnectorEndpoint

Options utilisées pour définir différents points de terminaison dans une instance ChatConnector. Cela ne doit pas être modifié et n’est normalement pas fourni par les développeurs dans IChatConnectorSettings. Au lieu de cela, les deux propriétés dans IChatConnectorSettings, « stateEndpoint » et « openIdMetadata » doivent être modifiées là-bas.

IChatConnectorSettings

Options utilisées pour initialiser une instance ChatConnector.

IChoice

Choix qui peut être transmis à Prompts.choice() ou [PromptRecognizers.recognizeChoices()][/en-us/node/builder/chat-reference/classes/botbuilder_d.promptrecognizers#recognizechoices].

IConnector

Implémenté par les plug-ins de connecteur pour UniversalBot.

IContactRelationUpdate

Un utilisateur a mis à jour sa liste de contacts. /** Un utilisateur a mis à jour sa liste de contacts.

IConversationMembers

Liste des membres d’une conversation.

IConversationUpdate

Les propriétés d’une conversation ont changé.

IConversationsResult

Objet result retourné par ChatConnector.getConversations().

IDefaultLocalizerSettings

Paramètres utilisés pour initialiser une implémentation ILocalizer.

IDialogActionOptions

Options passées lors de la définition d’une action de boîte de dialogue.

IDialogResult

Résultats retournés par une boîte de dialogue enfant à son parent via un appel à session.endDialog().

IDialogState

Entrée dans la pile de dialogue sessions.

IDialogVersionOptions

Options passées à Middleware.dialogVersion().

IDialogWaterfallStep

Signature pour les fonctions passées en tant qu’étapes pour DialogAction.waterfall(). Les cascades vous permettent d’inviter un utilisateur à entrer des informations à l’aide d’une séquence de questions. Chaque étape de la cascade peut exécuter l’une des invites intégrées, démarrer une nouvelle boîte de dialogue en appelant session.beginDialog(), passer à l’étape suivante de la cascade manuellement à l’aide de skip(), ou mettre fin à la cascade.

Quand un dialogue ou une invite intégrée est appelé à partir d’une étape en cascade, les résultats de ce dialogue ou de cette invite sont transmis via le paramètre results à l’étape suivante de la cascade. Les utilisateurs peuvent dire des éléments tels que « jamais à l’esprit » pour annuler les invites intégrées afin de vous protéger contre cela en vérifiant au moins results.response avant de continuer. Une explication plus détaillée de la raison pour laquelle la cascade continue peut être déterminée en examinant le code retourné pour results.reprise.

Vous pouvez passer manuellement à l’étape suivante de la cascade à l’aide de la fonction skip() passée. L’appel skip({ response: "some text" }) avec un IDialogResult vous permet d’imiter plus précisément les résultats d’une invite intégrée et de simplifier votre logique en cascade globale.

Vous pouvez arrêter une cascade tôt en tombant à chaque étape de la cascade à l’aide d’appels à skip() ou simplement de ne pas démarrer une autre invite ou dialogue.

remarque : Cascades ont une dernière étape masquée qui met automatiquement fin à la boîte de dialogue actuelle si vous appelez une invite ou un dialogue à partir de la dernière étape. Cela est utile lorsque vous disposez d’une pile approfondie de dialogues et que vous souhaitez appeler session.endDialog() du dernier enfant sur la pile pour mettre fin à l’ensemble de la pile. La fermeture du dernier enfant déclenchera tous ses parents à passer à cette étape masquée, ce qui cascadera la fermeture jusqu’à la pile. Il s’agit généralement d’un comportement souhaité, mais si vous souhaitez l’éviter ou l’arrêter quelque part au milieu, vous devez ajouter une étape à la fin de votre cascade qui ne fait rien ou appelle quelque chose comme session.send() qui ne va pas avancer la cascade vers l’avant.

IDisambiguateChoices

Choix d’itinéraires à passer à Prompts.disambiguate(). La clé de la carte doit être l’étiquette localisée à afficher à l’utilisateur et la valeur doit être l’itinéraire à sélectionner lorsqu’il est choisi par l’utilisateur. Vous pouvez passer null pour que l’itinéraire donne à l’utilisateur la possibilité d’annuler.

IDisambiguateRouteHandler

Logique de disambiguation de routage personnalisée passée à UniversalBot.onDisambiguateRoute().

IEntity

Entité reconnue.

IEvent

Événement reçu ou envoyé à une source.

IEventMiddleware

Signature de fonction pour un intergiciel qui raccorde les événements « receive » ou « send ».

IFact

Un fait affiché sur une carte comme un reçu .

IFindActionRouteContext

Contexte passé à ActionSet.findActionRoutes().

IFindMatchResult

Résultat retourné par un appel à EntityRecognizer.findBestMatch() ou EntityRecognizer.findAllMatches().

IFindRoutesHandler

Logique de recherche de routage personnalisée transmise à Library.onFindRoutes().

IFirstRunOptions

Options passées à Middleware.firstRun().

IIdentity

Représente un utilisateur, un bot ou une conversation.

IIntent

Une intention reconnue.

IIntentDialogOptions

Options utilisées pour configurer un IntentDialog.

IIntentRecognizer

Interface implémentée par des plug-ins de reconnaissance d’intention comme la classe LuisRecognizer.

IIntentRecognizerResult

Résultats retournés par un module de reconnaissance d’intention.

IIntentRecognizerSetOptions

Options utilisées pour configurer un IntentRecognizerSet.

IIsAttachment

Implémenté par les classes qui peuvent être converties en pièce jointe.

IIsCardAction

Implémenté par des classes qui peuvent être converties en action de carte.

IIsCardImage

Implémenté par des classes qui peuvent être converties en image de carte.

IIsCardMedia

Entités qui peuvent être converties en média pour les cartes

IIsFact

Implémenté par des classes qui peuvent être converties en fait.

IIsMessage

Implémenté par les classes qui peuvent être converties en IMessage, comme la classe de générateur Message.

IIsReceiptItem

Implémenté par les classes qui peuvent être converties en un élément de reçu.

IIsSuggestedActions

Implémenté par des classes qui peuvent être converties en actions suggérées

ILocalizer

Plug-in pour localiser les messages envoyés à l’utilisateur par un bot.

ILuisModelMap

Mappage par local de l’URL du service LUIS à utiliser pour un LuisRecognizer.

IMediaCard

Définition d’interface d’un MediaCard générique, qui sous sa forme concrète peut être une carte audio, animation ou vidéo

IMediaEventValue

Paramètre supplémentaire pour les événements multimédias.

IMessage

Message de conversation envoyé entre un utilisateur et un bot. Les messages du bot à l’utilisateur sont de deux versions :

  • messages réactifs sont des messages envoyés du bot à l’utilisateur en tant que réponse à un message entrant de l’utilisateur.
  • messages proactifs sont des messages envoyés du bot à l’utilisateur en réponse à un événement externe comme un déclenchement d’alarme.

Dans le cas réactif, vous devez copier l’adresse champ du message entrant vers le message sortant (si vous utilisez la classe Message générateur et l’initialisez avec la session cela se produit automatiquement), puis définissez le texte texte ou pièces jointes. Pour les messages proactifs, vous devez enregistrer l’adresse du message entrant vers un stockage externe quelque part. Vous pouvez ensuite le transmettre ultérieurement à UniversalBot.beginDialog() ou le copier dans un message sortant passé à UniversalBot.send().

La composition d’un message à l’utilisateur à l’aide de l’objet d’adresse entrant envoie par défaut une réponse à l’utilisateur dans le contexte de la conversation actuelle. Certains canaux permettent le démarrage de nouvelles conversations avec l’utilisateur. Pour démarrer une nouvelle conversation proactive avec l’utilisateur, supprimez simplement le champ conversation de l’objet d’adresse avant de composer le message sortant.

IMessageOptions

Propriétés de message facultatives qui peuvent être envoyées à des éléments tels que des invites ou session.say().

IMessageReaction

Objet de réaction de message.

IMessageUpdate

Les propriétés d’un message ont changé.

IMiddlewareMap

Carte des crochets d’intergiciels qui peuvent être inscrits dans un appel à UniversalBot.use().

IOAuthCard

Interface représentant OAuthCard. Carte représentant une demande de création d’une connexion via OAuth

IPagedMembersResult

Objet result retourné par ChatConnector.getConversationPagedMembers().

IPromptArgs

DÉCONSEILLÉe le nouveau système d’invite utilise simplement IPromptOptions.

IPromptAttachmentFeatures

Fonctionnalités facultatives pour classe PromptAttachment.

IPromptAttachmentOptions

Options passées à prompts.attachment() ou dans un appel session.beginDialog() à une invite personnalisée en fonction de la classe PromptAttachment.

IPromptAttachmentResult

Résultat de l’invite de pièces jointes fortement typées.

IPromptChoiceFeatures

Fonctionnalités facultatives pour classe PromptChoice.

IPromptChoiceOptions

Options passées à Prompts.choice() ou dans un appel session.beginDialog() à une invite personnalisée basée sur la classe PromptChoice.

IPromptChoiceResult

Résultat de l’invite de choix fortement typé.

IPromptConfirmResult

Résultat de l’invite de confirmation fortement typé.

IPromptContext

Informations contextuelles suivies pour une invite de . Ces informations sont accessibles dans une invite via session.dialogData.

IPromptFeatures

Fonctionnalités facultatives qui doivent être activées/désactivées lors de la création d’une invite de personnalisée

IPromptNumberOptions

Options passées à prompts.number() ou dans un appel session.beginDialog() à une invite personnalisée basée sur la classe PromptNumber.

IPromptNumberResult

Résultat de l’invite de nombre fortement typé.

IPromptOptions

Options passées aux invites intégrées .

IPromptRecognizeChoicesOptions

Options passées à PromptRecognizers.recognizeChoices().

IPromptRecognizeNumbersOptions

Options passées à PromptRecognizers.recognizeNumbers().

IPromptRecognizeTimesOptions

Options passées à PromptRecognizers.recognizeTimes().

IPromptRecognizeValuesOptions

Options passées à PromptRecognizers.recognizeValues().

IPromptRecognizer

DÉCONSEILLÉ plus pris en charge à partir de la version 3.8. Utilisez plutôt des invites personnalisées.

IPromptRecognizerArgs

DÉCONSEILLÉ plus pris en charge à partir de la version 3.8. Utilisez plutôt des invites personnalisées.

IPromptRecognizerResult

Résultat retourné par un IPromptRecognizer.

IPromptResult

Résultat de la boîte de dialogue retourné par une invite système.

IPromptTextFeatures

Fonctionnalités facultatives pour classe PromptText.

IPromptTextOptions

Options passées à prompts.text() ou dans un appel session.beginDialog() à une invite personnalisée basée sur la classe PromptText.

IPromptTextResult

Résultat de l’invite de texte fortement typé.

IPromptTimeResult

Résultat de l’invite de temps fortement typé.

IPromptsOptions

DÉCONSEILLÉ plus pris en charge à partir de la version 3.8. Utilisez plutôt des invites personnalisées.

IReceiptCard

Affiche un reçu enrichi à un utilisateur pour quelque chose qu’il a acheté ou qu’il envisage d’acheter.

IReceiptItem

Un élément individuel dans un reçu .

IRecognizeContext

Contexte du message reçu transmis à différentes méthodes de reconnaissance.

IRecognizeDialogContext

Contexte passé à Dialog.recognize().

IRecognizeResult

Résultats d’un appel à une fonction recognize(). L’implémentation est gratuite pour ajouter toutes les propriétés supplémentaires au résultat.

IRegExpMap

Mappage par local d’expressions régulières à utiliser pour un RegExpRecognizer.

IRouteResult

Itinéraire candidat retourné par Library.findRoutes().

ISelectRouteHandler

Logique de recherche de routage personnalisée transmise à Library.onSelectRoute().

ISemanticAction

Représente une référence à une action programmatique.

ISessionMiddleware

Signature de fonction pour un élément d’intergiciel qui raccorde l’événement « botbuilder ».

ISessionOptions

Options passées au constructeur d’une session.

ISessionState

État de session persistant utilisé pour suivre une pile de dialogues de conversations.

ISigninCard

Affiche une carte de connexion et un bouton pour l’utilisateur. Certains canaux peuvent choisir de le rendre sous la forme d’une invite de texte et d’un lien pour cliquer.

ISourceEventMap

Mappage par source des données d’événement personnalisées à envoyer.

IStartConversationAddress

Propriétés supplémentaires qui peuvent être transmises avec l’adresse à UniversalBot.beginDialog().

ISuggestedActions

Actions suggérées à envoyer à l’utilisateur et affichées sous forme de réponses rapides. Les actions suggérées sont affichées uniquement sur les canaux qui prennent en charge les actions suggérées.

ITextHighlight

Interface représentant TextHighlight. Fait référence à une sous-chaîne de contenu dans un autre champ.

IThumbnailCard

Affiche une carte à l’utilisateur à l’aide d’une disposition miniature plus petite ou d’une disposition héros plus grande (les pièces jointes contentType détermine qui). Tous les champs de cartes sont facultatifs afin que cette carte puisse être utilisée pour spécifier des éléments comme un clavier sur certains canaux. Certains canaux peuvent choisir d’afficher une version de fidélité inférieure de la carte ou d’utiliser une autre représentation.

ITokenResponse

Interface représentant TokenResponse. Réponse qui inclut un jeton d’utilisateur

ITranscript

Interface représentant des activités historiques.

ITriggerActionOptions

Options passées lors de la définition d’un triggerAction().

IUniversalBotSettings

Options utilisées pour initialiser une instance UniversalBot.

IVideoCard

Définition d’interface pour une carte vidéo

IWatchableHandler

Fonction permettant de récupérer la valeur d’une variable surveillée. Passé à session.watchable().

Alias de type

AttachmentType

Certaines méthodes peuvent prendre une IAttachment sous forme JSON ou l’une des différentes classes de générateur de cartes qui implémentent IIsAttachment.

MatchType

Règles prises en charge pour la correspondance d’un énoncé d’utilisateurs.

  • {RegExp} : une expression régulière sera utilisée pour correspondre aux énoncés des utilisateurs.
  • {string} : une intention nommée retournée par un module de reconnaissance sera utilisée pour faire correspondre l’énoncé des utilisateurs.
  • {(RegExp|string)[]} : un tableau d’expressions régulières ou d’intentions nommées peut être passé pour correspondre à l’énoncé des utilisateurs de plusieurs façons possibles. La règle générant le score le plus élevé (meilleure correspondance) sera utilisée à des fins de scoring.
MessageType

Invites basées sur des messages qui peuvent être envoyées à un utilisateur.

  • {IMessage} - Message à envoyer à l’utilisateur exprimé à l’aide de JSON. Le message peut contenir des pièces jointes et des actions suggérées. Tous les canaux ne prennent pas en charge en mode natif toutes les propriétés de message, mais la plupart des canaux restituent les champs non pris en charge.
  • {IIsMessage} : instance de la classe générateur Message. Cette classe permet de localiser vos messages et fournit des assistances pour faciliter la mise en forme des parties texte de votre message.
TextOrMessageType

Plage flexible d’invites possibles qui peuvent être envoyées à un utilisateur.

  • {string} : message simple à envoyer à l’utilisateur.
  • {string[]} - Tableau de messages possibles à envoyer à l’utilisateur. Un sera choisi au hasard.
  • {IMessage} - Message à envoyer à l’utilisateur exprimé à l’aide de JSON. Le message peut contenir des pièces jointes et des actions suggérées. Tous les canaux ne prennent pas en charge en mode natif toutes les propriétés de message, mais la plupart des canaux restituent les champs non pris en charge.
  • {IIsMessage} : instance de la classe générateur Message. Cette classe permet de localiser vos messages et fournit des assistances pour faciliter la mise en forme des parties texte de votre message.
TextType

Invites textuelles qui peuvent être envoyées à un utilisateur.

  • {string} : message simple à envoyer à l’utilisateur.
  • {string[]} - Tableau de messages possibles à envoyer à l’utilisateur. Un sera choisi au hasard.
ValueListType

Liste des valeurs de texte. Les valeurs peuvent être exprimées sous la forme d’une chaîne délimitée par un canal comme « value1|value2|value3 » ou un tableau simple de valeurs.

Énumérations

ListStyle

Type de liste à afficher pour l’invite PromptType.choice.

PromptType

Type d’invite appelé.

RecognizeMode

Contrôle un IntentDialogs traitement des énoncés de texte des utilisateurs.

RecognizeOrder

Ordre dans lequel un IntentDialogs les modules de reconnaissance doivent être évalués.

ResumeReason

Codes de raison pour la reprise d’une boîte de dialogue.