prompt-model/ai.koog.prompt.streaming

Package-level declarations

Types

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.

collectText

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

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

emitAppend

suspend fun FlowCollector<StreamFrame>.emitAppend(text: String)

Emits a StreamFrame.Append with the given text.

emitEnd

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

Emits a StreamFrame.End with the given finishReason.

emitToolCall

suspend fun FlowCollector<StreamFrame>.emitToolCall(id: String?, name: String, content: String)

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

filterTextOnly

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

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

streamFrameFlow

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

Builds a Flow of StreamFrame objects.

streamFrameFlowOf

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

Create a Flow of StreamFrame.Append 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.

toStreamFrame

fun Message.Response.toStreamFrame(): StreamFrame

Converts a Message.Response to a StreamFrame.

toToolCallMessages

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

Extracts only tool calls from frames.