Class NamedQueryPromptComposer
java.lang.Object
com.inductiveautomation.ignition.designer.db.namedquery.workspace.ai.NamedQueryPromptComposer
- All Implemented Interfaces:
PromptComposer
Composes the Named Query authoring panel's state into the host-context blocks sent to
NamedQueryAgent; the framework appends the canonical references block and the user's prompt
after them. Wire format (the agent's system prompt mirrors this — keep them in lockstep):
<database> name: my_postgres_db vendor: POSTGRES </database> <datasources> <datasource> name=datasource_name <datasource> </datasources> <queryType>Query</queryType> <parameters> - name=myValueX, kind=Parameter, dataType=String - name=orderClause, kind=QueryString </parameters> <query> SELECT ... </query> <selection>column_a</selection>
The <database> block is omitted when the datasource is the NamedQuery.DATABASE_PARAM_OPTION Parameter option — the agent falls back to ANSI-portable SQL in
that case. The <selection> block is omitted when nothing is highlighted. The
<datasources> block is omitted when there are no datasources configured on the gateway. The
<references> block is omitted when no autocomplete tokens were inserted; otherwise each
inserted reference appears as a <reference token="...">body</reference> entry keyed by
the literal still present in the prompt (matches the universal framing the harness's
system-prompt addendum documents). that case. The <selection> block is omitted when
nothing is highlighted.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncompose(String userPrompt, List<ContextReference> references) Builds the host-context blocks for one user submission.
-
Constructor Details
-
NamedQueryPromptComposer
- Parameters:
snapshotSupplier- returns the panel's live state on eachcompose(String, List)call. Must snapshot inside the supplier per the embed guide's "state must be snapshotted inside the composer" rule — retries replay the supplier and need fresh state.
-
-
Method Details
-
compose
Description copied from interface:PromptComposerBuilds 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:
composein interfacePromptComposer- 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 inreferences. 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 noPromptAssists 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.
-