Freigeben über


QnAMakerDialog class

Ein Dialogfeld, das mehrstufige und adaptive Lern-QnA Maker-Dienste 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 suggestionsActivityFactory übergeben wird, wird dieses Element nicht verwendet.

cardNoMatchResponse

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

cardNoMatchText

Dient zum Abrufen oder Festlegen des Schaltflächentexts, der mit aktiven Lernoptionen verwendet werden soll, sodass ein Benutzer angeben kann, dass keine Optionen anwendbar sind. Hinweis: Wenn suggestionsActivityFactory übergeben wird, ist dieses Element erforderlich.

displayPreciseAnswerOnly

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Dialogantwort nur präzise Antworten anzeigen soll.

enablePreciseAnswer

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob eine genaue Antwort in die Antwort eingeschlossen werden soll.

endpointKey

Ruft den QnA Maker-Endpunktschlüssel ab, der zum Abfragen der Wissensbasis 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 Knowledge Base ab oder legt sie fest.

includeUnstructuredSources

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob unstrukturierte Quellen in die Suche nach Antworten eingeschlossen werden sollen.

isTest

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die aufgerufene Wissensbasisumgebung abgerufen oder festgelegt wird.

knowledgeBaseId

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

logPersonalInformation

Ruft ab oder legt das Kennzeichen fest, um zu bestimmen, ob persönliche Informationen in Telemetrie protokolliert werden sollen.

noAnswer

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

qnaServiceType

Fragebeantwortungsdiensttyp – qnaMaker oder Sprache

rankerType

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

strictFilters

Ruft die QnA Maker-Metadaten ab, mit denen Abfragen auf die Knowledge Base gefiltert oder heraufverstärkt werden sollen, oder legt diese fest, um keines anzuwenden.

strictFiltersJoinOperator

Dient zum Abrufen oder Festlegen eines Werts – UND oder OR – logischer Vorgang in der Liste der Metadaten

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 von der Wissensbasis zurückgegeben werden sollen, oder legt diese fest.

Geerbte Eigenschaften

EndOfTurn

Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.

id
telemetryClient

Methoden

beginDialog(DialogContext, object)

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.

continueDialog(DialogContext)

Wird aufgerufen, wenn das Dialogfeld fortgesetzt, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einem neuen Aktivitäts-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 beendet wird.

getVersion()

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

onDialogEvent(DialogContext, DialogEvent)

Wird aufgerufen, wenn ein Ereignis mit DialogContext.emitEvent()ausgelöst wurde, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das 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 seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

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 zu abfragenden QnA Maker-Wissensbasis.

endpointKey

string

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

hostname

string

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

noAnswer

Activity

(Optional) Die Aktivität, die den Benutzer sendet, wenn QnA Maker keine Antwort findet.

threshold

number

(Optional) Der Schwellenwert, über dem Antworten aus der Wissensdatenbank als Übereinstimmung behandelt werden sollen.

suggestionsActivityFactory
QnASuggestionsActivityFactory

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

cardNoMatchText

string

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

top

number

(Optional) Maximale Anzahl von Antworten, die von der Wissensbasis 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 auf der Wissensbasis gefiltert oder erhöht werden sollen; oder NULL, um keine anzuwenden.

dialogId

string

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

strictFiltersJoinOperator
JoinOperator

Verknüpfungsoperator 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 zu abfragenden QnA Maker-Wissensbasis.

endpointKey

string

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

hostname

string

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

noAnswer

Activity

(Optional) Die Aktivität, die den Benutzer sendet, wenn QnA Maker keine Antwort findet.

threshold

number

(Optional) Der Schwellenwert, über dem Antworten aus der Wissensdatenbank als Übereinstimmung behandelt werden sollen.

activeLearningCardTitle

string

(Optional) Der Kartentitel, der beim Anzeigen aktiver Lernoptionen für den Benutzer verwendet werden soll, wenn aktives Lernen aktiviert ist.

cardNoMatchText

string

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

top

number

(Optional) Maximale Anzahl von Antworten, die von der Wissensbasis 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 auf der Wissensbasis gefiltert oder erhöht werden sollen; oder NULL, um keine anzuwenden.

dialogId

string

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

strictFiltersJoinOperator
JoinOperator

Verknüpfungsoperator 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 suggestionsActivityFactory übergeben wird, wird dieses Element nicht verwendet.

activeLearningCardTitle: StringExpression

Eigenschaftswert

StringExpression

cardNoMatchResponse

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

cardNoMatchResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

TemplateInterface<Partial<Activity>, DialogStateManager>

cardNoMatchText

Dient zum Abrufen oder Festlegen des Schaltflächentexts, der mit aktiven Lernoptionen verwendet werden soll, sodass ein Benutzer angeben kann, dass keine Optionen anwendbar sind. Hinweis: Wenn suggestionsActivityFactory übergeben wird, ist dieses Element erforderlich.

cardNoMatchText: StringExpression

Eigenschaftswert

StringExpression

displayPreciseAnswerOnly

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Dialogantwort nur präzise Antworten anzeigen soll.

displayPreciseAnswerOnly: boolean

Eigenschaftswert

boolean

enablePreciseAnswer

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob eine genaue Antwort in die Antwort eingeschlossen werden soll.

