prompt-structure/ai.koog.prompt.structure/DescriptionMetadata

DescriptionMetadata

interface DescriptionMetadata(source)

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

Properties

Link copied to clipboard
abstract val classDescription: String?

Represents a detailed description of a class provided in a metadata context.

Link copied to clipboard
abstract val className: String

Represents the name of a class associated with a description or metadata entry.

Link copied to clipboard
abstract val fieldDescriptions: Map<String, String>

A map containing metadata descriptions for fields associated with a specific class.

Functions

Link copied to clipboard
open fun allDescriptions(): Map<String, String>

Aggregates all the available descriptions into a single map. This includes field descriptions and, if available, the class description associated with the class name.