Enum Class AiExposure

java.lang.Object
java.lang.Enum<AiExposure>
com.kingsrook.qqq.backend.core.actions.ai.AiExposure
All Implemented Interfaces:
Serializable, Comparable<AiExposure>, Constable
public enum AiExposure extends Enum<AiExposure>
How much of a table or field the AI tool kernel may expose to a model. Ordered from most to least restrictive: NONE - invisible to the assistant: omitted from descriptions, and rejected if named in a filter, field list or sort. METADATA_ONLY - the assistant knows it exists and may filter (or sort) on it server-side, but its values are never sent to the model. MASKED - values are sent partially masked (e.g., j***@example.com, ***1234). VALUES - values are sent (after redaction and truncation). A table's exposure caps the exposure of each of its fields.

  • Enum Constant Details

  • Method Details

    • values

      public static AiExposure[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static AiExposure valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • mostRestrictive

      public AiExposure mostRestrictive(AiExposure other)
      The more restrictive of this exposure and another (null is ignored).

    • allowsValues

      public boolean allowsValues()
      Whether values at this exposure may be sent to a model (masked or not).