enablePreciseAnswer: boolean

Eigenschaftswert

boolean

endpointKey

Ruft den QnA Maker-Endpunktschlüssel ab, der zum Abfragen der Wissensbasis 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 Knowledge Base ab oder legt sie fest.

hostname: StringExpression

Eigenschaftswert

StringExpression

includeUnstructuredSources

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob unstrukturierte Quellen in die Suche nach Antworten eingeschlossen werden sollen.

includeUnstructuredSources: boolean

Eigenschaftswert

boolean

isTest

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die aufgerufene Wissensbasisumgebung abgerufen oder festgelegt wird.

isTest: boolean

Eigenschaftswert

boolean

knowledgeBaseId

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

knowledgeBaseId: StringExpression

Eigenschaftswert

StringExpression

logPersonalInformation

Ruft ab oder legt das Kennzeichen fest, um zu bestimmen, ob persönliche Informationen in Telemetrie protokolliert werden sollen.

logPersonalInformation: BoolExpression

Eigenschaftswert

BoolExpression

noAnswer

Ruft die Vorlage ab, die an den Benutzer gesendet werden soll, wenn QnA Maker keine Antwort findet, oder legt sie 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-Rangierertyp ab oder legt diesen fest.

rankerType: EnumExpression<RankerTypes>

Eigenschaftswert

EnumExpression<RankerTypes>

strictFilters

Ruft die QnA Maker-Metadaten ab, mit denen Abfragen auf die Knowledge Base gefiltert oder heraufverstärkt werden sollen, oder legt diese fest, um keines anzuwenden.

strictFilters: QnAMakerMetadata[]

Eigenschaftswert

strictFiltersJoinOperator

Dient zum Abrufen oder Festlegen eines Werts – UND oder OR – logischer Vorgang in der Liste der Metadaten

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 von der Wissensbasis zurückgegeben werden sollen, oder legt diese fest.

top: IntExpression

Eigenschaftswert

IntExpression

Geerbte Eigenschaftsdetails

EndOfTurn

Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.

static EndOfTurn: DialogTurnResult

Eigenschaftswert

DialogTurnResult

Hinweise

Dieses Ergebnis gibt an, dass ein Dialogfeld (oder ein logischer Schritt innerhalb eines Dialogfelds) die Verarbeitung für die aktuelle Drehung abgeschlossen hat, noch aktiv ist und auf weitere Eingaben wartet.

von Dialog.EndOfTurn geerbt

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 in den Dialogstapel verschoben wird.

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

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

options

object

(Optional) Anfängliche Informationen, die an das Dialogfeld übergeben werden sollen.

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die in das Turnergebnis aufgelöst wird

continueDialog(DialogContext)

Wird aufgerufen, wenn das Dialogfeld fortgesetzt, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einem neuen Aktivitäts-antwortet.

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

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

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

Wasserfalldialogfeld für Fluent-Anrufe an addStep().

Hinweise

Alle Schrittfunktionen sollten asynchron sein und einen DialogTurnResultzurückgeben. Die an Ihre Funktion übergebene WaterfallStepContext wird von DialogContext abgeleitet und enthält zahlreiche Stapelmanipulationsmethoden, die eine DialogTurnResult zurückgeben, sodass Sie in der Regel nur das Ergebnis aus der von Ihnen aufgerufenen DialogContext-Methode zurückgeben können.

Die Schrittfunktion selbst kann eine asynchrone Schließung 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 den 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>

Anzuwendende Konfigurationseinstellungen.

Gibt zurück

this

Die konfigurierbaren nach Abschluss des Vorgangs.

Geerbt von Konfigurierbar.configure

endDialog(TurnContext, DialogInstance, DialogReason)

Wird aufgerufen, wenn das Dialogfeld beendet wird.

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

Parameter

context

TurnContext

Kontext für die aktuelle Unterhaltungswende.

instance

DialogInstance

Die Instanz des aktuellen Dialogfelds.

reason

DialogReason

Der Grund, warum das Dialogfeld beendet wird.

Gibt zurück

Promise<void>

von WaterfallDialog.endDialog geerbt

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 DialogContext.emitEvent()ausgelöst wurde, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.

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

Parameter

dc

DialogContext

Der Dialogkontext für die aktuelle Unterhaltungswende.

e

DialogEvent

Das ausgelöste Ereignis.

Gibt zurück

Promise<boolean>

True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und Bubbling 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 die Drehung.

_instance

DialogInstance

Aktuelle Statusinformationen für dieses Dialogfeld.

Gibt zurück

Promise<void>

Hinweise

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

Die DialogContext- ruft diese Methode auf, wenn das aktuelle Dialogfeld eingaben vom Benutzer erneut anfordern soll. Diese Methode wird für Eingabeaufforderungsdialoge implementiert.

Siehe auch

geerbt von Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Wird aufgerufen, wenn ein untergeordnetes WaterfallDialog seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

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

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltung.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) warum das Dialogfeld fortgesetzt wurde.

result

any

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

Gibt zurück

Promise<DialogTurnResult>

Eine Zusage, die den asynchronen Vorgang darstellt.

von WaterfallDialog.resumeDialog geerbt