prompt-model/ai.koog.prompt.streaming/StreamFrame

StreamFrame

@Serializable

sealed interface StreamFrame(source)

Represents a frame of a streaming response from a LLM.

Inheritors

Types

CompleteFrame

sealed interface CompleteFrame : StreamFrame

The interface representing a complete frame of a streaming response from a LLM.

DeltaFrame

sealed interface DeltaFrame : StreamFrame

The interface representing a delta or partial frame of a streaming response from a LLM.

End

@Serializable

data class End(val finishReason: String? = null, val metaInfo: ResponseMetaInfo = ResponseMetaInfo.Empty) : StreamFrame

Represents a frame of a streaming response from a LLM that signals the end of the stream.

ReasoningComplete

@Serializable

data class ReasoningComplete(val id: String?, val text: List<String>, val summary: List<String>? = null, val encrypted: String? = null, val index: Int? = null) : StreamFrame.CompleteFrame, StreamFrame

Represents a frame of a streaming response from a LLM with reasoning text delta.

ReasoningDelta

@Serializable

data class ReasoningDelta(val id: String? = null, val text: String? = null, val summary: String? = null, val index: Int? = null) : StreamFrame.DeltaFrame, StreamFrame

Represents a frame of a streaming response from a LLM with reasoning text delta.

TextComplete

@Serializable

data class TextComplete(val text: String, val index: Int? = null) : StreamFrame.CompleteFrame, StreamFrame

Represents a completion of a streaming response text part.

TextDelta

@Serializable

data class TextDelta(val text: String, val index: Int? = null) : StreamFrame.DeltaFrame, StreamFrame

Represents a frame of a streaming response from a LLM with text delta.

ToolCallComplete

@Serializable

data class ToolCallComplete(val id: String?, val name: String, val content: String, val index: Int? = null) : StreamFrame.CompleteFrame, StreamFrame

Represents a frame of a streaming response from a LLM that contains a tool call.

ToolCallDelta

@Serializable

data class ToolCallDelta(val id: String?, val name: String?, val content: String?, val index: Int? = null) : StreamFrame.DeltaFrame, StreamFrame

Represents a frame of a streaming response from a LLM that contains a tool call.