botbuilder-dialogs package

Référence

Classes

ChoiceFactory	Ensemble de fonctions utilitaires pour faciliter la mise en forme d’une activité « message » contenant une liste de choix.
ComponentDialog	Classe de base pour un dialogue qui contient d’autres dialogues enfants.
Configurable	Classe de base pour toutes les classes configurables.
Dialog	Définit le comportement principal de toutes les boîtes de dialogue.
DialogContainer	Conteneur pour un ensemble de boîtes de dialogue.
DialogContext	Contexte du tour de dialogue actuel par rapport à un DialogSet spécifique.
DialogContextError	Erreur qui inclut un contexte de dialogue supplémentaire, y compris la pile de dialogues.
DialogEvents	Représente les événements liés au « cycle de vie » de la boîte de dialogue.
DialogManager	Classe qui exécute le système de dialogue.
DialogSet	Ensemble de boîtes de dialogue associées qui peuvent toutes s’appeler les unes les autres.
DialogTurnStateConstants	Définit les constantes d’état de tour de dialogue.
DialogsBotComponent	Composant bot pour les boîtes de dialogue de bot.
DialogsComponentRegistration	Rend le composant de boîtes de dialogue disponible pour la fonctionnalité d’inscription du système.
DialogPath	Définit le chemin d’accès pour les boîtes de dialogue disponibles.
DialogStateManager	DialogStateManager gère les étendues de mémoire et les résolveurs de chemins d’accès.
AliasPathResolver	Mappages aliasXXX :> path.xxx ($foo => dialog.foo).
AtAtPathResolver	Mappages @@ => tableau turn.recognized.entitites.xxx.
AtPathResolver	Cartes @@ => turn.recognized.entitites.xxx[0]
DollarPathResolver	Cartes $xxx => dialog.xxx
HashPathResolver	Cartes #xxx => turn.recognized.intents.xxx
PercentPathResolver	Maps %xxx => class.xxx (alias activeDialog.properties.xxx)
ScopePath	Définit les chemins d’accès pour les étendues disponibles.
BotStateMemoryScope	Classe de base pour les étendues de mémoire basées sur BotState.
ClassMemoryScope	ClassMemoryScope mappe « class » -> dc.activeDialog.properties
ConversationMemoryScope	Mémoire limitée à la conversation actuelle.
DialogClassMemoryScope	DialogClassMemoryScope mappe « dialogClass » -> dc.parent.activeDialog.properties
DialogContextMemoryScope	`DialogContextMemoryScope` map 'dialogcontext' -> propriétés.
DialogMemoryScope	DialogMemoryScope mappe « dialog » -> dc.parent.activeDialog.state \|\| dc.activeDialog.state
MemoryScope	Classe de base abstraite pour toutes les étendues de mémoire.
SettingsMemoryScope	SettingsMemoryScope mappe « settings » -> dc.context.turnState['settings']
ThisMemoryScope	ThisMemoryScope mappe « this » -> dc.activeDialog.state
TurnMemoryScope	TurnMemoryScope représente la mémoire limitée au tour actuel.
UserMemoryScope	Mémoire limitée à l’utilisateur actuel.
ThisPath	Définit le chemin d’accès passé au dialogue actif.
TurnPath	Définit le chemin d’accès pour les tours avaiables.
ActivityPrompt	Attend qu’une activité soit reçue.
AttachmentPrompt	Invite un utilisateur à charger des pièces jointes telles que des images.
ChoicePrompt	Invite un utilisateur à faire son choix dans une liste de choix.
ConfirmPrompt	Invite un utilisateur à confirmer quelque chose avec une réponse « oui » ou « non ».
DateTimePrompt	Invite un utilisateur à entrer une expression datetime.
NumberPrompt	Invite un utilisateur à entrer un nombre.
OAuthPrompt	Crée une invite qui demande à l’utilisateur de se connecter à l’aide du service d’authentification unique (SSO) Bot Frameworks.
Prompt	Classe de base pour toutes les invites.
PromptCultureModels	Conteneur de classes pour les modèles de culture actuellement pris en charge dans l’invite de confirmation et de choix.
TextPrompt	Invite un utilisateur à entrer du texte.
Recognizer	Classe de base recognizer.
SkillDialog	Boîte de dialogue spécialisée qui peut encapsuler des appels distants à une compétence.
WaterfallDialog	Une cascade est une boîte de dialogue optimisée pour inviter un utilisateur à répondre à une série de questions.
WaterfallStepContext	Objet de contexte passé à un `WaterfallStep`.

