kotlinx-schema-generator-json/kotlinx.schema.generator.json

Package-level declarations

Reflection-based JSON Schema generators and configuration.

Types

class FunctionCallingSchemaConfig(respectDefaultPresence: Boolean = JsonSchemaConfig.Default.respectDefaultPresence, requireNullableFields: Boolean = JsonSchemaConfig.Default.requireNullableFields, useUnionTypes: Boolean = JsonSchemaConfig.Default.useUnionTypes, useNullableField: Boolean = JsonSchemaConfig.Default.useNullableField, includePolymorphicDiscriminator: Boolean = JsonSchemaConfig.Default.includePolymorphicDiscriminator, val strictMode: Boolean = true) : JsonSchemaConfig

Configuration for function calling schema transformers.

JsonSchemaConfig

open class JsonSchemaConfig(val respectDefaultPresence: Boolean = true, val requireNullableFields: Boolean = false, val useUnionTypes: Boolean = true, val useNullableField: Boolean = false, val includePolymorphicDiscriminator: Boolean = true, val includeOpenAPIPolymorphicDiscriminator: Boolean = false)

Configuration for JSON Schema transformers.

JsonSchemaGenerator

interface JsonSchemaGenerator<T : Any> : SchemaGenerator<T, JsonObject>

A utility class for generating JSON schema representations of Kotlin objects.

ReflectionClassJsonObjectSchemaGenerator

class ReflectionClassJsonObjectSchemaGenerator(json: Json, config: JsonSchemaConfig) : AbstractSchemaGenerator<KClass<out Any>, JsonObject, Unit>

A generator class for creating JSON object schemas using reflection-based introspection.

ReflectionClassJsonSchemaGenerator

class ReflectionClassJsonSchemaGenerator(json: Json, config: JsonSchemaConfig) : AbstractSchemaGenerator<KClass<out Any>, JsonSchema, Unit>

A generator for producing JSON Schema representations of Kotlin classes using reflection.

ReflectionFunctionCallingSchemaGenerator

class ReflectionFunctionCallingSchemaGenerator(json: Json, config: FunctionCallingSchemaConfig) : AbstractSchemaGenerator<KCallable<*>, FunctionCallingSchema, Unit>

Generates FunctionCallingSchema from Kotlin functions using reflection.

TypeGraphToFunctionCallingSchemaTransformer

class TypeGraphToFunctionCallingSchemaTransformer @JvmOverloads constructor(val config: FunctionCallingSchemaConfig = DefaultConfig) : AbstractTypeGraphTransformer<FunctionCallingSchema, FunctionCallingSchemaConfig>

Transforms a TypeGraph into a FunctionCallingSchema for tool/function schema representation.

TypeGraphToJsonObjectSchemaTransformer

class TypeGraphToJsonObjectSchemaTransformer @JvmOverloads constructor(val config: JsonSchemaConfig = JsonSchemaConfig.Default, json: Json = Json { encodeDefaults = true }, jsonSchemaTransformer: TypeGraphToJsonSchemaTransformer = TypeGraphToJsonSchemaTransformer(config, json)) : AbstractTypeGraphTransformer<JsonObject, JsonSchemaConfig>

Transforms TypeGraph IR into JSON Schema as a JsonObject.

TypeGraphToJsonSchemaTransformer

class TypeGraphToJsonSchemaTransformer @JvmOverloads constructor(val config: JsonSchemaConfig, val json: Json = Json { encodeDefaults = false }) : AbstractTypeGraphTransformer<JsonSchema, JsonSchemaConfig>

Transforms TypeGraph IR into JSON Schema Draft 2020-12 format.