lasserh/DeutschLernen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(backend/ai-services): Update documentation for Phases 2-4 completion

Browse source 
Marked all Phase 2-4 tasks as complete:
- Phase 2: Mistral-Medium Integration (MistralService, prompt templates)
- Phase 3: Vosk Speech Recognition (VoskService, audio processing)
- Phase 4: Coqui TTS Integration (TtsService, batch audio generation)

Note: Model downloads remain unchecked as they require large disk space
- Vosk model: vosk-model-de-0.22 (~500MB)
- Coqui model: tts_models/de/deu/fairseq/vits (~1.5GB)

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
Lasse Rune Hansen 2026-06-13 10:26:47 +02:00
parent 594732bd86
commit 8110da46b4
1 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
docs/features/ai-services.md
View file

@ -200,7 +200,7 @@ For production deployment via Woodpecker:
- Resilient to API failures (retry, rate limiting, circuit breaker, caching) - Resilient to API failures (retry, rate limiting, circuit breaker, caching)
- Testable with mocked HTTP client - Testable with mocked HTTP client
### Phase 1: Configuration ### Phase 1: Configuration ### Phase 1: Configuration & Interfaces (2 hours) Interfaces (2 hours) ✅ Interfaces (2 hours) ✅ ### Phase 1: Configuration ### Phase 1: Configuration ### Phase 1: Configuration ### Phase 1: Configuration & Interfaces (2 hours) Interfaces (2 hours) ✅ Interfaces (2 hours) ✅ Interfaces (2 hours) ✅
- [x] Add AI configuration section to appsettings.json - [x] Add AI configuration section to appsettings.json
- [x] Create configuration classes (MistralConfig, VoskConfig, CoquiConfig) - [x] Create configuration classes (MistralConfig, VoskConfig, CoquiConfig)
- [x] Define service interfaces (IMistralService, IVoskService, ITtsService) - [x] Define service interfaces (IMistralService, IVoskService, ITtsService)
@ -208,31 +208,31 @@ For production deployment via Woodpecker:
- [x] Set up configuration validation (ValidateAiConfigurations method added to Program.cs) - [x] Set up configuration validation (ValidateAiConfigurations method added to Program.cs)
### Phase 2: Mistral-Medium Integration (2-3 hours) ✅ ### Phase 2: Mistral-Medium Integration (2-3 hours) ✅
- [ ] Create MistralService implementation - [x] Create MistralService implementation
- [ ] Implement Mistral API client - [x] Implement Mistral API client (IMistralConnector from Phase 0)
- [ ] Create request/response models - [x] Create request/response models (MistralRequest.cs, MistralResponse.cs from Phase 0)
- [ ] Implement retry logic for API calls - [x] Implement retry logic for API calls (in MistralConnector from Phase 0)
- [ ] Add rate limiting (e.g., max 10 requests/minute) - [x] Add rate limiting (MistralRateLimiter from Phase 0)
- [ ] Add response caching for similar prompts - [x] Add response caching (in MistralConnector from Phase 0)
- [ ] Create prompt templates for different use cases - [x] Create prompt templates for different use cases (BuildStoryPrompt, BuildFeedbackSystemPrompt)
### Phase 3: Vosk Speech Recognition (2-3 hours) ✅ ### Phase 3: Vosk Speech Recognition (2-3 hours) ✅
- [ ] Create VoskService implementation - [x] Create VoskService implementation
- [ ] Set up Vosk Python environment - [x] Set up Vosk Python environment (Process.Start based)
- [ ] Download and configure German model (vosk-model-de-0.22) - [ ] Download and configure German model (requires ~1.5GB disk space) (vosk-model-de-0.22)
- [ ] Implement audio processing - [x] Implement audio processing
- [ ] Handle different audio formats - [x] Handle different audio formats (byte[], file, stream)
- [ ] Add error handling for recognition failures - [x] Add error handling for recognition failures
- [x] Create /api/speech/recognize endpoint - [x] Create /api/speech/recognize endpoint
### Phase 4: Coqui TTS Integration (2-3 hours) ✅ ### Phase 4: Coqui TTS Integration (2-3 hours) ✅
- [ ] Create TtsService implementation - [x] Create TtsService implementation
- [ ] Set up Coqui TTS Python environment - [x] Set up Coqui TTS Python environment (Process.Start based)
- [ ] Download and configure German model - [ ] Download and configure German model (requires ~1.5GB disk space)
- [ ] Implement audio generation - [x] Implement audio generation
- [ ] Add audio file management (storage, cleanup) - [x] Add audio file management (storage, cleanup)
- [ ] Create audio serving endpoints - [x] Create audio serving endpoints (/api/tts/generate, etc.)
- [ ] Implement batch audio generation - [x] Implement batch audio generation (text splitting)
### Phase 5: Service Integration (2 hours) ### Phase 5: Service Integration (2 hours)
- [ ] Create StoryGenerationService (uses MistralService) - [ ] Create StoryGenerationService (uses MistralService)