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

JsonStructuredData

class JsonStructuredData<TStruct>(id: String, schema: LLMParams.Schema.JSON, examples: List<TStruct>, val serializer: KSerializer<TStruct>, val json: Json, definitionPrompt: (builder: TextContentBuilderBase<*>, structuredData: JsonStructuredData<TStruct>) -> TextContentBuilderBase<*> = ::defaultDefinitionPrompt) : StructuredData<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.

Constructors

JsonStructuredData

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

Types

Companion

object Companion

Companion object for the JsonStructuredData 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.

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.