QnAMakerDialog class
Boîte de dialogue qui prend en charge les services QnA Maker à plusieurs étapes et d’apprentissage adaptatif.
- Extends
-
WaterfallDialog
Constructeurs
Propriétés
$kind | |
active |
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é. |
card |
Obtient ou définit le modèle à envoyer à l’utilisateur s’il sélectionne l’option aucune correspondance sur une carte d’apprentissage active. |
card |
Obtient ou définit le texte du bouton à utiliser avec les options d’apprentissage actif, ce qui permet à un utilisateur d’indiquer que les options sont applicables. Remarque : si suggestionsActivityFactory est passé, ce membre est obligatoire. |
display |
Obtient ou définit une valeur indiquant si la réponse du dialogue doit afficher uniquement des réponses précises. |
enable |
Obtient ou définit une valeur indiquant s’il faut inclure une réponse précise dans la réponse. |
endpoint |
Obtient ou définit la clé de point de terminaison QnA Maker à utiliser pour interroger le 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 le base de connaissances. |
include |
Obtient ou définit une valeur indiquant s’il faut inclure des sources non structurées dans la recherche de réponses. |
is |
Obtient ou définit une valeur indiquant si obtient ou définit l’environnement de base de connaissances à appeler. |
knowledge |
Obtient ou définit l’ID de base de connaissances QnA Maker à interroger. |
log |
Obtient ou définit l’indicateur pour déterminer si les informations personnelles doivent être enregistrées dans les données de télémétrie. |
no |
Obtient ou définit le modèle à envoyer à l’utilisateur lorsque QnA Maker ne trouve pas de réponse. |
qna |
Type de service de réponse aux questions - qnaMaker ou language |
ranker |
Obtient ou définit le type de ranker QnA Maker à utiliser. |
strict |
Obtient ou définit les métadonnées QnA Maker avec lesquelles filtrer ou augmenter les requêtes sur le base de connaissances, ou null pour en appliquer aucune. |
strict |
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 pour les réponses retournées, en fonction du score. |
top | Obtient ou définit le nombre maximal de réponses à retourner à partir du base de connaissances. |
Propriétés héritées
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é. |
get |
Méthodes héritées
add |
Ajoute une nouvelle étape à la cascade. |
configure(Record<string, unknown>) | Méthode Fluent pour la configuration de l’objet. |
end |
Appelé lorsque le dialogue se termine. |
get |
Obtient la version de la boîte de dialogue, composée de l’ID et du nombre d’étapes. |
on |
Appelé lorsqu’un événement a été déclenché, à l’aide |
reprompt |
En cas de substitution dans une classe dérivée, repromène l’utilisateur pour l’entrée. |
resume |
Appelé lorsqu’un objet WaterfallDialog enfant a terminé son tour, en 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 l’base de connaissances QnA Maker à interroger.
- endpointKey
-
string
Clé de point de terminaison QnA Maker à utiliser pour interroger le base de connaissances.
- hostname
-
string
URL de l’hôte QnA Maker pour le 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 dans 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, ce qui permet à 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
(Facultatif) Métadonnées QnA Maker avec lesquelles filtrer ou augmenter les requêtes sur le 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 join 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 l’base de connaissances QnA Maker à interroger.
- endpointKey
-
string
Clé de point de terminaison QnA Maker à utiliser pour interroger le base de connaissances.
- hostname
-
string
URL de l’hôte QnA Maker pour le 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 dans la base de connaissances comme une correspondance.
- activeLearningCardTitle
-
string
(Facultatif) Titre de la carte à utiliser lors de l’affichage des 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, ce qui permet à 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
(Facultatif) Métadonnées QnA Maker avec lesquelles filtrer ou augmenter les requêtes sur le 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 join 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 que les options sont applicables. Remarque : si suggestionsActivityFactory est passé, ce membre est obligatoire.
cardNoMatchText: StringExpression
Valeur de propriété
StringExpression
displayPreciseAnswerOnly
Obtient ou définit une valeur indiquant si la réponse du 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 dans la 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 le 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é
hostname
Obtient ou définit l’URL de l’hôte QnA Maker pour le 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 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 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 enregistrées dans les données de 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 de réponse aux questions - qnaMaker ou language
qnaServiceType: ServiceType
Valeur de propriété
rankerType
Obtient ou définit le type de ranker 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 sur le base de connaissances, ou null pour en appliquer aucune.
strictFilters: QnAMakerMetadata[]
Valeur de propriété
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é
threshold
Obtient ou définit le seuil pour les 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 du 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 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 Dialog.telemetryClient
Détails de la méthode
beginDialog(DialogContext, object)
Appelé lorsque le dialogue est démarré et poussé vers la pile des dialogues.
function beginDialog(dc: DialogContext, options?: object): Promise<DialogTurnResult>
Paramètres
- dc
-
DialogContext
DialogContext pour la tournure actuelle de la conversation.
- options
-
object
(Facultatif) Informations initiales à passer au dialogue.
Retours
Promise<DialogTurnResult>
Promesse résolvant le résultat du tour
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.
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
Boîte de dialogue en cascade pour les appels Fluent à addStep()
.
Remarques
Toutes les fonctions d’étape doivent être asynchrones et retourner un DialogTurnResult
. Le WaterfallStepContext
transmis à votre fonction dérive de et contient de nombreuses méthodes de manipulation de DialogContext
pile qui retournent un DialogTurnResult
de sorte que vous pouvez généralement simplement retourner 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();
});
Une 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 qui a été liée à son this
pointeur :
helloDialog.addStep(this.helloWorldStep.bind(this));
Hérité 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é de Configurable.configure
endDialog(TurnContext, DialogInstance, DialogReason)
Appelé lorsque le dialogue se termine.
function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>
Paramètres
- context
-
TurnContext
Contexte pour la tournure actuelle de la conversation.
- instance
-
DialogInstance
Instance de la boîte de dialogue actuelle.
- reason
-
DialogReason
Raison pour laquelle le dialogue se termine.
Retours
Promise<void>
Hérité 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 du dialogue, composée de l’ID et du nombre d’étapes.
Hérité de WaterfallDialog.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 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 sur l’état actuel de cette boîte de dialogue.
Retours
Promise<void>
Remarques
Les boîtes de dialogue dérivées qui prennent en charge la logique de validation et de nouvelle invite doivent remplacer cette méthode. Par défaut, cette méthode n’a aucun effet.
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 boîtes de dialogue d’invite.
Voir aussi
Hérité de Dialog.repromptDialog
resumeDialog(DialogContext, DialogReason, any)
Appelé lorsqu’un objet WaterfallDialog enfant a terminé son tour, en 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
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.
Hérité de WaterfallDialog.resumeDialog