Edit

Share via

QnAMakerTelemetryClient interface

  • Reference
Package:
botbuilder-ai

Interface for adding telemetry logging capabilities to QnAMaker.

Properties

logPersonalInformation

Gets a value indicating whether determines whether to log personal information that came from the user.
telemetryClient

Gets the currently configured botTelemetryClient that logs the events.

Methods

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

Calls the QnA Maker service to generate answer(s) for a question.

Property Details

logPersonalInformation

Gets a value indicating whether determines whether to log personal information that came from the user.

logPersonalInformation: boolean

Property Value

boolean

telemetryClient

Gets the currently configured botTelemetryClient that logs the events.

telemetryClient: BotTelemetryClient

Property Value

BotTelemetryClient

Method Details

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

Calls the QnA Maker service to generate answer(s) for a question.

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

Parameters

context

TurnContext

The Turn Context that contains the user question to be queried against your knowledge base.

options
QnAMakerOptions

(Optional) The options for the QnA Maker knowledge base. If null, constructor option is used for this instance.

telemetryProperties

[key: string]: string

Additional properties to be logged to telemetry with the QnaMessage event.

telemetryMetrics

[key: string]: number

Additional metrics to be logged to telemetry with the QnaMessage event.

Returns

Promise<QnAMakerResult[]>

A promise resolving to the QnAMaker result