Edit

Share via

EntityRecognizer class

  • Reference
Package:
botbuilder-dialogs-adaptive

Entity recognizers base class.

Extends
AdaptiveRecognizer

Inherited Properties

id

Recognizers unique ID.
logPersonalInformation

(Optional) Flag that designates whether personally identifiable information (PII) should log to telemetry.
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.
recognizeEntities(DialogContext, string, string, Entity[])

Recognizes entities from an Entity list.

Inherited Methods

configure(Record<string, unknown>)

Fluent method for configuring the object.
getConverter(string)

Inherited Property Details

id

Recognizers unique ID.

id: string

Property Value

string

Inherited From Recognizer.id

logPersonalInformation

(Optional) Flag that designates whether personally identifiable information (PII) should log to telemetry.

logPersonalInformation: BoolExpression

Property Value

BoolExpression

Inherited From AdaptiveRecognizer.logPersonalInformation

telemetryClient

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

telemetryClient: BotTelemetryClient

Property Value

BotTelemetryClient

Inherited From Recognizer.telemetryClient

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>

Analysis of utterance.

recognizeEntities(DialogContext, string, string, Entity[])

Recognizes entities from an Entity list.

function recognizeEntities(_dialogContext: DialogContext, _text: string, _locale: string, _entities: Entity[]): Promise<Entity[]>

Parameters

_dialogContext

DialogContext

The DialogContext for the current turn of conversation.

_text

string

Text to recognize.

_locale

string

Locale to use.

_entities

Entity[]

The Entity list to be recognized.

Returns

Promise<Entity[]>

Recognized Entity list.

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