BeforeModelCallEvent
Defined in: src/hooks/events.ts:407
Event triggered just before the model is invoked. Fired before sending messages to the model for inference.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BeforeModelCallEvent(data): BeforeModelCallEvent;Defined in: src/hooks/events.ts:428
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { agent: LocalAgent; model: Model; invocationState: InvocationState; projectedInputTokens?: number; } & HookableEventData |
Returns
Section titled “Returns”BeforeModelCallEvent
Overrides
Section titled “Overrides”Properties
Section titled “Properties”invocationContext?
Section titled “invocationContext?”readonly invocationContext?: InvocationContext;Defined in: src/hooks/events.ts:100
The request this event belongs to (undefined outside one); pass it to InvokeOptions.invocationContext to join it.
Inherited from
Section titled “Inherited from”HookableEvent.invocationContext
readonly type: "beforeModelCallEvent";Defined in: src/hooks/events.ts:408
readonly agent: LocalAgent;Defined in: src/hooks/events.ts:409
readonly model: Model;Defined in: src/hooks/events.ts:410
invocationState
Section titled “invocationState”readonly invocationState: InvocationState;Defined in: src/hooks/events.ts:411
cancel
Section titled “cancel”cancel: string | boolean = false;Defined in: src/hooks/events.ts:418
Set by hook callbacks to cancel this model call.
When set to true, a default cancel message is used.
When set to a string, that string is used as the assistant response message.
projectedInputTokens?
Section titled “projectedInputTokens?”readonly projectedInputTokens?: number;Defined in: src/hooks/events.ts:426
Projected input token count for the upcoming model call. Computed by the agent loop from message metadata and token estimation. Available for hooks and plugins (e.g. conversation managers) to make proactive decisions about context management.
Methods
Section titled “Methods”toJSON()
Section titled “toJSON()”toJSON(): Pick<BeforeModelCallEvent, "type" | "projectedInputTokens">;Defined in: src/hooks/events.ts:449
Serializes for wire transport, excluding the agent reference and invocationState. Called automatically by JSON.stringify().
Returns
Section titled “Returns”Pick<BeforeModelCallEvent, "type" | "projectedInputTokens">