kotlinx-schema-annotations/kotlinx.schema/Schema

Schema

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class Schema(val value: String = "json", val withSchemaObject: Boolean = false)(source)

Annotation to define a schema for a class, type, or function.

This annotation is primarily used to associate a specific schema type with the annotated element. By default, it targets JSON Schema but can accommodate custom schema representations as well.

When applied to functions, generates FunctionCallingSchema for LLM function calling APIs.

Properties

value

val value: String

Schema Type

withSchemaObject

val withSchemaObject: Boolean = false

Generate specific representation, e.g. JsonObject for JSON Schema.