86e693b250
* refactor: model plugin to follow new specs Signed-off-by: James <james@jan.ai> * chore: rebase main chore: rebase main --------- Signed-off-by: James <james@jan.ai> Co-authored-by: James <james@jan.ai> Co-authored-by: Louis <louis@jan.ai>
31 lines
858 B
TypeScript
31 lines
858 B
TypeScript
import { MessageRequest, ModelSettingParams, ThreadMessage } from "../index";
|
|
import { JanPlugin } from "../plugin";
|
|
|
|
/**
|
|
* An abstract class representing an Inference Plugin for Jan.
|
|
*/
|
|
export abstract class InferencePlugin extends JanPlugin {
|
|
/**
|
|
* Initializes the model for the plugin.
|
|
* @param modelId - The ID of the model to initialize.
|
|
*/
|
|
abstract initModel(modelId: string, settings?: ModelSettingParams): Promise<void>;
|
|
|
|
/**
|
|
* Stops the model for the plugin.
|
|
*/
|
|
abstract stopModel(): Promise<void>;
|
|
|
|
/**
|
|
* Stops the streaming inference.
|
|
*/
|
|
abstract stopInference(): Promise<void>;
|
|
|
|
/**
|
|
* Processes an inference request.
|
|
* @param data - The data for the inference request.
|
|
* @returns The result of the inference request.
|
|
*/
|
|
abstract inferenceRequest(data: MessageRequest): Promise<ThreadMessage>;
|
|
}
|