Record Class HarnessEvent.TokenSpend

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.ai.HarnessEvent.TokenSpend
Record Components:
inputTokens - input tokens billed for this single chat call.
outputTokens - output tokens billed for this single chat call.
All Implemented Interfaces:
HarnessEvent
Enclosing interface:
HarnessEvent

public static record HarnessEvent.TokenSpend(int inputTokens, int outputTokens) extends Record implements HarnessEvent
Emitted after a chat response that reports token usage, carrying the input and output tokens billed for that one call. Suppressed when the provider returns no usage information, so this event is best-effort: a turn with no usage reports produces no HarnessEvent.TokenSpend events at all. Per-call deltas, not cumulative — consumers that want a session total sum these themselves.

Sub-harness HarnessEvent.TokenSpend events are forwarded into the orchestrator's stream, so a parent consumer sees one event per chat call across the entire orchestrator + subagent tree, not one per chat call in the orchestrator's own loop. Subagent events arrive between the enclosing HarnessEvent.SubagentStarted and HarnessEvent.SubagentFinished.

  • Constructor Details

    • TokenSpend

      public TokenSpend(int inputTokens, int outputTokens)
      Creates an instance of a TokenSpend record class.
      Parameters:
      inputTokens - the value for the inputTokens record component
      outputTokens - the value for the outputTokens 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 the compare method from their corresponding wrapper classes.
      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.
    • inputTokens

      public int inputTokens()
      Returns the value of the inputTokens record component.
      Returns:
      the value of the inputTokens record component
    • outputTokens

      public int outputTokens()
      Returns the value of the outputTokens record component.
      Returns:
      the value of the outputTokens record component