prompt-structure/ai.koog.prompt.structure.json/JsonStructure

JsonStructure

class JsonStructure<TStruct>(id: String, schema: LLMParams.Schema.JSON, examples: List<TStruct>, val serializer: KSerializer<TStruct>, val json: Json, definitionPrompt: (builder: TextContentBuilderBase<*>, structure: JsonStructure<TStruct>) -> TextContentBuilderBase<*> = ::defaultDefinitionPrompt, examplesPrompt: (builder: TextContentBuilderBase<*>, structure: JsonStructure<TStruct>) -> TextContentBuilderBase<*> = StructuredOutputPrompts::examplesPrompt) : Structure<TStruct, LLMParams.Schema.JSON> (source)

Represents a structure for handling and interacting with structured data of a specified type.

Parameters

TStruct

The type of data to be structured.

definitionPrompt

Prompt with definition, explaining the structure to the LLM. Default is JsonStructure.defaultDefinitionPrompt

examplesPrompt

Prompt with examples of valid formats for the structured data. Default is StructuredOutputPrompts.examplesPrompt

Constructors

JsonStructure

constructor(id: String, schema: LLMParams.Schema.JSON, examples: List<TStruct>, serializer: KSerializer<TStruct>, json: Json, definitionPrompt: (builder: TextContentBuilderBase<*>, structure: JsonStructure<TStruct>) -> TextContentBuilderBase<*> = ::defaultDefinitionPrompt, examplesPrompt: (builder: TextContentBuilderBase<*>, structure: JsonStructure<TStruct>) -> TextContentBuilderBase<*> = StructuredOutputPrompts::examplesPrompt)

Types

Companion

object Companion

Companion object for the JsonStructure class, providing utility methods to facilitate the creation of JSON structures with associated schema generation.

Properties

examples

val examples: List<TStruct>

A collection of example instances of the structured data type.

val id: String

A unique identifier for the structured data entity.

json

val json: Json

kotlinx.serialization.json.Json instance to perform de/serialization.

schema

val schema: LLMParams.Schema.JSON

The schema that defines the structure and validation rules for the data.

serializer

val serializer: KSerializer<TStruct>

The serializer used to convert the data to and from JSON.

Functions

definition

open override fun definition(builder: TextContentBuilderBase<*>): TextContentBuilderBase<*>

Defines the structure of textual content using the provided TextContentBuilder.

examples

open override fun examples(builder: TextContentBuilderBase<*>): TextContentBuilderBase<*>

Defines formatted examples using the provided TextContentBuilderBase.

parse

open override fun parse(text: String): TStruct

Parses the given text into a structured data representation.

pretty

open override fun pretty(value: TStruct): String

Formats the given structured data into a human-readable string representation.