Record Class TranscriptPolicy

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.ai.TranscriptPolicy
Record Components:
enabled - whether the harness writes a transcript.

public record TranscriptPolicy(boolean enabled) extends Record
Whether a harness writes a conversation transcript. Where transcripts land, what format they use, and how many are retained are the owning AiContext's concern — a caller opts in or out and nothing more.

This is a record instead of a plain boolean to leave room for other potential transcript options in the future, such as a per-harness retention policy or a custom transcript directory.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TranscriptPolicy
    Write no transcript for this harness.
    static final TranscriptPolicy
    Write a transcript to the owning context's transcript directory.
  • Constructor Summary

    Constructors
    Constructor
    Description
    TranscriptPolicy(boolean enabled)
    Creates an instance of a TranscriptPolicy record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns the value of the enabled record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    of(boolean enabled)
    Convenience for call sites gated on a system property or user setting.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • ENABLED

      public static final TranscriptPolicy ENABLED
      Write a transcript to the owning context's transcript directory. The default.
    • DISABLED

      public static final TranscriptPolicy DISABLED
      Write no transcript for this harness.
  • Constructor Details

    • TranscriptPolicy

      public TranscriptPolicy(boolean enabled)
      Creates an instance of a TranscriptPolicy record class.
      Parameters:
      enabled - the value for the enabled record component
  • Method Details

    • of

      public static TranscriptPolicy of(boolean enabled)
      Convenience for call sites gated on a system property or user setting.
      Parameters:
      enabled - whether to write a transcript.
      Returns:
      ENABLED or DISABLED.
    • 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 the compare method from their corresponding wrapper classes.
      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.
    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component