public/api/types/events library
Classes
- DownloadCancelled
- The transfer was cancelled by the caller. Terminal — no event follows.
- DownloadCompleted
- The model is on disk and registered. Terminal — no event follows.
- DownloadEvent
-
Events emitted by
models.download, correlated byDownloadEvent.operationIdand its per-eventsequencecounter. - DownloadExtracting
- The transfer finished and the archive is being unpacked.
- DownloadFailed
- The transfer failed in flight. Terminal — no event follows.
- DownloadProgressEvent
- Bytes are arriving.
- DownloadStarted
- The transfer was admitted and began.
- DownloadVerifying
- Downloaded bytes are being checksummed/validated.
- GenerationCancelled
- Generation was cancelled by the caller. Terminal — no event follows.
- GenerationCompleted
- Decoding finished; carries the aggregate result and metrics. Terminal — no event follows.
- GenerationEvent
-
Events emitted by
llm.generateStreamandvlm.generateStream. - GenerationFailed
- Generation failed in flight. Terminal — no event follows.
- GenerationReasoningDelta
- One reasoning/thinking delta, emitted only when reasoning output is enabled.
- GenerationStarted
- The request was admitted and generation began.
- GenerationTextDelta
- One answer-text delta.
- GenerationToken
- Deprecated v3 shape: one decoded token tagged with kind instead of a dedicated event per stream.
- GenerationToolCall
- Deprecated v3 name for GenerationToolCallAdded.
- GenerationToolCallAdded
- The model asked to call a tool.
- GenerationUsage
- Token accounting for the request so far.
- ImageCompleted
- Sampling finished; carries the images.
- ImageEvent
-
Events emitted by
images.generateStream. - ImageProgress
- One denoising step completed.
- ImageStarted
- Sampling began.
- RagCompleted
- The query finished; carries the grounded answer.
- RagEvent
-
Events emitted by
RagSession.queryStream. - RagRetrieved
- Retrieval finished and produced these chunks.
- RagToken
- One decoded answer token.
- SdkError
- Something went wrong outside a caller's request.
- SdkEvent
-
Lifecycle, download, and error breadcrumbs from
RunAnywhere.events. - SdkModelLoaded
- A model finished loading.
- SdkModelUnloaded
- A model was unloaded.
- SdkReady
- Local inference became usable.
- TranscriptionCancelled
- The stream was cancelled before it produced a final transcript. Terminal.
- TranscriptionCompleted
- The stream settled — TranscriptionFinal (when the session produced one) has already been emitted. Terminal.
- TranscriptionEvent
-
Events emitted by
stt.transcribeStream. - TranscriptionFailed
- The stream ended because of an error. Terminal — no event follows.
- TranscriptionFinal
- The session closed with a settled transcript.
- TranscriptionPartial
- An in-progress hypothesis that may still change.
- TranscriptionStarted
- The session opened and is waiting for audio.
- VadActivity
- One frame's verdict, with no state transition implied.
- VadCompleted
-
The stream finished normally, after
finish()drained the last frame. - VadEvent
-
Events emitted by
vad.openStream. - VadFailed
- The stream failed in flight. Terminal — no event follows.
- VadSpeechEnded
- Speech ended after a run of activity.
- VadSpeechStarted
- Speech began after a run of silence (or stream start).
- VoiceAgentResponse
- The agent produced reply text.
- VoiceAgentStateChanged
- The agent moved between listening, thinking, and speaking.
- VoiceError
- A component of the session hit trouble.
- VoiceEvent
- Events emitted by a VoiceEvent stream on a voice session.
- VoiceSpeechEnded
- Speech on the microphone ended.
- VoiceSpeechStarted
- Speech was detected on the microphone.
- VoiceUserTranscribed
- The user's speech was transcribed.
Enums
- AgentState
- What the voice agent is doing right now.
- TokenKind
- Whether a streamed delta is answer text or chain-of-thought.