This release is a pre-release and may not be stable for production use.
Description
OpenVoiceOS companion plugin for OpenVoiceOS STT Server
Install
pip install ovos-stt-plugin-server
Configuration
"stt": {
"module": "ovos-stt-plugin-server",
"ovos-stt-plugin-server": {
"urls": ["https://0.0.0.0:8080/stt"],
"verify_ssl": true
},
}
for audio language detection
"listener": {
"audio_transformers": {
"ovos-audio-lang-server-plugin": {
"urls": ["https://0.0.0.0:8080/lang_detect"],
"verify_ssl": true
}
}
}
Security warning
Please note that while you can set verify_ssl to false to disable SSL
verification, this is not recommended and should only be used for testing
purposes. Consider using a private CA or certificates signed using
Let's Encrypt instead.
Self-hosting (recommended)
Run your own server. It keeps your audio on your own hardware, it does not depend on somebody else's uptime, and you choose the model.
pip install ovos-stt-http-server ovos-stt-plugin-onnx-asr
ovos-stt-server --engine ovos-stt-plugin-onnx-asr
ovos-stt-plugin-onnx-asr is the recommended engine: it runs ONNX models on CPU, ships a best-model-per-language registry covering ~90 languages, and loads a model per request language, so one server can serve all of them. Point the plugin at it:
"stt": {
"module": "ovos-stt-plugin-server",
"ovos-stt-plugin-server": {
"urls": ["https://your-server.example/stt"]
}
}
The server runs one engine at a time, and you choose the engine with
--engine. This example serves Italian with the
Vosk engine:
pip install ovos-stt-http-server ovos-stt-plugin-vosk
ovos-stt-server --engine ovos-stt-plugin-vosk
"stt": {
"module": "ovos-stt-plugin-server",
"ovos-stt-plugin-server": {
"urls": ["http://0.0.0.0:8080/stt"]
},
"ovos-stt-plugin-vosk": {
"lang": "it-IT",
"model": "https://alphacephei.com/vosk/models/vosk-model-small-it-0.22.zip"
}
}
In this example the server and the listener run on the same machine, so one
mycroft.conf carries the whole block: the server reads the
ovos-stt-plugin-vosk section, and the listener reads the
ovos-stt-plugin-server section. If you move the server to another machine,
that machine keeps the ovos-stt-plugin-vosk section, and the listener keeps
only the ovos-stt-plugin-server section.
When the server is down, the listener can use a local STT plugin as a
fallback. Set fallback_module and give that plugin its own config:
"stt": {
"module": "ovos-stt-plugin-server",
"fallback_module": "ovos-stt-plugin-vosk",
"ovos-stt-plugin-server": {
"urls": ["https://your-server.example/stt"]
},
"ovos-stt-plugin-vosk": {
"model": "https://alphacephei.com/vosk/models/vosk-model-small-it-0.22.zip"
}
}
Public servers
If you set no urls, the plugin falls back to public servers.
These are a community courtesy, not a service. They exist so you can try OVOS without setting anything up first. They are provided on a best-effort basis with no guarantees of uptime, latency, accuracy, privacy, or continued existence, and they can change or disappear without notice. They are meant for demos, evaluation and onboarding — not for production, and not for anything you would not want a third party to receive. Audio you send is processed on hardware you do not control.
For anything beyond trying it out, self-host.
2 maintainers
Metadata
2 maintainers
Release files for ovos-stt-plugin-server 0.1.5a5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ovos_stt_plugin_server-0.1.5a5.tar.gz | 9.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ovos_stt_plugin_server-0.1.5a5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 19.5 kB
Release files / ovos_stt_plugin_server-0.1.5a5.tar.gz
| Download URL | ovos_stt_plugin_server-0.1.5a5.tar.gz |
|---|---|
| Size | 9.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a0f15a7a173c3091d867bad5b3adcf4da6ee465b9c940bcda08b73ab9ad73560
|
|
BLAKE2b-256 checksum How to use checksums |
16714bfb88131ca1ef0eb777f024b399bc4c8529a6e2908b9da7972b8b7240f6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / ovos_stt_plugin_server-0.1.5a5-py3-none-any.whl
| Download URL | ovos_stt_plugin_server-0.1.5a5-py3-none-any.whl |
|---|---|
| Size | 10.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f80f4b00cbb498eee70761aef180b78acf995aa511af54c40395908a43f3b088
|
|
BLAKE2b-256 checksum How to use checksums |
0e5fb36bc604e65c60d2df7ee531df93ee16c826561d7a5db4427808e4c4eac9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for ovos-stt-plugin-server 0.1.5a5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
