Class AiToolInput

java.lang.Object

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

public class AiToolInput
extends Object

Typed, validating access to the (untrusted) input object of an AI tool call. Every accessor throws an INVALID_INPUT AiToolException for a value of the wrong type, so tools never see unchecked input.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_STRING_LENGTH

Constructor Summary

Constructors

Constructor	Description
AiToolInput(Map<String,Object> values)	Constructor

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	asMap(Object value, String key)	A value as an object (a map with string keys).
static String	asString(Object value, String key)	A value as a string - accepting strings, numbers and booleans.
Integer	getOptionalInteger(String key)	An optional integer.
List<Object>	getOptionalList(String key)	An optional list.
Map<String,Object>	getOptionalMap(String key)	An optional object (map).
String	getOptionalString(String key)	An optional string (numbers are accepted, as their string form).
List<String>	getOptionalStringList(String key)	An optional list of strings.
String	getRequiredString(String key)	A required, non-blank string.
boolean	has(String key)	Whether the input has a (non-null) value for a key.
void	requireOnlyKeys(Collection<String> allowedKeys)	Reject any keys outside the allowed set (the schemas are additionalProperties = false, and the kernel enforces that, rather than trusting the model).

Methods inherited from class java.lang.Object

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

Field Details

MAX_STRING_LENGTH

public static final int MAX_STRING_LENGTH

See Also:

• Constant Field Values

Constructor Details

AiToolInput

public AiToolInput(Map<String,Object> values)

Constructor

Method Details

requireOnlyKeys

public void requireOnlyKeys(Collection<String> allowedKeys)
                     throws AiToolException

Reject any keys outside the allowed set (the schemas are additionalProperties = false, and the kernel enforces that, rather than trusting the model).

Throws:

AiToolException

getRequiredString

public String getRequiredString(String key)
                         throws AiToolException

A required, non-blank string.

Throws:

AiToolException

getOptionalString

public String getOptionalString(String key)
                         throws AiToolException

An optional string (numbers are accepted, as their string form).

Throws:

AiToolException

getOptionalInteger

public Integer getOptionalInteger(String key)
                           throws AiToolException

An optional integer.

Throws:

AiToolException

getOptionalStringList

public List<String> getOptionalStringList(String key)
                                   throws AiToolException

An optional list of strings.

Throws:

AiToolException

getOptionalList

public List<Object> getOptionalList(String key)
                             throws AiToolException

An optional list.

Throws:

AiToolException

getOptionalMap

public Map<String,Object> getOptionalMap(String key)
                                  throws AiToolException

An optional object (map).

Throws:

AiToolException

has

public boolean has(String key)

Whether the input has a (non-null) value for a key.

asString

public static String asString(Object value,
 String key)
                       throws AiToolException

A value as a string - accepting strings, numbers and booleans.

Throws:

AiToolException

asMap

public static Map<String,Object> asMap(Object value,
 String key)
                                throws AiToolException

A value as an object (a map with string keys).

Throws:

AiToolException