QnAMakerDialog class

Référence

Paquet:: botbuilder-ai

Boîte de dialogue qui prend en charge les services QnA Maker multi-étapes et adaptatifs.

Extends: WaterfallDialog

Constructeurs

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)	Initialise une nouvelle instance de la classe QnAMakerDialog.
QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)	Initialise une nouvelle instance de la classe QnAMakerDialog.

Propriétés

$kind
activeLearningCardTitle	Obtient ou définit le titre de la carte à utiliser lors de l’affichage des options d’apprentissage actif à l’utilisateur. Remarque : si suggestionsActivityFactory est passé, ce membre n’est pas utilisé.
cardNoMatchResponse	Obtient ou définit le modèle à envoyer à l’utilisateur s’il sélectionne l’option aucune correspondance sur une carte d’apprentissage active.
cardNoMatchText	Obtient ou définit le texte du bouton à utiliser avec les options d’apprentissage actif, ce qui permet à un utilisateur d’indiquer qu’aucune des options n’est applicable. Remarque : si suggestionsActivityFactory est passé, ce membre est requis.
displayPreciseAnswerOnly	Obtient ou définit une valeur indiquant si la réponse de boîte de dialogue doit afficher uniquement des réponses précises.
enablePreciseAnswer	Obtient ou définit une valeur indiquant s’il faut inclure une réponse précise en réponse.
endpointKey	Obtient ou définit la clé de point de terminaison QnA Maker à utiliser pour interroger la base de connaissances.
filters	Obtient ou définit les métadonnées et les sources utilisées pour filtrer les résultats.
hostname	Obtient ou définit l’URL de l’hôte QnA Maker pour la base de connaissances.
includeUnstructuredSources	Obtient ou définit une valeur indiquant s’il faut inclure des sources non structurées dans la recherche de réponses.
isTest	Obtient ou définit une valeur indiquant si l’environnement obtient ou définit l’environnement de base de connaissances à appeler.
knowledgeBaseId	Obtient ou définit l’ID de la base de connaissances QnA Maker à interroger.
logPersonalInformation	Obtient ou définit l’indicateur pour déterminer si les informations personnelles doivent être consignées dans la télémétrie.
noAnswer	Obtient ou définit le modèle à envoyer à l’utilisateur lorsque QnA Maker ne trouve pas de réponse.
qnaServiceType	Type de service réponse aux questions - qnaMaker ou langue
rankerType	Obtient ou définit le type d’éditeur de classement QnA Maker à utiliser.
strictFilters	Obtient ou définit les métadonnées QnA Maker avec lesquelles filtrer ou augmenter les requêtes vers la base de connaissances, ou null pour appliquer aucune.
strictFiltersJoinOperator	Obtient ou définit une valeur - AND ou OR - opération logique sur la liste des métadonnées
threshold	Obtient ou définit le seuil des réponses retournées, en fonction du score.
top	Obtient ou définit le nombre maximal de réponses à retourner à partir de la base de connaissances.

Propriétés héritées

EndOfTurn	Obtient un résultat de fin de tour par défaut.
id
telemetryClient

Méthodes

beginDialog(DialogContext, object)	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é.
getConverter(Object)

Méthodes héritées

addStep(WaterfallStep<O>)	Ajoute une nouvelle étape à la cascade.
configure(Record<string, unknown>)	Méthode Fluent pour la configuration de l’objet.
endDialog(TurnContext, DialogInstance, DialogReason)	Appelé lorsque la boîte de dialogue se termine.
getVersion()	Obtient la version de la boîte de dialogue, composée de l’ID et du nombre d’étapes.
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é.
repromptDialog(TurnContext, DialogInstance)	En cas de substitution dans une classe dérivée, repromène l’utilisateur pour l’entrée.
resumeDialog(DialogContext, DialogReason, any)	Appelé lorsqu’un enfant WaterfallDialog terminé son tour, retournant le contrôle à cette boîte de dialogue.

