QnAMaker class

Paket:

botbuilder-ai

Fragen Sie eine QnA Maker-Wissensdatenbank nach Antworten ab und geben Sie Feedback.

Konstruktoren

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Erstellt eine neue QnAMaker-Instanz.

Eigenschaften

logPersonalInformation	Ruft einen Wert ab, der angibt, ob persönliche Informationen protokolliert werden sollen, die vom Benutzer stammen.
telemetryClient	Ruft den aktuell konfigurierten BotTelemetryClient ab, der die Ereignisse protokolliert.

Methoden

answer(TurnContext)	Ruft generateAnswer() auf und sendet die resultierende Antwort als Antwort an den Benutzer.
callTrain(FeedbackRecords)	Senden Sie Feedback an die Wissensdatenbank.
generateAnswer(string | undefined, number, number)	Ruft den QnA Maker-Dienst auf, um Antworten auf eine Frage zu generieren.
getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Ruft den QnA Maker-Dienst auf, um Antworten auf eine Frage zu generieren.
getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Generiert eine Antwort aus dem Wissensdatenbank.
getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Generiert eine Antwort aus dem QnA Maker-Wissensdatenbank.
getLowScoreVariation(QnAMakerResult[])	Filtert die mehrdeutige Frage für aktives Lernen.

Details zum Konstruktor

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Erstellt eine neue QnAMaker-Instanz.

new QnAMaker(endpoint: QnAMakerEndpoint, options?: QnAMakerOptions, telemetryClient?: BotTelemetryClient, logPersonalInformation?: boolean)

Parameter

endpoint

QnAMakerEndpoint

Der Endpunkt des abzufragenden Wissensdatenbank.

options

QnAMakerOptions

(Optional) zusätzliche Einstellungen, die zum Konfigurieren der Instanz verwendet werden.

telemetryClient

BotTelemetryClient

Der BotTelemetryClient, der zum Protokollieren von Telemetrieereignissen verwendet wird.

logPersonalInformation

boolean

Legen Sie auf true fest, um personenbezogene Informationen in Telemetrieereignisse einzuschließen.

Details zur Eigenschaft

logPersonalInformation

Ruft einen Wert ab, der angibt, ob persönliche Informationen protokolliert werden sollen, die vom Benutzer stammen.

boolean logPersonalInformation

Eigenschaftswert

boolean

True, wenn persönliche Informationen in der BotTelemetryClient.TrackEvent-Methode protokolliert werden; andernfalls werden die Eigenschaften gefiltert.

telemetryClient

Ruft den aktuell konfigurierten BotTelemetryClient ab, der die Ereignisse protokolliert.

BotTelemetryClient telemetryClient

Eigenschaftswert

BotTelemetryClient

Der derzeit konfigurierte BotTelemetryClient, der das QnaMessage-Ereignis protokolliert.

Details zur Methode

answer(TurnContext)

Warnung

Diese API ist nun veraltet.

Instead, favor using QnAMaker.getAnswers() to generate answers for a question.

Ruft generateAnswer() auf und sendet die resultierende Antwort als Antwort an den Benutzer.

function answer(context: TurnContext): Promise<boolean>

Parameter

context

TurnContext

Kontext für den aktuellen Gesprächsverlauf mit dem Benutzer.

Gibt zurück

Promise<boolean>

Eine Zusage, die in true aufgelöst wird, wenn eine Antwort gesendet wurde

callTrain(FeedbackRecords)

Senden Sie Feedback an die Wissensdatenbank.

function callTrain(feedbackRecords: FeedbackRecords): Promise<void>

Parameter

feedbackRecords

FeedbackRecords

Feedbackdatensätze.

Gibt zurück

Promise<void>

Eine Zusage, die den asynchronen Vorgang darstellt

generateAnswer(string | undefined, number, number)

Warnung

Diese API ist nun veraltet.

Instead, favor using QnAMaker.getAnswers() to generate answers for a question.

Ruft den QnA Maker-Dienst auf, um Antworten auf eine Frage zu generieren.

function generateAnswer(question: string | undefined, top?: number, _scoreThreshold?: number): Promise<QnAMakerResult[]>

Parameter

question

string | undefined

Die zu beantwortende Frage.

