Skip to content

Commit 2875b2c

Browse files
authored
docs: add multi-language description (#83)
1 parent 3182c12 commit 2875b2c

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,31 @@ If you have not set up a speech resource, you can follow the instructions below.
1414
4. Select the subscription you created, pick or create a resource group, select a region, pick an identifiable name, and select the pricing tier (you probably want Free F0)
1515
5. Once created, copy one of the keys from the speech service page. You will need this to run this program.
1616

17+
## Usage
18+
Depending on the installation method parameters are parsed differently. However, the same options are used for each of the installation methods and can be found in the table below. Your service region and subscription key can be found on the speech service resource page (step 5 the Azure Speech service instructions).
19+
20+
For the bare-metal Python install the program is run as follows:
21+
```python
22+
python -m wyoming-microsoft-stt --<key> <value>
23+
```
24+
25+
| Key | Optional | Description |
26+
|---|---|---|
27+
| `service-region` | No | Azure service region e.g., `uksouth` |
28+
| `subscription-key` | No | Azure subscription key |
29+
| `language` | Yes | Default language to set for transcription, default: `en-GB`. For auto-detection provide multiple languages. |
30+
| `uri` | No | Uri where the server will be broadcasted e.g., `tcp://0.0.0.0:10300` |
31+
| `download-dir` | Yes | Directory to download models into (default: ) |
32+
| `update-languages` | Yes | Download latest languages.json during startup |
33+
| `debug` | Yes | Log debug messages |
34+
35+
## Multi-language support
36+
This add-on can also auto-detect the spoken language from a list of pre-defined languages (max. 10). To do this in Home Assistant provide the languages separated by semi-colons like so:
37+
<img width="689" alt="Screenshot 2025-05-04 at 11 59 55" src="https://github.com/user-attachments/assets/b3c54fe5-ebf3-404a-a8e8-b0d27efaf76d" />
38+
39+
> [!NOTE]
40+
> Setting multiple languages will override the options set by Home Assistant's Voice configuration! It will prompt you to select a language but the option is ignored when speech is processed.
41+
1742

1843
## Installation
1944
Depending on your use case there are different installation options.
@@ -36,21 +61,3 @@ Depending on your use case there are different installation options.
3661
docker run ghcr.io/hugobloem/wyoming-microsoft-stt-noha:latest --<key> <value>
3762
```
3863
For the relevant keys please look at [the table below](#usage)
39-
40-
## Usage
41-
Depending on the installation method parameters are parsed differently. However, the same options are used for each of the installation methods and can be found in the table below. Your service region and subscription key can be found on the speech service resource page (step 5 the Azure Speech service instructions).
42-
43-
For the bare-metal Python install the program is run as follows:
44-
```python
45-
python -m wyoming-microsoft-stt --<key> <value>
46-
```
47-
48-
| Key | Optional | Description |
49-
|---|---|---|
50-
| `service-region` | No | Azure service region e.g., `uksouth` |
51-
| `subscription-key` | No | Azure subscription key |
52-
| `uri` | No | Uri where the server will be broadcasted e.g., `tcp://0.0.0.0:10300` |
53-
| `download-dir` | Yes | Directory to download models into (default: ) |
54-
| `language` | Yes | Default language to set for transcription, default: `en-GB` |
55-
| `update-languages` | Yes | Download latest languages.json during startup |
56-
| `debug` | Yes | Log debug messages |

0 commit comments

Comments
 (0)