|
@@ -12,9 +12,6 @@ This part of the documentation explains the main configuration of Kalliope place
|
|
|
- [Speech to text configuration](#speech-to-text-configuration)
|
|
|
- [default_speech_to_text](#defaultspeechtotext)
|
|
|
- [speech_to_text](#speechtotext)
|
|
|
- - [recognition_options](#recognitionoptions)
|
|
|
- - [energy_threshold](#energythreshold)
|
|
|
- - [adjust_for_ambient_noise_second](#adjustforambientnoisesecond)
|
|
|
- [Text to speech configuration](#text-to-speech-configuration)
|
|
|
- [default_text_to_speech](#defaulttexttospeech)
|
|
|
- [text_to_speech](#texttospeech)
|
|
@@ -155,55 +152,6 @@ speech_to_text:
|
|
|
|
|
|
Some arguments are required, some others are optional, please refer to the [STT documentation](stt.md) to know available parameters for each supported STT.
|
|
|
|
|
|
-### recognition_options
|
|
|
-
|
|
|
-Represents a collection of speech recognition settings and functionality.
|
|
|
-```yml
|
|
|
-recognition_options:
|
|
|
- option_name: option_value
|
|
|
- option_name2: option_value2
|
|
|
-```
|
|
|
-
|
|
|
-E.g
|
|
|
-```yml
|
|
|
-recognition_options:
|
|
|
- energy_threshold: 3000
|
|
|
-```
|
|
|
-
|
|
|
-#### energy_threshold
|
|
|
-
|
|
|
-Represents the energy level threshold for sounds. By default set to **4000**.
|
|
|
-Values below this threshold are considered silence, and values above this threshold are considered speech.
|
|
|
-This is adjusted automatically if dynamic thresholds are enabled with `adjust_for_ambient_noise_second` parameter.
|
|
|
-
|
|
|
-This threshold is associated with the perceived loudness of the sound, but it is a nonlinear relationship.
|
|
|
-The actual energy threshold you will need depends on your microphone sensitivity or audio data.
|
|
|
-Typical values for a silent room are 0 to 100, and typical values for speaking are between 150 and 3500.
|
|
|
-Ambient (non-speaking) noise has a significant impact on what values will work best.
|
|
|
-
|
|
|
-If you're having trouble with the recognizer trying to recognize words even when you're not speaking, try tweaking this to a higher value.
|
|
|
-If you're having trouble with the recognizer not recognizing your words when you are speaking, try tweaking this to a lower value.
|
|
|
-For example, a sensitive microphone or microphones in louder rooms might have a ambient energy level of up to 4000.
|
|
|
-```yml
|
|
|
-recognition_options:
|
|
|
- energy_threshold: 4000
|
|
|
-```
|
|
|
-
|
|
|
->**Note:** The default value is 4000 if not set
|
|
|
-
|
|
|
-#### adjust_for_ambient_noise_second
|
|
|
-
|
|
|
-If defined, will adjusts the energy threshold dynamically by capturing the current ambient noise of the room during the number of second set in the parameter.
|
|
|
-When set, the `energy_threshold` parameter is overridden by the returned value of the noise calibration.
|
|
|
-This value should be at least 0.5 in order to get a representative sample of the ambient noise.
|
|
|
-
|
|
|
-```yml
|
|
|
-recognition_options:
|
|
|
- adjust_for_ambient_noise_second: 1
|
|
|
-```
|
|
|
-
|
|
|
->**Note:** The number of second here represents the time between kalliope's awakening and the moment when you can give her your order.
|
|
|
-
|
|
|
## Text to speech configuration
|
|
|
|
|
|
### default_text_to_speech
|
|
@@ -500,10 +448,47 @@ options:
|
|
|
|
|
|
Available options:
|
|
|
|
|
|
-| Option | Description |
|
|
|
-| ------ | --------------------------------------------------------------------------------------------- |
|
|
|
-| muted | When muted, the STT engine will not be used to make Kalliope talking during neurons execution |
|
|
|
-| deaf | When deaf, the trigger engine is not started. Kalliope will not listen for a wake up word |
|
|
|
+| Option | Description |
|
|
|
+| ----------------------------------| --------------------------------------------------------------------------------------------- |
|
|
|
+| muted | When muted, the STT engine will not be used to make Kalliope talking during neurons execution |
|
|
|
+| deaf | When deaf, the trigger engine is not started. Kalliope will not listen for a wake up word |
|
|
|
+| energy_threshold | [energy_threshold](#energythreshold) |
|
|
|
+| adjust_for_ambient_noise_second | [adjust_for_ambient_noise_second](#adjustforambientnoisesecond) |
|
|
|
|
|
|
## Next: configure the brain of Kalliope
|
|
|
Now your settings are ok, you can start creating the [brain](brain.md) of your assistant.
|
|
|
+
|
|
|
+
|
|
|
+#### energy_threshold
|
|
|
+
|
|
|
+Represents the energy level threshold for sounds. By default set to **4000**.
|
|
|
+Values below this threshold are considered silence, and values above this threshold are considered speech.
|
|
|
+This is adjusted automatically if dynamic thresholds are enabled with `adjust_for_ambient_noise_second` parameter.
|
|
|
+
|
|
|
+This threshold is associated with the perceived loudness of the sound, but it is a nonlinear relationship.
|
|
|
+The actual energy threshold you will need depends on your microphone sensitivity or audio data.
|
|
|
+Typical values for a silent room are 0 to 100, and typical values for speaking are between 150 and 3500.
|
|
|
+Ambient (non-speaking) noise has a significant impact on what values will work best.
|
|
|
+
|
|
|
+If you're having trouble with the recognizer trying to recognize words even when you're not speaking, try tweaking this to a higher value.
|
|
|
+If you're having trouble with the recognizer not recognizing your words when you are speaking, try tweaking this to a lower value.
|
|
|
+For example, a sensitive microphone or microphones in louder rooms might have a ambient energy level of up to 4000.
|
|
|
+```yml
|
|
|
+options:
|
|
|
+ energy_threshold: 4000
|
|
|
+```
|
|
|
+
|
|
|
+>**Note:** The default value is 4000 if not set
|
|
|
+
|
|
|
+#### adjust_for_ambient_noise_second
|
|
|
+
|
|
|
+If defined, will adjusts the energy threshold dynamically by capturing the current ambient noise of the room during the number of second set in the parameter.
|
|
|
+When set, the `energy_threshold` parameter is overridden by the returned value of the noise calibration.
|
|
|
+This value should be at least 0.5 in order to get a representative sample of the ambient noise.
|
|
|
+
|
|
|
+```yml
|
|
|
+options:
|
|
|
+ adjust_for_ambient_noise_second: 1
|
|
|
+```
|
|
|
+
|
|
|
+>**Note:** The number of second here represents the time between kalliope's awakening and the moment when you can give her your order.
|