Add vosk

vosk/.gitignore

@@ -0,0 +1 @@
+/local

vosk/Dockerfile

@@ -0,0 +1,29 @@
+FROM debian:bookworm-slim
+ARG TARGETARCH
+ARG TARGETVARIANT
+
+# Install wyoming-vosk
+WORKDIR /usr/src
+ENV WYOMING_VOSK_VERSION=1.0.0
+ENV PIP_BREAK_SYSTEM_PACKAGES=1
+
+RUN \
+    apt-get update \
+    && apt-get install -y --no-install-recommends \
+        python3 \
+        python3-pip \
+    && pip3 install --no-cache-dir -U \
+        setuptools \
+        wheel \
+    && pip3 install --no-cache-dir \
+        --extra-index-url https://www.piwheels.org/simple \
+        -f . \
+        "wyoming-vosk[limited] @ https://github.com/rhasspy/wyoming-vosk/archive/refs/tags/v${WYOMING_VOSK_VERSION}.tar.gz" \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /
+COPY run.sh ./
+
+EXPOSE 10300
+
+ENTRYPOINT ["bash", "/run.sh"]

vosk/Makefile

@@ -0,0 +1,20 @@
+.PHONY: local run update
+
+VERSION := 1.0.0
+TAG := rhasspy/wyoming-vosk
+PLATFORMS := linux/amd64,linux/arm64,linux/arm/v7
+HOST := 0.0.0.0
+PORT := 10300
+DATA_DIR := $(PWD)/local
+
+all:
+	docker buildx build . --platform "$(PLATFORMS)" --tag "$(TAG):$(VERSION)" --push
+
+update:
+	docker buildx build . --platform "$(PLATFORMS)" --tag "$(TAG):latest" --push
+
+local:
+	docker build . -t "$(TAG):$(VERSION)" --build-arg TARGETARCH=amd64
+
+run:
+	docker run -it -p "$(PORT):$(PORT)" -v "$(DATA_DIR):$(DATA_DIR)" "$(TAG):$(VERSION)" --uri 'tcp://$(HOST):$(PORT)' --data-dir "$(DATA_DIR)" --debug

vosk/README.md

