Interface ICompletionSchema

Interface representing the schema for configuring a completion mechanism. Defines how completions are generated within the swarm.

interface ICompletionSchema {
    callbacks?: Partial<ICompletionCallbacks>;
    completionName: string;
    flags?: string[];
    getCompletion(
        args: ICompletionArgs,
    ): Promise<IModelMessage<object> | IOutlineMessage>;
    json?: boolean;
}

Properties

callbacks?: Partial<ICompletionCallbacks>

Optional partial set of callbacks for completion events, allowing customization of post-completion behavior.

completionName: string

The unique name of the completion mechanism within the swarm.

flags?: string[]

List of flags for llm model. As example, /no_think for lmstudio-community/Qwen3-32B-GGUF

json?: boolean

Methods