Skip to content

ModelMessageStopEvent

Defined in: src/models/streaming.ts:204

Event emitted when the message completes.

new ModelMessageStopEvent(data): ModelMessageStopEvent;

Defined in: src/models/streaming.ts:220

ParameterType
dataModelMessageStopEventData

ModelMessageStopEvent

readonly type: "modelMessageStopEvent";

Defined in: src/models/streaming.ts:208

Discriminator for message stop events.

ModelMessageStopEventData.type


readonly stopReason: StopReason;

Defined in: src/models/streaming.ts:213

Reason why generation stopped.

ModelMessageStopEventData.stopReason


readonly optional additionalModelResponseFields?: JSONValue;

Defined in: src/models/streaming.ts:218

Additional provider-specific response fields.

ModelMessageStopEventData.additionalModelResponseFields