Class AiTableMetaData

java.lang.Object
com.kingsrook.qqq.backend.core.model.metadata.tables.QSupplementalTableMetaData
com.kingsrook.qqq.backend.core.actions.ai.AiTableMetaData
All Implemented Interfaces:
Cloneable
public class AiTableMetaData extends QSupplementalTableMetaData
Supplemental table meta-data (type "ai") for the AI tool kernel: how much of the table is exposed to a model, and an optional description written for a model (aiDescription), used by describe_table, search_help and the app digest. A null exposure means "use the default": NONE for the assistant's own tables, user-session tables and OAuth tables, else the kernel settings' defaultExposure. An explicit exposure always wins over the default.

  • Field Details

  • Constructor Details

    • AiTableMetaData

      public AiTableMetaData()

  • Method Details

    • of

      public static AiTableMetaData of(QTableMetaData table)
      The AiTableMetaData on a table, or null if it has none.

    • ofOrWithNew

      public static AiTableMetaData ofOrWithNew(QTableMetaData table)
      The AiTableMetaData on a table - adding a new (empty) one if it has none.

    • getType

      public String getType()
      Description copied from class: QSupplementalTableMetaData
      Getter for type
      Specified by:
      getType in class QSupplementalTableMetaData

    • finishClone

      protected QSupplementalTableMetaData finishClone(QSupplementalTableMetaData abstractClone)
      Description copied from class: QSupplementalTableMetaData
      finish the cloning operation started in the base class. copy all state from the subclass into the input clone (which can be safely casted to the subclass's type, as it was obtained by super.clone()) Rather than making this public and breaking all existing implementations that don't have it - we're making it protected, with a one-time warning if it isn't implemented in a subclass.
      Overrides:
      finishClone in class QSupplementalTableMetaData

    • getExposure

      public AiExposure getExposure()
      Getter for exposure

    • setExposure

      public void setExposure(AiExposure exposure)
      Setter for exposure

    • withExposure

      public AiTableMetaData withExposure(AiExposure exposure)
      Fluent setter for exposure

    • getAiDescription

      public String getAiDescription()
      Getter for aiDescription

    • setAiDescription

      public void setAiDescription(String aiDescription)
      Setter for aiDescription

    • withAiDescription

      public AiTableMetaData withAiDescription(String aiDescription)
      Fluent setter for aiDescription

    • getClassification

      public DataClassification getClassification()
      Getter for classification (null means not classified)

    • setClassification

      public void setClassification(DataClassification classification)
      Setter for classification

    • withClassification

      public AiTableMetaData withClassification(DataClassification classification)
      Fluent setter for classification