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?")
}

Functions

assistant

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

fun assistant(finishReason: String? = null, rawResponse: JsonObject? = null, id: String? = null, init: ResponseMessagePartsBuilder.() -> Unit): PromptBuilder

Adds an assistant message to the prompt using a TextContentBuilder.

fun assistant(content: String): PromptBuilder

fun assistant(parts: List<MessagePart.ResponsePart>, finishReason: String? = null, rawResponse: JsonObject? = null, id: String? = 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.

reasoning

fun reasoning(part: MessagePart.Reasoning): PromptBuilder

@JvmOverloads

fun reasoning(content: String, id: String? = null, summary: String? = null, encrypted: String? = null): PromptBuilder

system

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

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

Adds a system message to the prompt using a TextContentBuilder.

@JvmOverloads

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

Adds a system message to the prompt.

toolCall

fun toolCall(part: MessagePart.Tool.Call): PromptBuilder

@JvmOverloads

fun toolCall(tool: String, args: String, id: String? = null): PromptBuilder

@JvmOverloads

fun toolCall(tool: String, args: JsonObject, id: String? = null): PromptBuilder

toolResult

fun toolResult(part: MessagePart.Tool.Result): PromptBuilder

@JvmOverloads

fun toolResult(tool: String, output: String, id: String? = null, isError: Boolean = false): PromptBuilder

user

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

Adds a user message to the prompt with attachments.

@JvmOverloads

fun user(parts: List<MessagePart.RequestPart>): PromptBuilder

Adds a user message to the prompt with optional attachments.

@JvmOverloads

fun user(content: String, cache: CacheControl? = null): PromptBuilder

Adds a user message to the prompt.