Freigeben über


QnAMakerDialog class

Ein Dialogfeld, das QnA Maker-Dienste mit mehreren Schritten und adaptivem Lernen unterstützt.

Extends

WaterfallDialog

Konstruktoren

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

Initialisiert eine neue Instanz der QnAMakerDialog-Klasse .

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

Initialisiert eine neue Instanz der QnAMakerDialog-Klasse .

Eigenschaften

$kind
activeLearningCardTitle

Ruft den Kartentitel ab, der beim Anzeigen aktiver Lernoptionen für den Benutzer verwendet werden soll, oder legt diesen fest. Hinweis: Wenn suggestionActivityFactory übergeben wird, wird dieser Member nicht verwendet.

cardNoMatchResponse

Ruft die Vorlage ab, die an den Benutzer gesendet werden soll, wenn er die Option Keine Übereinstimmung auf einer aktiven Lernkarte auswählt, oder legt sie fest.

cardNoMatchText

Ruft den Schaltflächentext ab, der mit aktiven Lernoptionen verwendet werden soll, oder legt diesen fest, sodass ein Benutzer angeben kann, dass nicht die Optionen zutreffend sind. Hinweis: Wenn suggestionActivityFactory übergeben wird, ist dieses Element erforderlich.

displayPreciseAnswerOnly

Ruft einen Wert ab, der angibt, ob die Dialogantwort nur präzise Antworten anzeigen soll, oder legt diese fest.

enablePreciseAnswer

Ruft einen Wert ab, der angibt, ob eine präzise Antwort in die Antwort eingeschlossen werden soll, oder legt diesen fest.

endpointKey

Ruft den QnA Maker-Endpunktschlüssel ab, der zum Abfragen des Wissensdatenbank verwendet werden soll, oder legt diesen fest.

filters

Ruft die Metadaten und Quellen ab, die zum Filtern von Ergebnissen verwendet werden, oder legt diese fest.

hostname

Ruft die QnA Maker-Host-URL für die Wissensdatenbank ab oder legt diese fest.

includeUnstructuredSources

Ruft einen Wert ab, der angibt, ob unstrukturierte Quellen bei der Suche nach Antworten eingeschlossen werden sollen, oder legt diesen fest.

isTest

Ruft einen Wert ab, der angibt, ob eine Umgebung der Wissensdatenbank aufgerufen werden soll, oder legt diesen fest.

knowledgeBaseId

Ruft die QnA Maker-Wissensdatenbank-ID ab, um sie abzufragen, oder legt sie fest.

logPersonalInformation

Ruft das Flag ab, um zu bestimmen, ob personenbezogene Informationen in Telemetriedaten protokolliert werden sollen, oder legt es fest.

noAnswer

Ruft die Vorlage ab, die an den Benutzer gesendet werden soll, wenn QnA Maker keine Antwort findet, oder legt diese fest.

qnaServiceType

Fragebeantwortungsdiensttyp – qnaMaker oder Sprache

rankerType

Ruft den zu verwendenden QnA Maker-Rankertyp ab oder legt diesen fest.

strictFilters

Ruft die QnA Maker-Metadaten ab, mit denen Abfragen auf die Wissensdatenbank gefiltert oder erhöht werden sollen, oder legt diese fest, um keine anzuwenden.

strictFiltersJoinOperator

Ruft einen wert - AND oder OR - logischen Vorgang für die Liste der Metadaten ab oder legt diese fest.

threshold

Ruft den Schwellenwert für zurückgegebene Antworten basierend auf der Bewertung ab oder legt diese fest.

top

Ruft die maximale Anzahl von Antworten ab, die vom Wissensdatenbank zurückgegeben werden sollen, oder legt diese fest.

Geerbte Eigenschaften

EndOfTurn

Ruft ein Standardergebnis ab.

id
telemetryClient

Methoden

beginDialog(DialogContext, object)

Wird aufgerufen, wenn das Dialogfeld gestartet und auf den Dialogstapel gepusht wird.

continueDialog(DialogContext)