Détails du constructeur

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Initialise une nouvelle instance de la classe QnAMakerDialog.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, suggestionsActivityFactory?: QnASuggestionsActivityFactory, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Paramètres

knowledgeBaseId: string

ID de la base de connaissances QnA Maker à interroger.

endpointKey: string

Clé de point de terminaison QnA Maker à utiliser pour interroger la base de connaissances.

hostname: string

URL de l’hôte QnA Maker pour la base de connaissances, commençant par « https:// » et se terminant par « /qnamaker ».

noAnswer: Activity

(Facultatif) Activité à envoyer à l’utilisateur lorsque QnA Maker ne trouve pas de réponse.

threshold: number

(Facultatif) Seuil au-dessus duquel traiter les réponses trouvées à partir de la base de connaissances comme une correspondance.

suggestionsActivityFactory: QnASuggestionsActivityFactory

(xref :botbuilder-ai. QnASuggestionsActivityFactory) utilisé pour la mise en forme d’activité personnalisée.

cardNoMatchText: string

(Facultatif) Texte du bouton à utiliser avec les options d’apprentissage actif, permettant à un utilisateur d’indiquer qu’aucune des options n’est applicable.

top: number

(Facultatif) Nombre maximal de réponses à retourner à partir de la base de connaissances.

cardNoMatchResponse: Activity

(Facultatif) Activité à envoyer à l’utilisateur s’il sélectionne l’option aucune correspondance sur une carte d’apprentissage active.

rankerType: RankerTypes

strictFilters: QnAMakerMetadata[]

(Facultatif) Métadonnées QnA Maker avec lesquelles filtrer ou augmenter les requêtes vers la base de connaissances ; ou null pour ne pas appliquer.

dialogId: string

(Facultatif) ID de la boîte de dialogue créée. La valeur par défaut est « QnAMakerDialog ».

strictFiltersJoinOperator: JoinOperator

opérateur de jointure pour les filtres stricts

enablePreciseAnswer: boolean

displayPreciseAnswerOnly: boolean

qnaServiceType: ServiceType

QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Initialise une nouvelle instance de la classe QnAMakerDialog.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, activeLearningCardTitle?: string, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Paramètres

knowledgeBaseId: string

ID de la base de connaissances QnA Maker à interroger.

endpointKey: string

Clé de point de terminaison QnA Maker à utiliser pour interroger la base de connaissances.

hostname: string

URL de l’hôte QnA Maker pour la base de connaissances, commençant par « https:// » et se terminant par « /qnamaker ».

noAnswer: Activity

(Facultatif) Activité à envoyer à l’utilisateur lorsque QnA Maker ne trouve pas de réponse.

threshold: number

(Facultatif) Seuil au-dessus duquel traiter les réponses trouvées à partir de la base de connaissances comme une correspondance.

activeLearningCardTitle: string

(Facultatif) Titre de la carte à utiliser lors de l’affichage d’options d’apprentissage actif à l’utilisateur, si l’apprentissage actif est activé.

cardNoMatchText: string

(Facultatif) Texte du bouton à utiliser avec les options d’apprentissage actif, permettant à un utilisateur d’indiquer qu’aucune des options n’est applicable.

top: number

(Facultatif) Nombre maximal de réponses à retourner à partir de la base de connaissances.

cardNoMatchResponse: Activity

(Facultatif) Activité à envoyer à l’utilisateur s’il sélectionne l’option aucune correspondance sur une carte d’apprentissage active.

rankerType: RankerTypes

strictFilters: QnAMakerMetadata[]

(Facultatif) Métadonnées QnA Maker avec lesquelles filtrer ou augmenter les requêtes vers la base de connaissances ; ou null pour ne pas appliquer.

dialogId: string

(Facultatif) ID de la boîte de dialogue créée. La valeur par défaut est « QnAMakerDialog ».

strictFiltersJoinOperator: JoinOperator

