Package com.axelor.ai.chat

Record Class ToolResult.Success

java.lang.Object
java.lang.Record
com.axelor.ai.chat.ToolResult.Success
Record Components:
output - the tool's return value, serialized as JSON in stream events
shown - whether the output is drawn for the reader, not only read by the model: it is kept whole even when repeated, and a consulting parent is told it is already in the answer
All Implemented Interfaces:
ToolResult
Enclosing interface:
ToolResult
public static record ToolResult.Success(Object output, boolean shown) extends Record implements ToolResult

  • Constructor Details

    • Success

      public Success(Object output)

    • Success

      public Success(Object output, boolean shown)
      Creates an instance of a Success record class.
      Parameters:
      output - the value for the output record component
      shown - the value for the shown 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.

    • output

      public Object output()
      Returns the value of the output record component.
      Returns:
      the value of the output record component

    • shown

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