Dialog class
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.
- Extends
Méthodes
| add |
Appelé une fois pour chaque dialogue d’une bibliothèque pour permettre au dialogue d’ajouter son |
| begin<T>(Session, T) | Appelé lorsqu’une nouvelle session de dialogue est démarrée. |
| begin |
Lie une action au dialogue qui démarre un autre dialogue chaque fois qu’il est déclenché. La nouvelle boîte de dialogue est envoyée (push) sur la pile afin qu’elle ne termine pas automatiquement la tâche actuelle. La tâche actuelle sera poursuivie une fois la nouvelle boîte de dialogue terminée. Les invites intégrées invitent automatiquement l’utilisateur une fois que cela se produit, mais ce comportement peut être désactivé en définissant l’indicateur promptAfterAction lors de l’appel d’une invite intégrée. |
| cancel |
Lie une action au dialogue qui annule la boîte de dialogue chaque fois qu’elle est déclenchée. Lors de l’annulation, le parent des dialogues est repris avec un repris code indiquant qu’il était annulé. |
| clone(Action |
Retourne un clone d’un Jeu d’actions existant. |
| custom |
Lie une action personnalisée à la boîte de dialogue qui appelle le gestionnaire transmis onSelectAction lors du déclenchement. |
| dialog |
Appelé lorsqu’un dialogue racine est interrompu par un autre dialogue. Cela donne à la boîte de dialogue qui est interrompue une chance d’exécuter une logique personnalisée avant qu’elle ne soit supprimée de la pile. Le dialogue lui-même est responsable de l’effacement de la pile de dialogues et du démarrage de la nouvelle boîte de dialogue. |
| dialog |
Un dialogue enfant s’est terminé et le dialogue actuel est repris. |
| end |
Lie une action qui met fin à la conversation avec l’utilisateur lorsqu’il est déclenché. |
| find |
Appelé pendant le Library.findRoutes() appel de chaque boîte de dialogue de la pile pour déterminer si l’une des actions des dialogues est déclenchée par l’énoncé des utilisateurs. |
| recognize(IRecognize |
Analyse l’énoncé des utilisateurs et attribue un score compris entre 0,0 et 1,0 indiquant comment la boîte de dialogue est confiante qu’elle comprend l’énoncé des utilisateurs. Cette méthode est toujours appelée pour la boîte de dialogue active sur la pile. Un score de 1,0 indique une correspondance parfaite et met fin à toute autre reconnaissance. Lorsque le score est inférieur à 1,0, chaque boîte de dialogue de la pile aura sa méthode recognizeAction() appelée ainsi pour voir s’il existe des actions nommées liées au dialogue qui correspondent mieux à l’énoncé des utilisateurs. Les actions globales inscrites au niveau du bot seront également évaluées. Si la boîte de dialogue a un score supérieur, toutes les actions liées, les dialogues méthode replyReceived() sont appelées avec l’objet de résultat retourné par l’appel recognize(). Cela permet au dialogue de transmettre des données supplémentaires collectées pendant la phase de reconnaissance à la méthode replyReceived() pour la gestion. S’il existe une action avec un score plus élevé, la boîte de dialogue que l’action est appelée au lieu de la méthode replyReceived(). La boîte de dialogue reste sur la pile et peut être reprise à un moment donné si l’action appelle un nouveau dialogue afin que les dialogues puissent se préparer à des appels inattendus à dialogResumed(). |
| reload |
Lie une action au dialogue qui entraîne le rechargement de la boîte de dialogue à chaque fois qu’il est déclenché. Cela est utile pour implémenter une logique qui gère les énoncés utilisateur tels que « recommencer ». |
| reply |
Appelé lorsqu’un nouveau message de réponse a été reçu d’un utilisateur. Les classes dérivées doivent implémenter cette opération pour traiter le message reçu de l’utilisateur. |
| select |
Sélectionne l’itinéraire ayant le score de confiance le plus élevé pour l’énoncé. |
| trigger |
Lie une action au dialogue qui le rendra actif chaque fois qu’il est déclenché. Le comportement par défaut consiste à interupter n’importe quel dialogue existant en désactivant la pile et en démarrant le dialogue à la racine de la pile. La boîte de dialogue en cours d’interruption peut intercepter cette interruption en ajoutant une personnalisée sur le gestionnaire de interrompus à leurs options d’action de déclencheur. En outre, vous pouvez personnaliser la façon dont la boîte de dialogue déclenchée est démarrée en fournissant un gestionnaire de personnalisé surSelectAction à vos options d’action de déclencheur. |
Détails de la méthode
addDialogTrigger(ActionSet, string)
Appelé une fois pour chaque dialogue d’une bibliothèque pour permettre au dialogue d’ajouter son triggerAction() au jeu d’actions global des bibliothèques. Ces déclencheurs sont mappés à une beginDialogAction() qui démarre la boîte de dialogue lorsque la condition de déclencheur est remplie.
function addDialogTrigger(actions: ActionSet, dialogId: string)Paramètres
- actions
- ActionSet
Ensemble d’actions globales de bibliothèques.
- dialogId
-
string
ID complet de la boîte de dialogue à déclencher.
begin<T>(Session, T)
Appelé lorsqu’une nouvelle session de dialogue est démarrée.
function begin<T>(session: Session, args?: T)Paramètres
- session
- Session
Objet session pour la conversation actuelle.
- args
-
T
(Facultatif) arguments passés à la boîte de dialogue par son parent.
beginDialogAction(string, string, IBeginDialogActionOptions)
Lie une action au dialogue qui démarre un autre dialogue chaque fois qu’il est déclenché. La nouvelle boîte de dialogue est envoyée (push) sur la pile afin qu’elle ne termine pas automatiquement la tâche actuelle. La tâche actuelle sera poursuivie une fois la nouvelle boîte de dialogue terminée. Les invites intégrées invitent automatiquement l’utilisateur une fois que cela se produit, mais ce comportement peut être désactivé en définissant l’indicateur promptAfterAction lors de l’appel d’une invite intégrée.
function beginDialogAction(name: string, id: string, options?: IBeginDialogActionOptions)Paramètres
- name
-
string
Nom unique à affecter l’action.
- id
-
string
ID de la boîte de dialogue à démarrer.
- options
- IBeginDialogActionOptions
(Facultatif) options utilisées pour configurer l’action. Si correspond à est spécifié, l’action écoute l’utilisateur pour dire un mot ou une expression qui déclenche l’action, sinon l’action doit être liée à un bouton à l’aide de CardAction.dialogAction() pour déclencher l’action. Vous pouvez également utiliser dialogArgs pour transmettre des paramètres supplémentaires au dialogue démarré.
Retours
cancelAction(string, TextOrMessageType, ICancelActionOptions)
Lie une action au dialogue qui annule la boîte de dialogue chaque fois qu’elle est déclenchée. Lors de l’annulation, le parent des dialogues est repris avec un repris code indiquant qu’il était annulé.
function cancelAction(name: string, msg?: TextOrMessageType, options?: ICancelActionOptions)Paramètres
- name
-
string
Nom unique à affecter l’action.
(Facultatif) message à envoyer à l’utilisateur avant d’annuler la boîte de dialogue.
- options
- ICancelActionOptions
(Facultatif) options utilisées pour configurer l’action. Si correspond à est spécifié, l’action écoute l’utilisateur pour dire un mot ou une expression qui déclenche l’action, sinon l’action doit être liée à un bouton à l’aide de CardAction.dialogAction() pour déclencher l’action.
Retours
clone(ActionSet)
Retourne un clone d’un Jeu d’actions existant.
function clone(copyTo?: ActionSet)Paramètres
- copyTo
- ActionSet
(Facultatif) instance vers laquelle copier l’objet actuel. Si une nouvelle instance est manquante, elle est créée.
Retours
customAction(IDialogActionOptions)
Lie une action personnalisée à la boîte de dialogue qui appelle le gestionnaire transmis onSelectAction lors du déclenchement.
function customAction(options: IDialogActionOptions)Paramètres
- options
- IDialogActionOptions
Options utilisées pour configurer l’action. Si correspond à est spécifié, l’action écoute l’utilisateur pour dire un mot ou une expression qui déclenche l’action. Une logique de correspondance personnalisée peut être fournie à l’aide de onFindAction.
Retours
dialogInterrupted(Session, string, any)
Appelé lorsqu’un dialogue racine est interrompu par un autre dialogue. Cela donne à la boîte de dialogue qui est interrompue une chance d’exécuter une logique personnalisée avant qu’elle ne soit supprimée de la pile. Le dialogue lui-même est responsable de l’effacement de la pile de dialogues et du démarrage de la nouvelle boîte de dialogue.
function dialogInterrupted(session: Session, dialogId: string, dialogArgs: any)Paramètres
- session
- Session
Objet session pour la conversation actuelle.
- dialogId
-
string
ID de la boîte de dialogue qui doit être démarrée.
- dialogArgs
-
any
Arguments qui doivent être passés à la nouvelle boîte de dialogue.
dialogResumed<T>(Session, IDialogResult<T>)
Un dialogue enfant s’est terminé et le dialogue actuel est repris.
function dialogResumed<T>(session: Session, result: IDialogResult<T>)Paramètres
- session
- Session
Objet session pour la conversation actuelle.
- result
Résultat retourné par la boîte de dialogue enfant.
endConversationAction(string, TextOrMessageType, ICancelActionOptions)
Lie une action qui met fin à la conversation avec l’utilisateur lorsqu’il est déclenché.
function endConversationAction(name: string, msg?: TextOrMessageType, options?: ICancelActionOptions)Paramètres
- name
-
string
Nom unique à affecter l’action.
(Facultatif) message à envoyer à l’utilisateur avant de terminer la conversation.
- options
- ICancelActionOptions
(Facultatif) options utilisées pour configurer l’action. Si correspond à est spécifié, l’action écoute l’utilisateur pour dire un mot ou une expression qui déclenche l’action, sinon l’action doit être liée à un bouton à l’aide de CardAction.dialogAction() pour déclencher l’action.
Retours
findActionRoutes(IRecognizeDialogContext, (err: Error, results: IRouteResult[]) => void)
Appelé pendant le Library.findRoutes() appel de chaque boîte de dialogue de la pile pour déterminer si l’une des actions des dialogues est déclenchée par l’énoncé des utilisateurs.
function findActionRoutes(context: IRecognizeDialogContext, callback: (err: Error, results: IRouteResult[]) => void)Paramètres
- context
- IRecognizeDialogContext
Contexte du message entrant ainsi que dialogData pour la boîte de dialogue évaluée.
- callback
-
(err: Error, results: IRouteResult[]) => void
Fonction à appeler avec le ou les itinéraires candidats principaux.
recognize(IRecognizeDialogContext, (err: Error, result: IRecognizeResult) => void)
Analyse l’énoncé des utilisateurs et attribue un score compris entre 0,0 et 1,0 indiquant comment la boîte de dialogue est confiante qu’elle comprend l’énoncé des utilisateurs. Cette méthode est toujours appelée pour la boîte de dialogue active sur la pile. Un score de 1,0 indique une correspondance parfaite et met fin à toute autre reconnaissance. Lorsque le score est inférieur à 1,0, chaque boîte de dialogue de la pile aura sa méthode recognizeAction() appelée ainsi pour voir s’il existe des actions nommées liées au dialogue qui correspondent mieux à l’énoncé des utilisateurs. Les actions globales inscrites au niveau du bot seront également évaluées. Si la boîte de dialogue a un score supérieur, toutes les actions liées, les dialogues méthode replyReceived() sont appelées avec l’objet de résultat retourné par l’appel recognize(). Cela permet au dialogue de transmettre des données supplémentaires collectées pendant la phase de reconnaissance à la méthode replyReceived() pour la gestion.
S’il existe une action avec un score plus élevé, la boîte de dialogue que l’action est appelée au lieu de la méthode replyReceived(). La boîte de dialogue reste sur la pile et peut être reprise à un moment donné si l’action appelle un nouveau dialogue afin que les dialogues puissent se préparer à des appels inattendus à dialogResumed().
function recognize(context: IRecognizeDialogContext, callback: (err: Error, result: IRecognizeResult) => void)Paramètres
- context
- IRecognizeDialogContext
Contexte de la requête.
- callback
-
(err: Error, result: IRecognizeResult) => void
Fonction à appeler avec les résultats de la reconnaissance.
reloadAction(string, TextOrMessageType, IBeginDialogActionOptions)
Lie une action au dialogue qui entraîne le rechargement de la boîte de dialogue à chaque fois qu’il est déclenché. Cela est utile pour implémenter une logique qui gère les énoncés utilisateur tels que « recommencer ».
function reloadAction(name: string, msg?: TextOrMessageType, options?: IBeginDialogActionOptions)Paramètres
- name
-
string
Nom unique à affecter l’action.
(Facultatif) message à envoyer à l’utilisateur avant de recharger la boîte de dialogue.
- options
- IBeginDialogActionOptions
(Facultatif) options utilisées pour configurer l’action. Si correspond à est spécifié, l’action écoute l’utilisateur pour dire un mot ou une expression qui déclenche l’action, sinon l’action doit être liée à un bouton à l’aide de CardAction.dialogAction() pour déclencher l’action. Vous pouvez également utiliser dialogArgs pour passer des paramètres supplémentaires au dialogue lors du rechargement.
Retours
replyReceived(Session, IRecognizeResult)
Appelé lorsqu’un nouveau message de réponse a été reçu d’un utilisateur. Les classes dérivées doivent implémenter cette opération pour traiter le message reçu de l’utilisateur.
function replyReceived(session: Session, recognizeResult: IRecognizeResult)Paramètres
- session
- Session
Objet session pour la conversation actuelle.
- recognizeResult
- IRecognizeResult
Résultats retournés à partir d’un appel antérieur aux dialogues méthode recognize().
selectActionRoute(Session, IRouteResult)
Sélectionne l’itinéraire ayant le score de confiance le plus élevé pour l’énoncé.
function selectActionRoute(session: Session, route: IRouteResult)Paramètres
- session
- Session
Objet session pour la conversation actuelle.
- route
- IRouteResult
Résultats retournés à partir de l’appel à findActionRoutes().
triggerAction(ITriggerActionOptions)
Lie une action au dialogue qui le rendra actif chaque fois qu’il est déclenché. Le comportement par défaut consiste à interupter n’importe quel dialogue existant en désactivant la pile et en démarrant le dialogue à la racine de la pile. La boîte de dialogue en cours d’interruption peut intercepter cette interruption en ajoutant une personnalisée sur le gestionnaire de interrompus à leurs options d’action de déclencheur. En outre, vous pouvez personnaliser la façon dont la boîte de dialogue déclenchée est démarrée en fournissant un gestionnaire de personnalisé surSelectAction à vos options d’action de déclencheur.
function triggerAction(options: ITriggerActionOptions)Paramètres
- options
- ITriggerActionOptions
Options utilisées pour configurer l’action.