Skip to content

ai-text

Enterprise Part of the commercial Kumiko Enterprise offering — not in the open framework.

AI-augmented text actions for the AiTextField/AiTextArea widgets: ghost-text completion, grammar correction, translation, and style rewriting. Exposes ai-text:query:run (mode: complete|correct|translate|rewrite). Each mode’s system prompt, model, effort and token budget live in the prompt-store under ai-text:<mode>, with the shipped text as default. Requires ai-foundation (LLM provider), prompt-store and cap-counter (per-tenant monthly request limit). Toggleable — tenants without it mounted or enabled see the widgets degrade to plain text fields.

This Enterprise implementation is optional. If you need a narrower or domain-specific version, you can build an app-owned feature, handler, or job with Kumiko’s public extension points.

Use this package when you want the maintained implementation, its existing contracts, and the surrounding operational behavior. A custom implementation is not drop-in compatible automatically: your app owns its authorization, validation, integrations, tests, security review, and production operations.

Start with Features and composition and Custom write handlers.

What this feature needs to run (Requires, top) and the write commands this feature provides (Provides, bottom).

flowchart TB
  n_ai_text["ai-text"]
  subgraph how_reqs["Requires"]
    n_ai_foundation["ai-foundation"]
    n_prompt_store["prompt-store"]
    n_cap_counter["cap-counter"]
  end
  subgraph how_provides["Provides"]
    n_cmd_ai_text_write_log(["log"])
  end
  n_ai_foundation --> n_ai_text
  n_prompt_store --> n_ai_text
  n_cap_counter --> n_ai_text
  n_ai_text --> n_cmd_ai_text_write_log

Provides — write commands this feature registers (dispatch them through the command bus):

  • ai-text:write:log

Per-tenant config keys, set via the tenant-admin UI or a seed. 🔒 = encrypted at rest.

KeyTypeDefaultScopeWho can writeWho can read
monthly-request-limitnumber (1–1000000)1000tenantTenantAdmin, SystemAdminTenantAdmin, SystemAdmin, User