prompt-model/ai.koog.prompt.message/Message/Tool/Call

Call

data class Call(val id: String?, val tool: String, val parts: List<ContentPart.Text>, val metaInfo: ResponseMetaInfo) : Message.Tool, Message.Response(source)

Represents a tool call message sent as a response.

Constructors

constructor(id: String?, tool: String, parts: List<ContentPart.Text>, metaInfo: ResponseMetaInfo)

constructor(id: String?, tool: String, part: ContentPart.Text, metaInfo: ResponseMetaInfo)

Single content part tool call message constructor

constructor(id: String?, tool: String, content: String, metaInfo: ResponseMetaInfo)

Text content tool call message constructor

Properties

open val content: String

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

val contentJson: JsonObject

Lazily parses the content of the tool call as a JSON object. Can throw an exception when parsing fails.

contentJsonResult

val contentJsonResult: Result<JsonObject>

Lazily parses and caches the result of parsing content as a JSON object.

open override val id: String?

The unique identifier of the tool call.

open override val metaInfo: ResponseMetaInfo

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

open override val parts: List<ContentPart.Text>

The parts of the tool call. Only the ContentPart.Text part is allowed.

open override val role: Message.Role

The role associated with the message.

open override val tool: String

The name of the tool being called.

Functions

open override fun copy(updatedMetaInfo: ResponseMetaInfo): Message.Tool.Call

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 sungle 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.