87 lines
5.5 KiB
Markdown
87 lines
5.5 KiB
Markdown
# Документация по конфигурационному файлу config.yaml
|
|
|
|
## Секция system
|
|
Основные настройки системы
|
|
|
|
| Параметр | Описание | Возможные значения |
|
|
|----------|----------|-------------------|
|
|
| history_maxlen | Максимальное количество записей в истории распознавания | Целое число > 0 (рекомендуется: 50-1000) |
|
|
| polling_interval_ms | Интервал опроса состояния системы в миллисекундах | Целое число > 100 (рекомендуется: 1000-5000) |
|
|
| logging_level | Уровень логирования | INFO, DEBUG, WARNING, ERROR, CRITICAL |
|
|
| log_file | Путь к файлу логов | Строка, путь к файлу |
|
|
| log_save_file | Сохранять ли логи в файл | true/false |
|
|
|
|
## Секция vad
|
|
Настройки системы определения голосовой активности (Voice Activity Detection)
|
|
|
|
| Параметр | Описание | Возможные значения |
|
|
|----------|----------|-------------------|
|
|
| mode | Режим работы VAD (агрессивность фильтрации) | 0 (наименее агрессивный) - 3 (самый агрессивный) |
|
|
| sample_rate | Частота дискретизации аудио в герцах | 8000, 16000, 32000, 48000 |
|
|
| frame_duration_ms | Длительность фрейма в миллисекундах | 10, 20, 30 |
|
|
| ring_buffer_size | Размер кольцевого буфера для фреймов | Целое число > 0 (рекомендуется: 10-30) |
|
|
| speech_threshold | Порог вероятности речи | 0.0 - 1.0 (рекомендуется: 0.5-0.9) |
|
|
| energy_threshold | Порог энергии звука | Целое число > 0 (рекомендуется: 300-1000) |
|
|
| min_speech_duration_ms | Минимальная длительность речи в мс | Целое число > 0 (рекомендуется: 100-500) |
|
|
| record_stop_delay_sec | Задержка остановки записи после окончания речи в сек | Число > 0.0 (рекомендуется: 0.5-2.0) |
|
|
| prebuffer_duration_sec | Длительность предварительного буфера в сек | Число > 0.0 (рекомендуется: 0.5-2.0) |
|
|
| max_record_duration_sec | Максимальная длительность записи в сек | Число > 0.0 (рекомендуется: 5.0-30.0) |
|
|
| target_rms | Целевое среднеквадратичное значение громкости | Число > 0.0 (рекомендуется: 1000-3000) |
|
|
| max_gain | Максимальное усиление звука | Число > 0.0 (рекомендуется: 1.0-10.0) |
|
|
| noise_reduction_factor | Коэффициент подавления шума | Число > 1.0 (рекомендуется: 1.2-2.0) |
|
|
| noise_update_alpha | Коэффициент обновления оценки шума | 0.0 - 1.0 (рекомендуется: 0.01-0.1) |
|
|
| min_rms_threshold_factor | Минимальный коэффициент порога RMS | Число > 1.0 (рекомендуется: 1.5-3.0) |
|
|
| gain_smoothing_alpha | Коэффициент сглаживания усиления | 0.0 - 1.0 (рекомендуется: 0.05-0.2) |
|
|
| adaptive_energy_std_factor | Коэффициент стандартного отклонения для адаптивной энергии | Число > 0.0 (рекомендуется: 1.0-2.0) |
|
|
| adaptive_energy | Использовать ли адаптивный порог энергии | true/false |
|
|
| noise_reduction_enabled | Включить подавление шума | true/false |
|
|
| auto_gain_enabled | Включить автоматическую регулировку усиления | true/false |
|
|
| record_on_speech | Записывать ли аудио при обнаружении речи | true/false |
|
|
|
|
## Секция stt
|
|
Настройки системы распознавания речи (Speech-to-Text)
|
|
|
|
| Параметр | Описание | Возможные значения |
|
|
|----------|----------|-------------------|
|
|
| model_path | Путь к модели Vosk | Строка, абсолютный путь к директории с моделью |
|
|
|
|
## Секция commands
|
|
Настройки системы команд
|
|
|
|
| Параметр | Описание | Возможные значения |
|
|
|----------|----------|-------------------|
|
|
| commands_file | Путь к файлу с определениями команд | Строка, путь к YAML-файлу |
|
|
|
|
## Секция auth
|
|
Настройки аутентификации
|
|
|
|
| Параметр | Описание | Возможные значения |
|
|
|----------|----------|-------------------|
|
|
| username | Имя пользователя для входа | Строка |
|
|
| password | Пароль для входа | Строка |
|
|
|
|
## Пример использования
|
|
|
|
```yaml
|
|
system:
|
|
history_maxlen: 50
|
|
polling_interval_ms: 1000
|
|
logging_level: INFO
|
|
log_file: logs/app.log
|
|
log_save_file: false
|
|
|
|
vad:
|
|
mode: 3
|
|
sample_rate: 16000
|
|
frame_duration_ms: 30
|
|
speech_threshold: 0.7
|
|
energy_threshold: 400
|
|
|
|
stt:
|
|
model_path: /path/to/vosk/model
|
|
|
|
auth:
|
|
username: admin
|
|
password: your_secure_password
|
|
```
|