ModelMessageEvent
Defined in: src/hooks/events.ts:637
Event triggered when the model completes a full message. Wraps the assembled message and stop reason after model streaming finishes.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ModelMessageEvent(data): ModelMessageEvent;Defined in: src/hooks/events.ts:644
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { agent: LocalAgent; message: Message; stopReason: StopReason; invocationState: InvocationState; } & HookableEventData |
Returns
Section titled “Returns”ModelMessageEvent
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: "modelMessageEvent";Defined in: src/hooks/events.ts:638
readonly agent: LocalAgent;Defined in: src/hooks/events.ts:639
message
Section titled “message”readonly message: Message;Defined in: src/hooks/events.ts:640
stopReason
Section titled “stopReason”readonly stopReason: StopReason;Defined in: src/hooks/events.ts:641
invocationState
Section titled “invocationState”readonly invocationState: InvocationState;Defined in: src/hooks/events.ts:642
Methods
Section titled “Methods”toJSON()
Section titled “toJSON()”toJSON(): Pick<ModelMessageEvent, "type" | "message" | "stopReason">;Defined in: src/hooks/events.ts:663
Serializes for wire transport, excluding the agent reference and invocationState. Called automatically by JSON.stringify().
Returns
Section titled “Returns”Pick<ModelMessageEvent, "type" | "message" | "stopReason">