Merge pull request #288 from OpenVoiceOS/release-0.6.0a1

Release 0.6.0a1

CHANGELOG.md

@@ -1,12 +1,20 @@
 # Changelog
 
-## [0.5.6a1](https://github.com/OpenVoiceOS/ovos-plugin-manager/tree/0.5.6a1) (2024-11-05)
+## [0.6.0a1](https://github.com/OpenVoiceOS/ovos-plugin-manager/tree/0.6.0a1) (2024-11-20)
 
-[Full Changelog](https://github.com/OpenVoiceOS/ovos-plugin-manager/compare/0.5.5...0.5.6a1)
+[Full Changelog](https://github.com/OpenVoiceOS/ovos-plugin-manager/compare/0.5.7a1...0.6.0a1)
 
 **Merged pull requests:**
 
-- fix: allow latest bus client version [\#283](https://github.com/OpenVoiceOS/ovos-plugin-manager/pull/283) ([JarbasAl](https://github.com/JarbasAl))
+- feat: chat history [\#286](https://github.com/OpenVoiceOS/ovos-plugin-manager/pull/286) ([JarbasAl](https://github.com/JarbasAl))
+
+## [0.5.7a1](https://github.com/OpenVoiceOS/ovos-plugin-manager/tree/0.5.7a1) (2024-11-18)
+
+[Full Changelog](https://github.com/OpenVoiceOS/ovos-plugin-manager/compare/0.5.6...0.5.7a1)
+
+**Merged pull requests:**
+
+- Update `config` default value handling with updated unit test [\#276](https://github.com/OpenVoiceOS/ovos-plugin-manager/pull/276) ([NeonDaniel](https://github.com/NeonDaniel))
 
 
 

ovos_plugin_manager/solvers.py

@@ -1,10 +1,26 @@
-from ovos_plugin_manager.utils import normalize_lang, \
-    PluginTypes, PluginConfigTypes
 from ovos_plugin_manager.templates.solvers import QuestionSolver, TldrSolver, \
-    EntailmentSolver, MultipleChoiceSolver, EvidenceSolver
-from ovos_utils.log import LOG
+    EntailmentSolver, MultipleChoiceSolver, EvidenceSolver, ChatMessageSolver
+from ovos_plugin_manager.utils import PluginTypes, PluginConfigTypes
 
 
+def find_chat_solver_plugins() -> dict:
+    """
+    Find all installed plugins
+    @return: dict plugin names to entrypoints
+    """
+    from ovos_plugin_manager.utils import find_plugins
+    return find_plugins(PluginTypes.CHAT_SOLVER)
+
+
+def load_chat_solver_plugin(module_name: str) -> type(ChatMessageSolver):
+    """
+    Get an uninstantiated class for the requested module_name
+    @param module_name: Plugin entrypoint name to load
+    @return: Uninstantiated class
+    """
+    from ovos_plugin_manager.utils import load_plugin
+    return load_plugin(module_name, PluginTypes.CHAT_SOLVER)
+
 
 def find_question_solver_plugins() -> dict:
     """
@@ -172,7 +188,7 @@ def get_entailment_solver_module_configs(module_name: str) -> dict:
 
 
 def get_entailment_solver_lang_configs(lang: str,
-                                     include_dialects: bool = False) -> dict:
+                                       include_dialects: bool = False) -> dict:
     """
     Get a dict of plugin names to list valid configurations for the requested
     lang.
@@ -303,7 +319,7 @@ def get_reading_comprehension_solver_module_configs(module_name: str) -> dict:
 
 
 def get_reading_comprehension_solver_lang_configs(lang: str,
-                                     include_dialects: bool = False) -> dict:
+                                                  include_dialects: bool = False) -> dict:
     """
     Get a dict of plugin names to list valid configurations for the requested
     lang.
@@ -324,4 +340,3 @@ def get_reading_comprehension_solver_supported_langs() -> dict:
     from ovos_plugin_manager.utils.config import get_plugin_supported_languages
     return get_plugin_supported_languages(
         PluginTypes.READING_COMPREHENSION_SOLVER)
-

ovos_plugin_manager/templates/solvers.py

@@ -4,8 +4,8 @@
 from typing import Optional, List, Iterable, Tuple, Dict, Union, Any
 
 from json_database import JsonStorageXDG
-from ovos_utils.log import LOG, log_deprecation
 from ovos_utils.lang import standardize_lang_tag
+from ovos_utils.log import LOG, log_deprecation
 from ovos_utils.xdg_utils import xdg_cache_home
 
 from ovos_plugin_manager.templates.language import LanguageTranslator, LanguageDetector
@@ -398,6 +398,73 @@ def long_answer(self, query: str,
         return steps
 
 
+class ChatMessageSolver(QuestionSolver):
+    """A solver that processes chat history in LLM-style format to generate contextual responses.
+
+    This class extends QuestionSolver to handle multi-turn conversations, maintaining
+    context across messages. It expects chat messages in a format similar to LLM APIs:
+
+     messages = [
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Knock knock."},
+        {"role": "assistant", "content": "Who's there?"},
+        {"role": "user", "content": "Orange."},
+     ]
+     """
+
+    @abc.abstractmethod
+    def continue_chat(self, messages: List[Dict[str, str]],
+                      lang: Optional[str],
+                      units: Optional[str] = None) -> Optional[str]:
+        """Generate a response based on the chat history.
+
+        Args:
+            messages (List[Dict[str, str]]): List of chat messages, each containing 'role' and 'content'.
+            lang (Optional[str]): The language code for the response. If None, will be auto-detected.
+            units (Optional[str]): Optional unit system for numerical values.
+
+        Returns:
+            Optional[str]: The generated response or None if no response could be generated.
+        """
+
+    @auto_detect_lang(text_keys=["messages"])
+    @auto_translate(translate_keys=["messages"])
+    def get_chat_completion(self, messages: List[Dict[str, str]],
+                            lang: Optional[str] = None,
+                            units: Optional[str] = None) -> Optional[str]:
+        return self.continue_chat(messages=messages, lang=lang, units=units)
+
+    def stream_chat_utterances(self, messages: List[Dict[str, str]],
+                               lang: Optional[str] = None,
+                               units: Optional[str] = None) -> Iterable[str]:
+        """
+        Stream utterances for the given chat history as they become available.
+
+        Args:
+            messages: The chat messages.
+            lang (Optional[str]): Optional language code. Defaults to None.
+            units (Optional[str]): Optional units for the query. Defaults to None.
+
+        Returns:
+            Iterable[str]: An iterable of utterances.
+        """
+        ans = _call_with_sanitized_kwargs(self.get_chat_completion, messages, lang=lang, units=units)
+        for utt in self.sentence_split(ans):
+            yield utt
+
+    def get_spoken_answer(self, query: str,
+                          lang: Optional[str] = None,
+                          units: Optional[str] = None) -> Optional[str]:
+        """Override of QuestionSolver.get_spoken_answer for API compatibility.
+
+        This implementation converts the single query into a chat message format
+        and delegates to continue_chat. While functional, direct use of chat-specific
+        methods is recommended for chat-based interactions.
+        """
+        # just for api compat since it's a subclass, shouldn't be directly used
+        return self.continue_chat(messages=[{"role": "user", "content": query}], lang=lang, units=units)
+
+
 class CorpusSolver(QuestionSolver):
     """Retrieval based question solver"""
 

ovos_plugin_manager/utils/__init__.py

@@ -28,36 +28,37 @@ class PluginTypes(str, Enum):
     FACE_EMBEDDINGS = "opm.embeddings.face"
     VOICE_EMBEDDINGS = "opm.embeddings.voice"
     TEXT_EMBEDDINGS = "opm.embeddings.text"
-    GUI = "ovos.plugin.gui"
-    PHAL = "ovos.plugin.phal"
-    ADMIN = "ovos.plugin.phal.admin"
-    SKILL = "ovos.plugin.skill"
-    MIC = "ovos.plugin.microphone"
-    VAD = "ovos.plugin.VAD"
-    PHONEME = "ovos.plugin.g2p"
-    AUDIO2IPA = "ovos.plugin.audio2ipa"
+    GUI = "ovos.plugin.gui"  # TODO rename "opm.gui"
+    PHAL = "ovos.plugin.phal"  # TODO rename "opm.phal"
+    ADMIN = "ovos.plugin.phal.admin"  # TODO rename "opm.phal.admin"
+    SKILL = "ovos.plugin.skill"  # TODO rename "opm.skill"
+    MIC = "ovos.plugin.microphone"  # TODO rename "opm.microphone"
+    VAD = "ovos.plugin.VAD"  # TODO rename "opm.vad"
+    PHONEME = "ovos.plugin.g2p"  # TODO rename "opm.g2p"
+    AUDIO2IPA = "ovos.plugin.audio2ipa"  # TODO rename "opm.audio2ipa"
     AUDIO = 'mycroft.plugin.audioservice'  # DEPRECATED
-    STT = 'mycroft.plugin.stt'
-    TTS = 'mycroft.plugin.tts'
-    WAKEWORD = 'mycroft.plugin.wake_word'
-    TRANSLATE = "neon.plugin.lang.translate"
-    LANG_DETECT = "neon.plugin.lang.detect"
-    UTTERANCE_TRANSFORMER = "neon.plugin.text"
-    METADATA_TRANSFORMER = "neon.plugin.metadata"
-    AUDIO_TRANSFORMER = "neon.plugin.audio"
+    STT = 'mycroft.plugin.stt'  # TODO rename "opm.stt"
+    TTS = 'mycroft.plugin.tts'  # TODO rename "opm.tts"
+    WAKEWORD = 'mycroft.plugin.wake_word'  # TODO rename "opm.wake_word"
+    TRANSLATE = "neon.plugin.lang.translate"  # TODO rename "opm.lang.translate"
+    LANG_DETECT = "neon.plugin.lang.detect"  # TODO rename "opm.lang.detect"
+    UTTERANCE_TRANSFORMER = "neon.plugin.text"  # TODO rename "opm.transformer.text"
+    METADATA_TRANSFORMER = "neon.plugin.metadata"  # TODO rename "opm.transformer.metadata"
+    AUDIO_TRANSFORMER = "neon.plugin.audio"  # TODO rename "opm.transformer.audio"
     DIALOG_TRANSFORMER = "opm.transformer.dialog"
     TTS_TRANSFORMER = "opm.transformer.tts"
-    QUESTION_SOLVER = "neon.plugin.solver"
+    QUESTION_SOLVER = "neon.plugin.solver"  # TODO rename "opm.solver.question"
+    CHAT_SOLVER = "opm.solver.chat"
     TLDR_SOLVER = "opm.solver.summarization"
     ENTAILMENT_SOLVER = "opm.solver.entailment"
     MULTIPLE_CHOICE_SOLVER = "opm.solver.multiple_choice"
     READING_COMPREHENSION_SOLVER = "opm.solver.reading_comprehension"
-    COREFERENCE_SOLVER = "intentbox.coreference"
-    KEYWORD_EXTRACTION = "intentbox.keywords"
-    UTTERANCE_SEGMENTATION = "intentbox.segmentation"
-    TOKENIZATION = "intentbox.tokenization"
-    POSTAG = "intentbox.postag"
-    STREAM_EXTRACTOR = "ovos.ocp.extractor"
+    COREFERENCE_SOLVER = "intentbox.coreference"  # TODO rename "opm.coreference"
+    KEYWORD_EXTRACTION = "intentbox.keywords"  # TODO rename "opm.keywords"
+    UTTERANCE_SEGMENTATION = "intentbox.segmentation"  # TODO rename "opm.segmentation"
+    TOKENIZATION = "intentbox.tokenization"  # TODO rename "opm.tokenization"
+    POSTAG = "intentbox.postag"  # TODO rename "opm.postag"
+    STREAM_EXTRACTOR = "ovos.ocp.extractor"  # TODO rename "opm.ocp.extractor"
     AUDIO_PLAYER = "opm.media.audio"
     VIDEO_PLAYER = "opm.media.video"
     WEB_PLAYER = "opm.media.web"
@@ -91,6 +92,7 @@ class PluginConfigTypes(str, Enum):
     DIALOG_TRANSFORMER = "opm.transformer.dialog.config"
     TTS_TRANSFORMER = "opm.transformer.tts.config"
     QUESTION_SOLVER = "neon.plugin.solver.config"
+    CHAT_SOLVER = "opm.solver.chat.config"
     TLDR_SOLVER = "opm.solver.summarization.config"
     ENTAILMENT_SOLVER = "opm.solver.entailment.config"
     MULTIPLE_CHOICE_SOLVER = "opm.solver.multiple_choice.config"
@@ -173,6 +175,7 @@ def load_plugin(plug_name: str, plug_type: Optional[PluginTypes] = None):
     LOG.warning(f'Could not find the plugin {plug_type}.{plug_name}')
     return None
 
+
 @deprecated("normalize_lang has been deprecated! update to 'from ovos_utils.lang import standardize_lang_tag'", "1.0.0")
 def normalize_lang(lang):
     from ovos_utils.lang import standardize_lang_tag

ovos_plugin_manager/utils/config.py

@@ -14,6 +14,11 @@ def get_plugin_config(config: Optional[dict] = None, section: str = None,
     - module-specific configurations take priority
     - section-specific configuration is appended (new keys only)
     - global `lang` configuration is appended (if not already set)
+
+    If no module is specified, then the requested section configuration is
+    assumed to be a top-level key in the base configuration, defaulting to the
+    base configuration if that section is not found. If both `module` and
+    `section` are unspecified, then the base configuration is returned.
     @param config: Base configuration to parse, defaults to `Configuration()`
     @param section: Config section for the plugin (i.e. TTS, STT, language)
     @param module: Module/plugin to get config for, default reads from config
@@ -27,16 +32,23 @@ def get_plugin_config(config: Optional[dict] = None, section: str = None,
     if module:
         module_config = dict(config.get(module) or dict())
         module_config.setdefault('module', module)
-        for key, val in config.items():
-            # Configured module name is not part of that module's config
-            if key in ("module", "translation_module", "detection_module"):
-                continue
-            elif isinstance(val, dict):
-                continue
-            # Use section-scoped config as defaults (i.e. TTS.lang)
-            module_config.setdefault(key, val)
+        if config == Configuration():
+            LOG.debug(f"No `{section}` config in Configuration")
+        else:
+            # If the config section exists (i.e. `stt`), then handle any default
+            # values in that section (i.e. `lang`)
+            for key, val in config.items():
+                # Configured module name is not part of that module's config
+                if key in ("module", "translation_module", "detection_module"):
+                    continue
+                elif isinstance(val, dict):
+                    continue
+                # Use section-scoped config as defaults (i.e. TTS.lang)
+                module_config.setdefault(key, val)
         config = module_config
-    if section not in ["hotwords", "VAD", "listener", "gui"]:
+    if section not in ["hotwords", "VAD", "listener", "gui", None]:
+        # With some exceptions, plugins will want a `lang` value. If it was not
+        # set in the section or module config, use the default top-level config.
         config.setdefault('lang', lang)
     LOG.debug(f"Loaded configuration: {config}")
     return config

ovos_plugin_manager/version.py

@@ -1,6 +1,6 @@
 # START_VERSION_BLOCK
 VERSION_MAJOR = 0
-VERSION_MINOR = 5
-VERSION_BUILD = 6
-VERSION_ALPHA = 0
+VERSION_MINOR = 6
+VERSION_BUILD = 0
+VERSION_ALPHA = 1
 # END_VERSION_BLOCK

test/unittests/test_utils.py

@@ -649,6 +649,13 @@ def test_get_plugin_config(self, config):
         self.assertEqual(tts_config['voice'], 'german-mbrola-5')
         self.assertNotIn("ovos_tts_plugin_espeakng", tts_config)
 
+        # Test PHAL with no configuration
+        phal_config = get_plugin_config(config, "PHAL")
+        self.assertEqual(set(phal_config.keys()), config.keys())
+        phal_config = get_plugin_config(config, "PHAL", "test_plugin")
+        self.assertEqual(phal_config, {"module": "test_plugin",
+                                       "lang": config["lang"]})
+
         self.assertEqual(_MOCK_CONFIG, start_config)
 
     def test_get_valid_plugin_configs(self):