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.-
Nested Class Summary
Nested classes/interfaces inherited from interface HarnessEvent
HarnessEvent.ModelMessage, HarnessEvent.ModelThinking, HarnessEvent.ReplyRejected, HarnessEvent.ResponseTruncated, HarnessEvent.SubagentFinished, HarnessEvent.SubagentStarted, HarnessEvent.TokenSpend, HarnessEvent.ToolCallCompleted, HarnessEvent.ToolCallFailed, HarnessEvent.ToolCallRequested, HarnessEvent.TurnFinished, HarnessEvent.TurnStarted, HarnessEvent.WindowUsage -
Constructor Summary
ConstructorsConstructorDescriptionTurnStarted(String userMessage) Creates an instance of aTurnStartedrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.final StringtoString()Returns a string representation of this record class.Returns the value of theuserMessagerecord component.
-
Constructor Details
-
TurnStarted
Creates an instance of aTurnStartedrecord class.- Parameters:
userMessage- the value for theuserMessagerecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object). -
userMessage
Returns the value of theuserMessagerecord component.- Returns:
- the value of the
userMessagerecord component
-