feat: Support customizing the summarization prompt. Fixes #731

hoarder-app · Jan 12, 2025 · b8bd7d7 · b8bd7d7
1 parent 1ec21b6
commit b8bd7d7
Show file tree

Hide file tree

Showing 10 changed files with 1,649 additions and 16 deletions.
diff --git a/apps/web/components/settings/AISettings.tsx b/apps/web/components/settings/AISettings.tsx
@@ -27,7 +27,11 @@ import { Plus, Save, Trash2 } from "lucide-react";
 import { useForm } from "react-hook-form";
 import { z } from "zod";
 
-import { buildImagePrompt, buildTextPrompt } from "@hoarder/shared/prompts";
+import {
+  buildImagePrompt,
+  buildSummaryPrompt,
+  buildTextPrompt,
+} from "@hoarder/shared/prompts";
 import {
   zNewPromptSchema,
   ZPrompt,
@@ -42,7 +46,7 @@ export function PromptEditor() {
     resolver: zodResolver(zNewPromptSchema),
     defaultValues: {
       text: "",
-      appliesTo: "all",
+      appliesTo: "all_tagging",
     },
   });
 
@@ -100,9 +104,18 @@ export function PromptEditor() {
                     </SelectTrigger>
                     <SelectContent>
                       <SelectGroup>
-                        <SelectItem value="all">All</SelectItem>
-                        <SelectItem value="text">Text</SelectItem>
-                        <SelectItem value="images">Images</SelectItem>
+                        <SelectItem value="all_tagging">
+                          {t("settings.ai.all_tagging")}
+                        </SelectItem>
+                        <SelectItem value="text">
+                          {t("settings.ai.text_tagging")}
+                        </SelectItem>
+                        <SelectItem value="images">
+                          {t("settings.ai.image_tagging")}
+                        </SelectItem>
+                        <SelectItem value="summary">
+                          {t("settings.ai.summarization")}
+                        </SelectItem>
                       </SelectGroup>
                     </SelectContent>
                   </Select>
@@ -214,9 +227,18 @@ export function PromptRow({ prompt }: { prompt: ZPrompt }) {
                     </SelectTrigger>
                     <SelectContent>
                       <SelectGroup>
-                        <SelectItem value="all">All</SelectItem>
-                        <SelectItem value="text">Text</SelectItem>
-                        <SelectItem value="images">Images</SelectItem>
+                        <SelectItem value="all_tagging">
+                          {t("settings.ai.all_tagging")}
+                        </SelectItem>
+                        <SelectItem value="text">
+                          {t("settings.ai.text_tagging")}
+                        </SelectItem>
+                        <SelectItem value="images">
+                          {t("settings.ai.image_tagging")}
+                        </SelectItem>
+                        <SelectItem value="summary">
+                          {t("settings.ai.summarization")}
+                        </SelectItem>
                       </SelectGroup>
                     </SelectContent>
                   </Select>
@@ -289,7 +311,9 @@ export function PromptDemo() {
         {buildTextPrompt(
           clientConfig.inference.inferredTagLang,
           (prompts ?? [])
-            .filter((p) => p.appliesTo == "text" || p.appliesTo == "all")
+            .filter(
+              (p) => p.appliesTo == "text" || p.appliesTo == "all_tagging",
+            )
             .map((p) => p.text),
           "\n<CONTENT_HERE>\n",
           /* context length */ 1024 /* The value here doesn't matter */,
@@ -300,10 +324,23 @@ export function PromptDemo() {
         {buildImagePrompt(
           clientConfig.inference.inferredTagLang,
           (prompts ?? [])
-            .filter((p) => p.appliesTo == "images" || p.appliesTo == "all")
+            .filter(
+              (p) => p.appliesTo == "images" || p.appliesTo == "all_tagging",
+            )
             .map((p) => p.text),
         ).trim()}
       </code>
+      <p>{t("settings.ai.summarization_prompt")}</p>
+      <code className="whitespace-pre-wrap rounded-md bg-muted p-3 text-sm text-muted-foreground">
+        {buildSummaryPrompt(
+          clientConfig.inference.inferredTagLang,
+          (prompts ?? [])
+            .filter((p) => p.appliesTo == "summary")
+            .map((p) => p.text),
+          "\n<CONTENT_HERE>\n",
+          /* context length */ 1024 /* The value here doesn't matter */,
+        ).trim()}
+      </code>
     </div>
   );
 }

diff --git a/apps/web/lib/i18n/locales/en/translation.json b/apps/web/lib/i18n/locales/en/translation.json
@@ -87,7 +87,12 @@
       "tagging_rule_description": "Prompts that you add here will be included as rules to the model during tag generation. You can view the final prompts in the prompt preview section.",
       "prompt_preview": "Prompt Preview",
       "text_prompt": "Text Prompt",
-      "images_prompt": "Image Prompt"
+      "images_prompt": "Image Prompt",
+      "summarization_prompt": "Summarization Prompt",
+      "all_tagging": "All Tagging",
+      "text_tagging": "Text Tagging",
+      "image_tagging": "Image Tagging",
+      "summarization": "Summarization"
     },
     "feeds": {
       "rss_subscriptions": "RSS Subscriptions",

diff --git a/apps/workers/openaiWorker.ts b/apps/workers/openaiWorker.ts
@@ -172,7 +172,7 @@ async function fetchCustomPrompts(
   const prompts = await db.query.customPrompts.findMany({
     where: and(
       eq(customPrompts.userId, userId),
-      inArray(customPrompts.appliesTo, ["all", appliesTo]),
+      inArray(customPrompts.appliesTo, ["all_tagging", appliesTo]),
     ),
     columns: {
       text: true,

diff --git a/packages/db/drizzle/0038_calm_clint_barton.sql b/packages/db/drizzle/0038_calm_clint_barton.sql
@@ -0,0 +1,2 @@
+UPDATE `customPrompts` SET `attachedBy` = 'all_tagging' WHERE `attachedBy` = 'all';--> statement-breakpoint
+ALTER TABLE `customPrompts` RENAME COLUMN `attachedBy` TO `appliesTo`;
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		UPDATE `customPrompts` SET `attachedBy` = 'all_tagging' WHERE `attachedBy` = 'all';--> statement-breakpoint
		ALTER TABLE `customPrompts` RENAME COLUMN `attachedBy` TO `appliesTo`;