Edit

Share via

ValueRecognizer class

  • Reference
Package:
botbuilder-dialogs-adaptive

ValueRecognizer - Recognizer for mapping message activity. Value payload into intent/entities.

Extends
AdaptiveRecognizer

Remarks

This recognizer will map MessageActivity Value payloads into intents and entities. activity.Value.intent => RecognizerResult.Intents. activity.Value.properties => RecognizerResult.Entities.

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, Activity, [key: string]: string, [key: string]: number)

Runs current DialogContext.TurnContext.Activity through a recognizer and returns a RecognizerResult.

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, Activity, [key: string]: string, [key: string]: number)

Runs current DialogContext.TurnContext.Activity through a recognizer and returns a RecognizerResult.

function recognize(dialogContext: DialogContext, activity: Activity, telemetryProperties?: [key: string]: string, telemetryMetrics?: [key: string]: number): Promise<RecognizerResult>

Parameters

dialogContext

DialogContext

The DialogContext for the current turn of conversation.

activity

Activity

(xref:botframework-schema.Activity) to recognize.

telemetryProperties

[key: string]: string

Optional, additional properties to be logged to telemetry with the LuisResult event.

telemetryMetrics

[key: string]: number

Optional, additional metrics to be logged to telemetry with the LuisResult event.

Returns

Promise<RecognizerResult>

Analysis of utterance.

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