summaryrefslogtreecommitdiff
path: root/.totalrecall.yaml.example
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-07-15 21:12:18 +0300
committerPaul Buetow <paul@buetow.org>2025-07-15 21:12:18 +0300
commit9c77f2a7bef485fa137f123cbf55b42cacb2b285 (patch)
treed4ee67a4d3de0c17fc86e465f24480b768e80d13 /.totalrecall.yaml.example
parentb2e1d035ab8d32f6c3351ae5f0a514e569294ef0 (diff)
feat: add OpenAI gpt-4o-mini-tts support with voice instructions
- Add support for OpenAI's new gpt-4o-mini-tts model with customizable voice instructions - Add OpenAIInstruction field to audio configuration for natural language voice control - Update CLI with --openai-instruction flag for runtime voice customization - Enhanced cache key generation to include voice instructions - Update default model to gpt-4o-mini-tts with Bulgarian-optimized instructions - Add support for new voices: ash, ballad, coral, sage, verse - Improve error handling for models requiring special API access - Update documentation with examples and model information - Create .totalrecall.yaml.example with comprehensive configuration options Note: The gpt-4o-mini-tts model requires special API access and may not be available to all accounts yet. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to '.totalrecall.yaml.example')
-rw-r--r--.totalrecall.yaml.example59
1 files changed, 59 insertions, 0 deletions
diff --git a/.totalrecall.yaml.example b/.totalrecall.yaml.example
new file mode 100644
index 0000000..e41b97f
--- /dev/null
+++ b/.totalrecall.yaml.example
@@ -0,0 +1,59 @@
+# TotalRecall Configuration Example
+# Copy this to ~/.totalrecall.yaml or ./.totalrecall.yaml
+
+# Audio configuration
+audio:
+ # Provider: espeak or openai
+ provider: openai
+
+ # Audio output format
+ format: mp3
+
+ # ESpeak settings
+ voice: bg+f1
+ speed: 150
+ pitch: 50
+ amplitude: 100
+ word_gap: 0
+
+ # OpenAI TTS settings
+ openai_key: ${OPENAI_API_KEY} # Can also use environment variable
+ openai_model: gpt-4o-mini-tts # Options: tts-1, tts-1-hd, gpt-4o-mini-tts
+ openai_voice: nova # Options: alloy, ash, ballad, coral, echo, fable, onyx, nova, sage, shimmer, verse
+ openai_speed: 0.8 # Range: 0.25 to 4.0 (may be ignored by gpt-4o-mini models)
+
+ # Voice instructions for gpt-4o-mini-tts model
+ # This allows you to customize how the AI speaks
+ openai_instruction: "Speak slowly and clearly with natural Bulgarian pronunciation, emphasizing each syllable distinctly"
+
+ # Alternative instruction examples:
+ # openai_instruction: "Pronounce with a native Bulgarian accent, speaking at a moderate pace suitable for language learning"
+ # openai_instruction: "Speak as a patient Bulgarian language teacher, clearly articulating each sound"
+ # openai_instruction: "Use clear Bulgarian pronunciation with slight pauses between syllables"
+
+ # Caching
+ enable_cache: true
+ cache_dir: ./.audio_cache
+
+# Image configuration
+image:
+ # Provider: pixabay, unsplash, or openai
+ provider: openai
+
+ # API keys for image providers
+ pixabay_key: "" # Optional for Pixabay (higher rate limits with key)
+ unsplash_key: "" # Required for Unsplash
+
+ # OpenAI DALL-E settings
+ openai_model: dall-e-3 # Options: dall-e-2, dall-e-3
+ openai_size: 1024x1024 # Options vary by model
+ openai_quality: standard # Options: standard, hd (dall-e-3 only)
+ openai_style: natural # Options: natural, vivid (dall-e-3 only)
+
+ # Caching
+ enable_cache: true
+ cache_dir: ./.image_cache
+
+# Output configuration
+output:
+ directory: ./anki_cards \ No newline at end of file