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;
    getCompletion(args: ICompletionArgs): Promise<IModelMessage<object>>;
}

Index

Properties

callbacks? completionName

Methods

Properties

`Optional`callbacks

callbacks?: Partial<ICompletionCallbacks>

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

completionName

completionName: string

The unique name of the completion mechanism within the swarm.

Methods

getCompletion

getCompletion(args: ICompletionArgs): Promise<IModelMessage<object>>
Retrieves a completion based on the provided arguments. Generates a model response using the given context and tools.
Parameters
- args: ICompletionArgs
  The arguments required to generate the completion, including client, agent, and message context.
Returns Promise<IModelMessage<object>>
A promise resolving to the generated model message.

Throws
If completion generation fails (e.g., due to invalid arguments, model errors, or tool issues).
- Defined in types.d.ts:2839