QnAMakerDialog class

Initializes a new instance of the QnAMakerDialog class.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, suggestionsActivityFactory?: QnASuggestionsActivityFactory, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Parameters

Initializes a new instance of the QnAMakerDialog class.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, activeLearningCardTitle?: string, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Parameters

static $kind: string

Property Value

Gets or sets the card title to use when showing active learning options to the user. Note: If suggestionsActivityFactory is passed in, this member is unused.

activeLearningCardTitle: StringExpression

Property Value

Gets or sets the template to send to the user if they select the no match option on an active learning card.

cardNoMatchResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

Gets or sets the button text to use with active learning options, allowing a user to indicate non of the options are applicable. Note: If suggestionsActivityFactory is passed in, this member is required.

cardNoMatchText: StringExpression

Property Value

Gets or sets a value indicating whether the dialog response should display only precise answers.

displayPreciseAnswerOnly: boolean

Property Value

Gets or sets a value indicating whether to include precise answer in response.

enablePreciseAnswer: boolean

Property Value

Gets or sets the QnA Maker endpoint key to use to query the knowledge base.

endpointKey: StringExpression

Property Value

Gets or sets the metadata and sources used to filter results.

filters: Filters

Property Value

Gets or sets the QnA Maker host URL for the knowledge base.

hostname: StringExpression

Property Value

Gets or sets a value indicating whether to include unstructured sources in search for answers.

includeUnstructuredSources: boolean

Property Value

Gets or sets a value indicating whether gets or sets environment of knowledgebase to be called.

isTest: boolean

Property Value

Gets or sets the QnA Maker knowledge base ID to query.

knowledgeBaseId: StringExpression

Property Value

Gets or sets the flag to determine if personal information should be logged in telemetry.

logPersonalInformation: BoolExpression

Property Value

Gets or sets the template to send to the user when QnA Maker does not find an answer.

noAnswer: TemplateInterface<Partial<Activity>, DialogStateManager>

Property Value

Question answering service type - qnaMaker or language

qnaServiceType: ServiceType

Property Value

Gets or sets the QnA Maker ranker type to use.

rankerType: EnumExpression<RankerTypes>

Property Value

Gets or sets the QnA Maker metadata with which to filter or boost queries to the knowledge base, or null to apply none.

strictFilters: QnAMakerMetadata[]

Property Value

Gets or sets a value - AND or OR - logical operation on list of metadata

strictFiltersJoinOperator: JoinOperator

Property Value

Gets or sets the threshold for answers returned, based on score.

threshold: NumberExpression

Property Value

Gets or sets the maximum number of answers to return from the knowledge base.

top: IntExpression

Property Value

Gets a default end-of-turn result.

static EndOfTurn: DialogTurnResult

Property Value

Remarks

This result indicates that a dialog (or a logical step within a dialog) has completed processing for the current turn, is still active, and is waiting for more input.

Inherited From Dialog.EndOfTurn

id: string

Property Value

Inherited From Dialog.id

telemetryClient: BotTelemetryClient

Property Value

Inherited From Dialog.telemetryClient

Called when the dialog is started and pushed onto the dialog stack.

function beginDialog(dc: DialogContext, options?: object): Promise<DialogTurnResult>

Parameters

Returns

A promise resolving to the turn result

Called when the dialog is continued, where it is the active dialog and the user replies with a new Activity.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parameters

Returns

A Promise representing the asynchronous operation.

function getConverter(property: Object): Converter | ConverterFactory

Parameters

Returns

The expression converter.

Adds a new step to the waterfall.

function addStep(step: WaterfallStep<O>): this

Parameters

Returns

Waterfall dialog for fluent calls to addStep().

Remarks

All step functions should be asynchronous and return a DialogTurnResult. The WaterfallStepContext passed into your function derives from DialogContext and contains numerous stack manipulation methods which return a DialogTurnResult so you can typically just return the result from the DialogContext method you call.

The step function itself can be either an asynchronous closure:

const helloDialog = new WaterfallDialog('hello');

helloDialog.addStep(async (step) => {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
});

A named async function:

async function helloWorldStep(step) {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
}

helloDialog.addStep(helloWorldStep);

Or a class method that's been bound to its this pointer:

helloDialog.addStep(this.helloWorldStep.bind(this));

Inherited From WaterfallDialog.addStep

Fluent method for configuring the object.

function configure(config: Record<string, unknown>): this

Parameters

Returns

The Configurable after the operation is complete.

Inherited From Configurable.configure

Called when the dialog is ending.

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parameters

Returns

Inherited From WaterfallDialog.endDialog

Gets the dialog version, composed of the ID and number of steps.

function getVersion(): string

Returns

Dialog version, composed of the ID and number of steps.

Inherited From WaterfallDialog.getVersion

Called when an event has been raised, using DialogContext.emitEvent(), by either the current dialog or a dialog that the current dialog started.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameters

Returns

True if the event is handled by the current dialog and bubbling should stop.

Inherited From Dialog.onDialogEvent

When overridden in a derived class, reprompts the user for input.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parameters

Returns

Remarks

Derived dialogs that support validation and re-prompt logic should override this method. By default, this method has no effect.

The DialogContext calls this method when the current dialog should re-request input from the user. This method is implemented for prompt dialogs.

See also

• DialogContext.repromptDialog
• Prompt

Inherited From Dialog.repromptDialog

Called when a child WaterfallDialog completed its turn, returning control to this dialog.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Parameters

Returns

A Promise representing the asynchronous operation.

Inherited From WaterfallDialog.resumeDialog