Class FilePromptAssist
- All Implemented Interfaces:
PromptAssist
PromptAssist that exposes the project's file-resource tree through the @-popup.
Folders render as PromptAssist.Option.DrillIn rows; files whose resolved content type is textual
render as PromptAssist.Option.Insert rows whose body carries the file's content verbatim. Binary files
(images, PDFs, archives, application/octet-stream) are hidden from the popup so the
autocomplete only surfaces references whose bodies are useful as model context.
Eligibility. A file's content type is resolved the same way the File Resource editor
resolves it — the stored content-type attribute, else an extension guess, else the binary-safe
default — and tested with FileResourceUtil.isTextContentType(String), so the popup and the editor
agree on which files are text.
Query format. The query string is a file-resource path with / as the separator:
empty browses the workspace root, "foo/" browses inside foo, "foo/bar"
browses foo filtering children by name-prefix bar.
Literal contract. Inserts produce tokens shaped @file:path/to/file.ext. The
framework builds the @file: prefix from id(); the assist supplies only the
/-separated path within the project's file-resource tree. The @file: prefix keeps
these tokens distinct from other assists' and from anything typed by hand, and names the
namespace the agent reads them under — file references carry a plain text body, so nothing
downcasts them.
Snapshot semantics. Each PromptAssist.Option.Insert's supplier closes over the file's bytes
captured at the moment the user selected the row — not a live re-read. A file that is renamed,
deleted, or edited between selection and submit will still surface the snapshot the user
originally pointed at. This matches the documented prompt-assist contract: the supplier runs on
the EDT at submit time and must not block.
-
Nested Class Summary
Nested classes/interfaces inherited from interface PromptAssist
PromptAssist.Option -
Constructor Summary
Constructors -
Method Summary
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface PromptAssist
separator
-
Constructor Details
-
FilePromptAssist
-
-
Method Details
-
id
- Specified by:
idin interfacePromptAssist- Returns:
- the machine identifier owning this assist's
@<id>:token namespace. Lowercase[a-z0-9-]+, short (e.g."tag","opc"). - See Also:
-
label
- Specified by:
labelin interfacePromptAssist- Returns:
- a short friendly label for this assist to show in the UI.
-
agentContext
Description copied from interface:PromptAssistSelf-description appended to the embedded agent's system prompt. The embed concatenates the fragments from every mounted assist into a single addendum so each provider documents its own token shape and reference-body schema in one place, decoupled from any specific agent's translation rules. Fragments are expected to be Markdown; the embed adds a heading for each assist usingPromptAssist.label()and joins them with blank lines.The embed's framing already tells the model every token is shaped
@<id>:<path>and announces this assist's@<id>:prefix in its section heading, so the fragment should not restate the generic shape. It should cover:- the grammar of the
<path>portion, with a concrete example token; - the schema of the
<reference token="...">body</reference>body the embed will attach when one of those tokens appears — the line names (Path:,Type:, …) the agent should look for and what they mean; - a one-line statement of what the reference represents semantically (so the agent can reason about it without knowing this assist exists).
- Specified by:
agentContextin interfacePromptAssist- Returns:
- the Markdown fragment, or
Optional.empty()when the assist has nothing to contribute (e.g. unit-test stubs).
- the grammar of the
-
options
Description copied from interface:PromptAssistFetch the rows to show forquery.- Specified by:
optionsin interfacePromptAssist- Parameters:
query- the text the user has typed past the trigger character, or thePromptAssist.Option.DrillIn.nextQueryof a row the user just selected. Empty when the user has just typed the trigger and has not yet typed anything else.- Returns:
- the rows to render. The framework discards stale results silently, so an implementation that completes after a newer query has been issued does not need to special-case the race.
-