docs(features/ai-services): add Mistral configuration setup instructions
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful

- Add Configuration Setup section with appsettings.Development.json example
- Clarify where to add API key (local dev config, not version control)
- Add security note about not committing API keys
- Update Phase 0 deliverables with clarity

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
Lasse Rune Hansen 2026-06-09 19:55:23 +02:00
parent 2b11367a97
commit 3ff57ab0a6

View file

@ -91,6 +91,29 @@ As a learner, I want AI-powered features like generated stories, speech recognit
- Vosk Python library + German model - Vosk Python library + German model
- Coqui TTS Python library + German model - Coqui TTS Python library + German model
### Configuration Setup
Add the following to your local `appsettings.Development.json` file:
```json
{
"Mistral": {
"ApiKey": "YOUR_MISTRAL_API_KEY",
"BaseUrl": "https://api.mistral.ai/v1/",
"DefaultModel": "mistral-medium",
"TimeoutSeconds": 30,
"MaxRetries": 3,
"RateLimitPerMinute": 10,
"EnableCaching": true,
"CacheTTLMinutes": 60,
"CircuitBreakerFailureThreshold": 5,
"CircuitBreakerResetMinutes": 1
}
}
```
**Note**: Do NOT commit your API key to version control. Use environment variables in production or keep it in local development configuration files only.
### Data Flow ### Data Flow
#### Story Generation Flow #### Story Generation Flow
@ -148,8 +171,8 @@ As a learner, I want AI-powered features like generated stories, speech recognit
**Deliverables:** **Deliverables:**
- Standalone Mistral API connector component - Standalone Mistral API connector component
- Configurable via appsettings.json - Configurable via appsettings.json (add to local appsettings.Development.json)
- Resilient to API failures - Resilient to API failures (retry, rate limiting, circuit breaker, caching)
- Testable with mocked HTTP client - Testable with mocked HTTP client
### Phase 1: Configuration & Interfaces (2 hours) ### Phase 1: Configuration & Interfaces (2 hours)