Package com.axelor.ai.chat

Record Class ToolResult.PendingApproval

java.lang.Object

java.lang.Record

com.axelor.ai.chat.ToolResult.PendingApproval

Record Components:

toolCode - the code of the tool awaiting approval

descriptor - what the card shows beyond the call's input, or null: kind: "record" with the model and id of the record the call acts on, for a tool whose input does not name its model

All Implemented Interfaces:

ToolResult

Enclosing interface:

ToolResult

public static record ToolResult.PendingApproval(String toolCode, Map<String,Object> descriptor)
extends Record
implements ToolResult

The tool requires user approval before execution.

Nested Class Summary

Nested classes/interfaces inherited from interface com.axelor.ai.chat.ToolResult

ToolResult.ClientSide, ToolResult.Consult, ToolResult.Error, ToolResult.PendingApproval, ToolResult.PendingConfirmation, ToolResult.Success

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RECORD	The descriptor's kind for the record a call acts on.

Constructor Summary

Constructors

Constructor	Description
PendingApproval(String toolCode)
PendingApproval(String toolCode, Map<String,Object> descriptor)	Creates an instance of a PendingApproval record class.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	descriptor()	Returns the value of the descriptor record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	toolCode()	Returns the value of the toolCode record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

RECORD

public static final String RECORD

The descriptor's kind for the record a call acts on.

See Also:

• Constant Field Values

Constructor Details

PendingApproval

public PendingApproval(String toolCode)

PendingApproval

public PendingApproval(String toolCode,
 Map<String,Object> descriptor)

Creates an instance of a PendingApproval record class.

Parameters:

toolCode - the value for the toolCode record component

descriptor - the value for the descriptor record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

toolCode

public String toolCode()

Returns the value of the toolCode record component.

Returns:

the value of the toolCode record component

descriptor

public Map<String,Object> descriptor()

Returns the value of the descriptor record component.

Returns:

the value of the descriptor record component