QnAMaker class

Paket:

botbuilder-ai

Fragen Sie eine QnA Maker-Wissensbasis 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 Wissensbasis.
generateAnswer(string | undefined, number, number)	Ruft den QnA Maker-Dienst auf, um Antworten für eine Frage zu generieren.
getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Ruft den QnA Maker-Dienst auf, um Antworten für eine Frage zu generieren.
getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Generiert eine Antwort aus der Wissensbasis.
getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Generiert eine Antwort aus der QnA Maker-Wissensbasis.
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 der zu abfragenden Wissensbasis.

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

Auf "true" festlegen, 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 aktuell 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 die aktuelle Unterhaltungswende mit dem Benutzer.

Gibt zurück

Promise<boolean>

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

callTrain(FeedbackRecords)

Senden Sie Feedback an die Wissensbasis.

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 für 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. Der Standardwert ist ein Wert von 1.

_scoreThreshold

number

(Optional) Die mindeste Antwortbewertung muss als Übereinstimmung mit Fragen betrachtet werden. Der Standardwert ist ein Wert von 0.001.

Gibt zurück

Promise<QnAMakerResult[]>

Eine Zusage, die in die QnAMaker-Ergebnisse aufgelöst wird

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

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

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

Parameter

context

TurnContext

Der Kontext turn context that contains the user question to be queried against your knowledge base.

options

QnAMakerOptions

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

telemetryProperties

[key: string]: string

Zusätzliche Eigenschaften, die mit dem QnaMessage-Ereignis an Telemetrie protokolliert werden sollen.

telemetryMetrics

[key: string]: number

Zusätzliche Metriken, die mit dem QnaMessage-Ereignis an Telemetrie protokolliert werden sollen.

Gibt zurück

Promise<QnAMakerResult[]>

Eine Zusage, die zum QnAMaker-Ergebnis aufgelöst wird

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

Generiert eine Antwort aus der Wissensbasis.

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

Parameter

context

TurnContext

Die TurnContext-, die die Benutzerfrage enthält, die anhand Ihrer Wissensdatenbank abgefragt werden soll.

options

QnAMakerOptions

Wahlfrei. Die QnAMakerOptions für die QnA Maker-Wissensbasis. Wenn NULL, wird die Konstruktoroption für diese Instanz verwendet.

telemetryProperties

[key: string]: string

Wahlfrei. Zusätzliche Eigenschaften, die mit dem QnaMessage-Ereignis an Telemetrie protokolliert werden sollen.

telemetryMetrics

[key: string]: number

Wahlfrei. Zusätzliche Metriken, die mit dem QnaMessage-Ereignis an Telemetrie protokolliert werden sollen.

Gibt zurück

Promise<QnAMakerResults>

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

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

Generiert eine Antwort aus der QnA Maker-Wissensbasis.

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

Parameter

context

TurnContext

Die TurnContext-, die die Benutzerfrage enthält, die anhand Ihrer Wissensdatenbank abgefragt werden soll.

options

QnAMakerOptions

Wahlfrei. Die QnAMakerOptions für die QnA Maker-Wissensbasis. Wenn NULL, wird die Konstruktoroption für diese Instanz verwendet.

telemetryProperties

[key: string]: string

Wahlfrei. Zusätzliche Eigenschaften, die mit dem QnaMessage-Ereignis an Telemetrie protokolliert werden sollen.

telemetryMetrics

[key: string]: number

Wahlfrei. Zusätzliche Metriken, die mit dem QnaMessage-Ereignis an Telemetrie protokolliert werden sollen.

Gibt zurück

Promise<QnAMakerResults>

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

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