Package ai.acolite.agentsdk.core

Record Class RunItemStreamEvent

java.lang.Object
java.lang.Record
ai.acolite.agentsdk.core.RunItemStreamEvent
All Implemented Interfaces:
RunStreamEvent
public record RunItemStreamEvent(RunItem item, int turnIndex) extends Record implements RunStreamEvent
RunItemStreamEvent

Emitted when a new item is added to the conversation (message, tool call, tool output, etc.)

Source: https://github.com/openai/openai-agents-js/blob/main/packages/agents-core/src/events.ts

  • Constructor Summary

    Constructors
    Constructor
    Description
    RunItemStreamEvent(RunItem item, int turnIndex)
    Creates an instance of a RunItemStreamEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    getType()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    RunItem
    item()
    Returns the value of the item record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    turnIndex()
    Returns the value of the turnIndex record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RunItemStreamEvent

      public RunItemStreamEvent(RunItem item, int turnIndex)
      Creates an instance of a RunItemStreamEvent record class.
      Parameters:
      item - the value for the item record component
      turnIndex - the value for the turnIndex record component

  • Method Details

    • getType

      public String getType()
      Specified by:
      getType in interface RunStreamEvent

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • item

      public RunItem item()
      Returns the value of the item record component.
      Returns:
      the value of the item record component

    • turnIndex

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