http4k-ai-mcp-core/org.http4k.ai.mcp.model/ElicitationModel

ElicitationModel

abstract class ElicitationModel(source)

Superclass for all elicitation models. Creates a JSON schema for the model and provides properties for defining the model's fields.

Extend this class to create a custom elicitation model and define properties via delegation.

Note: Requires Kotlin-reflect dependency to introspect properties.

Constructors

ElicitationModel

constructor()

Functions

fun boolean(title: String, description: String, default: Boolean? = null, vararg metadata: Elicitation.Metadata<Boolean, *>): ElicitationModelStringReadWriteProperty<Boolean>

fun double(title: String, description: String, default: Double? = null, vararg metadata: Elicitation.Metadata<Double, *>): ElicitationModelStringReadWriteProperty<Double>

inline fun <T : Enum<T>> enum(title: String, description: String, mappings: Map<T, String>? = null, default: T? = null): ElicitationModelStringReadWriteProperty<T>

inline fun <T : Enum<T>> enums(title: String, description: String, mappings: Map<T, String>? = null, defaults: List<T>? = null): ElicitationModelStringReadWriteProperty<List<T>>

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

fun int(title: String, description: String, default: Int? = null, vararg metadata: Elicitation.Metadata<Int, *>): ElicitationModelStringReadWriteProperty<Int>

fun long(title: String, description: String, default: Long? = null, vararg metadata: Elicitation.Metadata<Long, *>): ElicitationModelStringReadWriteProperty<Long>

optionalBoolean

fun optionalBoolean(title: String, description: String, default: Boolean? = null, vararg metadata: Elicitation.Metadata<Boolean, *>): ElicitationModelStringReadWriteProperty<Boolean>

fun optionalDouble(title: String, description: String, default: Double? = null, vararg metadata: Elicitation.Metadata<Double, *>): ElicitationModelStringReadWriteProperty<Double>

fun <T : Enum<T>> optionalEnum(title: String, description: String, default: T? = null, enums: Elicitation.Metadata.EnumMapping<T>? = null): ElicitationModelStringReadWriteProperty<T>

fun optionalInt(title: String, description: String, default: Int? = null, vararg metadata: Elicitation.Metadata<Int, *>): ElicitationModelStringReadWriteProperty<Int>

fun optionalLong(title: String, description: String, default: Long? = null, vararg metadata: Elicitation.Metadata<Long, *>): ElicitationModelStringReadWriteProperty<Long>

fun optionalString(title: String, description: String, default: String? = null, vararg metadata: Elicitation.Metadata<String, *>): ElicitationModelStringReadWriteProperty<String>

fun <OUT, IN> required(title: String, description: String, meta: ParamMeta, default: Any?, metadata: Array<out Elicitation.Metadata<OUT, *>>, map: (OUT) -> IN): ElicitationModelStringReadWriteProperty<OUT>

fun string(title: String, description: String, default: String? = null, vararg metadata: Elicitation.Metadata<String, *>): ElicitationModelStringReadWriteProperty<String>

open override fun toString(): String