Record Class HarnessEvent.ToolCallFailed

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.ai.HarnessEvent.ToolCallFailed
Record Components:
id - the provider-supplied tool-call id paired with the originating HarnessEvent.ToolCallRequested.
toolName - the name of the tool that failed.
error - the exception thrown by the tool.
All Implemented Interfaces:
HarnessEvent
Enclosing interface:
HarnessEvent

public static record HarnessEvent.ToolCallFailed(String id, String toolName, Throwable error) extends Record implements HarnessEvent
Emitted when a tool invocation throws. The harness catches the exception and reports a fallback string to the model so the conversation can continue; this event surfaces the underlying failure to consumers.
  • Constructor Details

    • ToolCallFailed

      public ToolCallFailed(String id, String toolName, Throwable error)
      Creates an instance of a ToolCallFailed record class.
      Parameters:
      id - the value for the id record component
      toolName - the value for the toolName record component
      error - the value for the error 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.
    • id

      public String id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component
    • toolName

      public String toolName()
      Returns the value of the toolName record component.
      Returns:
      the value of the toolName record component
    • error

      public Throwable error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component