Introduced Klat personas management with persistent synchronisation + fallback on the initial implementation

kirgrim · kirgrim · commit d3bc687772a3 · 2024-01-14T22:55:14.000+01:00
diff --git a/neon_llm_core/rmq.py b/neon_llm_core/rmq.py
@@ -31,8 +31,10 @@
 from neon_mq_connector.utils.rabbit_utils import create_mq_callback
 from ovos_utils.log import LOG
 
-from neon_llm_core.config import load_config
+from neon_llm_core.utils.config import load_config
 from neon_llm_core.llm import NeonLLM
+from neon_llm_core.utils.constants import LLM_VHOST
+from neon_llm_core.utils.personas.provider import PersonasProvider
 
 
 class NeonLLMMQConnector(MQConnector, ABC):
@@ -45,11 +47,13 @@ def __init__(self):
         self.ovos_config = load_config()
         mq_config = self.ovos_config.get("MQ", dict())
         super().__init__(config=mq_config, service_name=self.service_name)
-        self.vhost = "/llm"
+        self.vhost = LLM_VHOST
 
         self.register_consumers()
         self._model = None
         self._bots = list()
+        self._personas_provider = PersonasProvider(service_name=self.name,
+                                                   ovos_config=self.ovos_config)
 
         if self.ovos_config.get("llm_bots", {}).get(self.name):
             from neon_llm_core.chatbot import LLMBot
