Package org.mule.weave.extension.api.llm.tools

Record Class LLMToolDescription

java.lang.Object

java.lang.Record

org.mule.weave.extension.api.llm.tools.LLMToolDescription

Record Components:

actionMessage - A customized progress message to show while the tool runs

confirmation - The information that is shown to the user to confirm that the tool will be executed

public record LLMToolDescription(Optional<String> actionMessage, Optional<LLMToolConfirmation> confirmation)
extends Record

Messages shown to the user when calling the tool

Constructor Summary

Constructors

Constructor	Description
LLMToolDescription(Optional<String> actionMessage, Optional<LLMToolConfirmation> confirmation)	Creates an instance of a LLMToolDescription record class.

Method Summary

Modifier and Type	Method	Description
Optional<String>	actionMessage()	Returns the value of the actionMessage record component.
Optional<LLMToolConfirmation>	confirmation()	Returns the value of the confirmation 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.
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

Constructor Details

LLMToolDescription

public LLMToolDescription(Optional<String> actionMessage,
 Optional<LLMToolConfirmation> confirmation)

Creates an instance of a LLMToolDescription record class.

Parameters:

actionMessage - the value for the actionMessage record component

confirmation - the value for the confirmation 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.

actionMessage

public Optional<String> actionMessage()

Returns the value of the actionMessage record component.

Returns:

the value of the actionMessage record component

confirmation

public Optional<LLMToolConfirmation> confirmation()

Returns the value of the confirmation record component.

Returns:

the value of the confirmation record component