Interfaces

BeginSkillDialogOptions	Classe avec des arguments de dialogue pour un SkillDialog.
ChoiceFactoryOptions	Options supplémentaires utilisées pour modifier la mise en forme des listes de choix.
Choice	Instance d’un choix qui peut être utilisée pour restituer un choix à un utilisateur ou pour reconnaître un élément choisi par l’utilisateur.
FindChoicesOptions	Options permettant de contrôler la reconnaissance effectuée par `findChoices()`.
FoundChoice	Résultat retourné par `findChoices()`.
FindValuesOptions	Options de recherche de base utilisées pour contrôler la façon dont les choix sont reconnus dans un énoncé utilisateur.
FoundValue	INTERNE : résultat de recherche brut retourné par `findValues()`.
SortedValue	INTERNE : valeur qui peut être triée et qui fait toujours référence à sa position d’origine dans un tableau source. La `findChoices()` fonction étend les choix passés à des instances individuelles `SortedValue` et les transmet à `findValues()`. Chaque individu `Choice` peut entraîner plusieurs synonymes qui doivent être recherchés, de sorte que cette structure de données nous permet de passer chaque synonyme comme valeur à rechercher tout en conservant l’index de choix dont la valeur provient.
ModelResult	Résultat externe retourné par un module de reconnaissance d’entité comme `recognizeChoices()`.
Token	Jeton individuel retourné par un `TokenizerFunction`.
Converter	Le convertisseur convertit l’objet d’un type à un autre.
DialogConfiguration
DialogEvent
DialogInstance	Contient des informations d’état pour une instance d’une boîte de dialogue sur la pile.
DialogTurnResult	Représente le résultat de la tentative d’un contexte de dialogue de commencer, de continuer ou de manipuler un ou plusieurs dialogues.
DialogState	Contient l’état du dialogue, des informations sur l’état de la pile de dialogues, pour un DialogSet spécifique.
DialogManagerConfiguration
DialogManagerResult
DialogDependencies
ComponentMemoryScopes	Interface pour énumérer les étendues de mémoire.
ComponentPathResolvers	Interface permettant de déclarer des résolveurs de chemins d’accès.
DialogStateManagerConfiguration
PathResolver	Copyright (c) Microsoft Corporation. Tous droits réservés. Concédé sous licence MIT.
ChoiceDefaultsChoicePrompt
ChoiceDefaultsConfirmPrompt
DateTimeResolution	Résultat retourné par .`DateTimePrompt`
OAuthPromptSettings	Paramètres utilisés pour configurer une `OAuthPrompt` instance.
PromptOptions	Options de configuration de base prises en charge par toutes les invites.
PromptRecognizerResult	Résultat retourné par une fonction de reconnaissance d’invite.
PromptValidatorContext	Informations contextuelles transmises à un personnalisé `PromptValidator`.
PromptCultureModel
RecognizerConfiguration
SkillDialogOptions
TemplateInterface	Définit l’interface de modèle pour lier des données à T.
WaterfallStepInfo	Valeurs passées au `WaterfallStepContext` constructeur.

Alias de type

TokenizerFunction	Signature d’un analyseur lexical de remplacement qui peut être passé à `recognizeChoices()`, `findChoices()`ou `findValues()`. `type TokenizerFunction = (text: string, locale?: string) => Token[];`
ConverterFactory
PromptValidator	Signature de fonction pour fournir un validateur d’invite personnalisé. `type PromptValidator<T> = (prompt: PromptValidatorContext<T>) => Promise<boolean>;`
WaterfallStep	Signature de fonction d’une étape en cascade individuelle. `type WaterfallStep<O extends object = {}> = (step: WaterfallStepContext<O>) => Promise<DialogTurnResult>;`

Énumérations

DialogReason

Indique pourquoi une méthode de dialogue est appelée.

DialogTurnStatus

Représente l’état de la pile de dialogues après qu’un contexte de dialogue tente de commencer, de continuer ou de manipuler un ou plusieurs dialogues. Voir aussi

ListStyle

Contrôle la façon dont les choix pour une ChoicePrompt option ou oui/non pour un ConfirmPrompt sont présentés à un utilisateur.

Fonctions