top

number

(Optional) Anzahl der Antworten, die zurückgegeben werden sollen. Standardmäßig wird der Wert verwendet 1.

_scoreThreshold

number

(Optional) Die Mindestantwortbewertung muss als Übereinstimmung mit Fragen betrachtet werden. Standardmäßig wird der Wert verwendet 0.001.

Gibt zurück

Promise<QnAMakerResult[]>

Eine Zusage, die zu den QnAMaker-Ergebnissen aufgelöst wird

getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

Ruft den QnA Maker-Dienst auf, um Antworten auf eine Frage zu generieren.

function getAnswers(context: TurnContext, options?: QnAMakerOptions, telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: string]: number): Promise<QnAMakerResult[]>

Parameter

context

TurnContext

Der Turn Context, der die Benutzerfrage enthält, die für Ihre Wissensdatenbank abgefragt werden soll.

options

QnAMakerOptions

(Optional) Die Optionen für die QnA Maker-Wissensdatenbank. Wenn null, wird die Konstruktoroption für diese Instanz verwendet.

telemetryProperties

[key: string]: string

Zusätzliche Eigenschaften, die mit dem QnaMessage-Ereignis in Telemetriedaten protokolliert werden sollen.

telemetryMetrics

[key: string]: number

Zusätzliche Metriken, die mit dem QnaMessage-Ereignis in Telemetriedaten protokolliert werden sollen.

Gibt zurück

Promise<QnAMakerResult[]>

Eine Zusage, die in das QnAMaker-Ergebnis aufgelöst wird

getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

Generiert eine Antwort aus dem Wissensdatenbank.

function getAnswersRaw(context: TurnContext, options: QnAMakerOptions, telemetryProperties: [key: string]: string, telemetryMetrics: [key: string]: number): Promise<QnAMakerResults>

Parameter

context

TurnContext

Der TurnContext, der die Benutzerfrage enthält, die für Ihre Wissensdatenbank abgefragt werden soll.

options

QnAMakerOptions

Optional. Die QnAMakerOptions für die QnA Maker-Wissensdatenbank. Wenn null, wird die Konstruktoroption für diese Instanz verwendet.

telemetryProperties

[key: string]: string

Optional. Zusätzliche Eigenschaften, die mit dem QnaMessage-Ereignis in Telemetriedaten protokolliert werden sollen.

telemetryMetrics

[key: string]: number

Optional. Zusätzliche Metriken, die mit dem QnaMessage-Ereignis in Telemetriedaten protokolliert werden sollen.

Gibt zurück

Promise<QnAMakerResults>

Eine Liste der Antworten für die Benutzerabfrage, sortiert in abnehmender Reihenfolge der Rangfolge.

getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

Generiert eine Antwort aus dem QnA Maker-Wissensdatenbank.

function getLegacyAnswersRaw(context: TurnContext, options?: QnAMakerOptions, telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: string]: number): Promise<QnAMakerResults>

Parameter

context

TurnContext

Der TurnContext, der die Benutzerfrage enthält, die für Ihre Wissensdatenbank abgefragt werden soll.

options

QnAMakerOptions

Optional. Die QnAMakerOptions für die QnA Maker-Wissensdatenbank. Wenn null, wird die Konstruktoroption für diese Instanz verwendet.

telemetryProperties

[key: string]: string

Optional. Zusätzliche Eigenschaften, die mit dem QnaMessage-Ereignis in Telemetriedaten protokolliert werden sollen.

telemetryMetrics

[key: string]: number

Optional. Zusätzliche Metriken, die mit dem QnaMessage-Ereignis in Telemetriedaten protokolliert werden sollen.

Gibt zurück

Promise<QnAMakerResults>

Eine Liste der Antworten für die Benutzerabfrage, sortiert in abnehmender Reihenfolge der Rangfolge.

getLowScoreVariation(QnAMakerResult[])

Filtert die mehrdeutige Frage für aktives Lernen.

function getLowScoreVariation(queryResult: QnAMakerResult[]): QnAMakerResult[]

Parameter

queryResult

QnAMakerResult[]

Ausgabe der Benutzerabfrage.

Gibt zurück

QnAMakerResult[]

die gefilterten Ergebnisse