Package ai.mindconnect.agent.tool

Record Class ToolAdvisor.Result

java.lang.Object
java.lang.Record
ai.mindconnect.agent.tool.ToolAdvisor.Result
Record Components:
text - text the LLM consumes as the tool result
failed - true when the tool was unknown, threw, or was short-circuited as a failure
Enclosing interface:
ToolAdvisor
public static record ToolAdvisor.Result(String text, boolean failed) extends Record
What the LLM ends up seeing. text is the tool result string (or an error description on failure). failed drives the runtime's failure-event vs success-event branch — advisors usually don't flip this, but a sanitizer may downgrade a successful but blocked call to failed=true with an explanatory text.

  • Constructor Details

    • Result

      public Result(String text, boolean failed)
      Creates an instance of a Result record class.
      Parameters:
      text - the value for the text record component
      failed - the value for the failed record component

  • Method Details

    • ok

      public static ToolAdvisor.Result ok(String text)

    • error

      public static ToolAdvisor.Result error(String text)

    • withText

      public ToolAdvisor.Result withText(String next)
      Returns a copy with the result text replaced.

    • append

      public ToolAdvisor.Result append(String extra)
      Returns a copy with extra appended after a blank line. Convenient for advisors that add a progress footer / status hint without disturbing the original output.

    • 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.

    • text

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • failed

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