Speakr is a personal, self-hosted web application designed for transcribing audio recordings
Python
Let users append or replace the summarization prompt at generate-summary time via a split button and modal
Murtaza Nasir4858a1c31297
diff --git a/src/api/recordings.py b/src/api/recordings.pyindex 4886139e..2c8b9368 100644--- a/src/api/recordings.py+++ b/src/api/recordings.py@@ -620,7 +620,14 @@ def download_notes_word(recording_id):@recordings_bp.route('/recording/<int:recording_id>/generate_summary', methods=['POST'])@login_requireddef generate_summary_endpoint(recording_id):- """Generate summary for a recording that doesn't have one."""+ """Generate summary for a recording that doesn't have one.++ Optional JSON body:+ - custom_prompt (string): user-supplied summarization instructions.+ - prompt_mode ('replace' | 'append', default 'replace'): in 'replace'+ mode the custom prompt overrides the resolved default; in 'append'+ mode it is appended after the resolved default as additional context.+ """try:recording = db.session.get(Recording, recording_id)if not recording:@@ -645,14 +652,31 @@ def generate_summary_endpoint(recording_id):if client is None:return jsonify({'error': 'Summary service is not available (OpenRouter client not configured)'}), 503- current_app.logger.info(f"Queueing summary generation for recording {recording_id}")+ # Optional custom prompt + mode (issue / discussion #253)+ data = request.get_json(silent=True) or {}+ raw_prompt = data.get('custom_prompt')+ custom_prompt = raw_prompt.strip() if isinstance(raw_prompt, str) and raw_prompt.strip() else None+ prompt_mode = (data.get('prompt_mode') or 'replace').strip().lower()+ if prompt_mode not in ('replace', 'append'):+ prompt_mode = 'replace'+ custom_prompt_append = bool(custom_prompt) and prompt_mode == 'append'++ current_app.logger.info(+ f"Queueing summary generation for recording {recording_id}"+ + (f" with custom prompt (mode={prompt_mode}, length={len(custom_prompt)})" if custom_prompt else "")+ )# Queue summary generation job+ job_params = {'user_id': current_user.id}+ if custom_prompt:+ job_params['custom_prompt'] = custom_prompt+ job_params['custom_prompt_append'] = custom_prompt_append+job_queue.enqueue(user_id=current_user.id,recording_id=recording.id,job_type='summarize',- params={'user_id': current_user.id}+ params=job_params,)return jsonify({diff --git a/src/services/job_queue.py b/src/services/job_queue.pyindex 92c2ffc8..794e0de3 100644--- a/src/services/job_queue.py+++ b/src/services/job_queue.py@@ -413,6 +413,7 @@ class FairJobQueue:current_app._get_current_object().app_context(),recording.id,custom_prompt_override=params.get('custom_prompt'),+ custom_prompt_append=params.get('custom_prompt_append', False),user_id=params.get('user_id'))diff --git a/src/tasks/processing.py b/src/tasks/processing.pyindex 21e107db..e353865e 100644--- a/src/tasks/processing.py+++ b/src/tasks/processing.py@@ -395,13 +395,18 @@ Title:"""return None-def generate_summary_only_task(app_context, recording_id, custom_prompt_override=None, user_id=None):+def generate_summary_only_task(app_context, recording_id, custom_prompt_override=None, custom_prompt_append=False, user_id=None):"""Generates only a summary for a recording (no title, no JSON response).Args:app_context: Flask app contextrecording_id: ID of the recording- custom_prompt_override: Optional custom prompt that overrides all other prompts (for reprocessing)+ custom_prompt_override: Optional user-supplied summarization instructions.+ By default this REPLACES the resolved default prompt (tag/folder/user/admin).+ When ``custom_prompt_append`` is True, it is appended to the resolved+ default as additional context instead.+ custom_prompt_append: When True, append ``custom_prompt_override`` to the+ resolved default prompt rather than replacing it.user_id: Optional user ID to filter tag visibility (defaults to recording owner)"""with app_context:@@ -506,10 +511,11 @@ def generate_summary_only_task(app_context, recording_id, custom_prompt_overridelanguage_directive = f"IMPORTANT: You MUST provide the summary in {user_output_language}. The entire response must be in {user_output_language}." if user_output_language else ""- # Determine which summarization instructions to use- # Priority order: custom_prompt_override > tag custom prompt > folder custom prompt > user summary prompt > admin default prompt > hardcoded fallback+ # Determine which summarization instructions to use.+ # Priority order: custom_prompt_override > tag custom prompt > folder custom prompt > user summary prompt > admin default prompt > hardcoded fallback.+ # When custom_prompt_append is True the override is appended to the resolved default rather than replacing it.summarization_instructions = ""- if custom_prompt_override:+ if custom_prompt_override and not custom_prompt_append:current_app.logger.info(f"Using custom prompt override for recording {recording_id} (length: {len(custom_prompt_override)})")summarization_instructions = custom_prompt_overrideelif tag_custom_prompt:@@ -535,6 +541,19 @@ def generate_summary_only_task(app_context, recording_id, custom_prompt_override- **Action Items**: A bulleted list of tasks assigned, including who is responsible if mentioned"""current_app.logger.info(f"Using hardcoded default prompt for recording {recording_id}")+ # Append the user's per-run additions on top of the resolved default+ # (issue / discussion #253). This is how a user supplies a meeting agenda+ # or one-off context without rewriting their saved summary prompt.+ if custom_prompt_override and custom_prompt_append:+ current_app.logger.info(+ f"Appending custom prompt to resolved default for recording {recording_id} "+ f"(append length: {len(custom_prompt_override)})"+ )+ summarization_instructions = (+ f"{summarization_instructions}\n\n"+ f"Additional context for this recording:\n{custom_prompt_override}"+ )+# Build context informationcurrent_date = datetime.now().strftime("%B %d, %Y")context_parts = []diff --git a/static/js/app.modular.js b/static/js/app.modular.jsindex 8fd375ad..7ff0ed29 100644--- a/static/js/app.modular.js+++ b/static/js/app.modular.js@@ -422,6 +422,9 @@ document.addEventListener('DOMContentLoaded', async () => {const showSharesListModal = ref(false);const showTextEditorModal = ref(false);const showAsrEditorModal = ref(false);+ const showCustomizeSummaryModal = ref(false);+ const customizeSummaryPrompt = ref('');+ const customizeSummaryMode = ref('append'); // 'append' | 'replace'const editingRecording = ref(null);const editingTranscriptionContent = ref('');const editingSegments = ref([]);@@ -715,7 +718,7 @@ document.addEventListener('DOMContentLoaded', async () => {// ModalsshowEditModal, showDeleteModal, showEditTagsModal, selectedNewTagId, tagSearchFilter,showReprocessModal, showResetModal, showSpeakerModal, speakerModalTab, showShareModal, showSharesListModal,- showTextEditorModal, showAsrEditorModal, editingRecording, editingTranscriptionContent,+ showTextEditorModal, showAsrEditorModal, showCustomizeSummaryModal, customizeSummaryPrompt, customizeSummaryMode, editingRecording, editingTranscriptionContent,editingSegments, availableSpeakers, showEditSpeakersModal, editingSpeakersList,databaseSpeakers, editingSpeakerSuggestions,showEditParticipantsModal, editingParticipantsList, editingParticipantSuggestions, allParticipants,diff --git a/static/js/modules/composables/reprocess.js b/static/js/modules/composables/reprocess.jsindex 4908ab91..9b5edb89 100644--- a/static/js/modules/composables/reprocess.js+++ b/static/js/modules/composables/reprocess.js@@ -14,7 +14,8 @@ export function useReprocess(state, utils) {recordings, asrReprocessOptions, summaryReprocessPromptSource,summaryReprocessSelectedTagId, summaryReprocessCustomPrompt,availableTags, processingProgress, processingMessage,- currentlyProcessingFile, uploadQueue, userTranscriptionLanguage+ currentlyProcessingFile, uploadQueue, userTranscriptionLanguage,+ showCustomizeSummaryModal, customizeSummaryPrompt, customizeSummaryMode} = state;const { showToast, setGlobalError, onChatComplete } = utils;@@ -244,8 +245,35 @@ export function useReprocess(state, utils) {// Generate Summary// =========================================- const generateSummary = async () => {+ // Open the "customise summarisation prompt" modal pre-populated with the+ // user's saved summary prompt (or the admin default if the user hasn't+ // set one). The user can then add or replace before generating.+ const openCustomizeSummaryModal = () => {if (!selectedRecording.value) return;+ // Default mode: append. Most users want to add agenda/context to+ // their saved prompt rather than replace it.+ customizeSummaryMode.value = 'append';+ // Start with an empty textarea so the user types just the additional+ // context. They can switch to replace mode and write a full prompt.+ customizeSummaryPrompt.value = '';+ showCustomizeSummaryModal.value = true;+ };++ const closeCustomizeSummaryModal = () => {+ showCustomizeSummaryModal.value = false;+ };++ const submitCustomizeSummaryModal = async () => {+ const prompt = (customizeSummaryPrompt.value || '').trim();+ const mode = customizeSummaryMode.value === 'replace' ? 'replace' : 'append';+ showCustomizeSummaryModal.value = false;+ await generateSummary({ customPrompt: prompt, promptMode: mode });+ };++ const generateSummary = async (options = {}) => {+ if (!selectedRecording.value) return;+ const customPrompt = (options.customPrompt || '').trim();+ const promptMode = options.promptMode === 'append' ? 'append' : 'replace';try {const csrfToken = document.querySelector('meta[name="csrf-token"]')?.getAttribute('content');@@ -281,13 +309,20 @@ export function useReprocess(state, utils) {return;}- // Regular recording - use existing flow+ // Regular recording - use existing flow. Forward an optional+ // user-supplied custom prompt + mode (issue / discussion #253).+ const body = {};+ if (customPrompt) {+ body.custom_prompt = customPrompt;+ body.prompt_mode = promptMode;+ }const response = await fetch(`/recording/${selectedRecording.value.id}/generate_summary`, {method: 'POST',headers: {'Content-Type': 'application/json','X-CSRFToken': csrfToken- }+ },+ body: JSON.stringify(body),});const data = await response.json();@@ -451,6 +486,9 @@ export function useReprocess(state, utils) {// SummaryreprocessSummary,generateSummary,+ openCustomizeSummaryModal,+ closeCustomizeSummaryModal,+ submitCustomizeSummaryModal,// PollingstartReprocessingPoll,diff --git a/templates/components/detail/desktop-summary-tab.html b/templates/components/detail/desktop-summary-tab.htmlindex a0684e70..125a7d03 100644--- a/templates/components/detail/desktop-summary-tab.html+++ b/templates/components/detail/desktop-summary-tab.html@@ -13,16 +13,24 @@<i class="fas fa-exclamation-triangle mr-1"></i>Cannot generate summary: transcription failed</p>- <button @click="generateSummary"- :disabled="processedTranscription.isError"- :class="[- 'px-6 py-3 font-medium rounded-lg shadow-lg transition-all duration-200',- processedTranscription.isError- ? 'bg-gray-400 text-gray-200 cursor-not-allowed'- : 'bg-gradient-to-r from-blue-600 to-purple-600 text-white hover:shadow-xl hover:from-blue-700 hover:to-purple-700 transform hover:scale-105'- ]">- <i class="fas fa-magic mr-2"></i>${ t('summary.generateSummary') }- </button>+ <div :class="['inline-flex rounded-lg shadow-lg transition-all duration-200 overflow-hidden', processedTranscription.isError ? '' : 'hover:shadow-xl']">+ <button @click="generateSummary()"+ :disabled="processedTranscription.isError"+ :class="[+ 'px-6 py-3 font-medium transition-colors duration-200',+ processedTranscription.isError+ ? 'bg-gray-400 text-gray-200 cursor-not-allowed'+ : 'bg-gradient-to-r from-blue-600 to-purple-600 text-white hover:from-blue-700 hover:to-purple-700'+ ]">+ <i class="fas fa-magic mr-2"></i>${ t('summary.generateSummary') }+ </button>+ <button v-if="!processedTranscription.isError"+ @click="openCustomizeSummaryModal"+ title="Customise the summarisation prompt"+ class="px-3 py-3 font-medium text-white bg-gradient-to-r from-purple-600 to-purple-700 hover:from-purple-700 hover:to-purple-800 transition-colors duration-200 border-l border-white/20">+ <i class="fas fa-sliders-h text-sm"></i>+ </button>+ </div></div><div v-else class="content-box relative">diff --git a/templates/components/detail/mobile-summary-panel.html b/templates/components/detail/mobile-summary-panel.htmlindex 0a3f33ed..d0ddc96d 100644--- a/templates/components/detail/mobile-summary-panel.html+++ b/templates/components/detail/mobile-summary-panel.html@@ -28,16 +28,24 @@<i class="fas fa-exclamation-triangle mr-1"></i>Cannot generate summary: transcription failed</p>- <button @click="generateSummary"- :disabled="processedTranscription.isError"- :class="[- 'px-6 py-3 font-medium rounded-lg shadow-lg transition-all duration-200',- processedTranscription.isError- ? 'bg-gray-400 text-gray-200 cursor-not-allowed'- : 'bg-gradient-to-r from-blue-600 to-purple-600 text-white hover:shadow-xl hover:from-blue-700 hover:to-purple-700 transform hover:scale-105'- ]">- <i class="fas fa-magic mr-2"></i>Generate Summary- </button>+ <div :class="['inline-flex rounded-lg shadow-lg transition-all duration-200 overflow-hidden', processedTranscription.isError ? '' : 'hover:shadow-xl']">+ <button @click="generateSummary()"+ :disabled="processedTranscription.isError"+ :class="[+ 'px-6 py-3 font-medium transition-colors duration-200',+ processedTranscription.isError+ ? 'bg-gray-400 text-gray-200 cursor-not-allowed'+ : 'bg-gradient-to-r from-blue-600 to-purple-600 text-white hover:from-blue-700 hover:to-purple-700'+ ]">+ <i class="fas fa-magic mr-2"></i>Generate Summary+ </button>+ <button v-if="!processedTranscription.isError"+ @click="openCustomizeSummaryModal"+ title="Customise the summarisation prompt"+ class="px-3 py-3 font-medium text-white bg-gradient-to-r from-purple-600 to-purple-700 hover:from-purple-700 hover:to-purple-800 transition-colors duration-200 border-l border-white/20">+ <i class="fas fa-sliders-h text-sm"></i>+ </button>+ </div></div><div v-else class="summary-box h-full" v-html="selectedRecording.summary_html || selectedRecording.summary"></div></div>diff --git a/templates/index.html b/templates/index.htmlindex 921b0374..593e4b59 100644--- a/templates/index.html+++ b/templates/index.html@@ -102,6 +102,7 @@{% include 'modals/edit-text-modal.html' %}{% include 'modals/text-editor-modal.html' %}{% include 'modals/asr-editor-modal.html' %}+ {% include 'modals/customize-summary-prompt-modal.html' %}{% include 'modals/edit-speakers-modal.html' %}{% include 'modals/edit-participants-modal.html' %}{% include 'modals/color-scheme-modal.html' %}diff --git a/templates/modals/customize-summary-prompt-modal.html b/templates/modals/customize-summary-prompt-modal.htmlnew file mode 100644index 00000000..1fda3a41--- /dev/null+++ b/templates/modals/customize-summary-prompt-modal.html@@ -0,0 +1,64 @@+<!-- Customise Summary Prompt Modal -->+<div v-if="showCustomizeSummaryModal" @click.self="closeCustomizeSummaryModal" class="fixed inset-0 bg-black bg-opacity-70 flex items-center justify-center z-50 p-4 backdrop-blur-sm">+ <div class="bg-[var(--bg-secondary)] rounded-xl shadow-2xl w-full max-w-2xl flex flex-col max-h-[85vh]">+ <div class="p-5 border-b border-[var(--border-primary)] flex-shrink-0 flex justify-between items-center">+ <div class="flex items-center gap-2">+ <i class="fas fa-magic text-[var(--text-accent)]"></i>+ <h3 class="text-lg font-semibold text-[var(--text-primary)]">Customise summary prompt</h3>+ </div>+ <button @click="closeCustomizeSummaryModal" class="p-2 rounded-lg hover:bg-[var(--bg-tertiary)] transition-colors">+ <i class="fas fa-times"></i>+ </button>+ </div>++ <div class="px-6 py-5 overflow-y-auto flex-1 space-y-4">+ <p class="text-sm text-[var(--text-muted)]">+ Add an agenda, list of attendees, or any other context you want the model to consider when summarising this recording. The text below is combined with the saved summary prompt unless you switch the mode.+ </p>++ <div class="grid grid-cols-2 gap-2 p-1 bg-[var(--bg-tertiary)] border border-[var(--border-secondary)] rounded-lg">+ <label+ :class="['flex items-start gap-2 p-3 rounded-md cursor-pointer transition-colors', customizeSummaryMode === 'append' ? 'bg-[var(--bg-secondary)] border border-[var(--border-accent)] shadow-sm' : 'border border-transparent hover:bg-[var(--bg-secondary)]']">+ <input type="radio" value="append" v-model="customizeSummaryMode" class="mt-1 h-4 w-4 text-[var(--text-accent)] border-[var(--border-secondary)] focus:ring-[var(--border-focus)]">+ <span class="flex-1">+ <span class="block text-sm font-medium text-[var(--text-primary)]">Append</span>+ <span class="block text-xs text-[var(--text-muted)] mt-0.5">Use my saved prompt and add this as extra context.</span>+ </span>+ </label>+ <label+ :class="['flex items-start gap-2 p-3 rounded-md cursor-pointer transition-colors', customizeSummaryMode === 'replace' ? 'bg-[var(--bg-secondary)] border border-[var(--border-accent)] shadow-sm' : 'border border-transparent hover:bg-[var(--bg-secondary)]']">+ <input type="radio" value="replace" v-model="customizeSummaryMode" class="mt-1 h-4 w-4 text-[var(--text-accent)] border-[var(--border-secondary)] focus:ring-[var(--border-focus)]">+ <span class="flex-1">+ <span class="block text-sm font-medium text-[var(--text-primary)]">Replace</span>+ <span class="block text-xs text-[var(--text-muted)] mt-0.5">Use only this text as the summarisation instructions.</span>+ </span>+ </label>+ </div>++ <div>+ <label class="block text-xs font-medium text-[var(--text-secondary)] mb-1.5 uppercase tracking-wide">+ <span v-if="customizeSummaryMode === 'append'">Additional context</span>+ <span v-else>Custom prompt</span>+ </label>+ <textarea+ v-model="customizeSummaryPrompt"+ rows="10"+ :placeholder="customizeSummaryMode === 'append' ? 'e.g.\nAgenda:\n1. Budget review\n2. Q3 hiring plan\n3. New product launch' : 'Write the full summarisation instructions you want the model to follow...'"+ class="w-full px-3 py-2 text-sm bg-[var(--bg-input)] text-[var(--text-primary)] border border-[var(--border-secondary)] rounded-md focus:outline-none focus:ring-2 focus:ring-[var(--border-focus)] focus:border-[var(--border-focus)] resize-y font-mono"></textarea>+ </div>+ </div>++ <div class="bg-[var(--bg-tertiary)] px-6 py-4 flex justify-end gap-3 border-t border-[var(--border-primary)] flex-shrink-0 rounded-b-xl">+ <button @click="closeCustomizeSummaryModal"+ class="px-4 py-2 bg-[var(--bg-secondary)] text-[var(--text-secondary)] rounded-lg border border-[var(--border-secondary)] hover:bg-[var(--bg-tertiary)] transition-colors">+ Cancel+ </button>+ <button @click="submitCustomizeSummaryModal"+ :disabled="!customizeSummaryPrompt.trim()"+ :class="['px-4 py-2 rounded-lg flex items-center gap-2 transition-all', customizeSummaryPrompt.trim() ? 'bg-gradient-to-r from-blue-600 to-purple-600 text-white hover:shadow-md hover:from-blue-700 hover:to-purple-700' : 'bg-[var(--bg-secondary)] text-[var(--text-muted)] border border-[var(--border-secondary)] cursor-not-allowed']">+ <i class="fas fa-magic text-xs"></i>+ <span>Generate Summary</span>+ </button>+ </div>+ </div>+</div>