kotlinx-schema-json/kotlinx.schema.json

Package-level declarations

Types

data class ArrayPropertyDefinition(val type: List<String> = listOf("array"), val description: String? = null, val nullable: Boolean? = null, val items: PropertyDefinition? = null, val minItems: UInt? = null, val maxItems: UInt? = null, val default: JsonElement? = null) : ValuePropertyDefinition

Represents an array property

BooleanPropertyBuilder

class BooleanPropertyBuilder

Builder for BooleanPropertyDefinition.

BooleanPropertyDefinition

@Serializable

data class BooleanPropertyDefinition(val type: List<String> = listOf("boolean"), val description: String? = null, val nullable: Boolean? = null, val default: JsonElement? = null, val constValue: JsonElement? = null) : ValuePropertyDefinition

Represents a boolean property

FunctionCallingSchema

@Serializable

data class FunctionCallingSchema(val type: String = "function", val name: String, val title: String? = null, val description: String? = null, val strict: Boolean? = true, val parameters: ParametersDefinition)

FunctionCallingSchema describes a function/tool call in LLM function calling APIs.

JsonSchema

@Serializable

data class JsonSchema(val name: String, val strict: Boolean = false, val description: String? = null, val schema: JsonSchemaDefinition)

Represents a JSON Schema definition

JsonSchemaBuilder

class JsonSchemaBuilder

Builder for JsonSchema instances.

JsonSchemaDefinition

@Serializable

data class JsonSchemaDefinition(val id: String? = null, val schema: String? = null, val type: String = "object", val properties: Map<String, PropertyDefinition> = emptyMap(), val required: List<String> = emptyList(), val additionalProperties: JsonElement? = null, val description: String? = null, val items: PropertyDefinition? = null)

Represents a JSON Schema definition.

JsonSchemaDefinitionBuilder

class JsonSchemaDefinitionBuilder

Builder for JsonSchemaDefinition.

JsonSchemaDsl

@DslMarker

annotation class JsonSchemaDsl

Marker annotation for the JSON Schema DSL.

NumericPropertyBuilder

class NumericPropertyBuilder

Builder for NumericPropertyDefinition.

NumericPropertyDefinition

@Serializable

data class NumericPropertyDefinition(val type: List<String>, val description: String? = null, val nullable: Boolean? = null, val multipleOf: Double? = null, val minimum: Double? = null, val exclusiveMinimum: Double? = null, val maximum: Double? = null, val exclusiveMaximum: Double? = null, val default: JsonElement? = null, val constValue: JsonElement? = null) : ValuePropertyDefinition

Represents a numeric property (integer or number).

ObjectPropertyBuilder

class ObjectPropertyBuilder

Builder for ObjectPropertyDefinition.

ObjectPropertyDefinition

@Serializable

data class ObjectPropertyDefinition(val type: List<String> = listOf("object"), val description: String? = null, val nullable: Boolean? = null, val properties: Map<String, PropertyDefinition>? = null, val required: List<String>? = null, val additionalProperties: JsonElement? = null, val default: JsonElement? = null) : ValuePropertyDefinition

Represents an object property

ParametersDefinition

@Serializable

data class ParametersDefinition(val properties: Map<String, PropertyDefinition> = emptyMap(), val required: List<String> = emptyList(), val additionalProperties: Boolean = false)

JSON schema defining the function's input arguments.

PropertyBuilder

class PropertyBuilder

Builder for defining property types and constraints.

PropertyDefinition

@Serializable(with = PropertyDefinitionSerializer::class)

sealed interface PropertyDefinition

Represents a property definition in a JSON Schema.

PropertyDefinitionSerializer

class PropertyDefinitionSerializer : KSerializer<PropertyDefinition>

Serializer for PropertyDefinition that handles polymorphic serialization.

ReferencePropertyDefinition

@Serializable

data class ReferencePropertyDefinition(val ref: String) : PropertyDefinition

Represents a reference to another element

StringOrListSerializer

class StringOrListSerializer : KSerializer<List<String>>

A custom serializer for handling JSON values that can either be a single string or a list of strings. This serializer ensures that both formats are correctly deserialized into a List<String> and serialized back into their appropriate JSON representation.

StringPropertyBuilder

class StringPropertyBuilder

Builder for StringPropertyDefinition.

StringPropertyDefinition

@Serializable

data class StringPropertyDefinition(val type: List<String> = listOf("string"), val description: String? = null, val nullable: Boolean? = null, val format: String? = null, val enum: List<String>? = null, val minLength: Int? = null, val maxLength: Int? = null, val pattern: String? = null, val default: JsonElement? = null, val constValue: JsonElement? = null) : ValuePropertyDefinition

Represents a string property.

ValuePropertyDefinition

sealed interface ValuePropertyDefinition : PropertyDefinition

Represents a value-based property definition in a JSON Schema.

Functions

encodeToJsonObject

fun FunctionCallingSchema.encodeToJsonObject(json: Json = Json): JsonObject

Encodes the given FunctionCallingSchema instance into a JsonObject representation.

fun JsonSchema.encodeToJsonObject(json: Json = Json): JsonObject

Encodes the given JsonSchema instance into a JsonObject representation.

encodeToString

fun FunctionCallingSchema.encodeToString(json: Json = Json): String

Encodes the FunctionCallingSchema instance into its JSON string representation.

fun JsonSchema.encodeToString(json: Json = Json): String

Encodes the JsonSchema instance into its JSON string representation.

jsonSchema

fun jsonSchema(block: JsonSchemaBuilder.() -> Unit): JsonSchema

DSL for building JSON Schema objects in a type-safe and readable way.