Edit

Share via

Recognizer class

  • Reference
Package:
botbuilder-dialogs

Recognizer base class.

Extends
Configurable

Properties

id

Recognizers unique ID.
telemetryClient

The telemetry client for logging events. Default this to the NullTelemetryClient, which does nothing.

Methods

recognize(DialogContext, Partial<Activity>, Record<string, string>, Record<string, number>)

To recognize intents and entities in a users utterance.

Inherited Methods

configure(Record<string, unknown>)

Fluent method for configuring the object.
getConverter(string)

Property Details

id

Recognizers unique ID.

id: string

Property Value

string

telemetryClient

The telemetry client for logging events. Default this to the NullTelemetryClient, which does nothing.

telemetryClient: BotTelemetryClient

Property Value

BotTelemetryClient

Method Details

recognize(DialogContext, Partial<Activity>, Record<string, string>, Record<string, number>)

To recognize intents and entities in a users utterance.

function recognize(_dialogContext: DialogContext, _activity: Partial<Activity>, _telemetryProperties?: Record<string, string>, _telemetryMetrics?: Record<string, number>): Promise<RecognizerResult>

Parameters

_dialogContext
DialogContext

Dialog Context.

_activity

Partial<Activity>

Activity.

_telemetryProperties

Record<string, string>

Additional properties to be logged to telemetry with event.

_telemetryMetrics

Record<string, number>

Additional metrics to be logged to telemetry with event.

Returns

Promise<RecognizerResult>

Inherited Method Details

configure(Record<string, unknown>)

Fluent method for configuring the object.

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

Parameters

config

Record<string, unknown>

Configuration settings to apply.

Returns

this

The Configurable after the operation is complete.

Inherited From Configurable.configure

getConverter(string) 

function getConverter(_property: string): Converter | ConverterFactory

Parameters

_property

string

The key of the conditional selector configuration.

Returns

Converter | ConverterFactory

The converter for the selector configuration.

Inherited From Configurable.getConverter