Record Class HarnessEvent.TurnStarted

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.ai.HarnessEvent.TurnStarted
Record Components:
userMessage - the user message that initiated the turn.
All Implemented Interfaces:
HarnessEvent
Enclosing interface:
HarnessEvent

public static record HarnessEvent.TurnStarted(String userMessage) extends Record implements HarnessEvent
Emitted at the start of each conversation turn, immediately after the user's message has been accepted but before the first request is sent to the model. Pairs with a terminating HarnessEvent.TurnFinished on the same thread.
  • Constructor Details

    • TurnStarted

      public TurnStarted(String userMessage)
      Creates an instance of a TurnStarted record class.
      Parameters:
      userMessage - the value for the userMessage 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.
    • userMessage

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