Partager via

QnAMaker class

  • Référence
Paquet:
botbuilder-ai

Interrogez une base de connaissances QnA Maker pour obtenir des réponses et fournir des commentaires.

Constructeurs

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Crée une instance QnAMaker.

Propriétés

logPersonalInformation

Obtient une valeur indiquant si vous souhaitez enregistrer des 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 résultante en tant que réponse à l’utilisateur.
callTrain(FeedbackRecords)

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

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

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

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

Génère une réponse à partir de la 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 de la base de connaissances à interroger.

options
QnAMakerOptions

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

telemetryClient

BotTelemetryClient

BotTelemetryClient utilisé pour journaliser les événements de télémétrie.

logPersonalInformation

boolean

Définissez la valeur 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 vous souhaitez enregistrer des informations personnelles provenant de l’utilisateur.

boolean logPersonalInformation

Valeur de propriété

boolean

True si vous journaliserez des 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 enregistre 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 résultante en tant que réponse à l’utilisateur.

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

Paramètres

context

TurnContext

Contexte pour le tour de conversation actuel avec l’utilisateur.

Retours

Promise<boolean>

Promesse de résolution de la valeur true si une réponse a été envoyée

callTrain(FeedbackRecords)

Envoyez des commentaires à la 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 des réponses pour une question.

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

Paramètres

question

string | undefined

Question à répondre.

top

number

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

_scoreThreshold

number

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

Retours

Promise<QnAMakerResult[]>

Promesse de résolution des résultats QnAMaker

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

Appelle le service QnA Maker pour générer des réponses pour 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 de la base de connaissances QnA Maker. Si la valeur est Null, l’option de constructeur est utilisée pour cette instance.

telemetryProperties

[key: string]: string

Propriétés supplémentaires à journaliser dans la télémétrie avec l’événement QnaMessage.

telemetryMetrics

[key: string]: number

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

Retours

Promise<QnAMakerResult[]>

Promesse de résolution du résultat QnAMaker

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

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

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

Paramètres

context

TurnContext

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

options
QnAMakerOptions

Optionnel. Les QnAMakerOptions pour la base de connaissances QnA Maker. Si la valeur est Null, l’option de constructeur est utilisée pour cette instance.

telemetryProperties

[key: string]: string

Optionnel. Propriétés supplémentaires à journaliser dans la télémétrie avec l’événement QnaMessage.

telemetryMetrics

[key: string]: number

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

Retours

Promise<QnAMakerResults>

Liste des réponses pour la requête utilisateur, triée 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 de la 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

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

options
QnAMakerOptions

Optionnel. Les QnAMakerOptions pour la base de connaissances QnA Maker. Si la valeur est Null, l’option de constructeur est utilisée pour cette instance.

telemetryProperties

[key: string]: string

Optionnel. Propriétés supplémentaires à journaliser dans la télémétrie avec l’événement QnaMessage.

telemetryMetrics

[key: string]: number

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

Retours

Promise<QnAMakerResults>

Liste des réponses pour la requête utilisateur, triée 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[]

résultats filtrés