QnAMaker class

Pacchetto:

botbuilder-ai

Eseguire query su una knowledge base di QnA Maker per ottenere risposte e fornire commenti e suggerimenti.

Costruttori

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Crea una nuova istanza di QnAMaker.

Proprietà

logPersonalInformation	Ottiene un valore che indica se determinare se registrare informazioni personali provenienti dall'utente.
telemetryClient	Ottiene il BotTelemetryClient attualmente configurato che registra gli eventi.

Metodi

answer(TurnContext)	Chiama generateAnswer() e invia la risposta risultante come risposta all'utente.
callTrain(FeedbackRecords)	Inviare commenti e suggerimenti alla Knowledge Base.
generateAnswer(string | undefined, number, number)	Chiama il servizio QnA Maker per generare risposte per una domanda.
getAnswers(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Chiama il servizio QnA Maker per generare risposte per una domanda.
getAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Genera una risposta dalla Knowledge Base.
getLegacyAnswersRaw(TurnContext, QnAMakerOptions, [key: string]: string, [key: string]: number)	Genera una risposta dalla knowledge base di QnA Maker.
getLowScoreVariation(QnAMakerResult[])	Filtra la domanda ambigua per l'apprendimento attivo.

Dettagli costruttore

QnAMaker(QnAMakerEndpoint, QnAMakerOptions, BotTelemetryClient, boolean)

Crea una nuova istanza di QnAMaker.

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

Parametri

endpoint

QnAMakerEndpoint

Endpoint della Knowledge Base su cui eseguire una query.

options

QnAMakerOptions

(Facoltativo) Impostazioni aggiuntive usate per configurare l'istanza.

telemetryClient

BotTelemetryClient

BotTelemetryClient usato per registrare gli eventi di telemetria.

logPersonalInformation

boolean

Impostare su true per includere informazioni personali negli eventi di telemetria.

Dettagli proprietà

logPersonalInformation

Ottiene un valore che indica se determinare se registrare informazioni personali provenienti dall'utente.

boolean logPersonalInformation

Valore della proprietà

boolean

True se registra le informazioni personali nel metodo BotTelemetryClient.TrackEvent; in caso contrario, le proprietà verranno filtrate.

telemetryClient

Ottiene il BotTelemetryClient attualmente configurato che registra gli eventi.

BotTelemetryClient telemetryClient

Valore della proprietà

BotTelemetryClient

BotTelemetryClient attualmente configurato che registra l'evento QnaMessage.

Dettagli metodo

answer(TurnContext)

Avviso

Questa API è ora deprecata.

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

Chiama generateAnswer() e invia la risposta risultante come risposta all'utente.

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

Parametri

context

TurnContext

Contesto per il turno di conversazione corrente con l'utente.

Restituisce

Promise<boolean>

Una promessa che si risolve in true se è stata inviata una risposta

callTrain(FeedbackRecords)

Inviare commenti e suggerimenti alla Knowledge Base.

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

Parametri

feedbackRecords

FeedbackRecords

Record di feedback.

Restituisce

Promise<void>

Promessa che rappresenta l'operazione asincrona

generateAnswer(string | undefined, number, number)

Avviso

Questa API è ora deprecata.

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

Chiama il servizio QnA Maker per generare risposte per una domanda.

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

Parametri

question

string | undefined

La domanda a cui rispondere.

top

number

(Facoltativo) numero di risposte da restituire. Il valore predefinito è 1.

_scoreThreshold

number

(Facoltativo) Punteggio di risposta minimo necessario per essere considerato una corrispondenza alle domande. Il valore predefinito è 0.001.

Restituisce

Promise<QnAMakerResult[]>

Una promessa che risolve i risultati di QnAMaker

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

Chiama il servizio QnA Maker per generare risposte per una domanda.

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

Parametri

context

TurnContext

Contesto turn che contiene la domanda dell'utente su cui eseguire una query sulla knowledge base.

options

QnAMakerOptions

(Facoltativo) Opzioni per la knowledge base di QnA Maker. Se null, viene usata l'opzione del costruttore per questa istanza.

telemetryProperties

[key: string]: string

Proprietà aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.

telemetryMetrics

[key: string]: number

Metriche aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.

Restituisce

Promise<QnAMakerResult[]>

Una promessa che risolve il risultato di QnAMaker

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

Genera una risposta dalla Knowledge Base.

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

Parametri

context

TurnContext

Il TurnContext che contiene la domanda dell'utente su cui eseguire query sulla knowledge base.

options

QnAMakerOptions

Opzionale. QnAMakerOptions per la knowledge base di QnA Maker. Se null, viene usata l'opzione del costruttore per questa istanza.

telemetryProperties

[key: string]: string

Opzionale. Proprietà aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.

telemetryMetrics

[key: string]: number

Opzionale. Metriche aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.

Restituisce

Promise<QnAMakerResults>

Elenco di risposte per la query dell'utente, ordinato in ordine decrescente del punteggio di classificazione.

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

Genera una risposta dalla knowledge base di QnA Maker.

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

Parametri

context

TurnContext

Il TurnContext che contiene la domanda dell'utente su cui eseguire query sulla knowledge base.

options

QnAMakerOptions

Opzionale. QnAMakerOptions per la knowledge base di QnA Maker. Se null, viene usata l'opzione del costruttore per questa istanza.

telemetryProperties

[key: string]: string

Opzionale. Proprietà aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.

telemetryMetrics

[key: string]: number

Opzionale. Metriche aggiuntive da registrare ai dati di telemetria con l'evento QnaMessage.

Restituisce

Promise<QnAMakerResults>

Elenco di risposte per la query dell'utente, ordinato in ordine decrescente del punteggio di classificazione.

getLowScoreVariation(QnAMakerResult[])

Filtra la domanda ambigua per l'apprendimento attivo.

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

Parametri

queryResult

QnAMakerResult[]

Output della query utente.

Restituisce

QnAMakerResult[]

risultati filtrati