Package ai.confiqure

Annotation Type Confiqure

@Target(TYPE) @Retention(RUNTIME) public @interface Confiqure
Marks a class as a confiqure.ai configuration target. The confiqure CLI scans source files for this annotation and uploads them; the confiqure backend AI parses the annotated class and generates the chat playbook. 
 @Confiqure(
     end      = "/notifications",
     type     = Confiqure.Type.SINGLE,
     scope    = Confiqure.Scope.LIMITED,
     tools    = {"SEND_TEST_NOTIFICATION"}
 )
 public class Notifications { ... }

Tools come in two kinds, both declared once as a Confiqure.Tool-annotated method and referenced by name in tools():

  • Server-side (serverSide=true, the default) — a real controller method confiqure invokes over HTTP. Returns data or performs a backend action; no UI.
  • Frontend (serverSide=false) — a contract-stub method (body never runs on the backend) whose handler runs in the host's browser via the embed SDK. Use for anything needing a UI (OAuth, a picker, rendering a view). The method signature still carries the I/O contract: its @RequestBody DTO is the input, its return type the output. Example: 
           @Confiqure.Tool(name = "show_report", serverSide = false)
       public String showReport(@RequestBody StockFilterData filter) { return null; }

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    Confiqure.DefaultCallbackHook
    Marks a controller method as the workspace's default callback hook.
    static enum 
    Confiqure.Scope
     
    static @interface 
    Confiqure.Tool
    Marks a method as a tool the chat agent can invoke during a session.
    static enum 
    Confiqure.Type
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    end
    Chat endpoint segment.
    Confiqure.Scope
    scope
    Chat context scope: LIMITED (this endpoint only) or UNLIMITED (can navigate all endpoints).
    String[]
    tools
    Names of @Confiqure.Tool methods this endpoint can invoke during chat.
    Confiqure.Type
    type
    Configuration shape: SINGLE (one record per user) or MULTI (table of records).

  • Element Details

    • end

      String end
      Chat endpoint segment. Defaults to snake_case of the class name when blank.
      Default:
      ""

    • type

      Confiqure.Type type
      Configuration shape: SINGLE (one record per user) or MULTI (table of records).
      Default:
      SINGLE

    • scope

      Confiqure.Scope scope
      Chat context scope: LIMITED (this endpoint only) or UNLIMITED (can navigate all endpoints).
      Default:
      LIMITED

    • tools

      String[] tools
      Names of @Confiqure.Tool methods this endpoint can invoke during chat.
      Default:
      {}