Wird aufgerufen, wenn das Dialogfeld fortgesetzt wird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.

getConverter(Object)

Geerbte Methoden

addStep(WaterfallStep<O>)

Fügt dem Wasserfall einen neuen Schritt hinzu.

configure(Record<string, unknown>)

Fluent-Methode zum Konfigurieren des Objekts.

endDialog(TurnContext, DialogInstance, DialogReason)

Wird aufgerufen, wenn das Dialogfeld endet.

getVersion()

Ruft die Dialogversion ab, die aus der ID und der Anzahl der Schritte besteht.

onDialogEvent(DialogContext, DialogEvent)

Wird aufgerufen, wenn ein Ereignis mit ausgelöst wurde, entweder DialogContext.emitEvent()durch den aktuellen Dialog oder einen Dialog, den das aktuelle Dialogfeld gestartet hat.

repromptDialog(TurnContext, DialogInstance)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert.

resumeDialog(DialogContext, DialogReason, any)

Wird aufgerufen, wenn ein untergeordnetes WaterfallDialog-Element seinen Drehvorgang abgeschlossen hat und das Steuerelement an dieses Dialogfeld zurückgibt.

Details zum Konstruktor

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

Initialisiert eine neue Instanz der QnAMakerDialog-Klasse .

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)

Parameter

knowledgeBaseId

string

Die ID der abzufragenden QnA Maker-Wissensdatenbank.

endpointKey

string

Der QnA Maker-Endpunktschlüssel, der zum Abfragen der Wissensdatenbank verwendet werden soll.

hostname

string

Die QnA Maker-Host-URL für den Wissensdatenbank, beginnend mit "https://" und endet mit "/qnamaker".

noAnswer

Activity

(Optional) Die Aktivität, die dem Benutzer gesendet werden soll, wenn QnA Maker keine Antwort findet.

threshold

number

(Optional) Der Schwellenwert, ab dem antworten, die aus der Wissensdatenbank gefunden wurden, als Übereinstimmung zu behandeln.

suggestionsActivityFactory
QnASuggestionsActivityFactory

(xref:botbuilder-ai. QnASuggestionsActivityFactory), die für die benutzerdefinierte Aktivitätsformatierung verwendet wird.

cardNoMatchText

string

(Optional) Der Schaltflächentext, der mit aktiven Lernoptionen verwendet werden soll, sodass ein Benutzer angeben kann, dass keine der Optionen zutreffend ist.

top

number

(Optional) Maximale Anzahl von Antworten, die vom Wissensdatenbank zurückgegeben werden sollen.

cardNoMatchResponse

Activity

(Optional) Die Aktivität, die dem Benutzer gesendet werden soll, wenn er die Option "Keine Übereinstimmung" auf einer aktiven Lernkarte auswählt.

rankerType
RankerTypes
strictFilters

QnAMakerMetadata[]

(Optional) QnA Maker-Metadaten, mit denen Abfragen für die Wissensdatenbank gefiltert oder erhöht werden sollen, oder NULL, um keine anzuwenden.

dialogId

string

(Optional) ID des erstellten Dialogfelds. Der Standardwert ist "QnAMakerDialog".

strictFiltersJoinOperator
JoinOperator

Joinoperator für strenge Filter

enablePreciseAnswer

boolean

displayPreciseAnswerOnly

boolean

qnaServiceType
ServiceType

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

Initialisiert eine neue Instanz der QnAMakerDialog-Klasse .

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)

Parameter

knowledgeBaseId

string

Die ID der abzufragenden QnA Maker-Wissensdatenbank.

endpointKey

string

Der QnA Maker-Endpunktschlüssel, der zum Abfragen der Wissensdatenbank verwendet werden soll.

hostname

string

Die QnA Maker-Host-URL für den Wissensdatenbank, beginnend mit "https://" und endet mit "/qnamaker".

noAnswer

Activity

(Optional) Die Aktivität, die dem Benutzer gesendet werden soll, wenn QnA Maker keine Antwort findet.

threshold

number

