Package com.axelor.ai.chat

Record Class ToolResult.PendingConfirmation

java.lang.Object

java.lang.Record

com.axelor.ai.chat.ToolResult.PendingConfirmation

Record Components:

toolCode - the code of the tool asking

message - the question, verbatim, as the user would read it

descriptor - what the card needs to ask it: kind: "confirmation", the id the tool gave the question, and the question's own title and button titles when it has them

All Implemented Interfaces:

ToolResult

Enclosing interface:

ToolResult

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

The tool stopped at a question only the user can answer — a form's alert, a button's prompt — and will carry on from where it stopped once they answer. It rides the approval channel: the run pauses as for an approval, with the question as the request's reason, and the answer comes back as the approval's.

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	KIND	The descriptor's kind, telling a confirmation from consent to run a tool.
static final String	QUESTION	The descriptor's key for the question's id, handed back with the answer so that the answer carries on only the question it was given for.

Constructor Summary

Constructors

Constructor	Description
PendingConfirmation(String toolCode, String message, Map<String,Object> descriptor)	Creates an instance of a PendingConfirmation 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	message()	Returns the value of the message record component.
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

KIND

public static final String KIND

The descriptor's kind, telling a confirmation from consent to run a tool.

See Also:

• Constant Field Values

QUESTION

public static final String QUESTION

The descriptor's key for the question's id, handed back with the answer so that the answer carries on only the question it was given for.

See Also:

• Constant Field Values

Constructor Details

PendingConfirmation

public PendingConfirmation(String toolCode,
 String message,
 Map<String,Object> descriptor)

Creates an instance of a PendingConfirmation record class.

Parameters:

toolCode - the value for the toolCode record component

message - the value for the message 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

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

descriptor

public Map<String,Object> descriptor()

Returns the value of the descriptor record component.

Returns:

the value of the descriptor record component