prompt-structure/ai.koog.prompt.structure

Package-level declarations

Types

Represents a metadata definition for annotated descriptions of a class and its fields. This interface facilitates managing descriptions for classes and their corresponding fields.

LLMStructuredParsingError

class LLMStructuredParsingError(message: String) : Exception

StructuredData

abstract class StructuredData<TStruct>(val id: String, val examples: List<TStruct>, val schema: LLMParams.Schema) : StructuredDataDefinition

Represents a generic structure for handling data with a specific schema.

StructuredDataDefinition

interface StructuredDataDefinition

Represents the definition of structured data, enabling content construction and customization.

StructuredOutputPrompts

object StructuredOutputPrompts

An object that provides utilities for formatting structured output prompts.

StructuredResponse

data class StructuredResponse<T>(val structure: T, val raw: String)

Represents a container for structured data parsed from raw text.

StructureParser

class StructureParser(executor: PromptExecutor, fixingModel: LLModel = OpenAIModels.Chat.GPT4o)

A parser for processing structured data that utilizes language models (LLMs) and attempts to correct any errors in the provided content to produce valid structured outputs.

Functions

executeStructured

suspend fun <T> PromptExecutor.executeStructured(prompt: Prompt, mainModel: LLModel, structure: StructuredData<T>, retries: Int = 1, fixingModel: LLModel = OpenAIModels.Chat.GPT4o): Result<StructuredResponse<T>>

Executes a prompt and ensures the response is properly structured by applying automatic output coercion.

executeStructuredOneShot

suspend fun <T> PromptExecutor.executeStructuredOneShot(prompt: Prompt, model: LLModel, structure: StructuredData<T>): StructuredResponse<T>

Executes a given prompt and parses the resulting text, expecting structured data in the response message.

structure

inline fun <T> TextContentBuilder.structure(language: JsonStructureLanguage, value: T)

Adds a structured representation of the given value to the text content using the specified language.

fun <T> TextContentBuilder.structure(language: JsonStructureLanguage, value: T, serializer: KSerializer<T>)

Adds a structured JSON representation of the given value to the TextContentBuilder.