(Optional) Der Schwellenwert, ab dem antworten, die aus der Wissensdatenbank gefunden wurden, als Übereinstimmung zu behandeln.

activeLearningCardTitle

string

(Optional) Der Kartentitel, der verwendet werden soll, wenn dem Benutzer aktive Lernoptionen angezeigt werden, wenn aktives Lernen aktiviert ist.

cardNoMatchText

string

(Optional) Der Schaltflächentext, der mit aktiven Lernoptionen verwendet werden soll, sodass ein Benutzer angeben kann, dass keine der Optionen zutreffend ist.

top

number

(Optional) Maximale Anzahl von Antworten, die vom Wissensdatenbank zurückgegeben werden sollen.

cardNoMatchResponse

Activity

(Optional) Die Aktivität, die dem Benutzer gesendet werden soll, wenn er die Option "Keine Übereinstimmung" auf einer aktiven Lernkarte auswählt.

rankerType
RankerTypes
strictFilters

QnAMakerMetadata[]

(Optional) QnA Maker-Metadaten, mit denen Abfragen für die Wissensdatenbank gefiltert oder erhöht werden sollen, oder NULL, um keine anzuwenden.

dialogId

string

(Optional) ID des erstellten Dialogfelds. Der Standardwert ist "QnAMakerDialog".

strictFiltersJoinOperator
JoinOperator

Joinoperator für strenge Filter

enablePreciseAnswer

boolean

displayPreciseAnswerOnly

boolean

qnaServiceType
ServiceType

Details zur Eigenschaft

$kind

static $kind: string

Eigenschaftswert

string

activeLearningCardTitle

Ruft den Kartentitel ab, der beim Anzeigen aktiver Lernoptionen für den Benutzer verwendet werden soll, oder legt diesen fest. Hinweis: Wenn suggestionActivityFactory übergeben wird, wird dieser Member nicht verwendet.

activeLearningCardTitle: StringExpression

Eigenschaftswert

StringExpression

cardNoMatchResponse

Ruft die Vorlage ab, die an den Benutzer gesendet werden soll, wenn er die Option Keine Übereinstimmung auf einer aktiven Lernkarte auswählt, oder legt sie fest.

cardNoMatchResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

TemplateInterface<Partial<Activity>, DialogStateManager>

cardNoMatchText

Ruft den Schaltflächentext ab, der mit aktiven Lernoptionen verwendet werden soll, oder legt diesen fest, sodass ein Benutzer angeben kann, dass nicht die Optionen zutreffend sind. Hinweis: Wenn suggestionActivityFactory übergeben wird, ist dieses Element erforderlich.

cardNoMatchText: StringExpression

Eigenschaftswert

StringExpression

displayPreciseAnswerOnly

Ruft einen Wert ab, der angibt, ob die Dialogantwort nur präzise Antworten anzeigen soll, oder legt diese fest.

displayPreciseAnswerOnly: boolean

Eigenschaftswert

boolean

enablePreciseAnswer

Ruft einen Wert ab, der angibt, ob eine präzise Antwort in die Antwort eingeschlossen werden soll, oder legt diesen fest.

enablePreciseAnswer: boolean

Eigenschaftswert

boolean

endpointKey

Ruft den QnA Maker-Endpunktschlüssel ab, der zum Abfragen des Wissensdatenbank verwendet werden soll, oder legt diesen fest.

endpointKey: StringExpression

Eigenschaftswert

StringExpression

filters

Ruft die Metadaten und Quellen ab, die zum Filtern von Ergebnissen verwendet werden, oder legt diese fest.

filters: Filters

Eigenschaftswert

hostname

Ruft die QnA Maker-Host-URL für die Wissensdatenbank ab oder legt diese fest.

hostname: StringExpression

Eigenschaftswert

StringExpression

includeUnstructuredSources

Ruft einen Wert ab, der angibt, ob unstrukturierte Quellen bei der Suche nach Antworten eingeschlossen werden sollen, oder legt diesen fest.

includeUnstructuredSources: boolean

Eigenschaftswert

