Class ConversationLearner

Hierarchy

ConversationLearner

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConversationLearner(modelId: string | undefined, maxTimeout?: undefined | number): ConversationLearner

- Defined in ConversationLearner.ts:32
Parameters
- modelId: string | undefined
- Optional maxTimeout: undefined | number
Returns ConversationLearner

Properties

clRunner

clRunner: CLRunner

Static clClient

clClient: CLClient

Static options

options: ICLOptions | null = null

Methods

AddCallback

AddCallback<T>(callback: ICallbackInput<T>): void

- Defined in ConversationLearner.ts:93
Define an API callback that can be used by the Model

Type parameters
- T
Parameters
- callback: ICallbackInput<T>
  
  Object with callback name, optional logic function, and optional render function.
Returns void

EntityDetectionCallback

EntityDetectionCallback(target: EntityDetectionCallback): void

- Defined in ConversationLearner.ts:100
Define an Callback that will be called after Entity Detection

Parameters
- target: EntityDetectionCallback
  
  Callback of the form (text: string, memoryManager: ClientMemoryManager) => Promise
Returns void

InTrainingUI

InTrainingUI(turnContext: TurnContext): Promise<boolean>

- Defined in ConversationLearner.ts:84
Returns true is bot is running in the Training UI

Parameters
- turnContext: TurnContext
  
  BotBuilder Context
Returns Promise<boolean>

OnSessionEndCallback

OnSessionEndCallback(target: OnSessionEndCallback): void

- Defined in ConversationLearner.ts:73
Provide a callback that will be invoked whenever a Session ends. Sessions can end because of a timeout or the selection of an EndSession activity

Parameters
- target: OnSessionEndCallback
  
  Callback of the form (context: BB.TurnContext, memoryManager: ClientMemoryManager, sessionEndState: CLM.SessionEndState, data: string | undefined) => Promise<string[] | undefined>
Returns void

OnSessionStartCallback

OnSessionStartCallback(target: OnSessionStartCallback): void

- Defined in ConversationLearner.ts:64
Provide an callback that will be invoked whenever a Session is started

Parameters
- target: OnSessionStartCallback
  
  Callback of the form (context: BB.TurnContext, memoryManager: ClientMemoryManager) => Promise
Returns void

SendResult

SendResult(result: CLRecognizerResult): Promise<void>

- Defined in ConversationLearner.ts:77
Parameters
- result: CLRecognizerResult
Returns Promise<void>

StartSession

StartSession(turnContext: TurnContext): Promise<void>

- Defined in ConversationLearner.ts:56
OPTIONAL: Sessions are started automatically, StartSession call is only needed if bot needs to start Conversation Learner Session with initial entity values. Results in clearing of existing Entity values, and a call to the OnSessionStartCallback

Parameters
- turnContext: TurnContext
  
  BotBuilder Context
Returns Promise<void>

recognize

recognize(turnContext: TurnContext, force?: undefined | false | true): Promise<CLRecognizerResult | null>

- Defined in ConversationLearner.ts:46
Parameters
- turnContext: TurnContext
- Optional force: undefined | false | true
Returns Promise<CLRecognizerResult | null>

Static Init

Init(options: ICLOptions, storage?: Storage | null): express.Router

- Defined in ConversationLearner.ts:21
Parameters
- options: ICLOptions
- Default value storage: Storage | null = null
Returns express.Router

Generated using TypeDoc