prompt-structure/ai.koog.prompt.structure/StructuredData

StructuredData

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

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

This abstract class provides a base for defining structured data entities that are identified by a unique id, involve a list of examples of a specific type TStruct, and adhere to a given schema.

Parameters

TStruct

The type of the structured data that this class handles.

Inheritors

Constructors

Link copied to clipboard
constructor(id: String, schema: TSchema, examples: List<TStruct>)

Properties

Link copied to clipboard
val examples: List<TStruct>

A collection of example instances of the structured data type.

Link copied to clipboard
val id: String

A unique identifier for the structured data entity.

Link copied to clipboard
val schema: TSchema

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

Functions

Link copied to clipboard
abstract fun definition(builder: TextContentBuilderBase<*>): TextContentBuilderBase<*>

Defines the structure of textual content using the provided TextContentBuilder.

Link copied to clipboard
abstract fun parse(text: String): TStruct

Parses the given text into a structured data representation.

Link copied to clipboard
abstract fun pretty(value: TStruct): String

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