Record Class HarnessEvent.ToolCallRequested

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.ai.HarnessEvent.ToolCallRequested
Record Components:
id - the provider-supplied tool-call id; pairs this event with its terminal HarnessEvent.ToolCallCompleted or HarnessEvent.ToolCallFailed.
toolName - the name of the tool the model asked to invoke.
argsJson - the raw JSON-encoded arguments produced by the model.
All Implemented Interfaces:
HarnessEvent
Enclosing interface:
HarnessEvent

public static record HarnessEvent.ToolCallRequested(String id, String toolName, String argsJson) extends Record implements HarnessEvent
Emitted when the model requests a tool invocation, before the tool runs.
  • Constructor Details

    • ToolCallRequested

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

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