@conversationlearner/sdk/lib/ConversationLearner.d.ts

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */
import * as BB from 'botbuilder';
import { CLRunner, EntityDetectionCallback, OnSessionStartCallback, OnSessionEndCallback, ICallbackInput } from './CLRunner';
import { ICLOptions } from './CLOptions';
import { CLClient } from './CLClient';
import { CLRecognizerResult } from './CLRecognizeResult';
import * as express from 'express';
export declare class ConversationLearner {
    static options: ICLOptions | null;
    static clClient: CLClient;
    clRunner: CLRunner;
    static Init(options: ICLOptions, storage?: BB.Storage | null): express.Router;
    constructor(modelId: string | undefined, maxTimeout?: number);
    recognize(turnContext: BB.TurnContext, force?: boolean): Promise<CLRecognizerResult | null>;
    /**
     * 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
     * @param turnContext BotBuilder Context
     */
    StartSession(turnContext: BB.TurnContext): Promise<void>;
    /**
     * Provide an callback that will be invoked whenever a Session is started
     * @param target Callback of the form (context: BB.TurnContext, memoryManager: ClientMemoryManager) => Promise<void>
     */
    OnSessionStartCallback(target: OnSessionStartCallback): void;
    /**
     * 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
     * @param target Callback of the form (context: BB.TurnContext, memoryManager: ClientMemoryManager, sessionEndState: CLM.SessionEndState, data: string | undefined) => Promise<string[] | undefined>
     */
    OnSessionEndCallback(target: OnSessionEndCallback): void;
    SendResult(result: CLRecognizerResult): Promise<void>;
    /** Returns true is bot is running in the Training UI
     * @param turnContext BotBuilder Context
     */
    InTrainingUI(turnContext: BB.TurnContext): Promise<boolean>;
    /**
     * Define an API callback that can be used by the Model
     * @param callback Object with callback name, optional logic function, and optional render function.
     */
    AddCallback<T>(callback: ICallbackInput<T>): void;
    /** Define an Callback that will be called after Entity Detection
     * @param target Callback of the form (text: string, memoryManager: ClientMemoryManager) => Promise<void>
     */
    EntityDetectionCallback(target: EntityDetectionCallback): void;
}