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

Record Class LLMToolResponse

java.lang.Object
java.lang.Record
org.mule.weave.extension.api.llm.tools.LLMToolResponse
Record Components:
messages - A list of strings containing messages from the tool's execution. This could include informational messages, error details, or results. The list will be empty if no messages were generated.
success - true if the tool executed successfully, false otherwise. Indicates the overall status of the tool's operation.
public record LLMToolResponse(List<String> messages, boolean success) extends Record
Represents the outcome of a LLMTool execution.

This record encapsulates the result, including any messages generated during the tool's operation and a boolean flag indicating whether the execution was successful.

See Also:

  • Constructor Details

    • LLMToolResponse

      public LLMToolResponse(List<String> messages, boolean success)
      Creates an instance of a LLMToolResponse record class.
      Parameters:
      messages - the value for the messages record component
      success - the value for the success 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • messages

      public List<String> messages()
      Returns the value of the messages record component.
      Returns:
      the value of the messages record component

    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component