Class RenderWidgetTool

java.lang.Object

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

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

public class RenderWidgetTool
extends AbstractAiTool

render_widget: render a dashboard widget the current user may see, with the widget permission check the widget endpoint makes. Widgets are default-DENY: a widget renderer may read data without the user's table permissions (e.g., as a system user), so only widgets listed in the settings' allowedWidgetNames (and not in hiddenWidgetNames) are rendered. Any other widget gets the same DENIED answer as a missing or unpermitted one. The widget data is redacted and truncated (strings to maxCellChars, lists to maxRowsToModel, the whole tree to MAX_TREE_NODES values) for both the model and the UI.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_DEPTH
static final int	MAX_TREE_NODES
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
RenderWidgetTool()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	execute(AiToolContext context, AiToolInput input)	Run the tool - returning the data to send to the model.
String	getDescription()	The tool's description, for the model.
Map<String,Object>	getInputSchema()	The tool's strict input schema (an object schema).
AiToolKind	getKind()	The tool's kind.
String	getName()	The tool's wire name (snake_case).

Methods inherited from class com.kingsrook.qqq.backend.core.actions.ai.tools.AbstractAiTool

getDefinition, getInputPropertyNames

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

MAX_DEPTH

public static final int MAX_DEPTH

See Also:

• Constant Field Values

MAX_TREE_NODES

public static final int MAX_TREE_NODES

See Also:

• Constant Field Values

Constructor Details

RenderWidgetTool

public RenderWidgetTool()

Method Details

getName

public String getName()

Description copied from class: AbstractAiTool

The tool's wire name (snake_case).

Specified by:

getName in class AbstractAiTool

getDescription

public String getDescription()

Description copied from class: AbstractAiTool

The tool's description, for the model.

Specified by:

getDescription in class AbstractAiTool

getKind

public AiToolKind getKind()

Description copied from class: AbstractAiTool

The tool's kind.

Specified by:

getKind in class AbstractAiTool

getInputSchema

public Map<String,Object> getInputSchema()

Description copied from class: AbstractAiTool

The tool's strict input schema (an object schema).

Specified by:

getInputSchema in class AbstractAiTool

execute

public Map<String,Object> execute(AiToolContext context,
 AiToolInput input)
                           throws QException

Description copied from class: AbstractAiTool

Run the tool - returning the data to send to the model.

Specified by:

execute in class AbstractAiTool

Throws:

QException