prompt-model/ai.koog.prompt.message

Package-level declarations

Types

AssistantMessageBuilder

class AssistantMessageBuilder

Builder for creating Message.Assistant instances from Java code.

AttachmentContent

@Serializable

sealed interface AttachmentContent

Content of the attachment, check implementation nested classes for supported content types.

AttachmentSource

@Serializable

sealed interface AttachmentSource

Source of the attachment.

CacheControl

interface CacheControl

Cache control configuration for prompt caching. Indicates that the LLM provider should cache content up to and including the element this is attached to.

LLMChoice

typealias LLMChoice = List<Message.Assistant>

A list of Message.Assistant responses representing multiple completion choices from the LLM.

Message

@Serializable

sealed interface 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.

MessageBuilder

object MessageBuilder

Entry point for creating Message instances from Java code using the builder pattern.

MessageMetaInfo

@Serializable

sealed interface MessageMetaInfo

Meta-information associated with a message in a chat system.

MessagePart

@Serializable

sealed interface MessagePart

A discrete piece of content within a Message. Parts are typed by their direction and purpose: RequestPart parts go to the LLM, ResponsePart parts come from the LLM, and ContentPart parts (text, attachments) are valid in both directions.

ReasoningBuilder

class ReasoningBuilder

Builder for creating MessagePart.Reasoning instances from Java code.

RequestMetaInfo

@Serializable

data class RequestMetaInfo @JvmOverloads constructor(val timestamp: Instant, val metadata: JsonObject? = null) : MessageMetaInfo

Represents MessageMetaInfo specific to a request within the system.

RequestMetaInfoBuilder

class RequestMetaInfoBuilder

Builder for creating RequestMetaInfo instances from Java code.

ResponseMetaInfo

@Serializable

data class ResponseMetaInfo @JvmOverloads constructor(val timestamp: Instant, val totalTokensCount: Int? = null, val inputTokensCount: Int? = null, val outputTokensCount: Int? = null, val modelId: String? = null, val metadata: JsonObject? = null) : MessageMetaInfo

Represents metadata associated with a response message in a chat system.

ResponseMetaInfoBuilder

class ResponseMetaInfoBuilder

Builder for creating ResponseMetaInfo instances from Java code.

SystemMessageBuilder

class SystemMessageBuilder

Builder for creating Message.System instances from Java code.

ToolCallBuilder

class ToolCallBuilder

Builder for creating MessagePart.Tool.Call instances from Java code.

ToolResultBuilder

class ToolResultBuilder

Builder for creating MessagePart.Tool.Result instances from Java code.

UserMessageBuilder

class UserMessageBuilder

Builder for creating Message.User instances from Java code.

Functions

builder

fun RequestMetaInfo.Companion.builder(): RequestMetaInfoBuilder

Creates a new RequestMetaInfoBuilder.

fun ResponseMetaInfo.Companion.builder(): ResponseMetaInfoBuilder

Creates a new ResponseMetaInfoBuilder.

fromJavaInstant

fun RequestMetaInfo.Companion.fromJavaInstant(timestamp: Instant, metadata: JsonObject? = null): RequestMetaInfo

Creates a RequestMetaInfo with a java.time.Instant timestamp.

fun ResponseMetaInfo.Companion.fromJavaInstant(timestamp: Instant, totalTokensCount: Int? = null, inputTokensCount: Int? = null, outputTokensCount: Int? = null, metadata: JsonObject? = null): ResponseMetaInfo

Creates a ResponseMetaInfo with a java.time.Instant timestamp.

require

inline fun <T : CacheControl> CacheControl.require(): T

Requires this CacheControl to be of the specified type T, or throws an IllegalStateException.