@microsoft/teams-ai/lib/models/PromptCompletionModel.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 EventEmitter from 'events';
import { TurnContext } from 'botbuilder-core';
import { Message, PromptFunctions, PromptTemplate } from '../prompts';
import { Tokenizer } from '../tokenizers';
import { PromptResponse } from '../types';
import { Memory } from '../MemoryFork';
import StrictEventEmitter from '../external/strict-event-emitter-types';
import { StreamingResponse } from '../StreamingResponse';
/**
 * Events emitted by a PromptCompletionModel.
 */
export interface PromptCompletionModelEvents {
    /**
     * Triggered before the model is called to complete a prompt.
     * @param context Current turn context.
     * @param memory An interface for accessing state values.
     * @param functions Functions to use when rendering the prompt.
     * @param tokenizer Tokenizer to use when rendering the prompt.
     * @param template Prompt template being completed.
     * @param streaming `true` if the prompts response is being streamed.
     */
    beforeCompletion: (context: TurnContext, memory: Memory, functions: PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate, streaming: boolean) => void;
    /**
     * Triggered when a chunk is received from the model via streaming.
     * @param context Current turn context.
     * @param memory An interface for accessing state values.
     * @param chunk Message delta received from the model.
     */
    chunkReceived: (context: TurnContext, memory: Memory, chunk: PromptChunk) => void;
    /**
     * Triggered after the model finishes returning a response.
     * @param context Current turn context.
     * @param memory An interface for accessing state values.
     * @param response Final response returned by the model.
     */
    responseReceived: (context: TurnContext, memory: Memory, response: PromptResponse<string>, streamer: StreamingResponse) => void;
}
/**
 * Type signature for the `beforeCompletion` event of a `PromptCompletionModel`.
 */
export type PromptCompletionModelBeforeCompletionEvent = (context: TurnContext, memory: Memory, functions: PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate, streaming: boolean) => void;
/**
 * Type signature for the `chunkReceived` event of a `PromptCompletionModel`.
 */
export type PromptCompletionModelChunkReceivedEvent = (context: TurnContext, memory: Memory, chunk: PromptChunk) => void;
/**
 * Type signature for the `responseReceived` event of a `PromptCompletionModel`.
 */
export type PromptCompletionModelResponseReceivedEvent = (context: TurnContext, memory: Memory, response: PromptResponse<string>, streamer: StreamingResponse) => void;
/**
 * Helper type that strongly types the the EventEmitter for a PromptCOmpletionModel instance.
 */
export type PromptCompletionModelEmitter = StrictEventEmitter<EventEmitter, PromptCompletionModelEvents>;
/**
 * An AI model that can be used to complete prompts.
 */
export interface PromptCompletionModel {
    /**
     * Optional. Events emitted by the model.
     */
    readonly events?: PromptCompletionModelEmitter;
    /**
     * Completes a prompt.
     * @param context Current turn context.
     * @param memory An interface for accessing state values.
     * @param functions Functions to use when rendering the prompt.
     * @param tokenizer Tokenizer to use when rendering the prompt.
     * @param template Prompt template to complete.
     * @returns A `PromptResponse` with the status and message.
     */
    completePrompt(context: TurnContext, memory: Memory, functions: PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate): Promise<PromptResponse<string>>;
}
/**
 * Streaming chunk passed in the `sendChunk` event of a `PromptCompletionClient`.
 */
export interface PromptChunk {
    /**
     * Delta for the response message being buffered up.
     */
    delta?: Partial<Message<string>>;
}
//# sourceMappingURL=PromptCompletionModel.d.ts.map