findChoices(string, string \| Choice[], FindChoicesOptions)	Fonction de recherche de niveau intermédiaire pour reconnaître un choix dans un énoncé.
findValues(string, SortedValue[], FindValuesOptions)	INTERNE : fonction de bas niveau qui recherche un ensemble de valeurs dans un énoncé. Les fonctions de niveau supérieur comme `findChoices()` et `recognizeChoices()` sont superposées au-dessus de cette fonction. Dans la plupart des cas, il est plus facile d’appeler simplement l’une des fonctions de niveau supérieur à la place, mais cette fonction contient l’algorithme de recherche approximative qui pilote la reconnaissance des choix.
recognizeChoices(string, string \| Choice[], FindChoicesOptions)	Fonction de haut niveau pour reconnaître un choix dans un énoncé utilisateur.
defaultTokenizer(string, string)	Générateur de jetons simple qui s’interrompt sur les espaces et la ponctuation.
getActiveDialogContext(DialogContext)	Parcourez de manière récursive la pile du contrôleur de domaine pour trouver le contrôleur de domaine actif.
internalRun(TurnContext, string, DialogContext, DialogStateManagerConfiguration)
isFromParentToSkill(TurnContext)	Détermine si la compétence agit en tant que parent de compétence.
runDialog(Dialog, TurnContext, StatePropertyAccessor<DialogState>)	Exécute un dialogue à partir d’un contexte et d’un accesseur donnés.
shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)	Assistance pour déterminer si nous devons envoyer un EoC au parent ou non.
isComponentMemoryScopes(unknown)	Vérifiez si un ComponentRegistration est ComponentMemoryScopes ou non.
isComponentPathResolvers(unknown)	Vérifiez si un ComponentRegistration est ComponentPathResolvers ou non.
createConnectorClient(TurnContext, string, ClaimsIdentity, string)
exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)
getSignInResource(TurnContext, OAuthPromptSettings)
getUserToken(TurnContext, OAuthPromptSettings, string)
signOutUser(TurnContext, OAuthPromptSettings)

Informations relatives à la fonction

findChoices(string, string | Choice[], FindChoicesOptions)

Fonction de recherche de niveau intermédiaire pour reconnaître un choix dans un énoncé.

function findChoices(utterance: string, choices: string | Choice[], options?: FindChoicesOptions): ModelResult<FoundChoice>[]

Paramètres

utterance: string

Texte ou énoncé utilisateur à rechercher. Pour une activité « message » entrante, vous pouvez simplement utiliser context.activity.text.

choices: string | Choice[]

Liste des choix à rechercher.

options: FindChoicesOptions

(Facultatif) options utilisées pour ajuster la recherche effectuée.

Retours

ModelResult<FoundChoice>[]

Liste des choix trouvés, triés en premier par les plus pertinents.

Remarques

Cette fonction est superposée au-dessus findValues() et détermine simplement tous les synonymes à rechercher avant d’appeler findValues() pour effectuer la recherche réelle. La recognizeChoices() fonction est superposée au-dessus de cette fonction et ajoute la possibilité de sélectionner un choix par index ou position ordinale dans la liste. L’appel de cette fonction particulière est utile lorsque vous ne souhaitez pas que l’index et la reconnaissance de position ordinale soient effectués par recognizeChoices().

const { findChoices } = require('botbuilder-choices');

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = findChoices(utterance, choices);
if (results.length == 1) {
    await context.sendActivity(`I like ${results[0].resolution.value} too!`);
} else if (results.length > 1) {
    const ambiguous = results.map((r) => r.resolution.value);
    await context.sendActivity(ChoiceFactory.forChannel(context, ambiguous, `Which one?`));
} else {
    await context.sendActivity(ChoiceFactory.forChannel(context, choices, `I didn't get that... Which color?`));
}

findValues(string, SortedValue[], FindValuesOptions)

INTERNE : fonction de bas niveau qui recherche un ensemble de valeurs dans un énoncé. Les fonctions de niveau supérieur comme findChoices() et recognizeChoices() sont superposées au-dessus de cette fonction. Dans la plupart des cas, il est plus facile d’appeler simplement l’une des fonctions de niveau supérieur à la place, mais cette fonction contient l’algorithme de recherche approximative qui pilote la reconnaissance des choix.

function findValues(utterance: string, values: SortedValue[], options?: FindValuesOptions): ModelResult<FoundValue>[]

Paramètres

utterance: string

Texte ou énoncé utilisateur à rechercher.

values: SortedValue[]

Liste des valeurs à rechercher.

options: FindValuesOptions

(Facultatif) options utilisées pour ajuster la recherche effectuée.

Retours

ModelResult<FoundValue>[]

