@microsoft/teams-ai/lib/planners/Planner.d.ts

SDK focused on building AI based applications for Microsoft Teams.

/**
 * @module teams-ai
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */
import { TurnContext } from 'botbuilder';
import { TurnState } from '../TurnState';
import { AI } from '../AI';
import { Message } from '../prompts';
/**
 * A planner is responsible for generating a plan that the AI system will execute.
 * @template TState Optional. Type of application state.
 */
export interface Planner<TState extends TurnState = TurnState> {
    /**
     * Starts a new task.
     * @remarks
     * This method is called when the AI system is ready to start a new task. The planner should
     * generate a plan that the AI system will execute. Returning an empty plan signals that
     * there is no work to be performed.
     *
     * The planner should take the users input from `state.temp.input`.
     * @param context Context for the current turn of conversation.
     * @param state Application state for the current turn of conversation.
     * @param ai The AI system that is generating the plan.
     * @returns The plan that was generated.
     */
    beginTask(context: TurnContext, state: TState, ai: AI<TState>): Promise<Plan>;
    /**
     * Continues the current task.
     * @remarks
     * This method is called when the AI system has finished executing the previous plan and is
     * ready to continue the current task. The planner should generate a plan that the AI system
     * will execute. Returning an empty plan signals that the task is completed and there is no work
     * to be performed.
     *
     * The output from the last plan step that was executed is passed to the planner via `state.temp.input`.
     * @param context Context for the current turn of conversation.
     * @param state Application state for the current turn of conversation.
     * @param ai The AI system that is generating the plan.
     * @returns The plan that was generated.
     */
    continueTask(context: TurnContext, state: TState, ai: AI<TState>): Promise<Plan>;
}
/**
 * A plan is a set of commands that the AI system will execute.
 */
export interface Plan {
    /**
     * Type to indicate that a plan is being returned.
     */
    type: 'plan';
    /**
     * Array of predicted commands that the AI system should execute.
     */
    commands: PredictedCommand[];
}
/**
 * A predicted command is a command that the AI system should execute.
 */
export interface PredictedCommand {
    /**
     * Type of command to execute.
     * @remarks
     * DO commands are actions that the AI system should perform. SAY commands are responses that
     * the AI system should say.
     */
    type: 'DO' | 'SAY';
}
/**
 * A predicted DO command is an action that the AI system should perform.
 */
export interface PredictedDoCommand extends PredictedCommand {
    /**
     * Type to indicate that a DO command is being returned.
     */
    type: 'DO';
    /**
     * The named action that the AI system should perform.
     */
    action: string;
    /**
     * Any parameters that the AI system should use to perform the action.
     */
    parameters: Record<string, any>;
    /**
     * Optional. The id mapped to the name action that the AI system should perform.
     * In OpenAI, this is associated with the action_id tool calls.
     */
    actionId?: string;
}
/**
 * A predicted SAY command is a response that the AI system should say.
 */
export interface PredictedSayCommand extends PredictedCommand {
    /**
     * Type to indicate that a SAY command is being returned.
     */
    type: 'SAY';
    /**
     * The response that the AI system should say.
     */
    response: Message<string>;
}
//# sourceMappingURL=Planner.d.ts.map