prompt-structure/ai.koog.prompt.structure.markdown/MarkdownStructuredDataDefinition

MarkdownStructuredDataDefinition

class MarkdownStructuredDataDefinition(val id: String, val schema: TextContentBuilder.() -> Unit, val examples: TextContentBuilder.() -> Unit? = null, definitionPrompt: (builder: TextContentBuilderBase<*>, structureDefinition: MarkdownStructuredDataDefinition) -> TextContentBuilderBase<*> = ::defaultDefinitionPrompt) : StructuredDataDefinition(source)

Represents a specific definition of structured data that uses Markdown for its schema and example formatting. This class is part of a framework for constructing and handling structured data definitions through textual builders.

Constructors

Link copied to clipboard
constructor(id: String, schema: TextContentBuilder.() -> Unit, examples: TextContentBuilder.() -> Unit? = null, definitionPrompt: (builder: TextContentBuilderBase<*>, structureDefinition: MarkdownStructuredDataDefinition) -> TextContentBuilderBase<*> = ::defaultDefinitionPrompt)

Types

Link copied to clipboard
object Companion

Companion object for MarkdownStructuredDataDefinition class, providing utility methods.

Properties

Link copied to clipboard
val examples: TextContentBuilder.() -> Unit? = null

An optional lambda providing Markdown-formatted examples of the structured data, applied to a TextContentBuilder.

Link copied to clipboard
val id: String

A string identifier for the structured data definition.

Link copied to clipboard
val schema: TextContentBuilder.() -> Unit

A lambda representing the Markdown-based schema definition, applied to a TextContentBuilder.

Functions

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

Defines the structure of textual content using the provided TextContentBuilder.