opérateur de jointure pour les filtres stricts

enablePreciseAnswer: boolean

displayPreciseAnswerOnly: boolean

qnaServiceType: ServiceType

Détails de la propriété

$kind

static $kind: string

Valeur de propriété

string

activeLearningCardTitle

Obtient ou définit le titre de la carte à utiliser lors de l’affichage des options d’apprentissage actif à l’utilisateur. Remarque : si suggestionsActivityFactory est passé, ce membre n’est pas utilisé.

activeLearningCardTitle: StringExpression

Valeur de propriété

StringExpression

cardNoMatchResponse

Obtient ou définit le modèle à envoyer à l’utilisateur s’il sélectionne l’option aucune correspondance sur une carte d’apprentissage active.

cardNoMatchResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Valeur de propriété

TemplateInterface<Partial<Activity>, DialogStateManager>

cardNoMatchText

Obtient ou définit le texte du bouton à utiliser avec les options d’apprentissage actif, ce qui permet à un utilisateur d’indiquer qu’aucune des options n’est applicable. Remarque : si suggestionsActivityFactory est passé, ce membre est requis.

cardNoMatchText: StringExpression

Valeur de propriété

StringExpression

displayPreciseAnswerOnly

Obtient ou définit une valeur indiquant si la réponse de boîte de dialogue doit afficher uniquement des réponses précises.

displayPreciseAnswerOnly: boolean

Valeur de propriété

boolean

enablePreciseAnswer

Obtient ou définit une valeur indiquant s’il faut inclure une réponse précise en réponse.

enablePreciseAnswer: boolean

Valeur de propriété

boolean

endpointKey

Obtient ou définit la clé de point de terminaison QnA Maker à utiliser pour interroger la base de connaissances.

endpointKey: StringExpression

Valeur de propriété

StringExpression

filters

Obtient ou définit les métadonnées et les sources utilisées pour filtrer les résultats.

filters: Filters

Valeur de propriété

Filters

hostname

Obtient ou définit l’URL de l’hôte QnA Maker pour la base de connaissances.

hostname: StringExpression

Valeur de propriété

StringExpression

includeUnstructuredSources

Obtient ou définit une valeur indiquant s’il faut inclure des sources non structurées dans la recherche de réponses.

includeUnstructuredSources: boolean

Valeur de propriété

boolean

isTest

Obtient ou définit une valeur indiquant si l’environnement obtient ou définit l’environnement de base de connaissances à appeler.

isTest: boolean

Valeur de propriété

boolean

knowledgeBaseId

Obtient ou définit l’ID de la base de connaissances QnA Maker à interroger.

knowledgeBaseId: StringExpression

Valeur de propriété

StringExpression

logPersonalInformation

Obtient ou définit l’indicateur pour déterminer si les informations personnelles doivent être consignées dans la télémétrie.

logPersonalInformation: BoolExpression

Valeur de propriété

BoolExpression

noAnswer

Obtient ou définit le modèle à envoyer à l’utilisateur lorsque QnA Maker ne trouve pas de réponse.

noAnswer: TemplateInterface<Partial<Activity>, DialogStateManager>

Valeur de propriété

TemplateInterface<Partial<Activity>, DialogStateManager>

qnaServiceType

Type de service réponse aux questions - qnaMaker ou langue

qnaServiceType: ServiceType

Valeur de propriété

ServiceType

rankerType

Obtient ou définit le type d’éditeur de classement QnA Maker à utiliser.

rankerType: EnumExpression<RankerTypes>

Valeur de propriété

EnumExpression<RankerTypes>

strictFilters

Obtient ou définit les métadonnées QnA Maker avec lesquelles filtrer ou augmenter les requêtes vers la base de connaissances, ou null pour appliquer aucune.

strictFilters: QnAMakerMetadata[]

Valeur de propriété

QnAMakerMetadata[]

strictFiltersJoinOperator