@@ -242,3 +246,15 @@ def compose_opinion_prompt(respondent_nick: str, question: str,
         @param answer: respondent's response to the question
         """
         pass
+
+    def run(self, run_consumers: bool = True, run_sync: bool = True,
+            run_observer: bool = True, **kwargs):
+        super().run(run_consumers=run_consumers,
+                    run_sync=run_sync,
+                    run_observer=run_observer,
+                    **kwargs)
+        self._personas_provider.start_sync()
+
+    def stop(self):
+        super().stop()
+        self._personas_provider.stop_sync()
diff --git a/neon_llm_core/utils/__init__.py b/neon_llm_core/utils/__init__.py
@@ -0,0 +1,25 @@
+# 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.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# 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.
diff --git a/neon_llm_core/utils/config.py b/neon_llm_core/utils/config.py
@@ -31,6 +31,8 @@
 from ovos_utils.log import LOG
 from ovos_config.config import Configuration
 
+from neon_llm_core.utils.constants import LLM_VHOST
+
 
 def load_config() -> dict:
     """
@@ -56,4 +58,4 @@ class LLMMQConfig:
     ask_response_queue: str
     ask_appraiser_queue: str
     ask_discusser_queue: str
-    vhost: str = '/llm'
+    vhost: str = LLM_VHOST
diff --git a/neon_llm_core/utils/constants.py b/neon_llm_core/utils/constants.py
@@ -0,0 +1,27 @@
+# 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.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# 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.
+
+LLM_VHOST = '/llm'
diff --git a/neon_llm_core/utils/personas/provider.py b/neon_llm_core/utils/personas/provider.py
@@ -0,0 +1,91 @@
+# 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.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# 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.
+import os
+from time import time
+
+from neon_mq_connector.utils import RepeatingTimer
+from neon_mq_connector.utils.client_utils import send_mq_request
+from ovos_utils.log import LOG
+
+from neon_llm_core.utils.constants import LLM_VHOST
+from neon_llm_core.utils.personas.state import PersonaHandlersState
+
+
+class PersonasProvider:
+
+    PERSONA_STATE_TTL = int(os.getenv("PERSONA_STATE_TTL", 15 * 60))
+    PERSONA_SYNC_INTERVAL = int(os.getenv("PERSONA_SYNC_INTERVAL", 5 * 60))
+
+    def __init__(self, service_name: str, ovos_config: dict):
+        self.service_name = service_name
+        self._persona_handlers_state = PersonaHandlersState(service_name=service_name,
+                                                            ovos_config=ovos_config)
+        self._personas = []  # list of personas available for given service
+        self._persona_last_sync = 0
+        self._persona_sync_thread = None
+
+    @property
+    def persona_sync_thread(self):
+        """Creates new synchronization thread which fetches Klat personas"""
+        if not (isinstance(self._persona_sync_thread, RepeatingTimer) and
+                self._persona_sync_thread.is_alive()):
+            self._persona_sync_thread = RepeatingTimer(self.PERSONA_SYNC_INTERVAL,
+                                                       self._fetch_persona_config)
+            self._persona_sync_thread.daemon = True
+        return self._persona_sync_thread
+
+    @property
+    def personas(self):
+        return self._personas
+
+    @personas.setter
+    def personas(self, data):
+        now = int(time())
+        LOG.debug(f'Setting personas={data}')
+        if data and isinstance(data, list):
+            self._personas = data
+            self._persona_last_sync = now
+        elif now - self._persona_last_sync > self.PERSONA_STATE_TTL:
+            LOG.warning(f'Persona state TTL expired, resetting personas config')
+            self._personas = []
+            self._persona_handlers_state.init_default_handlers()
+
+    def _fetch_persona_config(self):
+        response = send_mq_request(vhost=LLM_VHOST,
+                                   request_data={"service_name": self.service_name},
+                                   target_queue="get_configured_personas")
+        self.personas = response.get('items', [])
+        for persona in self.personas:
+            if persona:
+                self._persona_handlers_state.add_persona_handler(persona=persona)
+
+    def start_sync(self):
+        self.persona_sync_thread.start()
+
+    def stop_sync(self):
+        if self._persona_sync_thread:
+            self._persona_sync_thread.cancel()
+            self._persona_sync_thread = None
diff --git a/neon_llm_core/utils/personas/state.py b/neon_llm_core/utils/personas/state.py
@@ -0,0 +1,48 @@
+import time
+from typing import Dict, Union
+
+from ovos_utils import LOG
+
+from neon_llm_core.chatbot import LLMBot
+
+
+class PersonaHandlersState:
+
+    def __init__(self, service_name: str, ovos_config: dict):
+        self._created_items: Dict[str, LLMBot] = {}
+        self.service_name = service_name
+        self.ovos_config = ovos_config
+        self.mq_config = ovos_config.get('MQ', {})
+        self.init_default_handlers()
+
+    def init_default_handlers(self):
+        if self.ovos_config.get("llm_bots", {}).get(self.service_name):
+            from neon_llm_core.chatbot import LLMBot
+            LOG.info(f"Chatbot(s) configured for: {self.service_name}")
+            for persona in self.ovos_config['llm_bots'][self.service_name]:
+                self.add_persona_handler(persona=persona)
+
+    def add_persona_handler(self, persona: dict) -> Union[LLMBot, None]:
+        persona_name = persona['name']
+        if persona_name in list(self._created_items):
+            if self._created_items[persona_name].persona != persona:
+                LOG.warning(f"Overriding already existing persona: '{persona_name}' with new data={persona}")
+                self._created_items[persona_name].stop()
+                # time to gracefully stop the submind
+                time.sleep(0.5)
+            else:
+                LOG.warning('Persona config provided is identical to existing, skipping')
+                return self._created_items[persona_name]
+        if not persona.get('enabled', True):
+            LOG.warning(f"Persona disabled: {persona['name']}")
+            return
+        # Get a configured username to use for LLM submind connections
+        if self.mq_config.get("users", {}).get("neon_llm_submind"):
+            self.ovos_config["MQ"]["users"][persona['name']] = self.mq_config['users']['neon_llm_submind']
+        bot = LLMBot(llm_name=self.service_name, service_name=persona['name'],
+                     persona=persona, config=self.ovos_config,
+                     vhost="/chatbots")
+        bot.run()
+        LOG.info(f"Started chatbot: {bot.service_name}")
+        self._created_items[persona_name] = bot
+        return bot
