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

Message

Represents a message exchanged in a chat with LLM. Messages can be categorized by their type and role, denoting the purpose and source of the message.

Represents both a message from LLM and a message to LLM from user or environment.

Inheritors

Request

Response

Tool

Types

Assistant

@Serializable

data class Assistant(val parts: List<ContentPart>, val metaInfo: ResponseMetaInfo, val finishReason: String? = null) : Message.Response

Represents a message generated by the assistant as a response.

Reasoning

@Serializable

data class Reasoning(val id: String? = null, val encrypted: String? = null, val parts: List<ContentPart.Text>, val metaInfo: ResponseMetaInfo) : Message.Response

Represents a reasoning message exchanged in a chat system, encapsulating the content, role, and associated metadata, with an optional reference to the original thinking process.

Request

@Serializable

sealed interface Request : Message

Represents a request message in the chat.

Response

@Serializable

sealed interface Response : Message

Represents a response message in the chat.

Role

@Serializable

enum Role : Enum<Message.Role>

Defines the role of the message in the chat (e.g., system, user, assistant, tool).

System

@Serializable

data class System(val parts: List<ContentPart.Text>, val metaInfo: RequestMetaInfo) : Message.Request

Represents a system-generated message.

Tool

@Serializable

sealed interface Tool : Message

Represents messages exchanged with tools, either as calls or results.

User

@Serializable

data class User @JvmOverloads constructor(val parts: List<ContentPart>, val metaInfo: RequestMetaInfo) : Message.Request

Represents a message sent by the user as a request.

Properties

content

open val content: String

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

metaInfo

abstract val metaInfo: MessageMetaInfo

Stores metadata information for the current message instance, such as token count and timestamp.

parts

abstract val parts: List<ContentPart>

The content parts of the message. By default, if the message is a single text message, it will contain a single ContentPart.Text part. If the message contains multiple parts, it will contain an ordered list of ContentPart.Text and ContentPart.Attachment instances.

role

abstract val role: Message.Role

The role associated with the message.

Functions

hasAttachments

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.