Package com.axelor.ai.tool.builder

Class TryAgentTool

java.lang.Object

com.axelor.ai.tool.builder.TryAgentTool

All Implemented Interfaces:

SystemTool<TryAgentTool.Input>

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

Runs an agent on a request a user would make, as a trial (see ChatRequest.trial): its writes run and are undone, and the builder reads back the answer and every call the agent made, with what each returned or why it failed. The agent may be disabled, as a new one is.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TryAgentTool.Input

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CODE

Method Summary

Modifier and Type	Method	Description
ToolResult	beforeApproval(TryAgentTool.Input input, ToolContext context)	Looked at before the user is asked to approve a call, for a tool that needs approval: a refusal known up front should not cost the user a decision.
String	callTitle(TryAgentTool.Input input, String name)	What to call one call of this tool, given what it was called with.
String	code()	Unique code matching AiTool.systemTool field.
String	description()	Brief description of what this tool does.
ToolResult	execute(TryAgentTool.Input input, ToolContext context)	Execute with the given typed input and agent-scoped context.
Class<TryAgentTool.Input>	inputType()	The input record class.
String	name()	Human-readable display name (e.g.
boolean	runsOutsideTransaction()	Whether this tool opens its own transactions and must run outside the call's.

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

provideContext, refusal, safety, undoneByRollback

Field Details

CODE

public static final String CODE

See Also:

• Constant Field Values

Method Details

code

public String code()

Description copied from interface: SystemTool

Unique code matching AiTool.systemTool field.

Specified by:

code in interface SystemTool<TryAgentTool.Input>

name

public String name()

Description copied from interface: SystemTool

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

Specified by:

name in interface SystemTool<TryAgentTool.Input>

description

public String description()

Description copied from interface: SystemTool

Brief description of what this tool does.

Specified by:

description in interface SystemTool<TryAgentTool.Input>

inputType

public Class<TryAgentTool.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<TryAgentTool.Input>

runsOutsideTransaction

public boolean runsOutsideTransaction()

Description copied from interface: SystemTool

Whether this tool opens its own transactions and must run outside the call's. A tool whose work is several steps, each to be committed on its own as a browser commits each request, returns true; every other tool keeps the one transaction that makes its writes atomic.

Specified by:

runsOutsideTransaction in interface SystemTool<TryAgentTool.Input>

callTitle

public String callTitle(TryAgentTool.Input input,
 String name)

Description copied from interface: SystemTool

What to call one call of this tool, given what it was called with.

One call of a tool is not like the next: a tool that takes one record or several cannot be named accurately by its configuration alone. The name it is configured with is passed in, and returning it — as the default does — is what leaves the tool named the way the administrator named it.

Specified by:

callTitle in interface SystemTool<TryAgentTool.Input>

Parameters:

input - the call's input, or null when the tool takes none

name - the tool's configured display name

beforeApproval

public ToolResult beforeApproval(TryAgentTool.Input input,
 ToolContext context)

Description copied from interface: SystemTool

Looked at before the user is asked to approve a call, for a tool that needs approval: a refusal known up front should not cost the user a decision. Return an ToolResult.Error to refuse the call without asking, a ToolResult.PendingApproval to ask with what its card should show, or null to ask as usual. The call itself checks again when it runs.

Specified by:

beforeApproval in interface SystemTool<TryAgentTool.Input>

Parameters:

input - the call's input, or null when the tool takes none

context - the call's context

execute

public ToolResult execute(TryAgentTool.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<TryAgentTool.Input>