0.1.0 (#29)

# Changelog

##
[0.0.5a8](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/tree/0.0.5a8)
(2025-03-14)

[Full
Changelog](0.0.5a7...0.0.5a8)

**Merged pull requests:**

- Pin ovos-stt-http-server dependency to resolve Gradio deployment bug
[\#28](#28)
([NeonDaniel](https://github.com/NeonDaniel))

##
[0.0.5a7](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/tree/0.0.5a7)
(2025-03-14)

[Full
Changelog](0.0.5a6...0.0.5a7)

**Merged pull requests:**

- Update dependencies
[\#27](#27)
([NeonDaniel](https://github.com/NeonDaniel))

##
[0.0.5a6](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/tree/0.0.5a6)
(2025-03-14)

[Full
Changelog](0.0.4...0.0.5a6)

**Merged pull requests:**

- Update GitHub Actions and License Notices
[\#26](#26)
([NeonDaniel](https://github.com/NeonDaniel))
- Add support for multiple transcripts with updated unit tests
[\#25](#25)
([NeonDaniel](https://github.com/NeonDaniel))
- Update OPM dependency to allow latest stable version
[\#24](#24)
([NeonDaniel](https://github.com/NeonDaniel))
- feat/accept model from path
[\#23](#23)
([JarbasAl](https://github.com/JarbasAl))
- Update dependencies to allow ovos-utils 0.1
[\#22](#22)
([NeonDaniel](https://github.com/NeonDaniel))
- Add test case to validate available languages
[\#21](#21)
([NeonDaniel](https://github.com/NeonDaniel))



\* *This Changelog was automatically generated by
[github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

---------

Co-authored-by: Daniel McKnight <[email protected]>
Co-authored-by: Daniel McKnight <[email protected]>
Co-authored-by: NeonDaniel <[email protected]>
Co-authored-by: JarbasAI <[email protected]>

Author: NeonDaniel

.github/workflows/publish_test_build.yml

@@ -15,6 +15,8 @@ jobs:
     with:
       version_file: "version.py"
       setup_py: "setup.py"
+      publish_prerelease: true
+      update_changelog: true
   build_and_publish_docker:
     needs: publish_alpha_release
     uses: neongeckocom/.github/.github/workflows/publish_docker.yml@master

.github/workflows/unit_tests.yml

@@ -13,12 +13,12 @@ jobs:
   unit_tests:
     strategy:
       matrix:
-        python-version: [ 3.7, 3.8, 3.9 ]
+        python-version: [ 3.9, "3.10", "3.11" ]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -35,8 +35,8 @@ jobs:
         run: |
           pytest tests/test_stt.py --junitxml=tests/stt-test-results.xml
       - name: Upload STT test results
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
-          name: pytest-results-3.7
+          name: pytest-results-${{ matrix.python-version }}
           path: tests/stt-test-results.xml
         if: ${{ always() }}

CHANGELOG.md

@@ -1,15 +1,33 @@
 # Changelog
 
-## [0.0.4](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/tree/0.0.4) (2023-06-27)
+## [0.0.5a8](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/tree/0.0.5a8) (2025-03-14)
 
-[Full Changelog](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/compare/0.0.2...0.0.4)
+[Full Changelog](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/compare/0.0.5a7...0.0.5a8)
 
 **Merged pull requests:**
 
-- Update Docker and docs [\#18](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/18) ([NeonDaniel](https://github.com/NeonDaniel))
-- Using ONNX Nemo STT [\#15](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/15) ([NeonBohdan](https://github.com/NeonBohdan))
-- Docker container and Updated GitHub Automation [\#13](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/13) ([NeonDaniel](https://github.com/NeonDaniel))
-- Add `available_languages` property [\#11](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/11) ([NeonDaniel](https://github.com/NeonDaniel))
+- Pin ovos-stt-http-server dependency to resolve Gradio deployment bug [\#28](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/28) ([NeonDaniel](https://github.com/NeonDaniel))
+
+## [0.0.5a7](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/tree/0.0.5a7) (2025-03-14)
+
+[Full Changelog](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/compare/0.0.5a6...0.0.5a7)
+
+**Merged pull requests:**
+
+- Update dependencies [\#27](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/27) ([NeonDaniel](https://github.com/NeonDaniel))
+
+## [0.0.5a6](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/tree/0.0.5a6) (2025-03-14)
+
+[Full Changelog](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/compare/0.0.4...0.0.5a6)
+
+**Merged pull requests:**
+
+- Update GitHub Actions and License Notices [\#26](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/26) ([NeonDaniel](https://github.com/NeonDaniel))
+- Add support for multiple transcripts with updated unit tests [\#25](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/25) ([NeonDaniel](https://github.com/NeonDaniel))
+- Update OPM dependency to allow latest stable version [\#24](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/24) ([NeonDaniel](https://github.com/NeonDaniel))
+- feat/accept model from path [\#23](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/23) ([JarbasAl](https://github.com/JarbasAl))
+- Update dependencies to allow ovos-utils 0.1 [\#22](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/22) ([NeonDaniel](https://github.com/NeonDaniel))
+- Add test case to validate available languages [\#21](https://github.com/NeonGeckoCom/neon-stt-plugin-nemo/pull/21) ([NeonDaniel](https://github.com/NeonDaniel))
 
 
 

LICENSE.md

@@ -1,6 +1,6 @@
 # NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
 # All trademark and other rights reserved by their respective owners
-# Copyright 2008-2021 Neongecko.com Inc.
+# Copyright 2008-2025 Neongecko.com Inc.
 # BSD-3 License
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the

neon_stt_plugin_nemo/__init__.py

@@ -1,6 +1,6 @@
 # NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
 # All trademark and other rights reserved by their respective owners
-# Copyright 2008-2022 Neongecko.com Inc.
+# Copyright 2008-2025 Neongecko.com Inc.
 # Contributors: Daniel McKnight, Guy Daniels, Elon Gasper, Richard Leeds,
 # Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
 # BSD-3 License
@@ -25,6 +25,7 @@
 # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+from typing import Optional, List, Tuple
 
 import numpy as np
 
@@ -45,35 +46,49 @@ def __init__(self, config: dict = None):
 
         self._engines = {}
         self.cache_engines = self.config.get("cache", True)
+        self.default_model = self.config.get("model", None)
         if self.cache_engines:
-            self._init_model(self.lang)
+            self._init_model()
 
-    def _init_model(self, language) -> Model:
+    def _init_model(self, language=None) -> Model:
         # OVOS uses 'en-us' so this hacks that to work until dialects are supported
-        language = (language or self.lang).split('-')[0]
-        if language not in self._engines:
-            model = Model(language)
+        lang = (language or self.lang).split('-')[0]
+        if lang not in self._engines:
+            if self.default_model and language is None:
+                model = Model(lang=lang, model_folder=self.default_model)
+            else:
+                model = Model(lang=lang)
             if self.cache_engines:
-                self._engines[language] = model
+                self._engines[lang] = model
         else:
-            model = self._engines[language]
+            model = self._engines[lang]
 
         return model
 
     @property
     def available_languages(self) -> set:
         return set(available_languages)
 
-    def execute(self, audio: AudioData, language = None):
-        '''
-        Executes speach recognition
+    def execute(self, audio: AudioData, language: Optional[str] = None) -> str:
+        """
+        Executes speech recognition and returns the most likely transcription
+        @param audio: input audio data
+        @param language: language of input audio
+        @return: recognized text
+        """
 
-        Parameters:
-                    audio : input audio file path
-        Returns:
-                    text (str): recognized text
-        '''
-        model = self._init_model(language)
+        return self.transcribe(audio, language)[0][0]
+
+    def transcribe(self, audio,
+                   lang: Optional[str] = None) -> List[Tuple[str, float]]:
+        """
+        Executes speech recognition and returns a list of possible
+        transcriptions with associated confidence levels.
+        @param audio: input audio data
+        @param lang: language of input audio
+        @return: List of (transcript, confidence) elements
+        """
+        model = self._init_model(lang)
 
         audio_buffer = np.frombuffer(audio.get_raw_data(), dtype=np.int16)
         self.transcriptions = model.stt(audio_buffer, audio.sample_rate)
@@ -83,6 +98,5 @@ def execute(self, audio: AudioData, language = None):
             self.transcriptions = []
         else:
             LOG.debug("Audio had data")
-        # TODO: Return a string since we currently only get one result and the
-        #   ovos-stt-server only handles strings here
-        return self.transcriptions[0]
+        # Models do not return confidence, so just assume max of 1.0
+        return [(t, 1.0) for t in self.transcriptions]

requirements/docker.txt

@@ -1 +1,2 @@
-ovos-stt-http-server~=0.0.2
+ovos-stt-http-server==0.0.2
+# TODO: Gradio broken in 0.0.3+ with fix in https://github.com/OpenVoiceOS/ovos-stt-http-server/pull/28

requirements/requirements.txt

@@ -1,7 +1,4 @@
-ovos-plugin-manager~=0.0.21
-ovos-utils~=0.0.30
-streaming-stt-nemo~=0.2
+ovos-plugin-manager~=0.0,>=0.0.24
+ovos-utils~=0.0,>=0.0.30
+streaming-stt-nemo~=0.3
 SpeechRecognition~=3.8
-
-# TODO: Patching OPM
-mycroft-messagebus-client~=0.10

setup.py

@@ -1,6 +1,6 @@
 # NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
 #
-# Copyright 2008-2021 Neongecko.com Inc. | All Rights Reserved
+# Copyright 2008-2025 Neongecko.com Inc. | All Rights Reserved
 #
 # Notice of License - Duplicating this Notice of License near the start of any file containing
 # a derivative of this software is a condition of license for this software.

tests/test_stt.py

@@ -1,6 +1,6 @@
 # NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
 # All trademark and other rights reserved by their respective owners
-# Copyright 2008-2022 Neongecko.com Inc.
+# Copyright 2008-2025 Neongecko.com Inc.
 # Contributors: Daniel McKnight, Guy Daniels, Elon Gasper, Richard Leeds,
 # Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
 # BSD-3 License
@@ -51,6 +51,17 @@ def test_get_stt(self):
                 audio = r.record(source)  # read the entire audio file
                 result = self.stt.execute(audio)
                 self.assertIn(transcription, result)
+                results = self.stt.transcribe(audio)
+                self.assertEqual(results[0][0], result)
+                for result in results:
+                    self.assertIsInstance(result[0], str)
+                    self.assertIsInstance(result[1], float)
+
+    def test_available_languages(self):
+        langs = self.stt.available_languages
+        self.assertIsInstance(langs, set)
+        self.assertTrue(all((isinstance(lang, str) for lang in langs)))
+        self.assertIn("en", langs)
 
 
 if __name__ == '__main__':

version.py

@@ -1,6 +1,6 @@
 # NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
 #
-# Copyright 2008-2021 Neongecko.com Inc. | All Rights Reserved
+# Copyright 2008-2025 Neongecko.com Inc. | All Rights Reserved
 #
 # Notice of License - Duplicating this Notice of License near the start of any file containing
 # a derivative of this software is a condition of license for this software.
@@ -17,4 +17,4 @@
 # US Patents 2008-2021: US7424516, US20140161250, US20140177813, US8638908, US8068604, US8553852, US10530923, US10530924
 # China Patent: CN102017585  -  Europe Patent: EU2156652  -  Patents Pending
 
-__version__ = "0.0.4"
+__version__ = "0.1.0"