Obtient ou définit une valeur - AND ou OR - opération logique sur la liste des métadonnées

strictFiltersJoinOperator: JoinOperator

Valeur de propriété

JoinOperator

threshold

Obtient ou définit le seuil des réponses retournées, en fonction du score.

threshold: NumberExpression

Valeur de propriété

NumberExpression

top

Obtient ou définit le nombre maximal de réponses à retourner à partir de la base de connaissances.

top: IntExpression

Valeur de propriété

IntExpression

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

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 Dialog.telemetryClient

Détails de la méthode

beginDialog(DialogContext, object)

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

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

Paramètres

dc: DialogContext

DialogContext pour le tour de conversation actuel.

options: object

(Facultatif) Informations initiales à transmettre à la boîte de dialogue.

Retours

Promise<DialogTurnResult>

Une promesse de résolution du résultat de tour

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.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Paramètres

property: Object

Propriétés qui étendent QnAMakerDialogConfiguration.

Retours

Converter | ConverterFactory

Convertisseur d’expression.

Détails de la méthode héritée

addStep(WaterfallStep<O>)

Ajoute une nouvelle étape à la cascade.

function addStep(step: WaterfallStep<O>): this

Paramètres

step: WaterfallStep<O>

Fonction d’étape asynchrone à appeler.

Retours

this

Dialogue en cascade pour les appels Fluent à addStep().

Remarques

Toutes les fonctions d’étape doivent être asynchrones et retourner une DialogTurnResult. Le WaterfallStepContext passé dans votre fonction dérive de DialogContext et contient de nombreuses méthodes de manipulation de pile qui retournent un DialogTurnResult afin de pouvoir simplement renvoyer le résultat de la méthode DialogContext que vous appelez.

La fonction d’étape elle-même peut être une fermeture asynchrone :

const helloDialog = new WaterfallDialog('hello');

helloDialog.addStep(async (step) => {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
});

Fonction asynchrone nommée :

async function helloWorldStep(step) {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
}

helloDialog.addStep(helloWorldStep);

Ou une méthode de classe liée à son pointeur this :

helloDialog.addStep(this.helloWorldStep.bind(this));

héritée de WaterfallDialog.addStep

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

endDialog(TurnContext, DialogInstance, DialogReason)

Appelé lorsque la boîte de dialogue se termine.

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Paramètres

context: TurnContext

Contexte pour le tour de conversation actuel.

instance: DialogInstance

Instance de la boîte de dialogue active.

reason: DialogReason

Raison pour laquelle la boîte de dialogue se termine.

Retours

Promise<void>

héritée de WaterfallDialog.endDialog

getVersion()

Obtient la version de la boîte de dialogue, composée de l’ID et du nombre d’étapes.

function getVersion(): string

Retours

string

Version de boîte de dialogue, composée de l’ID et du nombre d’étapes.

héritée de WaterfallDialog.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 Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

En cas de substitution dans une classe dérivée, repromène l’utilisateur pour l’entrée.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Paramètres

_context: TurnContext

Objet de contexte pour le tour.

_instance: DialogInstance

Informations d’état actuelles pour cette boîte de dialogue.

Retours

Promise<void>

Remarques

Les dialogues dérivés qui prennent en charge la validation et la logique de nouvelle invite doivent remplacer cette méthode. Par défaut, cette méthode n’a aucun effet.

Le DialogContext appelle cette méthode lorsque la boîte de dialogue active doit demander à nouveau l’entrée de l’utilisateur. Cette méthode est implémentée pour les dialogues d’invite.

Voir également

héritée de Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Appelé lorsqu’un enfant WaterfallDialog terminé son tour, retournant le contrôle à cette boîte de dialogue.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Paramètres

dc: DialogContext

DialogContext pour le tour actuel de la conversation.

reason: DialogReason

(xref :botbuilder-dialogs. DialogReason) pourquoi 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.

héritée de WaterfallDialog.resumeDialog