prompt-model/ai.koog.prompt.dsl

Package-level declarations

Types

class ContentPartsBuilder : TextContentBuilderBase<List<ContentPart>>

A builder for constructing parts for prompt messages. All parts are added to a list in declaration order and can be retrieved through the build method.

ModerationCategory

@Serializable

open class ModerationCategory(val name: String)

Represents categories for content moderation used to classify potentially harmful or inappropriate content. These categories help identify specific types of violations that content may fall under.

ModerationCategoryResult

@Serializable

data class ModerationCategoryResult(val detected: Boolean, val confidenceScore: Double? = null, val appliedInputTypes: List<ModerationResult.InputType> = emptyList())

Represents the detailed result of moderating a specific category of content.

ModerationResult

@Serializable

data class ModerationResult(val isHarmful: Boolean, val categories: Map<ModerationCategory, ModerationCategoryResult>)

Represents the result of a content moderation request.

Prompt

@Serializable

data class Prompt @JvmOverloads constructor(val messages: List<Message>, val id: String, val params: LLMParams = LLMParams())

Represents a data structure for a prompt, consisting of a list of messages, a unique identifier, and optional parameters for language model settings.

PromptBuilder

class PromptBuilder

A builder class for creating prompts using a DSL approach.

PromptDSL

@DslMarker

annotation class PromptDSL

Marker annotation for the Prompt DSL.

Functions

emptyPrompt

fun emptyPrompt(): Prompt

Constructs an empty instance of the Prompt class with no messages, default parameters, and an empty identifier. This empty prompt can be used as a default or placeholder.

prompt

fun prompt(existing: Prompt, clock: Clock = Clock.System, build: PromptBuilder.() -> Unit): Prompt

Extends an existing prompt using the Prompt DSL.

fun prompt(id: String, params: LLMParams = LLMParams(), clock: Clock = Clock.System, build: PromptBuilder.() -> Unit): Prompt

Creates a new prompt using the Prompt DSL.