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

RequestMessagePartsBuilder

class RequestMessagePartsBuilder : ContentPartsBuilderBase<List<MessagePart.RequestPart>> (source)

Constructors

constructor()

Properties

caret

val caret: TextContentBuilderBase.Caret

Represents the current caret position in the text being built.

Functions

attachment

fun attachment(attachment: AttachmentSource, cacheControl: CacheControl? = null)

audio

fun audio(audio: AttachmentSource.Audio, cacheControl: CacheControl? = null)

Adds AttachmentSource.Audio to the list of parts.

fun audio(url: String, cacheControl: CacheControl? = null)

Adds AttachmentSource.Audio with AttachmentContent.URL content from the provided URL.

fun audio(path: Path, cacheControl: CacheControl? = null)

Adds AttachmentSource.Audio with AttachmentContent.Binary.Bytes content from the provided local file path.

binaryFile

fun binaryFile(path: Path, mimeType: String)

Adds AttachmentSource.File with AttachmentContent.Binary.Bytes content from the provided local file path.

fun br()

Adds two consecutive newline characters to the text content.

build

open override fun build(): List<MessagePart.RequestPart>

file

fun file(file: AttachmentSource.File, cacheControl: CacheControl? = null)

Adds AttachmentSource.File to the list of parts.

fun file(url: String, mimeType: String)

Adds AttachmentSource.File with AttachmentContent.URL content from the provided URL.

image

fun image(image: AttachmentSource.Image, cacheControl: CacheControl? = null)

Adds AttachmentSource.Image to the list of parts.

fun image(url: String, cacheControl: CacheControl? = null)

Adds AttachmentSource.Image with AttachmentContent.URL content from the provided URL.

fun image(path: Path, cacheControl: CacheControl? = null)

Adds AttachmentSource.Image with AttachmentContent.Binary.Bytes content from the provided local file path.

newline

fun newline()

Appends a newline character to the underlying text builder.

not

open operator fun String.not()

Defines a custom operator function for the String class. This unary not operator (!) is invoked on a String instance and performs a custom action defined by the text function.

numbered

fun TextContentBuilderBase<*>.numbered(startLineNumber: Int = 1, body: TextContentBuilderBase<*>.() -> Unit): TextContentBuilderBase<*>

Extension function for TextContentBuilder that adds line numbering to the content.

padding

fun padding(padding: String, body: TextContentBuilder.() -> Unit)

Adds padding to each line of the content produced by the provided builder block.

part

fun part(part: MessagePart.ContentPart)

Adds MessagePart to the list of parts.

text

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

fun text(text: String, cacheControl: CacheControl)

Adds MessagePart.Text to the list of parts.

open fun text(text: String)

Appends the given text to the current content.

text

inline fun TextContentBuilderBase<*>.text(init: TextContentBuilder.() -> Unit)

Extension function to add text content to a TextContentBuilder.

textFile

fun textFile(path: Path, mimeType: String)

Adds AttachmentSource.File with AttachmentContent.PlainText content from the provided local file path.

textWithNewLine

fun textWithNewLine(text: String)

Adds the given text to the content. If the caret is not at the beginning of the line, a newline is added before appending the text.

toolResult

fun toolResult(result: MessagePart.Tool.Result)

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

unaryPlus

open operator fun String.unaryPlus()

Adds the given string as a new line of text to the content being built by the TextContentBuilder.

video

fun video(video: AttachmentSource.Video, cacheControl: CacheControl? = null)

Adds AttachmentSource.Video to the list of parts.

fun video(url: String, cacheControl: CacheControl? = null)

Adds AttachmentSource.Video with AttachmentContent.URL content from the provided URL.

fun video(path: Path, cacheControl: CacheControl? = null)

Adds AttachmentSource.Video with AttachmentContent.Binary.Bytes content from the provided local file path.