Class AiJsonSchema

java.lang.Object

com.kingsrook.qqq.backend.core.actions.ai.tools.AiJsonSchema

public class AiJsonSchema
extends Object

Small builders for the strict JSON Schemas of AI tool inputs. All objects are additionalProperties=false with an explicit required list, and every map is insertion-ordered, so the serialized schemas are byte-stable.

Constructor Summary

Constructors

Constructor	Description
AiJsonSchema()

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	array(Map<String,Object> items, String description)	An array schema with an item schema and a description.
static Map<String,Object>	bool(String description)	A boolean schema with a description.
static Map<String,Object>	enumOf(List<String> values, String description)	An enum schema (of string values).
static Map<String,Object>	integer(String description)	An integer schema with a description.
static Map<String,Object>	object(Map<String,Object> properties, List<String> required)	An object schema, with properties (in order) and the required names.
static Map<String,Object>	properties(Object... nameSchemaPairs)	An ordered properties map - from alternating name, schema arguments.
static Map<String,Object>	ref(String definitionName)	A reference to a definition under the root's $defs.
static Map<String,Object>	string(String description)	A string schema with a description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AiJsonSchema

public AiJsonSchema()

Method Details

object

public static Map<String,Object> object(Map<String,Object> properties,
 List<String> required)

An object schema, with properties (in order) and the required names.

properties

public static Map<String,Object> properties(Object... nameSchemaPairs)

An ordered properties map - from alternating name, schema arguments.

string

public static Map<String,Object> string(String description)

A string schema with a description.

integer

public static Map<String,Object> integer(String description)

An integer schema with a description.

bool

public static Map<String,Object> bool(String description)

A boolean schema with a description.

array

public static Map<String,Object> array(Map<String,Object> items,
 String description)

An array schema with an item schema and a description.

enumOf

public static Map<String,Object> enumOf(List<String> values,
 String description)

An enum schema (of string values).

ref

public static Map<String,Object> ref(String definitionName)

A reference to a definition under the root's $defs.