boolean

isTest

Ruft einen Wert ab, der angibt, ob eine Umgebung der Wissensdatenbank aufgerufen werden soll, oder legt diesen fest.

isTest: boolean

Eigenschaftswert

boolean

knowledgeBaseId

Ruft die QnA Maker-Wissensdatenbank-ID ab, um sie abzufragen, oder legt sie fest.

knowledgeBaseId: StringExpression

Eigenschaftswert

StringExpression

logPersonalInformation

Ruft das Flag ab, um zu bestimmen, ob personenbezogene Informationen in Telemetriedaten protokolliert werden sollen, oder legt es fest.

logPersonalInformation: BoolExpression

Eigenschaftswert

BoolExpression

noAnswer

Ruft die Vorlage ab, die an den Benutzer gesendet werden soll, wenn QnA Maker keine Antwort findet, oder legt diese fest.

noAnswer: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

TemplateInterface<Partial<Activity>, DialogStateManager>

qnaServiceType

Fragebeantwortungsdiensttyp – qnaMaker oder Sprache

qnaServiceType: ServiceType

Eigenschaftswert

rankerType

Ruft den zu verwendenden QnA Maker-Rankertyp ab oder legt diesen fest.

rankerType: EnumExpression<RankerTypes>

Eigenschaftswert

EnumExpression<RankerTypes>

strictFilters

Ruft die QnA Maker-Metadaten ab, mit denen Abfragen auf die Wissensdatenbank gefiltert oder erhöht werden sollen, oder legt diese fest, um keine anzuwenden.

strictFilters: QnAMakerMetadata[]

Eigenschaftswert

strictFiltersJoinOperator

Ruft einen wert - AND oder OR - logischen Vorgang für die Liste der Metadaten ab oder legt diese fest.

strictFiltersJoinOperator: JoinOperator

Eigenschaftswert

threshold

Ruft den Schwellenwert für zurückgegebene Antworten basierend auf der Bewertung ab oder legt diese fest.

threshold: NumberExpression

Eigenschaftswert

NumberExpression

top

Ruft die maximale Anzahl von Antworten ab, die vom Wissensdatenbank zurückgegeben werden sollen, oder legt diese fest.

top: IntExpression

Eigenschaftswert

IntExpression

Geerbte Eigenschaftsdetails

EndOfTurn

Ruft ein Standardergebnis ab.

static EndOfTurn: DialogTurnResult

Eigenschaftswert

DialogTurnResult

Hinweise

Dieses Ergebnis gibt an, dass ein Dialog (oder ein logischer Schritt in einem Dialog) die Verarbeitung für den aktuellen Turn abgeschlossen hat, weiterhin aktiv ist und auf weitere Eingaben wartet.

Geerbt von Dialog.EndOfTurn

id

id: string

Eigenschaftswert

string

Geerbt von Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Eigenschaftswert

BotTelemetryClient

Geerbt von Dialog.telemetryClient

Details zur Methode

beginDialog(DialogContext, object)

Wird aufgerufen, wenn das Dialogfeld gestartet und auf den Dialogstapel gepusht wird.

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

Parameter

dc

DialogContext

Der DialogContext für den aktuellen Gesprächsverlauf.

options

object

(Optional) Erste Informationen, die an das Dialogfeld übergeben werden sollen.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die zum Turnergebnis aufgelöst wird

continueDialog(DialogContext)

Wird aufgerufen, wenn das Dialogfeld fortgesetzt wird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.

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

Parameter

dc

DialogContext

Der DialogContext für den aktuellen Gesprächsverlauf.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die den asynchronen Vorgang darstellt.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parameter

property

Object

Eigenschaften, die QnAMakerDialogConfiguration erweitern.

Gibt zurück

Converter | ConverterFactory

Der Ausdruckskonverter.

Details zur geerbten Methode

addStep(WaterfallStep<O>)

Fügt dem Wasserfall einen neuen Schritt hinzu.

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

Parameter

step

WaterfallStep<O>

Asynchrone Schrittfunktion, die aufgerufen werden soll.

