Edit

Share via

TextEntityRecognizer class

  • Reference
Package:
botbuilder-dialogs-adaptive

TextEntityRecognizer - base class for Text.Recogizers from the text recognizer library.

Extends
EntityRecognizer

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

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)
recognize(DialogContext, Partial<Activity>, Record<string, string>, Record<string, number>)

To recognize intents and entities in a users utterance.

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

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 array to be recognized.

Returns

Promise<Entity[]>

Recognized Entity list Promise.

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

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.

Inherited From EntityRecognizer.recognize