PromptNumber class

Paquet:

botbuilder

Invite de confirmation personnalisable.

Extends

Prompt<IPromptFeatures>

Constructeurs

PromptNumber(IPromptFeatures)

Crée une instance personnalisable de l’invite. Votre nouvelle invite doit être ajoutée en tant que boîte de dialogue à un bot ou une bibliothèque.

Propriétés

features

L’ensemble actuel des fonctionnalités configurées s’affiche.

Méthodes

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.
begin<T>(Session, T)	Appelé lorsqu’une nouvelle session de dialogue est démarrée.
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.
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é.
clone(ActionSet)	Retourne un clone d’un Jeu d’actions existant.
customAction(IDialogActionOptions)	Lie une action personnalisée à la boîte de dialogue qui appelle le gestionnaire transmis onSelectAction lors du déclenchement.
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.
dialogResumed<T>(Session, IDialogResult<T>)	Un dialogue enfant s’est terminé et le dialogue actuel est repris.
endConversationAction(string, TextOrMessageType, ICancelActionOptions)	Lie une action qui met fin à la conversation avec l’utilisateur lorsqu’il est déclenché.
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.
formatMessage(Session, TextType, TextType, (err: Error, msg: IMessage) => void)	Crée le message à envoyer pour l’invite. Cela est appelé automatiquement par sendPrompt(). Dans la plupart des cas, vous souhaitez inscrire un gestionnaire onFormatMessage() pour personnaliser le message envoyé pour une invite. Vous devez uniquement appeler cette méthode si vous implémentez votre propre logique de sendPrompt().
gettext(Session, TextType, string)	Retourne le texte d’une invite localisée à l’aide de l’espace de noms de l’appelant d’invites.
matches(RegExp | string, string | IDialogWaterfallStep[] | IDialogWaterfallStep, any)	Appelle un gestionnaire lorsqu’une intention donnée est détectée dans l’énoncé des utilisateurs. Pour les intentions basées sur , l’intention peut être une intention retournée par un module de reconnaissance de () inscrit pour l’invite ou il peut s’agir d’une intention qui circule à partir d’unglobal recognizer(). REMARQUE : Les détails complets de la correspondance, y compris la liste des intentions & entités détectées, sont transmis aux arguments de la première étape ou boîte de dialogue en cascade démarrée.
matchesAny(RegExp[] | string[], string | IDialogWaterfallStep[] | IDialogWaterfallStep, any)	Appelle un gestionnaire quand l’une des intentions données est détectée dans l’énoncé des utilisateurs. Pour les intentions basées sur , l’intention peut être une intention retournée par un module de reconnaissance de () inscrit pour l’invite ou il peut s’agir d’une intention qui circule à partir d’unglobal recognizer(). REMARQUE : Les détails complets de la correspondance, y compris la liste des intentions & entités détectées, sont transmis aux arguments de la première étape ou boîte de dialogue en cascade démarrée.
onFormatMessage((session: Session, text: TextType, speak: TextType, callback: (err: Error, message?: IMessage) => void) => void)	Inscrit un gestionnaire qui sera appelé pour créer le IMessage sortant qui sera envoyé pour l’invite. Ce gestionnaire est appelé uniquement lorsque l’invite/retryPrompt actuelle est de type string|string[]. Chaque fois que l’invite/retryPrompt est une IMessage|IIsMessage le message configuré est utilisé afin que votre gestionnaire ne soit pas appelé. Plusieurs gestionnaires peuvent être inscrits et le premier gestionnaire à appeler callback() avec un message sera utilisé. L’appel de callback(null, null) entraîne le traitement vers le gestionnaire suivant de la chaîne.
onPrompt((session: Session, next: Function) => void)	Inscrit un gestionnaire qui sera appelé chaque fois que l’invite est sur le point d’envoyer un message à l’utilisateur. Vous pouvez utiliser ce hook pour implémenter votre propre logique d’envoi d’invite personnalisée. Plusieurs gestionnaires peuvent être inscrits et appeler next() appelleront le gestionnaire suivant dans la chaîne. Le gestionnaire final effectue la logique par défaut des invites, qui consiste à créer un message à l’aide de formatMessage(), puis de l’envoyer.
onRecognize((context: IRecognizeDialogContext, callback: (err: Error, score: number, response?: any) => void) => void)	Inscrit un gestionnaire qui sera appelé chaque fois que l’invite reçoit une réponse de l’utilisateur. Les gestionnaires callback() peuvent être utilisés pour retourner un score de confiance qu’il a compris les entrées des utilisateurs ainsi que la valeur qui doit être retournée à l’appelant de l’invite. L’appel de callback(null, 1.0, true); indique une confiance élevée que l’utilisateur a répondu à l’invite et retournerait une boolean true comme réponse de l’invite. Tout type de réponse est possible, y compris les objets. L’appel callback(null, 0.0); indique que l’entrée des utilisateurs n’a pas été comprise du tout et qu’elles doivent être réinititions. Plusieurs gestionnaires peuvent être inscrits et contrairement aux autres types de gestionnaires, tous les gestionnaires inscrits seront appelés et le gestionnaire fournissant le score de confiance le plus élevé sera choisi comme gagnant. Lors de la personnalisation de l’un des types d’invites intégrés, vous souhaiterez souvent désactiver la logique de module de reconnaissance par défaut des invites. Pour ce faire, définissez les fonctionnalités de de l’invite lorsque vous la créez. N’oubliez pas que si vous désactivez complètement la logique de module de reconnaissance par défaut des invites, vous devez effectuer vous-même toutes les reconnaissances.
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().
recognizer(IIntentRecognizer)	Ajoute un nouveau plug-in recognizer à l’invite qui sera exécuté chaque fois que l’utilisateur répond à l’invite.
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 ».
replyReceived(Session, IRecognizeResult)	Traite les messages reçus de l’utilisateur. Appelé par le système de dialogue.
selectActionRoute(Session, IRouteResult)	Sélectionne l’itinéraire ayant le score de confiance le plus élevé pour l’énoncé.
sendPrompt(Session)	Envoie une invite à l’utilisateur pour le tour actuel. Cela peut être appelé à partir d’un gestionnaire [matches()][#matches] pour envoyer manuellement une invite/reprompt à l’utilisateur. Pour forcer l’envoi de l’invite initiale, vous devez définir session.dialogData.turns = 0; avant d’appeler sendPrompt().
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.

Détails du constructeur

PromptNumber(IPromptFeatures)

Crée une instance personnalisable de l’invite. Votre nouvelle invite doit être ajoutée en tant que boîte de dialogue à un bot ou une bibliothèque.

new PromptNumber(features?: IPromptFeatures)

Paramètres

features

IPromptFeatures

(Facultatif) fonctionnalités utilisées pour personnaliser le comportement des invites.

Détails de la propriété

features

L’ensemble actuel des fonctionnalités configurées s’affiche.

public features: IPromptFeatures

Valeur de propriété

IPromptFeatures

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

Dialog

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.

msg

TextOrMessageType

(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

Dialog

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

ActionSet

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

Library

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

IDialogResult<T>

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.

msg

TextOrMessageType

(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

Dialog

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.

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

Crée le message à envoyer pour l’invite. Cela est appelé automatiquement par sendPrompt(). Dans la plupart des cas, vous souhaitez inscrire un gestionnaire onFormatMessage() pour personnaliser le message envoyé pour une invite. Vous devez uniquement appeler cette méthode si vous implémentez votre propre logique de sendPrompt().

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

Paramètres

session

Session

Objet session pour la conversation actuelle.

text

TextType

Texte d’invite/retryPrompt actuel.

speak

TextType

Speak/retrySpeak SSML actuel. Cette valeur peut être null.

callback

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

Fonction pour recevoir le message créé.

gettext(Session, TextType, string)

Retourne le texte d’une invite localisée à l’aide de l’espace de noms de l’appelant d’invites.

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

Paramètres

session

Session

Session active pour la conversation.

text

TextType

Invite à localiser.

namespace

string

(Facultatif) espace de noms de bibliothèque à utiliser pour localiser l’invite. Par défaut, l’espace de noms de l’appelant des invites sera utilisé.

Retours

string

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

Appelle un gestionnaire lorsqu’une intention donnée est détectée dans l’énoncé des utilisateurs. Pour les intentions basées sur , l’intention peut être une intention retournée par un module de reconnaissance de () inscrit pour l’invite ou il peut s’agir d’une intention qui circule à partir d’unglobal recognizer().

REMARQUE : Les détails complets de la correspondance, y compris la liste des intentions & entités détectées, sont transmis aux arguments de la première étape ou boîte de dialogue en cascade démarrée.

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

Paramètres

intent

RegExp | string

• intention :{RegExp} : expression régulière qui sera évaluée pour détecter l’intention des utilisateurs.
• intention :{string} : intention nommée retournée par un plug-in IIntentRecognizer qui sera utilisé pour correspondre à l’intention des utilisateurs.

dialogId

string | IDialogWaterfallStep[] | IDialogWaterfallStep

• dialogId : _{string} : ID d’un dialogue à commencer lorsque l’intention est mise en correspondance.
• dialogId :{IDialogWaterfallStep[]} - Cascade d’étapes à exécuter lorsque l’intention est mise en correspondance.
• dialogId :{IDialogWaterfallStep} - Cascade à étape unique à exécuter lorsque l’intention est mise en correspondance. L’appel d’une invite intégrée ou le démarrage d’une nouvelle boîte de dialogue entraîne la fin du dialogue actuel à l’achèvement de l’invite/boîte de dialogue enfant.

dialogArgs

any

(Facultatif) arguments pour passer la boîte de dialogue qui a démarré lorsque dialogId est un {string}.

Retours

IntentDialog

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

Appelle un gestionnaire quand l’une des intentions données est détectée dans l’énoncé des utilisateurs. Pour les intentions basées sur , l’intention peut être une intention retournée par un module de reconnaissance de () inscrit pour l’invite ou il peut s’agir d’une intention qui circule à partir d’unglobal recognizer().

REMARQUE : Les détails complets de la correspondance, y compris la liste des intentions & entités détectées, sont transmis aux arguments de la première étape ou boîte de dialogue en cascade démarrée.

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

Paramètres

intent

RegExp[] | string[]

• intention :{RegExp[]} - Tableau d’expressions régulières qui seront évaluées pour détecter l’intention des utilisateurs.
• intention :{string[]} - Tableau d’intentions nommées retournées par un plug-in IIntentRecognizer qui sera utilisé pour correspondre à l’intention des utilisateurs.

dialogId

string | IDialogWaterfallStep[] | IDialogWaterfallStep

• dialogId : _{string} : ID d’un dialogue à commencer lorsque l’intention est mise en correspondance.
• dialogId :{IDialogWaterfallStep[]} - Cascade d’étapes à exécuter lorsque l’intention est mise en correspondance.
• dialogId :{IDialogWaterfallStep} - Cascade à étape unique à exécuter lorsque l’intention est mise en correspondance. L’appel d’une invite intégrée ou le démarrage d’une nouvelle boîte de dialogue entraîne la fin du dialogue actuel à l’achèvement de l’invite/boîte de dialogue enfant.

dialogArgs

any

(Facultatif) arguments pour passer la boîte de dialogue qui a démarré lorsque dialogId est un {string}.

Retours

IntentDialog

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

Inscrit un gestionnaire qui sera appelé pour créer le IMessage sortant qui sera envoyé pour l’invite. Ce gestionnaire est appelé uniquement lorsque l’invite/retryPrompt actuelle est de type string|string[]. Chaque fois que l’invite/retryPrompt est une IMessage|IIsMessage le message configuré est utilisé afin que votre gestionnaire ne soit pas appelé. Plusieurs gestionnaires peuvent être inscrits et le premier gestionnaire à appeler callback() avec un message sera utilisé. L’appel de callback(null, null) entraîne le traitement vers le gestionnaire suivant de la chaîne.

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

Paramètres

handler

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

Fonction qui sera appelée pour créer une IMessage pour l’invite actuelle. Appelez callback() avec un message ou null pour continuer le traitement.

Retours

Prompt<any>

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

Inscrit un gestionnaire qui sera appelé chaque fois que l’invite est sur le point d’envoyer un message à l’utilisateur. Vous pouvez utiliser ce hook pour implémenter votre propre logique d’envoi d’invite personnalisée. Plusieurs gestionnaires peuvent être inscrits et appeler next() appelleront le gestionnaire suivant dans la chaîne. Le gestionnaire final effectue la logique par défaut des invites, qui consiste à créer un message à l’aide de formatMessage(), puis de l’envoyer.

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

Paramètres

handler

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

Fonction appelée à tout moment sendPrompt() est appelée.

Retours

Prompt<any>

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

Inscrit un gestionnaire qui sera appelé chaque fois que l’invite reçoit une réponse de l’utilisateur. Les gestionnaires callback() peuvent être utilisés pour retourner un score de confiance qu’il a compris les entrées des utilisateurs ainsi que la valeur qui doit être retournée à l’appelant de l’invite. L’appel de callback(null, 1.0, true); indique une confiance élevée que l’utilisateur a répondu à l’invite et retournerait une boolean true comme réponse de l’invite. Tout type de réponse est possible, y compris les objets. L’appel callback(null, 0.0); indique que l’entrée des utilisateurs n’a pas été comprise du tout et qu’elles doivent être réinititions.

Plusieurs gestionnaires peuvent être inscrits et contrairement aux autres types de gestionnaires, tous les gestionnaires inscrits seront appelés et le gestionnaire fournissant le score de confiance le plus élevé sera choisi comme gagnant. Lors de la personnalisation de l’un des types d’invites intégrés, vous souhaiterez souvent désactiver la logique de module de reconnaissance par défaut des invites. Pour ce faire, définissez les fonctionnalités de de l’invite lorsque vous la créez. N’oubliez pas que si vous désactivez complètement la logique de module de reconnaissance par défaut des invites, vous devez effectuer vous-même toutes les reconnaissances.

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

Paramètres

handler

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

Fonction qui sera appelée pour reconnaître que les utilisateurs répondent à une invite.

Retours

Prompt<any>

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.

recognizer(IIntentRecognizer)

Ajoute un nouveau plug-in recognizer à l’invite qui sera exécuté chaque fois que l’utilisateur répond à l’invite.

function recognizer(plugin: IIntentRecognizer)

Paramètres

plugin

IIntentRecognizer

Module de reconnaissance à ajouter.

Retours

IntentDialog

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.

msg

TextOrMessageType

(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

Dialog

replyReceived(Session, IRecognizeResult)

Traite les messages reçus de l’utilisateur. Appelé par le système de dialogue.

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

Paramètres

session

Session

Objet session pour la conversation actuelle.

recognizeResult

IRecognizeResult

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().

sendPrompt(Session)

Envoie une invite à l’utilisateur pour le tour actuel. Cela peut être appelé à partir d’un gestionnaire [matches()][#matches] pour envoyer manuellement une invite/reprompt à l’utilisateur. Pour forcer l’envoi de l’invite initiale, vous devez définir session.dialogData.turns = 0; avant d’appeler sendPrompt().

function sendPrompt(session: Session)

Paramètres

session

Session

Objet session pour la conversation actuelle.

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.

Retours

Dialog