Record Class UnifiedResponse

java.lang.Object
java.lang.Record
com.tnsai.channels.api.UnifiedResponse
Record Components:
channelId - target adapter id
conversationId - target chat/channel/thread
text - response text
attachments - files to send along with the response
hints - delivery hints (streaming, typing, message splitting)

public record UnifiedResponse(String channelId, String conversationId, String text, List<Attachment> attachments, ResponseHints hints) extends Record
Platform-agnostic outbound response. The gateway produces this after agent processing; the channel adapter converts it into the native platform format.
  • Constructor Details

    • UnifiedResponse

      public UnifiedResponse(String channelId, String conversationId, String text, List<Attachment> attachments, ResponseHints hints)
      Creates an instance of a UnifiedResponse record class.
      Parameters:
      channelId - the value for the channelId record component
      conversationId - the value for the conversationId record component
      text - the value for the text record component
      attachments - the value for the attachments record component
      hints - the value for the hints record component
  • Method Details

    • builder

      public static UnifiedResponse.Builder builder()
    • 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.
    • channelId

      public String channelId()
      Returns the value of the channelId record component.
      Returns:
      the value of the channelId record component
    • conversationId

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

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

      public List<Attachment> attachments()
      Returns the value of the attachments record component.
      Returns:
      the value of the attachments record component
    • hints

      public ResponseHints hints()
      Returns the value of the hints record component.
      Returns:
      the value of the hints record component