prompt-model/ai.koog.prompt.streaming

Package-level declarations

Types

class IncompleteStreamException(message: String = "Stream completed without receiving an End frame", cause: Throwable? = null) : Exception

Signals that a streaming response terminated without receiving a StreamFrame.End frame.

StreamFrame

@Serializable

sealed interface StreamFrame

Represents a frame of a streaming response from a LLM.

StreamFrameFlowBuilder

class StreamFrameFlowBuilder(flowCollector: FlowCollector<StreamFrame>)

Represents a wrapper around a FlowCollector that provides methods for emitting StreamFrame objects.

StreamFrameFlowBuilderError

sealed class StreamFrameFlowBuilderError : Throwable

Represents an error that can occur during buildStreamFrameFlow operations.

Functions

buildStreamFrameFlow

fun buildStreamFrameFlow(block: suspend StreamFrameFlowBuilder.() -> Unit): Flow<StreamFrame>

Builds a Flow of StreamFrame objects. Should be used only in case model does not produce completion events.

collectText

suspend fun Flow<StreamFrame>.collectText(): String

Collects the textual content of a Flow of StreamFrame objects and returns it as a single string.

emitEnd

suspend fun FlowCollector<StreamFrame>.emitEnd(finishReason: String? = null, metaInfo: ResponseMetaInfo? = null)

Emits a StreamFrame.End with the given finishReason.

emitReasoningComplete

suspend fun FlowCollector<StreamFrame>.emitReasoningComplete(id: String? = null, text: String, summary: String? = null, encrypted: String? = null, index: Int? = null)

suspend fun FlowCollector<StreamFrame>.emitReasoningComplete(id: String? = null, text: List<String>, summary: List<String>? = null, encrypted: String? = null, index: Int? = null)

Emits a StreamFrame.ReasoningComplete with the given text.

emitReasoningDelta

suspend fun FlowCollector<StreamFrame>.emitReasoningDelta(id: String? = null, text: String? = null, summary: String? = null, index: Int? = null)

Emits a StreamFrame.ReasoningDelta with the given text and summary.

emitTextComplete

suspend fun FlowCollector<StreamFrame>.emitTextComplete(text: String, index: Int? = null)

Emits a StreamFrame.TextComplete with the given text.

emitTextDelta

suspend fun FlowCollector<StreamFrame>.emitTextDelta(text: String, index: Int? = null)

Emits a StreamFrame.TextDelta with the given text.

emitToolCallComplete

suspend fun FlowCollector<StreamFrame>.emitToolCallComplete(id: String?, name: String, content: String, index: Int? = null)

Emits a StreamFrame.ToolCallComplete with the given id, name and content.

emitToolCallDelta

suspend fun FlowCollector<StreamFrame>.emitToolCallDelta(id: String?, name: String?, content: String?, index: Int? = null)

Emits a StreamFrame.ToolCallDelta with the given id, name and content.

filterTextOnly

fun Flow<StreamFrame>.filterTextOnly(): Flow<String>

Returns a transformed flow of StreamFrame.TextDelta objects that contains only the textual content.

requireEndFrame

fun Flow<StreamFrame>.requireEndFrame(): Flow<StreamFrame>

Ensures that the stream contains a StreamFrame.End frame before completing.

streamFrameFlow

fun streamFrameFlow(block: suspend FlowCollector<StreamFrame>.() -> Unit): Flow<StreamFrame>

Builds a Flow of StreamFrame objects.

streamFrameFlowOf

fun streamFrameFlowOf(vararg content: String): Flow<StreamFrame.TextDelta>

Create a Flow of StreamFrame.TextDelta objects from a list of String content.

toAssistantMessageOrNull

fun Iterable<StreamFrame>.toAssistantMessageOrNull(): Message.Assistant?

Extracts the assistant response from frames, if any.

toMessageResponses

fun Iterable<StreamFrame>.toMessageResponses(): List<Message.Response>

Converts frames into Message.Response objects.

toReasoningMessageOrNull

fun Iterable<StreamFrame>.toReasoningMessageOrNull(): Message.Reasoning?

Extracts the reasoning response from frames, if any.

toStreamFrames

fun List<Message.Response>.toStreamFrames(): List<StreamFrame>

Converts a list of Message.Response to a list of StreamFrame. Final StreamFrame.End is also emitted.

fun Message.Response.toStreamFrames(index: Int? = null): List<StreamFrame>

Converts a Message.Response to a list of StreamFrame. First it emits the delta frames for each content part for each message, then complete frame with the full message content.

toToolCallMessages

fun Iterable<StreamFrame>.toToolCallMessages(): List<Message.Tool.Call>

Extracts only tool calls from frames.