Package com.axelor.ai.tool.data

Class QueryRecordsTool

java.lang.Object

com.axelor.ai.tool.data.QueryRecordsTool

All Implemented Interfaces:

SystemTool<QueryRecordsTool.Input>

public class QueryRecordsTool
extends Object
implements SystemTool<QueryRecordsTool.Input>

System tool for advanced queries using a structured JSON DSL, returning the rows of the columns a query selects, computed or grouped.

A query with no select would return whole records, carrying every field whether or not the user may read it: the engine checks only the fields a query names. So one is refused, and every column the model gets has been checked.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	QueryRecordsTool.Input

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE

Constructor Summary

Constructors

Constructor	Description
QueryRecordsTool()

Method Summary

Modifier and Type	Method	Description
String	code()	Unique code matching AiTool.systemTool field.
String	description()	Brief description of what this tool does.
ToolResult	execute(QueryRecordsTool.Input input, ToolContext context)	Execute with the given typed input and agent-scoped context.
Class<QueryRecordsTool.Input>	inputType()	The input record class.
String	name()	Human-readable display name (e.g.
ToolSafety	safety()	Safety classification for approval decisions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axelor.ai.tool.system.SystemTool

beforeApproval, callTitle, provideContext, refusal, runsOutsideTransaction, undoneByRollback

Field Details

CODE

public static final String CODE

See Also:

• Constant Field Values

Constructor Details

QueryRecordsTool

public QueryRecordsTool()

Method Details

safety

public ToolSafety safety()

Description copied from interface: SystemTool

Safety classification for approval decisions. Tools default to ToolSafety.WRITE. Override to ToolSafety.READ_ONLY for safe tools that never require approval or ToolSafety.DESTRUCTIVE for tools that should always require approval.

Specified by:

safety in interface SystemTool<QueryRecordsTool.Input>

code

public String code()

Description copied from interface: SystemTool

Unique code matching AiTool.systemTool field.

Specified by:

code in interface SystemTool<QueryRecordsTool.Input>

name

public String name()

Description copied from interface: SystemTool

Human-readable display name (e.g. "Search Records").

Specified by:

name in interface SystemTool<QueryRecordsTool.Input>

description

public String description()

Description copied from interface: SystemTool

Brief description of what this tool does.

Specified by:

description in interface SystemTool<QueryRecordsTool.Input>

inputType

public Class<QueryRecordsTool.Input> inputType()

Description copied from interface: SystemTool

The input record class. Return Void.class for tools with no input.

Specified by:

inputType in interface SystemTool<QueryRecordsTool.Input>

execute

public ToolResult execute(QueryRecordsTool.Input input,
 ToolContext context)

Description copied from interface: SystemTool

Execute with the given typed input and agent-scoped context.

Specified by:

execute in interface SystemTool<QueryRecordsTool.Input>