Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CLRunner

Hierarchy

  • CLRunner

Index

Constructors

Properties

Methods

Constructors

Private constructor

  • new CLRunner(configModelId: string | undefined, maxTimeout: number | undefined, client: CLClient): CLRunner

Properties

adapter

adapter: BotAdapter | undefined

callbacks

callbacks: CallbackMap

Private checksum

checksum: string | null = null

clClient

clClient: CLClient

Private configModelId

configModelId: string | undefined

entityDetectionCallback

entityDetectionCallback: EntityDetectionCallback | undefined

Private maxTimeout

maxTimeout: number | undefined

onSessionEndCallback

onSessionEndCallback: OnSessionEndCallback | undefined

onSessionStartCallback

onSessionStartCallback: OnSessionStartCallback | undefined

Static Private Runners

Runners: RunnerLookup

Static Private UIRunner

UIRunner: CLRunner

Methods

AddCallback

Private AddInput

BotStartSession

  • BotStartSession(turnContext: TurnContext): Promise<void>

  • Parameters

    • turnContext: TurnContext

    Returns Promise<void>

CallEntityDetectionCallback

  • CallEntityDetectionCallback(text: string, predictedEntities: PredictedEntity[], clMemory: CLMemory, allEntities: EntityBase[], skipEntityDetectionCallBack?: boolean): Promise<ScoreInput>

  • Parameters

    • text: string
    • predictedEntities: PredictedEntity[]
    • clMemory: CLMemory
    • allEntities: EntityBase[]
    • Default value skipEntityDetectionCallBack: boolean = false

    Returns Promise<ScoreInput>

Protected CheckSessionEndCallback

  • CheckSessionEndCallback(clMemory: CLMemory, entities: EntityBase[], sessionEndState: SessionEndState, data?: undefined | string): Promise<void>

  • Parameters

    • clMemory: CLMemory
    • entities: EntityBase[]
    • sessionEndState: SessionEndState
    • Optional data: undefined | string

    Returns Promise<void>

Protected CheckSessionStartCallback

  • CheckSessionStartCallback(clMemory: CLMemory, entities: EntityBase[]): Promise<void>

Private CreateFilledEntityMap

  • CreateFilledEntityMap(filledEntities: FilledEntity[], entityList: EntityList): FilledEntityMap

  • Parameters

    • filledEntities: FilledEntity[]
    • entityList: EntityList

    Returns FilledEntityMap

Private CreateMemoryManagerAsync

  • CreateMemoryManagerAsync(clMemory: CLMemory, allEntities: EntityBase[], prevMemories?: CLM.FilledEntityMap): Promise<ClientMemoryManager>

Private CreateReadOnlyMemoryManagerAsync

DialogValidationErrors

  • DialogValidationErrors(trainDialog: TrainDialog, entities: EntityBase[], actions: ActionBase[]): string[]

  • Identify any validation issues Missing Entities Missing Actions Unavailable Actions

    Parameters

    • trainDialog: TrainDialog
    • entities: EntityBase[]
    • actions: ActionBase[]

    Returns string[]

EndSessionAsync

  • EndSessionAsync(memory: CLMemory, sessionEndState: SessionEndState, data?: undefined | string): Promise<void>

  • Parameters

    • memory: CLMemory
    • sessionEndState: SessionEndState
    • Optional data: undefined | string

    Returns Promise<void>

Private GetArguments

  • GetArguments(func: Function, skip?: number): string[]

  • Parameters

    • func: Function
    • Default value skip: number = 0

    Returns string[]

GetHistory

  • GetHistory(trainDialog: TrainDialog, userName: string, userId: string, clMemory: CLMemory): Promise<TeachWithHistory | null>

  • Get Activities generated by trainDialog. Return any errors in TrainDialog NOTE: Will set bot memory to state at end of history

    Parameters

    • trainDialog: TrainDialog
    • userName: string
    • userId: string
    • clMemory: CLMemory

    Returns Promise<TeachWithHistory | null>

Private GetRenderedArguments

  • GetRenderedArguments(fnArgs: string[], actionArgs: ActionArgument[], filledEntityMap: FilledEntityMap): string[]

  • Parameters

    • fnArgs: string[]
    • actionArgs: ActionArgument[]
    • filledEntityMap: FilledEntityMap

    Returns string[]

Private GetRunningApp

  • GetRunningApp(turnContext: TurnContext, inEditingUI: boolean): Promise<AppBase | null>

  • Parameters

    • turnContext: TurnContext
    • inEditingUI: boolean

    Returns Promise<AppBase | null>

Private GetTurnContext

  • GetTurnContext(clMemory: CLMemory): Promise<TurnContext>

InTrainingUI

  • InTrainingUI(turnContext: TurnContext): Promise<boolean>

  • Parameters

    • turnContext: TurnContext

    Returns Promise<boolean>

Private InitReplayMemory

  • InitReplayMemory(clMemory: CLMemory, trainDialog: TrainDialog, allEntities: EntityBase[]): Promise<void>

  • Initialize memory for replay

    Parameters

    • clMemory: CLMemory
    • trainDialog: TrainDialog
    • allEntities: EntityBase[]

    Returns Promise<void>

Private PopulateMissingFilledEntities

  • PopulateMissingFilledEntities(action: ActionBase, filledEntityMap: FilledEntityMap, allEntities: EntityBase[]): string[]

  • Provide empty FilledEntity for any missing entities so they can still be rendered

    Parameters

    • action: ActionBase
    • filledEntityMap: FilledEntityMap
    • allEntities: EntityBase[]

    Returns string[]

