Package ai.confiqure

Annotation Type Confiqure.Secret

Enclosing class:
Confiqure

@Target(FIELD) @Retention(RUNTIME) public static @interface Confiqure.Secret
Classifies a String field as a secret (password, API token, TOTP seed, …). The engine keeps the plaintext OUT of the conversation entirely: the user enters the value in a masked input that posts directly to the engine, the stored configuration carries an opaque secret_ref:… reference, and the real value — encrypted at rest — is substituted back ONLY where your application receives the data (tool-call bodies and the data API). The chat model, the transcript, and the logs only ever see the reference.

Gate predicates may test whether a secret is present (password != null) but never its value — a value comparison against a secret field fails the push.

 @Confiqure.Secret(kind = Confiqure.SecretKind.PASSWORD)
 private String password;
 
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    What kind of credential this is (drives masking hints and audit labels).
  • Element Details

    • kind

      What kind of credential this is (drives masking hints and audit labels).
      Default:
      PASSWORD