Record Class ContextSection

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.ai.ContextSection
Record Components:
heading - the section heading, rendered as a level-2 markdown heading.
body - the section body. Already trimmed by of(String, String).

public record ContextSection(String heading, String body) extends Record
A heading and body pair contributed to an Agent's additional context. The combiner in ComposedAgent renders each section as ## heading\n\nbody; bodies that arrive without a heading or with no body are excluded by construction via of(String, String).
  • Constructor Details

    • ContextSection

      public ContextSection(String heading, String body)
      Creates an instance of a ContextSection record class.
      Parameters:
      heading - the value for the heading record component
      body - the value for the body record component
  • Method Details

    • of

      public static Optional<ContextSection> of(String heading, @Nullable String body)
      Builds a section if body is non-null and not blank, otherwise empty. The body is trimmed before storage so callers don't have to.
      Parameters:
      heading - the section heading.
      body - the section body, or null if no body is available.
      Returns:
      a section wrapping heading and the trimmed body, or empty if body is null or blank.
    • 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.
    • heading

      public String heading()
      Returns the value of the heading record component.
      Returns:
      the value of the heading record component
    • body

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