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

StreamFrameFlowBuilder

class StreamFrameFlowBuilder(flowCollector: FlowCollector<StreamFrame>)(source)

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

This is mainly used for combining chunked tool calls and only emit completed tool calls.

Constructors

constructor(flowCollector: FlowCollector<StreamFrame>)

Functions

emitEnd

suspend fun emitEnd(finishReason: String? = null, metaInfo: ResponseMetaInfo? = null)

Emits a StreamFrame.End with the given finishReason.

emitReasoningDelta

suspend fun emitReasoningDelta(id: String? = null, text: String? = null, summary: String? = null, index: Int? = null)

Emits a StreamFrame.ReasoningDelta with the given text.

emitTextDelta

suspend fun emitTextDelta(text: String, index: Int? = null)

Emits a StreamFrame.TextDelta with the given text.

emitToolCallDelta

suspend fun emitToolCallDelta(id: String? = null, name: String? = null, args: String? = null, index: Int? = null)

Updates the coroutine context to signal we're currently combining a tool call, this does not emit anything yet, that happens only in tryEmitPendingToolCall.

tryEmitPendingReasoning

suspend fun tryEmitPendingReasoning()

Emits a pendingReasoningRef if it exists and then clears it.

tryEmitPendingText

suspend fun tryEmitPendingText()

Emits a pendingTextRef if it exists and then clears it.

tryEmitPendingToolCall

suspend fun tryEmitPendingToolCall()

Emits a pendingToolCallRef if it exists and then clears it.