8e4c70aaa8
- docs/speech.md: a new Recording section (wake lock and why it is re-taken on visibility, idempotent start, what happens when a recording ends by itself, what signing out does), the retention rules, and step-by-step instructions for moving audio backups to MinIO. - Records that the model for a transcription is the user's choice first, which is why the picker must only ever offer models the gateway has, and that LITELLM_STT_MODELS is a fallback rather than a list known to work. - api-reference: /api/transcribe takes `module` and returns `backupId`, and the Audio Backups group is no longer failure-only. - configuration.md and .env.example document AUDIO_BACKUPS_S3_*, preferring the _FILE credential variants. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Dv6sqaY6Vq3ChZHMem3cnU
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# Transcription Options
|
|
|
|
Ped-AI currently supports server-side transcription through LiteLLM plus an explicit browser Web Speech preview option. Browser Whisper was removed and should not be offered in settings, documentation, public workers, or model download scripts.
|
|
|
|
## Recommended Clinical Setup
|
|
|
|
Route STT through LiteLLM and configure the compliant upstream in LiteLLM.
|
|
|
|
| Need | Recommended provider |
|
|
|---|---|
|
|
| Server STT | LiteLLM with a compliant upstream. |
|
|
| Real-time draft preview | Browser Web Speech only with explicit user opt-in and privacy warning. |
|
|
|
|
Auto-detect uses LiteLLM when `LITELLM_API_BASE` is configured. Direct Google, AWS, local Whisper, and OpenAI Whisper branches are not part of the app runtime.
|
|
|
|
## Configuration
|
|
|
|
```env
|
|
TRANSCRIBE_PROVIDER=litellm
|
|
LITELLM_API_BASE=https://your-litellm.example/v1
|
|
LITELLM_API_KEY=<key>
|
|
LITELLM_STT_MODEL=local-parakeet-v3
|
|
```
|
|
|
|
## Failure Handling
|
|
|
|
- Every recording is kept, encrypted, for 24 hours — not only the ones whose
|
|
transcription failed — and can be downloaded from Settings.
|
|
- Users can retry or delete failed backups from Settings.
|
|
- Web Speech interim text is not a substitute for a server transcription response.
|
|
|
|
## Removed Paths
|
|
|
|
These should remain absent unless the project intentionally reintroduces browser-local STT with a new design review:
|
|
|
|
- `public/js/browserWhisper.js`
|
|
- `public/js/whisperWorker.js`
|
|
- `public/js/whisperWorkerV2.js`
|
|
- `public/models/Xenova/*`
|
|
- Browser Whisper setup/troubleshooting docs
|
|
- Whisper model download scripts for public browser models
|