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

emitAppend

suspend fun emitAppend(text: String)

Emits a StreamFrame.Append with the given text.

emitEnd

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

Emits a StreamFrame.End with the given finishReason.

tryEmitPendingToolCall

suspend fun tryEmitPendingToolCall()

Emits a pendingToolCallRef if it exists and then clears it.

upsertToolCall

suspend fun upsertToolCall(index: Int, id: String? = null, name: String? = null, args: String? = 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.