Partager via

QnAMaker class

  • Référence
Paquet:
botbuilder-ai

Interrogez un base de connaissances QnA Maker pour obtenir des réponses et fournissez des commentaires.

Constructeurs

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Crée une instance QnAMaker.

Propriétés

logPersonalInformation

Obtient une valeur indiquant si détermine s’il faut enregistrer les informations personnelles provenant de l’utilisateur.
telemetryClient

Obtient le BotTelemetryClient actuellement configuré qui journalise les événements.

Méthodes

answer(TurnContext)

Appelle generateAnswer() et envoie la réponse obtenue en tant que réponse à l’utilisateur.
callTrain(FeedbackRecords)

Envoyez des commentaires au base de connaissances.
generateAnswer(string | undefined, number, number)

Appelle le service QnA Maker pour générer la ou les réponses à une question.
getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

Appelle le service QnA Maker pour générer la ou les réponses à une question.
getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

Génère une réponse à partir du base de connaissances.
getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)

Génère une réponse à partir du base de connaissances QnA Maker.
getLowScoreVariation(QnAMakerResult[])

Filtre la question ambiguë pour l’apprentissage actif.

Détails du constructeur

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Crée une instance QnAMaker.

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

Paramètres

endpoint
QnAMakerEndpoint

Point de terminaison du base de connaissances à interroger.

options
QnAMakerOptions

(Facultatif) paramètres supplémentaires utilisés pour configurer l’instance.

telemetryClient

BotTelemetryClient

BotTelemetryClient utilisé pour la journalisation des événements de télémétrie.

logPersonalInformation

boolean

Définissez sur true pour inclure des informations d’identification personnelle dans les événements de télémétrie.

Détails de la propriété

logPersonalInformation

Obtient une valeur indiquant si détermine s’il faut enregistrer les informations personnelles provenant de l’utilisateur.

boolean logPersonalInformation

Valeur de propriété

boolean

True si enregistre les informations personnelles dans la méthode BotTelemetryClient.TrackEvent ; sinon, les propriétés seront filtrées.

telemetryClient

Obtient le BotTelemetryClient actuellement configuré qui journalise les événements.

BotTelemetryClient telemetryClient

Valeur de propriété

BotTelemetryClient

BotTelemetryClient actuellement configuré qui journalise l’événement QnaMessage.

Détails de la méthode

answer(TurnContext)

Avertissement

Cette API est à présent déconseillée.

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

Appelle generateAnswer() et envoie la réponse obtenue en tant que réponse à l’utilisateur.

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

Paramètres

context

TurnContext

Contexte de la tour actuelle de la conversation avec l’utilisateur.

Retours

Promise<boolean>

Promesse se résolvant à true si une réponse a été envoyée

callTrain(FeedbackRecords)

Envoyez des commentaires au base de connaissances.

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

Paramètres

feedbackRecords
FeedbackRecords

Enregistrements de commentaires.

Retours

Promise<void>

Promesse représentant l’opération asynchrone

generateAnswer(string | undefined, number, number)

Avertissement

Cette API est à présent déconseillée.

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

Appelle le service QnA Maker pour générer la ou les réponses à une question.

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

Paramètres

question

string | undefined

Question à laquelle répondre.

top

number

(Facultatif) nombre de réponses à retourner. La valeur 1par défaut est .

_scoreThreshold

number

(Facultatif) le score de réponse minimal doit être considéré comme une correspondance aux questions. La valeur 0.001par défaut est .

Retours

Promise<QnAMakerResult[]>

Promesse résolvant les résultats de QnAMaker

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

Appelle le service QnA Maker pour générer la ou les réponses à une question.

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

Paramètres

context

TurnContext

Contexte de tour qui contient la question de l’utilisateur à interroger sur votre base de connaissances.

options
QnAMakerOptions

(Facultatif) Options du base de connaissances QnA Maker. Si la valeur est null, l’option constructeur est utilisée pour cette instance.

telemetryProperties

[key: string]: string

Propriétés supplémentaires à consigner dans les données de télémétrie avec l’événement QnaMessage.

telemetryMetrics

[key: string]: number

Métriques supplémentaires à enregistrer dans la télémétrie avec l’événement QnaMessage.

Retours

Promise<QnAMakerResult[]>

Une promesse résolvant le résultat QnAMaker

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

Génère une réponse à partir du base de connaissances.

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

Paramètres

context

TurnContext

TurnContext qui contient la question de l’utilisateur à interroger sur votre base de connaissances.

options
QnAMakerOptions

facultatif. QnAMakerOptions pour le base de connaissances QnA Maker. Si la valeur est null, l’option constructeur est utilisée pour cette instance.

telemetryProperties

[key: string]: string

facultatif. Propriétés supplémentaires à consigner dans les données de télémétrie avec l’événement QnaMessage.

telemetryMetrics

[key: string]: number

facultatif. Métriques supplémentaires à enregistrer dans la télémétrie avec l’événement QnaMessage.

Retours

Promise<QnAMakerResults>

Liste de réponses pour la requête de l’utilisateur, triées dans l’ordre décroissant du score de classement.

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

Génère une réponse à partir du base de connaissances QnA Maker.

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

Paramètres

context

TurnContext

TurnContext qui contient la question de l’utilisateur à interroger sur votre base de connaissances.

options
QnAMakerOptions

facultatif. QnAMakerOptions pour le base de connaissances QnA Maker. Si la valeur est null, l’option constructeur est utilisée pour cette instance.

telemetryProperties

[key: string]: string

facultatif. Propriétés supplémentaires à consigner dans les données de télémétrie avec l’événement QnaMessage.

telemetryMetrics

[key: string]: number

facultatif. Métriques supplémentaires à enregistrer dans la télémétrie avec l’événement QnaMessage.

Retours

Promise<QnAMakerResults>

Liste de réponses pour la requête de l’utilisateur, triées dans l’ordre décroissant du score de classement.

getLowScoreVariation(QnAMakerResult[])

Filtre la question ambiguë pour l’apprentissage actif.

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

Paramètres

queryResult

QnAMakerResult[]

Sortie de requête utilisateur.

Retours

QnAMakerResult[]

les résultats filtrés