AdaptiveDialog class

Paquet:

botbuilder-dialogs-adaptive

La conversation de dialogue adaptatif modélise la conversation à l’aide d’événements et d’événements pour s’adapter dynamiquement à la modification du flux de conversation.

Extends

DialogContainer<O>

Constructeurs

AdaptiveDialog(string)

Crée une instance AdaptiveDialog.

Propriétés

$kind
autoEndDialog	Indique s’il faut mettre fin à la boîte de dialogue en l’absence d’actions à exécuter.
conditionTracker
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.
generator	Optionnel. Remplacement du générateur de langage.
recognizer	Optionnel. Module de reconnaissance utilisé pour analyser tous les énoncés de message.
schema	Définit le schéma JSON de la boîte de dialogue. Obtient le schéma JSON de la boîte de dialogue.
selector	Optionnel. Sélecteur permettant de sélectionner les événements possibles à exécuter.
triggers	Déclenchez des gestionnaires pour répondre aux conditions qui modifient le plan en cours d’exécution.

Propriétés héritées

dialogs	La boîte de dialogue conteneurs est définie.
EndOfTurn	Obtient un résultat de fin de tour par défaut.
id
telemetryClient

Méthodes

beginDialog(DialogContext, O)	Appelé lorsque le dialogue est démarré et envoyé (push) sur la pile de dialogues.
continueDialog(DialogContext)	Appelé lorsque le dialogue est continu, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.
createChildContext(DialogContext)	Crée un DialogContext enfant pour le contexte donné.
endDialog(TurnContext, DialogInstance, DialogReason)	Appelé lorsque la boîte de dialogue se termine.
getConverter(Object)
getDependencies()	Obtient boîte de dialogue dépendances énumérées.
repromptDialog(DialogContext | TurnContext, DialogInstance)	Repromptise l’utilisateur.
resumeDialog(DialogContext, DialogReason, any)	Appelé lorsqu’un dialogue enfant a terminé son tour, renvoyant le contrôle à ce dialogue.

Méthodes héritées

configure(Record<string, unknown>)	Méthode Fluent pour la configuration de l’objet.
findDialog(string)	Recherche une boîte de dialogue enfant qui a été précédemment ajoutée au conteneur.
getVersion()	Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du rééploiement.
onDialogEvent(DialogContext, DialogEvent)	Appelé lorsqu’un événement a été déclenché, à l’aide de DialogContext.emitEvent(), par la boîte de dialogue active ou par une boîte de dialogue que la boîte de dialogue active a démarré.

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 à la boîte de 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écutée, la boîte de dialogue active se termine. Si la valeur est false, lorsqu’il n’y a aucune action à exécuter, la boîte de dialogue actuelle termine simplement le 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 par défaut est dialog.result.

generator

Optionnel. Remplacement du générateur de langage.

generator?: LanguageGenerator

Valeur de propriété

LanguageGenerator

recognizer

Optionnel. Module de reconnaissance utilisé pour analyser tous les énoncés de message.

recognizer?: Recognizer

Valeur de propriété

Recognizer

schema

Définit le schéma JSON de la boîte de dialogue. Obtient le schéma JSON de la boîte de dialogue.

object schema

Valeur de propriété

object

Schéma de boîte de dialogue.

selector

Optionnel. Sélecteur permettant de sélectionner les événements possibles à exécuter.

selector: TriggerSelector

Valeur de propriété

TriggerSelector

triggers

Déclenchez des gestionnaires pour répondre aux conditions qui modifient le plan en cours d’exécution.

triggers: OnCondition[]

Valeur de propriété

OnCondition[]

Détails de la propriété héritée

dialogs

La boîte de dialogue conteneurs est définie.

dialogs: DialogSet

Valeur de propriété

DialogSet

héritée 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 du tour actuel, est toujours actif et attend plus d’entrée.

héritée de Dialog.EndOfTurn

id

id: string

Valeur de propriété

string

héritée de Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Valeur de propriété

BotTelemetryClient

héritée de DialogContainer.telemetryClient

Détails de la méthode

beginDialog(DialogContext, O)

Appelé lorsque le dialogue est démarré et envoyé (push) sur la pile de dialogues.

function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult>

Paramètres

dc

DialogContext

DialogContext pour le tour de conversation actuel.

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 continu, où il s’agit du dialogue actif et que l’utilisateur répond avec une nouvelle activité.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Paramètres

dc

DialogContext

DialogContext pour le tour de conversation actuel.

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 le tour de conversation actuel.

Retours

DialogContext

L'DialogContext enfant ou null si aucun AdaptiveDialogState.actions sont trouvés pour le contexte donné.

endDialog(TurnContext, DialogInstance, DialogReason)

Appelé lorsque la boîte de 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 cette boîte de dialogue sur la pile de 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 de la configuration du sélecteur.

getDependencies()

Obtient boîte de dialogue dépendances énumérées.

function getDependencies(): Dialog[]

Retours

Dialog[]

(xref :botbuilder-dialogs. Dépendances énumérées de la boîte de dialogue.

repromptDialog(DialogContext | TurnContext, DialogInstance)

Repromptise 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 d’état actuelles pour 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, renvoyant 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

Facultatif, valeur retournée à partir de la boîte de dialogue appelée. Le type de la valeur retournée dépend de la boîte de 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ée 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 s’il est trouvé ; sinon null.

héritée de DialogContainer.findDialog

getVersion()

Chaîne encodée utilisée pour faciliter la détection des modifications de bot lors du rééploiement.

function getVersion(): string

Retours

string

Chaîne unique qui ne doit changer que lorsque la boîte de dialogue a changé de manière à redémarrer la boîte de dialogue.

Remarques

Cela permet par défaut de retourner les dialogues id, mais peut être substitué pour fournir une logique de détection des modifications plus précise. Toute boîte de dialogue sur la pile qui a sa modification de version entraîne un événement versionChanged sera déclenché. 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 tous ensemble.

héritée de Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Appelé lorsqu’un événement a été déclenché, à l’aide de DialogContext.emitEvent(), par la boîte de dialogue active ou par une boîte de dialogue que la boîte de dialogue active a démarré.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Paramètres

dc

DialogContext

Contexte de boîte de dialogue pour le tour de conversation actuel.

e

DialogEvent

Événement déclenché.

Retours

Promise<boolean>

True si l’événement est géré par la boîte de dialogue actuelle et que le bouglage doit s’arrêter.

héritée de DialogContainer.onDialogEvent