Class ComponentPropsPromptComposer

java.lang.Object
com.inductiveautomation.perspective.designer.workspace.propertyeditor.ai.ComponentPropsPromptComposer
All Implemented Interfaces:
PromptComposer

public final class ComponentPropsPromptComposer extends Object implements PromptComposer
PromptComposer for ComponentPropsAgent. Re-snapshots the live PROPS JSON on every submit and contributes it as a <currentProps> block; that framing must stay in sync with the agent's system prompt.
  • Constructor Details

    • ComponentPropsPromptComposer

      public ComponentPropsPromptComposer(Supplier<@Nullable com.inductiveautomation.ignition.common.gson.JsonObject> currentPropsSupplier)
      Parameters:
      currentPropsSupplier - reads the component's PROPS JSON from the live selection on every call. Capturing a JsonObject once at construction would replay stale state on retry, so pass a supplier that re-reads from the selection each time.
  • Method Details

    • compose

      public CompletableFuture<String> compose(String userPrompt, List<ContextReference> references)
      Description copied from interface: PromptComposer
      Builds the host-context blocks for one user submission. The framework appends the canonical references block and the user's prompt after whatever this returns.
      Specified by:
      compose in interface PromptComposer
      Parameters:
      userPrompt - the text the user typed into the prompt box, including any inline reference tokens (e.g. @tag:[default]Tank/Level) that match entries in references. Provided so composers can adapt their context to the request; implementations must not append it to their output — the framework places it.
      references - references the user inserted via the autocomplete popup, each with its body already resolved. Empty when the user inserted no references — or when no PromptAssists were supplied to the session. Provided so composers can load extra context keyed off a reference (e.g. OPC grounding); implementations must not render the references themselves — the framework emits the canonical block.
      Returns:
      a future completing with the host-context blocks, or the empty string when the host has nothing to contribute. Sync composers return CompletableFuture.completedFuture(Object); composers that defer slow reads return a future they complete on a worker thread.