File size: 13,578 Bytes
6e6157b |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 |
# Speaker Name Conflict Resolution - Enhancement
## Date
October 1, 2025
## Overview
Enhancement to handle conflicts between user-edited speaker names and automatically detected names, allowing users to intentionally clear names to enable automatic detection to fill them again.
## Current Behavior Analysis
### Existing Merge Logic
**Location:** `frontend/app.js:handleSpeakerNameDetection()` (lines ~1030-1037)
```javascript
// Merge detected names with existing user-edited names (preserve user edits)
const mergedNames = { ...speakerNames };
if (state.speakerNames) {
Object.entries(state.speakerNames).forEach(([speakerId, info]) => {
if (info.confidence === 'user') {
// Preserve user-edited names
mergedNames[speakerId] = info;
}
});
}
```
**Current Logic:**
- β
Preserves ALL user-edited names (confidence === 'user')
- β
Prevents auto-detection from overwriting user edits
- β Does NOT allow user to "reset" a name to enable auto-detection
### Existing Edit Logic
**Location:** `frontend/app.js:startSpeakerEdit()` (lines ~665-680)
```javascript
const finishEdit = (save = true) => {
const newName = input.value.trim();
if (save && newName) {
// Update state with user-edited name
state.speakerNames[speakerId] = {
name: newName,
confidence: 'user',
reason: 'User edited'
};
// Force re-render...
} else {
// Restore original name (doesn't remove from state)
const originalName = state.speakerNames?.[speakerId]?.name
|| `Speaker ${speakerId + 1}`;
speakerTag.textContent = originalName;
}
};
```
**Current Logic:**
- β
Saves non-empty names as user-edited
- β Empty input (after trim) restores original name, doesn't clear it
- β No way to "clear" a user-edited name to allow auto-detection
## Problem Statement (Bug 2.4.3)
### User Story
**As a user**, I want to:
1. Manually edit speaker names when I know them
2. Have my edits protected from auto-detection override
3. **Clear/reset a name to allow auto-detection to try again**
4. Have auto-detection only fill empty speaker names
### Current Limitations
#### Scenario 1: User Cannot Clear Name
```
1. User edits: "Speaker 1" β "John"
state.speakerNames[0] = { name: "John", confidence: "user" }
2. User realizes this is wrong, tries to clear it
- Edits tag, deletes all text, presses Enter
- Expected: Name cleared, tag shows "Speaker 1"
- Actual: Name restored to "John" (not cleared)
3. User clicks "Detect Speaker Names"
- Expected: Auto-detection fills "Speaker 1"
- Actual: "John" preserved (auto-detection blocked)
4. User is stuck with wrong name!
```
#### Scenario 2: No Way to Reset
```
User workflow:
1. Manually name speakers: 0="Alice", 1="Bob"
2. Later realize they're wrong
3. Want auto-detection to try again
4. No way to "reset" to allow auto-detection
Current workaround: None (would need to reload page or manually correct)
```
## Solution Design
### Design Principles
1. **Explicit Intent:** Empty input should signal "clear this name"
2. **Selective Override:** Auto-detection should only fill empty names
3. **User Control:** User can always override auto-detection
4. **Clear Reset Path:** User can clear name to enable auto-detection
### State Management Strategy
#### Three States for Speaker Names
```javascript
state.speakerNames[speakerId] =
// State 1: User-Edited (Protected)
{ name: "John", confidence: "user", reason: "User edited" }
// State 2: Auto-Detected (Overridable)
{ name: "Alice", confidence: "high", reason: "Self-introduction" }
// State 3: Cleared (Allows Auto-Detection)
undefined // Speaker removed from state.speakerNames
```
**Key Decision:** When user clears a name, **remove it from `state.speakerNames`** entirely.
### Logic Flow
#### Flow 1: Manual Edit (Non-Empty)
```
User edits tag: "" or "Speaker 1" β "John"
β
Input validation: newName.trim() !== ""
β
state.speakerNames[0] = { name: "John", confidence: "user" }
β
Re-render UI: All tags show "John"
β
Auto-detection: Skips speaker 0 (user-edited)
```
#### Flow 2: Manual Clear (Empty)
```
User edits tag: "John" β "" (empty)
β
Input validation: newName.trim() === ""
β
delete state.speakerNames[0] // Remove from state
β
Re-render UI: Tags show "Speaker 1" (default)
β
Auto-detection: Can fill speaker 0 (no longer user-edited)
```
#### Flow 3: Auto-Detection Merge
```
Auto-detection returns: { 0: {name: "Alice", ...}, 1: {name: "Bob", ...} }
β
Merge logic checks each speaker:
- Speaker 0: state.speakerNames[0] exists?
β YES (confidence="user"): Keep "John", skip "Alice"
β NO: Use "Alice"
- Speaker 1: state.speakerNames[1] exists?
β YES (confidence="user"): Keep user name
β NO: Use "Bob"
β
Re-render UI with merged names
```
## Implementation
### Change 1: Update Manual Edit Logic
**File:** `frontend/app.js:startSpeakerEdit()` (lines ~665-680)
```javascript
const finishEdit = (save = true) => {
const newName = input.value.trim();
if (save) {
if (newName) {
// Non-empty name: Save as user-edited
if (!state.speakerNames) state.speakerNames = {};
state.speakerNames[speakerId] = {
name: newName,
confidence: 'user',
reason: 'User edited'
};
} else {
// Empty name: Clear from state (allow auto-detection)
if (state.speakerNames && state.speakerNames[speakerId]) {
delete state.speakerNames[speakerId];
}
}
// Force re-render to update all UI elements
renderTranscript(true);
renderTimelineSegments();
renderDiarizationStats();
} else {
// Cancel edit: Restore current name
const originalName = state.speakerNames?.[speakerId]?.name
|| `Speaker ${speakerId + 1}`;
speakerTag.textContent = originalName;
speakerTag.classList.add('editable-speaker');
}
};
```
**Key Changes:**
- Added `else` branch for empty input
- `delete state.speakerNames[speakerId]` removes from state
- Triggers re-render even for empty input (to show default name)
- Cancel (Escape) still restores original name without clearing
### Change 2: Enhance Merge Logic (Already Correct!)
**File:** `frontend/app.js:handleSpeakerNameDetection()` (lines ~1030-1037)
```javascript
// Current code is already correct!
const mergedNames = { ...speakerNames };
if (state.speakerNames) {
Object.entries(state.speakerNames).forEach(([speakerId, info]) => {
if (info.confidence === 'user') {
// Preserve user-edited names
mergedNames[speakerId] = info;
}
});
}
```
**Why it's correct:**
- If speaker cleared: `state.speakerNames[speakerId]` is undefined
- Loop skips undefined entries
- Auto-detected name fills the gap β
**No changes needed here!**
## Behavior Examples
### Example 1: Clear and Auto-Detect
**Initial State:**
```javascript
state.speakerNames = {
0: { name: "John", confidence: "user" },
1: { name: "Alice", confidence: "user" }
}
Transcript:
[John] Hello everyone...
[Alice] Hi there...
[John] Today we'll discuss...
```
**User Action 1:** Clear Speaker 0
```
User clicks "John" tag, deletes all text, presses Enter
state.speakerNames = {
1: { name: "Alice", confidence: "user" }
}
// Speaker 0 removed from state
Transcript:
[Speaker 1] Hello everyone... β Shows default
[Alice] Hi there... β User-edited preserved
[Speaker 1] Today we'll discuss... β Shows default
```
**User Action 2:** Click "Detect Speaker Names"
```
Auto-detection returns:
{ 0: {name: "Dr. Smith", confidence: "high"} }
Merge logic:
- Speaker 0: No user edit β Use "Dr. Smith" β
- Speaker 1: User edited β Keep "Alice" β
state.speakerNames = {
0: { name: "Dr. Smith", confidence: "high" },
1: { name: "Alice", confidence: "user" }
}
Transcript:
[Dr. Smith] Hello everyone... β Auto-detected
[Alice] Hi there... β User-edited preserved
[Dr. Smith] Today we'll discuss... β Auto-detected
```
### Example 2: Edit, Clear, Edit Again
**Initial State:**
```javascript
state.speakerNames = {}
Transcript:
[Speaker 1] Hello...
[Speaker 2] Hi...
```
**Step 1:** User edits
```
Edit Speaker 1 β "Wrong Name"
state.speakerNames = {
0: { name: "Wrong Name", confidence: "user" }
}
Transcript:
[Wrong Name] Hello...
```
**Step 2:** User realizes mistake, clears
```
Edit "Wrong Name" β "" (empty)
state.speakerNames = {} // Speaker 0 removed
Transcript:
[Speaker 1] Hello... β Back to default
```
**Step 3:** User edits correctly
```
Edit Speaker 1 β "Correct Name"
state.speakerNames = {
0: { name: "Correct Name", confidence: "user" }
}
Transcript:
[Correct Name] Hello...
```
### Example 3: Cancel vs Clear
**Scenario A: Cancel Edit (Escape key)**
```
Tag shows "John"
User clicks tag, deletes text, presses Escape
β Input cancelled, "John" restored
β state.speakerNames unchanged
```
**Scenario B: Clear Edit (Enter key)**
```
Tag shows "John"
User clicks tag, deletes text, presses Enter
β Edit saved with empty value
β state.speakerNames[speakerId] deleted
β Tag shows "Speaker 1" (default)
```
## Edge Cases
### Edge Case 1: Clear Non-Existent Name
```
Speaker has default name "Speaker 1" (not in state)
User clicks tag, clears (empty input), presses Enter
Check: state.speakerNames[0] exists?
β NO: Nothing to delete
β Result: No error, shows "Speaker 1" (unchanged)
```
### Edge Case 2: Clear During Transcription
```
Live transcription in progress
User clears speaker name
Result:
- Name cleared from state β
- Re-render triggered β
- New utterances show default name β
- Incremental rendering preserved β
```
### Edge Case 3: Clear All Names
```
User clears all speaker names
state.speakerNames = {}
Auto-detection:
- All speakers available for detection β
- Can fill all empty names β
```
### Edge Case 4: Whitespace-Only Input
```
User enters " " (spaces only)
Validation: " ".trim() === ""
β Treated as empty input
β Name cleared from state β
```
## Testing Scenarios
### β
Test 1: Clear User-Edited Name
1. Edit "Speaker 1" β "John"
2. Verify: Tag shows "John"
3. Edit "John" β "" (empty)
4. Verify: Tag shows "Speaker 1"
5. Verify: `state.speakerNames[0]` is undefined
### β
Test 2: Auto-Detection After Clear
1. Edit "Speaker 1" β "Wrong"
2. Click "Detect Speaker Names"
3. Verify: "Wrong" preserved (not overwritten)
4. Clear "Wrong" β ""
5. Click "Detect Speaker Names" again
6. Verify: Auto-detected name appears
### β
Test 3: Cancel Does Not Clear
1. Tag shows "John"
2. Click tag, delete text
3. Press Escape
4. Verify: Tag shows "John" (restored)
5. Verify: `state.speakerNames[0]` unchanged
### β
Test 4: Empty Edit Triggers Re-Render
1. Tag shows "John"
2. Clear name β ""
3. Verify: All tags for speaker 0 show "Speaker 1"
4. Verify: Timeline segments updated
5. Verify: Stats panel updated
### β
Test 5: Clear and Re-Edit
1. Edit "Speaker 1" β "First"
2. Clear "First" β ""
3. Edit "Speaker 1" β "Second"
4. Verify: All tags show "Second"
5. Verify: Protected from auto-detection
### β
Test 6: Whitespace Handling
1. Edit "Speaker 1" β " " (spaces)
2. Press Enter
3. Verify: Treated as empty, name cleared
4. Verify: Tag shows "Speaker 1"
## User Experience Improvements
### Visual Feedback
Consider adding visual hints:
```css
/* Indicate clearable/editable state */
.speaker-tag.editable-speaker {
cursor: text;
border-style: dashed; /* Hint: editable */
}
.speaker-tag.editable-speaker:hover::after {
content: " β"; /* Pencil icon */
opacity: 0.5;
}
```
### Tooltip Enhancement
```javascript
// In createUtteranceElement()
if (speakerInfo?.confidence === 'user') {
speakerTag.title = 'User-edited name (click to edit or clear)';
} else if (speakerInfo?.confidence === 'high') {
speakerTag.title = 'Auto-detected name (click to override)';
} else {
speakerTag.title = 'Click to edit speaker name';
}
```
### Clear Button (Optional)
Add explicit "Clear" button in edit mode:
```html
<input class="speaker-edit-input" value="John" />
<button class="clear-speaker-btn" title="Clear and allow auto-detection">Γ</button>
```
## Implementation Checklist
- [x] Analyze current merge logic
- [x] Design clear/reset mechanism
- [x] Document three speaker name states
- [ ] Implement empty input handling in `startSpeakerEdit()`
- [ ] Test manual clear functionality
- [ ] Test auto-detection after clear
- [ ] Test cancel vs clear behavior
- [ ] Verify timeline and stats panel sync
- [ ] Update documentation
- [ ] Commit changes
## Files to Modify
### `/home/luigi/VoxSum/frontend/app.js`
- **Function:** `startSpeakerEdit()` (lines ~665-690)
- **Change:** Add `else` branch for empty input to delete from state
- **Impact:** ~10 lines modified
### No Other Files Required
- Merge logic already correct (no changes needed)
- UI rendering already supports undefined names (shows default)
## Performance Considerations
- **Delete operation:** O(1) - fast
- **Re-render trigger:** Same as edit (~10-50ms)
- **Memory:** Reduces state size (removes cleared entries)
## Backward Compatibility
- β
Existing user-edited names preserved
- β
Auto-detection logic unchanged
- β
Default name display unchanged
- β
No breaking changes to API
## Conclusion
The enhancement allows users to intentionally clear speaker names to enable auto-detection, providing a clear "reset" path while maintaining protection for user edits. The implementation is simple (one `else` branch), robust, and maintains all existing functionality.
|