Package ai.octoryn.sdk

Record Class StreamEvent

java.lang.Object
java.lang.Record
ai.octoryn.sdk.StreamEvent
public record StreamEvent(String type, String text, ToolCall toolCall, Usage usage, String finishReason, GovernanceMetadata octoryn, com.fasterxml.jackson.databind.JsonNode providerEvent, Throwable error) extends Record

  • Constructor Details

    • StreamEvent

      public StreamEvent(String type, String text, ToolCall toolCall, Usage usage, String finishReason, GovernanceMetadata octoryn, com.fasterxml.jackson.databind.JsonNode providerEvent, Throwable error)
      Creates an instance of a StreamEvent record class.
      Parameters:
      type - the value for the type record component
      text - the value for the text record component
      toolCall - the value for the toolCall record component
      usage - the value for the usage record component
      finishReason - the value for the finishReason record component
      octoryn - the value for the octoryn record component
      providerEvent - the value for the providerEvent record component
      error - the value for the error record component

  • Method Details

    • start

      public static StreamEvent start(GovernanceMetadata metadata)

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

    • type

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

    • text

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

    • toolCall

      public ToolCall toolCall()
      Returns the value of the toolCall record component.
      Returns:
      the value of the toolCall record component

    • usage

      public Usage usage()
      Returns the value of the usage record component.
      Returns:
      the value of the usage record component

    • finishReason

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

    • octoryn

      public GovernanceMetadata octoryn()
      Returns the value of the octoryn record component.
      Returns:
      the value of the octoryn record component

    • providerEvent

      public com.fasterxml.jackson.databind.JsonNode providerEvent()
      Returns the value of the providerEvent record component.
      Returns:
      the value of the providerEvent record component

    • error

      public Throwable error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component