Package io.agentscope.core.agui.event

Record Class AguiEvent.ToolCallResult

java.lang.Object
java.lang.Record
io.agentscope.core.agui.event.AguiEvent.ToolCallResult
All Implemented Interfaces:
AguiEvent
Enclosing interface:
AguiEvent
public static record AguiEvent.ToolCallResult(String threadId, String runId, String toolCallId, String content, String role, String messageId) extends Record implements AguiEvent
Event containing the result of a tool call.

  • Constructor Details

    • ToolCallResult

      public ToolCallResult(String threadId, String runId, String toolCallId, String content, String role, String messageId)
      Creates an instance of a ToolCallResult record class.
      Parameters:
      threadId - the value for the threadId record component
      runId - the value for the runId record component
      toolCallId - the value for the toolCallId record component
      content - the value for the content record component
      role - the value for the role record component
      messageId - the value for the messageId record component

  • Method Details

    • getType

      public AguiEventType getType()
      Description copied from interface: AguiEvent
      Get the event type.
      Specified by:
      getType in interface AguiEvent
      Returns:
      The event type

    • getThreadId

      public String getThreadId()
      Description copied from interface: AguiEvent
      Get the thread ID associated with this event.
      Specified by:
      getThreadId in interface AguiEvent
      Returns:
      The thread ID

    • getRunId

      public String getRunId()
      Description copied from interface: AguiEvent
      Get the run ID associated with this event.
      Specified by:
      getRunId in interface AguiEvent
      Returns:
      The run ID

    • getRole

      public String getRole()

    • getMessageId

      public String getMessageId()

    • 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.

    • threadId

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

    • runId

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

    • toolCallId

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

    • content

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

    • role

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

    • messageId

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