Gibt zurück

this

Wasserfalldialog für fließende Aufrufe von addStep().

Hinweise

Alle Schrittfunktionen sollten asynchron sein und einen DialogTurnResultzurückgeben. Die WaterfallStepContext an Ihre Funktion übergebene leitet sich von ab DialogContext und enthält zahlreiche Stapelbearbeitungsmethoden, die eine DialogTurnResult zurückgeben, sodass Sie in der Regel einfach das Ergebnis der dialogContext-Methode zurückgeben können, die Sie aufrufen.

Die Schrittfunktion selbst kann entweder ein asynchroner Abschluss sein:

const helloDialog = new WaterfallDialog('hello');

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

Eine benannte asynchrone Funktion:

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

helloDialog.addStep(helloWorldStep);

Oder eine Klassenmethode, die an ihren this Zeiger gebunden wurde:

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

Geerbt von WaterfallDialog.addStep

configure(Record<string, unknown>)

Fluent-Methode zum Konfigurieren des Objekts.

function configure(config: Record<string, unknown>): this

Parameter

config

Record<string, unknown>

Zu übernehmende Konfigurationseinstellungen.

Gibt zurück

this

Die Konfigurierbare nach Abschluss des Vorgangs.

Geerbt von Konfigurierbar.configure

endDialog(TurnContext, DialogInstance, DialogReason)

Wird aufgerufen, wenn das Dialogfeld endet.

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

Parameter

context

TurnContext

Kontext für den aktuellen Gesprächsverlauf.

instance

DialogInstance

Die Instanz des aktuellen Dialogfelds.

reason

DialogReason

Der Grund, warum das Dialogfeld endet.

Gibt zurück

Promise<void>

Geerbt von WaterfallDialog.endDialog

getVersion()

Ruft die Dialogversion ab, die aus der ID und der Anzahl der Schritte besteht.

function getVersion(): string

Gibt zurück

string

Dialogversion, bestehend aus der ID und der Anzahl der Schritte.

Geerbt von WaterfallDialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Wird aufgerufen, wenn ein Ereignis mit ausgelöst wurde, entweder DialogContext.emitEvent()durch den aktuellen Dialog oder einen Dialog, den das aktuelle Dialogfeld gestartet hat.

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

Parameter

dc

DialogContext

Der Dialogkontext für den aktuellen Gesprächsverlauf.

e

DialogEvent

Das ausgelöste Ereignis.

Gibt zurück

Promise<boolean>

True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und das Brodeln beendet werden soll.

Geerbt von Dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Wenn sie in einer abgeleiteten Klasse überschrieben wird, wird der Benutzer erneut zur Eingabe aufgefordert.

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

Parameter

_context

TurnContext

Das Kontextobjekt für den Turn.

_instance

DialogInstance

Aktuelle Statusinformationen für dieses Dialogfeld.

Gibt zurück

Promise<void>

Hinweise

Abgeleitete Dialogfelder, die validierungs- und eingabeaufforderungslogik unterstützen, sollten diese Methode überschreiben. Standardmäßig hat diese Methode keine Auswirkungen.

DialogContext ruft diese Methode auf, wenn der aktuelle Dialog eingaben vom Benutzer erneut anfordern soll. Diese Methode wird für Eingabeaufforderungsdialoge implementiert.

Weitere Informationen

Geerbt von Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Wird aufgerufen, wenn ein untergeordnetes WaterfallDialog-Element seinen Drehvorgang abgeschlossen hat und das Steuerelement an dieses Dialogfeld zurückgibt.

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

Parameter

dc

DialogContext

Der DialogContext für den aktuellen Gesprächsverlauf.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) warum der Dialog fortgesetzt wurde.

result

any

Optionaler Wert, der aus dem aufgerufenen Dialogfeld zurückgegeben wird. Der Typ des zurückgegebenen Werts hängt vom untergeordneten Dialogfeld ab.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die den asynchronen Vorgang darstellt.

Geerbt von WaterfallDialog.resumeDialog