Private PopulatePrebuilts

  • PopulatePrebuilts(predictedEntities: PredictedEntity[], filledEntities: FilledEntity[]): void

  • Populate prebuilt information in predicted entities given filled entity array

    Parameters

    • predictedEntities: PredictedEntity[]
    • filledEntities: FilledEntity[]

    Returns void

Private ProcessFormData

  • ProcessFormData(request: Activity, clMemory: CLMemory, appId: string): Promise<string | null>

  • Parameters

    • request: Activity
    • clMemory: CLMemory
    • appId: string

    Returns Promise<string | null>

Private ProcessInput

Private ProcessPredictedEntities

  • ProcessPredictedEntities(text: string, memory: BotMemory, predictedEntities: PredictedEntity[], allEntities: EntityBase[]): Promise<void>

  • Parameters

    • text: string
    • memory: BotMemory
    • predictedEntities: PredictedEntity[]
    • allEntities: EntityBase[]

    Returns Promise<void>

Private RenderAPICard

  • RenderAPICard(callback: Callback, args: string[]): Partial<Activity>

  • Parameters

    • callback: Callback
    • args: string[]

    Returns Partial<Activity>

Private RenderErrorCard

  • RenderErrorCard(title: string, error: string): Partial<Activity>

  • Parameters

    • title: string
    • error: string

    Returns Partial<Activity>

ReplayTrainDialogLogic

  • ReplayTrainDialogLogic(trainDialog: TrainDialog, clMemory: CLMemory, cleanse: boolean): Promise<TrainDialog>

  • Replay a TrainDialog, calling EntityDetection callback and API Logic, recalculating FilledEntities along the way

    Parameters

    • trainDialog: TrainDialog
    • clMemory: CLMemory
    • cleanse: boolean

    Returns Promise<TrainDialog>

Private Score

  • Score(appId: string, sessionId: string, memory: CLMemory, text: string, predictedEntities: PredictedEntity[], allEntities: EntityBase[], inTeach: boolean, skipEntityDetectionCallBack?: boolean): Promise<ScoredAction>

  • Parameters

    • appId: string
    • sessionId: string
    • memory: CLMemory
    • text: string
    • predictedEntities: PredictedEntity[]
    • allEntities: EntityBase[]
    • inTeach: boolean
    • Default value skipEntityDetectionCallBack: boolean = false

    Returns Promise<ScoredAction>

SendIntent

Private SendMessage

  • SendMessage(memory: CLMemory, message: string | Partial<Activity>, incomingActivityId?: string | undefined): Promise<void>

  • Parameters

    • memory: CLMemory
    • message: string | Partial<Activity>
    • Optional incomingActivityId: string | undefined

    Returns Promise<void>

SetAdapter

  • SetAdapter(adapter: BotAdapter, conversationReference: Partial<ConversationReference>): void

  • Parameters

    • adapter: BotAdapter
    • conversationReference: Partial<ConversationReference>

    Returns void

StartSessionAsync

  • StartSessionAsync(clMemory: CLMemory, conversationId: string | null, appId: string, sessionStartFlags: SessionStartFlags, createParams: SessionCreateParams | CreateTeachParams): Promise<Teach | Session>

  • Parameters

    • clMemory: CLMemory
    • conversationId: string | null
    • appId: string
    • sessionStartFlags: SessionStartFlags
    • createParams: SessionCreateParams | CreateTeachParams

    Returns Promise<Teach | Session>

TakeAPIAction

  • TakeAPIAction(apiAction: ApiAction, filledEntityMap: FilledEntityMap, clMemory: CLMemory, allEntities: EntityBase[], inTeach: boolean, actionInput: IActionInput): Promise<IActionResult>

TakeActionAsync

  • TakeActionAsync(conversationReference: Partial<ConversationReference>, clRecognizeResult: CLRecognizerResult, clData: CLChannelData | null): Promise<IActionResult>

TakeCardAction

  • TakeCardAction(cardAction: CardAction, filledEntityMap: FilledEntityMap): Promise<Partial<Activity> | string>

  • Parameters

    • cardAction: CardAction
    • filledEntityMap: FilledEntityMap

    Returns Promise<Partial<Activity> | string>

Private TakeSessionAction

  • TakeSessionAction(sessionAction: SessionAction, filledEntityMap: FilledEntityMap, inTeach: boolean, clMemory: CLMemory, sessionId: string | null, app: AppBase | null): Promise<Partial<Activity> | null>

  • Parameters

    • sessionAction: SessionAction
    • filledEntityMap: FilledEntityMap
    • inTeach: boolean
    • clMemory: CLMemory
    • sessionId: string | null
    • app: AppBase | null

    Returns Promise<Partial<Activity> | null>

TakeTextAction

  • TakeTextAction(textAction: TextAction, filledEntityMap: FilledEntityMap): Promise<Partial<Activity> | string>

  • Parameters

    • textAction: TextAction
    • filledEntityMap: FilledEntityMap

    Returns Promise<Partial<Activity> | string>

botChecksum

  • botChecksum(): string

convertInternalCallbackToCallback

isActionAvailable

  • isActionAvailable(action: ActionBase, filledEntities: FilledEntity[]): boolean

  • Parameters

    • action: ActionBase
    • filledEntities: FilledEntity[]

    Returns boolean

onTurn

  • onTurn(turnContext: TurnContext, next: function): Promise<void>

recognize

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

validateTrainDialogs

  • validateTrainDialogs(appDefinition: AppDefinition): string[]

  • Return a list of trainDialogs that are invalid for the given set of entities and actions

    Parameters

    • appDefinition: AppDefinition

    Returns string[]

Static Create

  • Create(configModelId: string | undefined, maxTimeout: number | undefined, client: CLClient): CLRunner

Static GetRunnerForUI

  • GetRunnerForUI(appId?: undefined | string): CLRunner

Generated using TypeDoc