Liste des valeurs trouvées.

recognizeChoices(string, string | Choice[], FindChoicesOptions)

Fonction de haut niveau pour reconnaître un choix dans un énoncé utilisateur.

function recognizeChoices(utterance: string, choices: string | Choice[], options?: FindChoicesOptions): ModelResult<FoundChoice>[]

Paramètres

utterance: string

Texte ou énoncé utilisateur à rechercher. Pour une activité « message » entrante, vous pouvez simplement utiliser context.activity.text.

choices: string | Choice[]

Liste des choix à rechercher.

options: FindChoicesOptions

(Facultatif) options utilisées pour ajuster la recherche effectuée.

Retours

ModelResult<FoundChoice>[]

Liste des choix trouvés, triés en premier par les plus pertinents.

Remarques

Cette couche est superposée au-dessus de la findChoices() fonction et ajoute une logique pour permettre à l’utilisateur de spécifier son choix par index (il peut dire « un » pour choisir choice[0]) ou la position ordinale (il peut dire « le deuxième » pour sélectionner choice[1].) L’énoncé des utilisateurs est reconnu dans l’ordre suivant :

Par nom à l’aide de findChoices().
Par position ordinale basée sur 1.
Par position d’index de base de 1.

const { recognizeChoices } = require('botbuilder-choices');

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = recognizeChoices(utterance, choices);
if (results.length == 1) {
    await context.sendActivity(`I like ${results[0].resolution.value} too!`);
} else if (results.length > 1) {
    const ambiguous = results.map((r) => r.resolution.value);
    await context.sendActivity(ChoiceFactory.forChannel(context, ambiguous, `Which one?`));
} else {
    await context.sendActivity(ChoiceFactory.forChannel(context, choices, `I didn't get that... Which color?`));
}

defaultTokenizer(string, string)

Générateur de jetons simple qui s’interrompt sur les espaces et la ponctuation.

function defaultTokenizer(text: string, _locale?: string): Token[]

Paramètres

text: string

Texte d’entrée.

_locale: string

Facultatif, identifie les paramètres régionaux du texte d’entrée.

Retours

Token[]

Liste de jetons.

Remarques

La seule normalisation effectuée consiste à réduire les jetons. Les développeurs peuvent encapsuler ce générateur de jetons avec leur propre fonction pour effectuer une normalisation supplémentaire telle que la recherche de résultats.

const { recognizeChoices, defaultTokenizer } = require('botbuilder-choices');
const stemmer = require('stemmer');

function customTokenizer(text, locale) {
   const tokens = defaultTokenizer(text, locale);
   tokens.forEach((t) => {
       t.normalized = stemmer(t.normalized);
   });
   return tokens;
}

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = recognizeChoices(utterance, choices, { tokenizer: customTokenizer });

getActiveDialogContext(DialogContext)

Parcourez de manière récursive la pile du contrôleur de domaine pour trouver le contrôleur de domaine actif.

function getActiveDialogContext(dialogContext: DialogContext): DialogContext

Paramètres

dialogContext: DialogContext

(xref:botbuilder-dialogs. DialogContext) pour le tour actuel de la conversation avec l’utilisateur.

Retours

DialogContext

DialogContext actif.

internalRun(TurnContext, string, DialogContext, DialogStateManagerConfiguration)

function internalRun(context: TurnContext, dialogId: string, dialogContext: DialogContext, dialogStateManagerConfiguration?: DialogStateManagerConfiguration): Promise<DialogTurnResult>

Paramètres

context: TurnContext

TurnContext pour le tour.

dialogId: string

ID de boîte de dialogue.

dialogContext: DialogContext

DialogContext pour la tournure actuelle de la conversation.

dialogStateManagerConfiguration: DialogStateManagerConfiguration

Configuration du gestionnaire d’état de la boîte de dialogue.

Retours

Promise<DialogTurnResult>

promesse résolvant le résultat du tour de boîte de dialogue.

isFromParentToSkill(TurnContext)

Détermine si la compétence agit en tant que parent de compétence.

function isFromParentToSkill(context: TurnContext): boolean

Paramètres

context: TurnContext

(xref:botbuilder-core. TurnContext) pour la tournure actuelle de la conversation avec l’utilisateur.

Retours

boolean

Boolean qui représente si la compétence joue le rôle de parent de compétence.

runDialog(Dialog, TurnContext, StatePropertyAccessor<DialogState>)

Exécute un dialogue à partir d’un contexte et d’un accesseur donnés.