@@ -0,0 +1,209 @@
+# vosk
+
+[Wyoming protocol](https://github.com/rhasspy/wyoming) server for the [vosk](https://alphacephei.com/vosk) speech to text system, with optional sentence correction using [rapidfuzz](https://github.com/maxbachmann/RapidFuzz).
+
+This speech-to-text system can run well, even on a Raspberry Pi 3. Using the corrected or limited modes (described below), you can achieve very high accuracy by restricting the sentences that can be spoken.
+
+## Modes
+
+There are three operating modes:
+
+1. Open-ended - any sentence can be spoken, but recognition is very poor compared to [Whisper](https://github.com/rhasspy/wyoming-faster-whisper)
+2. Corrected - sentences similar to [templates](#sentence-templates) are forced to match
+3. Limited -  only sentences from [templates](#sentence-templates) can be spoken
+
+
+### Open-ended
+
+This is the default mode: transcripts from [vosk](https://alphacephei.com/vosk) are used directly.
+
+Recognition is very poor compared to [Whisper](https://github.com/rhasspy/wyoming-faster-whisper) unless you use one of the [larger models](https://alphacephei.com/vosk/models).
+To use a specific model, such as `vosk-model-en-us-0.21` (1.6GB):
+
+1. Download and extract the model to a directory (`<DATA_DIR>`) so that you have `<DATA_DIR>/vosk-model-en-us-0.21`
+2. Run `wyoming_vosk` with `--data-dir <DATA_DIR>` and `--model-for-language en vosk-model-en-us-0.21`
+
+Note that `wyoming_vosk` will only automatically download models listed in `download.py`.
+
+
+### Corrected
+
+By specifying which sentences will be spoken ahead of time, transcripts from vosk can be corrected using [rapidfuzz](https://github.com/maxbachmann/RapidFuzz).
+
+Create your [sentence templates](#sentence-templates) and save them to a file named `<SENTENCES_DIR>/<LANGUAGE>.yaml` where `<LANGUAGE>` is one of the [supported language codes](#supported-languages). For example, English sentences should be saved in `<SENTENCES_DIR>/en.yaml`.
+
+Then, run `wyoming_vosk` like:
+
+``` sh
+script/run ... --sentences-dir <SENTENCES_DIR> --correct-sentences <CUTOFF>
+```
+
+where `<CUTOFF>` is:
+
+* empty or 0 - force transcript to be one of the template sentences
+* 1-100 - allow more sentences that are not similar to templates to pass through
+
+When `<CUTOFF>` is 100, speech recognition is effectively open-ended again. Experiment with different values to find one that lets you speak sentences outside your templates without sacrificing accuracy too much.
+
+If you have a set of sentences with a specific pattern that you'd like to skip correction, add them to your [no-correct patterns](#no-correct-patterns).
+
+
+### Limited
+
+Follow the instructions for [corrected mode](#corrected), then run `wyoming_vosk` like:
+
+``` sh
+script/run ... --sentences-dir <SENTENCES_DIR> --correct-sentences --limit-sentences
+```
+
+This will tell vosk that **only** the sentences from you templates can ever be spoken. Sentence correction is still needed (due to how vosk works internally), but it will ensure that sentences outside the templates cannot be sent.
+
+This mode will get you the highest possible accuracy, with the trade-off being that you cannot speak sentences outside the templates.
+
+## Sentence Templates
+
+Each language may have a YAML file with [sentence templates](https://github.com/home-assistant/hassil#sentence-templates).
+Most syntax is supported, including:
+
+* Optional words, surrounded with `[square brackets]`
+* Alternative words, `(surrounded|with|parens)`
+* Lists of values, referenced by `{name}`
+* Expansion rules, inserted by `<name>`
+
+The general format of a language's YAML file is:
+
+``` yaml
+sentences:
+  - this is a plain sentence
+  - this is a sentence with a {list} and a <rule>
+lists:
+  list:
+    values:
+      - value 1
+      - value 2
+expansion_rules:
+  rule: body of the rule
+```
+
+Sentences have a special `in/out` form as well, which lets you say one thing (`in`) but put something else in the transcript (`out`).
+
+For example:
+
+``` yaml
+sentences:
+  - in: lumos
+    out: turn on all the lights
+  - in: nox
+    out: turn off all the lights
+```
+
+lets you say "lumos" to send "turn on all the lights", and "nox" to send "turn off all the lights".
+
+The `in` key can also take a list of sentences, all of them outputting the same `out` string.
+
+### Lists
+
+Lists are useful when you many possible words/phrases in a sentence.
+
+For example:
+
+``` yaml
+sentences:
+  - set light to {color}
+lists:
+  color:
+    values:
+      - red
+      - green
+      - blue
+      - orange
+      - yellow
+      - purple
+```
+
+lets you set a light to one of six colors.
+
+This could also be written as `set light to (red|green|blue|orange|yellow|purple)`, but the list is more manageable and can be shared between sentences.
+
+List values have a special `in/out` form that lets you say one thing (`in`) but put something else in the transcript (`out`).
+
+For example:
+
+``` yaml
+sentences:
+  - turn (on|off) {device}
+lists:
+  device:
+    values:
+      - in: tv
+        out: living room tv
+      - in: light
+        out: bedroom room light
+```
+
+lets you say "turn on tv" to turn on the living room TV, and "turn off light" to turn off the bedroom light.
+
+### Expansion Rules
+
+Repeated parts of a sentence template can be abstracted into an expansion rule.
+
+For example:
+
+``` yaml
+sentences:
+  - turn on <the> light
+  - turn off <the> light
+expansion_rules:
+  the: [the|my]
+```
+
+lets you say "turn on light" or "turn off my light" without having to repeat the optional part.
+
+## No Correct Patterns
+
+When you [correct sentences](#correct-sentences), you want to keep the score cutoff as low as possible to avoid letting invalid sentences though. But what if you just want *some* open-ended sentences, such as "draw me a picture of ..." which you can then forward to an image generator?
+
+Add the following to your sentences YAML file:
+
+``` yaml
+sentences:
+  ...
+no_correct_patterns:
+  - <regular expression>
+  - <regular expression>
+  ...
+```
+
+You can add as many regular expressions to `no_correct_patterns` as you'd like. If the transcript matches any of these patterns, it will be sent with no further corrections. This effectively lets you "punch holes" in the sentence templates to allow some sentences through.
+
+## Allow Unknown
+
+With `--allow-unknown`, you can enable the detection of "unknown" words/phrases outside of the model's vocabulary. Transcripts that are "unknown" will be set to empty strings, indicating that nothing was recognized. When combined with [limited sentences](#limited-sentences), this lets you differentiate between in and out of domain sentences.
+
+## Supported Languages
+
+* Arabic (`ar`)
+* Breton (`br`)
+* Catalan (`ca`)
+* Czech (`cz`)
+* German (`de`)
+* English (`en`)
+* Esperanto (`eo`)
+* Spanish (`es`)
+* Persian (`fa`)
+* French (`fr`)
+* Hindi (`hi`)
+* Italian (`it`)
+* Japanese (`ja`)
+* Korean (`ko`)
+* Kazakh (`kz`)
+* Dutch (`nl`)
+* Polish (`pl`)
+* Portuguese (`pt`)
+* Russian (`ru`)
+* Swedish (`sv`)
+* Tagalog (`tl`)
+* Ukrainian (`uk`)
+* Uzbek (`uz`)
+* Vietnamese (`vn`)
+* Chinese (`zh`)

vosk/run.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+python3 -m wyoming_vosk \
+    --uri 'tcp://0.0.0.0:10300' "$@"