prompt-model/ai.koog.prompt.message/Message/Assistant

Assistant

data class Assistant @JvmOverloads constructor(val parts: List<ContentPart>, val metaInfo: ResponseMetaInfo, val finishReason: String? = null, val cacheControl: CacheControl? = null) : Message.Response(source)

Represents a message generated by the assistant as a response.

Constructors

constructor(parts: List<ContentPart>, metaInfo: ResponseMetaInfo, finishReason: String? = null, cacheControl: CacheControl? = null)

constructor(part: ContentPart, metaInfo: ResponseMetaInfo, finishReason: String? = null, cacheControl: CacheControl? = null)

Single content part assistant message constructor

constructor(content: String, metaInfo: ResponseMetaInfo, finishReason: String? = null, cacheControl: CacheControl? = null)

Text content assistant message constructor

Properties

val cacheControl: CacheControl?

The cache strategy for this message.

open val content: String

The textual content of the message aggregated from all ContentPart.Text parts joined to String separated by newlines.

val finishReason: String?

An optional explanation for why the assistant's response was finalized. Defaults to null if not provided.

open override val metaInfo: ResponseMetaInfo

Metadata related to the response, including token counts and timestamp.

open override val parts: List<ContentPart>

The parts of the assistant's response.

open override val role: Message.Role

The role associated with the response, which is fixed as Role.Assistant.

Functions

open override fun copy(updatedMetaInfo: ResponseMetaInfo): Message.Assistant

Creates a copy of the current Response instance with updated metadata.

open fun hasAttachments(): Boolean

Checks weather the message consists of attachments.

hasOnlyTextContent

open fun hasOnlyTextContent(): Boolean

Checks weather the message consists of only single text content.

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.