AdaptiveDialog class
La boîte de dialogue adaptative modélise la conversation à l’aide d’événements et d’événements pour s’adapter dynamiquement à l’évolution du flux de conversation.
- Extends
-
DialogContainer<O>
Constructeurs
Adaptive |
Crée une instance |
Propriétés
$kind | |
auto |
Indique s’il faut mettre fin au dialogue en l’absence d’actions à exécuter. |
condition |
|
default |
Propriété à retourner comme résultat lorsque la boîte de dialogue se termine lorsqu’il n’y a plus d’actions et |
generator | facultatif. Remplacement du générateur de langage. |
recognizer | facultatif. Module de reconnaissance utilisé pour analyser les énoncés de message. |
schema | Définit le schéma JSON pour la boîte de dialogue. Obtient le schéma JSON pour la boîte de dialogue. |
selector | facultatif. Sélecteur permettant de sélectionner les événements possibles à exécuter. |
triggers | Déclencher des gestionnaires pour répondre aux conditions qui modifient le plan d’exécution. |
Propriétés héritées
dialogs | Ensemble de boîtes de dialogue conteneurs. |
End |
Obtient un résultat de fin de tour par défaut. |
id | |
telemetry |
Méthodes
begin |
Appelé lorsque le dialogue est démarré et poussé vers la pile des dialogues. |
continue |
Appelé lorsque le dialogue est poursuivi, où il s’agit du dialogue actif et où l’utilisateur répond avec une nouvelle activité. |
create |
Crée un DialogContext enfant pour le contexte donné. |
end |
Appelé lorsque le dialogue se termine. |
get |
|
get |
Obtient les dépendances énumérées par la boîte de dialogue . |
reprompt |
Réexécte l’utilisateur. |
resume |
Appelé lorsqu’un dialogue enfant a terminé son tour, en retournant le contrôle à ce dialogue. |
Méthodes héritées
configure(Record<string, unknown>) | Méthode Fluent pour la configuration de l’objet. |
find |
Recherche une boîte de dialogue enfant qui a été précédemment ajoutée au conteneur. |
get |
Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du redéploiement. |
on |
Appelé lorsqu’un événement a été déclenché, à l’aide |
Détails du constructeur
AdaptiveDialog(string)
Crée une instance AdaptiveDialog
.
new AdaptiveDialog(dialogId?: string)
Paramètres
- dialogId
-
string
(Facultatif) ID unique du composant dans son jeu de dialogue parents.
Détails de la propriété
$kind
static $kind: string
Valeur de propriété
string
autoEndDialog
Indique s’il faut mettre fin au dialogue en l’absence d’actions à exécuter.
autoEndDialog: BoolExpression
Valeur de propriété
BoolExpression
Remarques
Si la valeur est true, lorsqu’aucune action n’est à exécuter, la boîte de dialogue actuelle se termine. Si la valeur est false, lorsqu’aucune action n’est à exécuter, la boîte de dialogue actuelle met simplement fin au tour et reste active. La valeur par défaut est true.
conditionTracker
static conditionTracker: string
Valeur de propriété
string
defaultResultProperty
Propriété à retourner comme résultat lorsque la boîte de dialogue se termine lorsqu’il n’y a plus d’actions et AutoEndDialog = true
.
defaultResultProperty: string
Valeur de propriété
string
Remarques
La valeur dialog.result
par défaut est .
generator
facultatif. Remplacement du générateur de langage.
generator?: LanguageGenerator
Valeur de propriété
recognizer
facultatif. Module de reconnaissance utilisé pour analyser les énoncés de message.
recognizer?: Recognizer
Valeur de propriété
Recognizer
schema
Définit le schéma JSON pour la boîte de dialogue. Obtient le schéma JSON pour la boîte de dialogue.
object schema
Valeur de propriété
object
Schéma de boîte de dialogue.
selector
facultatif. Sélecteur permettant de sélectionner les événements possibles à exécuter.
selector: TriggerSelector
Valeur de propriété
triggers
Déclencher des gestionnaires pour répondre aux conditions qui modifient le plan d’exécution.
triggers: OnCondition[]
Valeur de propriété
Détails de la propriété héritée
dialogs
Ensemble de boîtes de dialogue conteneurs.
dialogs: DialogSet
Valeur de propriété
DialogSet
Hérité de DialogContainer.dialogs
EndOfTurn
Obtient un résultat de fin de tour par défaut.
static EndOfTurn: DialogTurnResult
Valeur de propriété
DialogTurnResult
Remarques
Ce résultat indique qu’un dialogue (ou une étape logique dans un dialogue) a terminé le traitement pour le tour actuel, est toujours actif et attend plus d’entrée.
Hérité de Dialog.EndOfTurn
id
id: string
Valeur de propriété
string
Hérité de Dialog.id
telemetryClient
telemetryClient: BotTelemetryClient
Valeur de propriété
BotTelemetryClient
Hérité de DialogContainer.telemetryClient
Détails de la méthode
beginDialog(DialogContext, O)
Appelé lorsque le dialogue est démarré et poussé vers la pile des dialogues.
function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult>
Paramètres
- dc
-
DialogContext
DialogContext pour la tournure actuelle de la conversation.
- options
-
O
Informations initiales facultatives à transmettre à la boîte de dialogue.
Retours
Promise<DialogTurnResult>
Promesse représentant l’opération asynchrone.
continueDialog(DialogContext)
Appelé lorsque le dialogue est poursuivi, où il s’agit du dialogue actif et où l’utilisateur répond avec une nouvelle activité.
function continueDialog(dc: DialogContext): Promise<DialogTurnResult>
Paramètres
- dc
-
DialogContext
DialogContext pour la tournure actuelle de la conversation.
Retours
Promise<DialogTurnResult>
Promesse représentant l’opération asynchrone.
createChildContext(DialogContext)
Crée un DialogContext enfant pour le contexte donné.
function createChildContext(dc: DialogContext): DialogContext
Paramètres
- dc
-
DialogContext
DialogContext pour la tournure actuelle de la conversation.
Retours
DialogContext
DialogContext enfant ou null si aucun adaptiveDialogState.actions n’est trouvé pour le contexte donné.
endDialog(TurnContext, DialogInstance, DialogReason)
Appelé lorsque le dialogue se termine.
function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>
Paramètres
- turnContext
-
TurnContext
Objet de contexte pour ce tour.
- instance
-
DialogInstance
Informations d’état associées à l’instance de ce dialogue sur la pile des dialogues.
- reason
-
DialogReason
Raison pour laquelle le dialogue s’est terminé.
Retours
Promise<void>
Promesse représentant l’opération asynchrone.
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactory
Paramètres
- property
-
Object
Clé de la configuration du sélecteur conditionnel.
Retours
Converter | ConverterFactory
Convertisseur pour la configuration du sélecteur.
getDependencies()
Obtient les dépendances énumérées par la boîte de dialogue .
function getDependencies(): Dialog[]
Retours
Dialog[]
(xref:botbuilder-dialogs. Dépendances énumérées de la boîte de dialogue.
repromptDialog(DialogContext | TurnContext, DialogInstance)
Réexécte l’utilisateur.
function repromptDialog(context: DialogContext | TurnContext, instance: DialogInstance): Promise<void>
Paramètres
- context
-
DialogContext | TurnContext
Objet de contexte pour le tour.
- instance
-
DialogInstance
Informations sur l’état actuel de cette boîte de dialogue.
Retours
Promise<void>
Promesse représentant l’opération asynchrone.
resumeDialog(DialogContext, DialogReason, any)
Appelé lorsqu’un dialogue enfant a terminé son tour, en retournant le contrôle à ce dialogue.
function resumeDialog(dc: DialogContext, _reason?: DialogReason, _result?: any): Promise<DialogTurnResult>
Paramètres
- dc
-
DialogContext
Contexte de boîte de dialogue pour le tour actuel de la conversation.
- _reason
-
DialogReason
Raison pour laquelle le dialogue a repris.
- _result
-
any
Valeur facultative retournée par la boîte de dialogue appelée. Le type de la valeur retournée dépend du dialogue enfant.
Retours
Promise<DialogTurnResult>
Promesse représentant l’opération asynchrone.
Détails de la méthode héritée
configure(Record<string, unknown>)
Méthode Fluent pour la configuration de l’objet.
function configure(config: Record<string, unknown>): this
Paramètres
- config
-
Record<string, unknown>
Paramètres de configuration à appliquer.
Retours
this
Configurable une fois l’opération terminée.
Hérité de Configurable.configure
findDialog(string)
Recherche une boîte de dialogue enfant qui a été précédemment ajoutée au conteneur.
function findDialog(dialogId: string): Dialog | undefined
Paramètres
- dialogId
-
string
ID de la boîte de dialogue à rechercher.
Retours
Dialog | undefined
Boîte de dialogue si elle est trouvée ; sinon, null.
Hérité de DialogContainer.findDialog
getVersion()
Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du redéploiement.
function getVersion(): string
Retours
string
Chaîne unique qui ne doit changer que lorsque le dialogue a changé d’une manière qui doit redémarrer le dialogue.
Remarques
Par défaut, cela renvoie l’ID des boîtes de dialogue, mais peut être remplacé pour fournir une logique de détection des modifications plus précise. Toute boîte de dialogue sur la pile dont la version est modifiée entraîne le déclenché d’un versionChanged
événement. Si cet événement n’est pas géré par le bot, une erreur est générée, ce qui entraîne l’exécution de la logique du gestionnaire d’erreurs des bots.
Le renvoi d’une chaîne vide désactive le suivi des versions pour le composant.
Hérité de Dialog.getVersion
onDialogEvent(DialogContext, DialogEvent)
Appelé lorsqu’un événement a été déclenché, à l’aide DialogContext.emitEvent()
de , par le dialogue actuel ou par un dialogue que le dialogue actuel a démarré.
function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>
Paramètres
- dc
-
DialogContext
Contexte de boîte de dialogue pour la tour actuelle de la conversation.
- e
-
DialogEvent
Événement déclenché.
Retours
Promise<boolean>
Cette propriété a la valeur True si l’événement est géré par la boîte de dialogue actuelle et que le bouillonnement doit s’arrêter.
Hérité de DialogContainer.onDialogEvent