kt-schema-generator-json/me.kpavlov.kt.schema.generator.json/FunctionCallingSchemaConfig

FunctionCallingSchemaConfig

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, allowAdditionalProperties: Boolean = false) : JsonSchemaConfig(source)

Configuration for function calling schema transformers.

Extends JsonSchemaConfig with defaults optimized for LLM function calling. By default, uses strict mode settings to comply with OpenAI function calling requirements.

Constructors

constructor(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, strictMode: Boolean = true, allowAdditionalProperties: Boolean = false)

Types

Companion

object Companion

Properties

allowAdditionalProperties

val allowAdditionalProperties: Boolean

Whether object schemas allow properties that are not declared.

includeOpenAPIPolymorphicDiscriminator

val includeOpenAPIPolymorphicDiscriminator: Boolean

Whether to include discriminator in polymorphic schemas.

includePolymorphicDiscriminator

val includePolymorphicDiscriminator: Boolean

Whether to include a type discriminator field in polymorphic schemas.

requireNullableFields

val requireNullableFields: Boolean

Whether nullable fields must be present in JSON.

respectDefaultPresence

val respectDefaultPresence: Boolean

Whether to derive required fields from each property's optionality and default value.

shortDefinitionNames

val shortDefinitionNames: Boolean

Whether $defs keys, $ref targets, the root $id and discriminator const values use the shortest unique dotted suffix of the type's qualified name (com.acme.Payload becomes Payload).