function runDialog(dialog: Dialog, context: TurnContext, accessor: StatePropertyAccessor<DialogState>): Promise<void>

Paramètres

dialog: Dialog

Boîte de dialogue à exécuter.

context: TurnContext

(xref:botbuilder-core. TurnContext) pour la tournure actuelle de la conversation avec l’utilisateur.

accessor: StatePropertyAccessor<DialogState>

Méthodes définies pour accéder à la propriété d’état créée dans un objet BotState.

Retours

Promise<void>

shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)

Assistance pour déterminer si nous devons envoyer un EoC au parent ou non.

function shouldSendEndOfConversationToParent(context: TurnContext, turnResult: DialogTurnResult): boolean

Paramètres

context: TurnContext

TurnContext pour le tour.

turnResult: DialogTurnResult

Résultat du tour de boîte de dialogue.

Retours

boolean

True si doit envoyer EoC, sinon false.

isComponentMemoryScopes(unknown)

Vérifiez si un ComponentRegistration est ComponentMemoryScopes ou non.

function isComponentMemoryScopes(component: unknown): boolean

Paramètres

component: unknown

Inscription du composant.

Retours

boolean

Résultat de la vérification de type.

isComponentPathResolvers(unknown)

Vérifiez si un ComponentRegistration est ComponentPathResolvers ou non.

function isComponentPathResolvers(component: unknown): boolean

Paramètres

component: unknown

Inscription du composant.

Retours

boolean

Résultat de la vérification de type.

createConnectorClient(TurnContext, string, ClaimsIdentity, string)

function createConnectorClient(context: TurnContext, serviceUrl: string, claimsIdentity: ClaimsIdentity, audience: string): Promise<ConnectorClient>

Paramètres

context: TurnContext

serviceUrl: string

claimsIdentity: ClaimsIdentity

audience: string

Retours

Promise<ConnectorClient>

exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)

function exchangeToken(context: TurnContext, settings: OAuthPromptSettings, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

Paramètres

context: TurnContext

settings: OAuthPromptSettings

tokenExchangeRequest: TokenExchangeRequest

Retours

Promise<TokenResponse>

getSignInResource(TurnContext, OAuthPromptSettings)

function getSignInResource(context: TurnContext, settings: OAuthPromptSettings): Promise<SignInUrlResponse>

Paramètres

context: TurnContext

settings: OAuthPromptSettings

Retours

Promise<SignInUrlResponse>

getUserToken(TurnContext, OAuthPromptSettings, string)

function getUserToken(context: TurnContext, settings: OAuthPromptSettings, magicCode: string): Promise<TokenResponse>

Paramètres

context: TurnContext

settings: OAuthPromptSettings

magicCode: string

Retours

Promise<TokenResponse>

signOutUser(TurnContext, OAuthPromptSettings)

function signOutUser(context: TurnContext, settings: OAuthPromptSettings): Promise<void>

Paramètres

context: TurnContext

settings: OAuthPromptSettings

Retours

Promise<void>

Partager via

botbuilder-dialogs package

Classes

Interfaces

Alias de type

Énumérations

Fonctions

Informations relatives à la fonction

findChoices(string, string | Choice[], FindChoicesOptions)

Paramètres

Retours

Remarques

findValues(string, SortedValue[], FindValuesOptions)

Paramètres

Retours

recognizeChoices(string, string | Choice[], FindChoicesOptions)

Paramètres

Retours

Remarques

defaultTokenizer(string, string)

Paramètres

Retours

Remarques

getActiveDialogContext(DialogContext)

Paramètres

Retours

internalRun(TurnContext, string, DialogContext, DialogStateManagerConfiguration)

Paramètres

Retours

isFromParentToSkill(TurnContext)

Paramètres

Retours

runDialog(Dialog, TurnContext, StatePropertyAccessor<DialogState>)

Paramètres

Retours

shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)

Paramètres

Retours

isComponentMemoryScopes(unknown)

Paramètres

Retours

isComponentPathResolvers(unknown)

Paramètres

Retours

createConnectorClient(TurnContext, string, ClaimsIdentity, string)

Paramètres

Retours

exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)

Paramètres

Retours

getSignInResource(TurnContext, OAuthPromptSettings)

Paramètres

Retours

getUserToken(TurnContext, OAuthPromptSettings, string)

Paramètres

Retours

signOutUser(TurnContext, OAuthPromptSettings)

Paramètres

Retours

Ressources supplémentaires