prompt-model/ai.koog.prompt.dsl/PromptBuilder

PromptBuilder

A builder class for creating prompts using a DSL approach.

PromptBuilder allows constructing prompts by adding different types of messages (system, user, assistant, tool) in a structured way.

Example usage:

val prompt = prompt("example-prompt") {
    system("You are a helpful assistant.")
    user("What is the capital of France?")
}

Types

ToolMessageBuilder

inner class ToolMessageBuilder(val clock: Clock)

Builder class for adding tool-related messages to the prompt.

ToolResultMessageBuilder

class ToolResultMessageBuilder(clock: Clock, call: PromptBuilder.ToolMessageBuilder.() -> Unit, promptBuilder: PromptBuilder)

A builder class for constructing tool result messages and appending them to a PromptBuilder.

Functions

assistant

fun assistant(init: TextContentBuilder.() -> Unit): PromptBuilder

fun assistant(cacheControl: CacheControl? = null, init: TextContentBuilder.() -> Unit): PromptBuilder

Adds an assistant message to the prompt using a TextContentBuilder.

@JvmOverloads

fun assistant(content: String, cacheControl: CacheControl? = null): PromptBuilder

Adds an assistant message to the prompt.

build

fun build(): Prompt

Builds and returns a Prompt object from the current state of the builder.

message

fun message(message: Message): PromptBuilder

Adds a generic message to the prompt.

messages

fun messages(messages: List<Message>): PromptBuilder

Adds multiple messages to the prompt.

system

fun system(init: TextContentBuilder.() -> Unit): PromptBuilder

fun system(cacheControl: CacheControl? = null, init: TextContentBuilder.() -> Unit): PromptBuilder

Adds a system message to the prompt using a TextContentBuilder.

@JvmOverloads

fun system(content: String, cacheControl: CacheControl? = null): PromptBuilder

Adds a system message to the prompt.

tool

fun tool(init: PromptBuilder.ToolMessageBuilder.() -> Unit): PromptBuilder

Adds tool-related messages to the prompt using a ToolMessageBuilder.

toolCall

fun toolCall(call: Message.Tool.Call): PromptBuilder.ToolResultMessageBuilder

Creates a ToolResultMessageBuilder initialized with the provided tool call.

fun toolCall(id: String?, tool: String, content: String): PromptBuilder.ToolResultMessageBuilder

Adds a tool call message and initializes a ToolResultMessageBuilder.

user

fun user(block: ContentPartsBuilder.() -> Unit): PromptBuilder

Adds a user message to the prompt with attachments.

fun user(content: String): PromptBuilder

Adds a user message to the prompt.

fun ~~user~~(content: String, block: ContentPartsBuilder.() -> Unit): PromptBuilder

fun ~~user~~(content: String, attachments: List<ContentPart> = emptyList()): PromptBuilder

@JvmOverloads

fun user(parts: List<ContentPart>, cacheControl: CacheControl? = null): PromptBuilder

Adds a user message to the prompt with optional attachments.