Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
feat(llm): teach the chat models Trilium's inline icons
Elian Doran2e0acc2c813d
diff --git a/packages/trilium-core/src/services/llm/system_prompt.spec.ts b/packages/trilium-core/src/services/llm/system_prompt.spec.tsindex 77856fc69e..6e0d680927 100644--- a/packages/trilium-core/src/services/llm/system_prompt.spec.ts+++ b/packages/trilium-core/src/services/llm/system_prompt.spec.ts@@ -46,8 +46,9 @@ describe("buildSystemPrompt", () => {it("points the user at the toggle that turns a missing capability on", () => {const prompt = buildSystemPrompt([], {}) ?? "";- expect(prompt).toContain("globe icon");- expect(prompt).toContain("note icon");+ // The toggles' own icons, as ChatInputBar draws them, for the model to show the user.+ expect(prompt).toContain(`<span class="tn-icon bx bx-globe"></span> "Web search" toggle`);+ expect(prompt).toContain(`<span class="tn-icon bx bx-note"></span> "Note access" toggle`);expect(prompt).not.toContain("model name dropdown");});@@ -59,6 +60,12 @@ describe("buildSystemPrompt", () => {expect(prompt).toContain("Tables");expect(prompt).toContain("Collapsible blocks");expect(prompt).toContain("Keyboard keys");+ expect(prompt).toContain(`<span class="tn-icon bx bx-cog"></span>`);+ });++ it("names the icon search tool in the icon hint only when the tool is there", () => {+ expect(buildSystemPrompt([], { enableNoteTools: true }) ?? "").toContain("find one with search_icons");+ expect(buildSystemPrompt([], {}) ?? "").not.toContain("find one with search_icons");});it("lists the workspace's custom task-state markers so the model can recognize them", () => {diff --git a/packages/trilium-core/src/services/llm/system_prompt.ts b/packages/trilium-core/src/services/llm/system_prompt.tsindex 2bbe682d5e..76937628c7 100644--- a/packages/trilium-core/src/services/llm/system_prompt.ts+++ b/packages/trilium-core/src/services/llm/system_prompt.ts@@ -104,6 +104,7 @@ export function buildSystemPrompt(messages: LlmMessage[], config: LlmProviderCon+ `<details><summary>Option A</summary>\nDetails about the first option.\n</details>\n<details><summary>Option B</summary>\nDetails about the second option.\n</details>\n\n`+ `**Footnotes** — use \`[^1]\` in text and \`[^1]: explanation\` at the bottom.\n\n`+ `**Keyboard keys** — wrap each key in a \`<kbd>\` tag when documenting shortcuts, e.g. \`<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd>\`.\n\n`+ + buildIconHint(config.enableNoteTools === true)+ buildTaskListHint());@@ -113,6 +114,15 @@ export function buildSystemPrompt(messages: LlmMessage[], config: LlmProviderConreturn parts.length > 0 ? parts.join("\n\n") : undefined;}+/**+ * The inline-icon hint: the `tn-icon` span Trilium's text notes store and the chat renders. The+ * icon search tool is named only when note tools are on, since it is one of them.+ */+function buildIconHint(canSearchIcons: boolean): string {+ const find = canSearchIcons ? ", find one with search_icons" : "";+ return `**Icons** — insert an inline icon as \`<span class="tn-icon bx bx-cog"></span>\`, with the icon's classes in place of \`bx bx-cog\` (Boxicons such as \`bx bx-star\`, or an installed icon pack's${find}). Use one to show a button or other UI element the user should look for, e.g. "click <span class="tn-icon bx bx-cog"></span> to open the settings"; not as decoration, and not in note titles.\n\n`;+}+/*** The task-list formatting hint, extended with the workspace's user-defined multi-state checkboxes so* the model recognizes their markers (e.g. `- [/]` = "Doing") in the user's notes and can produce them.@@ -130,7 +140,11 @@ function buildTaskListHint(): string {/*** Where the user turns a capability on: the icon toggles beside the model- * selector in `ChatInputBar`, each labeled in its tooltip.+ * selector in `ChatInputBar`. The icon classes must match the toggles' own.*/-const NOTE_ACCESS_TOGGLE = `the note icon ("Note access") next to the model selector, below the message box`;-const WEB_SEARCH_TOGGLE = `the globe icon ("Web search") next to the model selector, below the message box`;+const NOTE_ACCESS_TOGGLE = describeToggle("bx bx-note", "Note access");+const WEB_SEARCH_TOGGLE = describeToggle("bx bx-globe", "Web search");++function describeToggle(iconClass: string, label: string): string {+ return `the <span class="tn-icon ${iconClass}"></span> "${label}" toggle next to the model selector, below the message box (include the icon exactly as written, so the user sees the same icon)`;+}