refactor!: opm agents plugins

Author: JarbasAl

ovos_solver_aiml_plugin/__init__.py

@@ -3,8 +3,9 @@
 from datetime import date
 from os import listdir, remove as remove_file, makedirs
 from os.path import dirname, isfile, isdir
-from typing import Optional
-from ovos_plugin_manager.templates.solvers import QuestionSolver
+from typing import Dict, Optional, List, Any, Tuple
+
+from ovos_plugin_manager.templates.agents import RetrievalEngine
 from ovos_utils.log import LOG
 from ovos_utils.xdg_utils import xdg_data_home
 
@@ -94,31 +95,29 @@ def shutdown(self):
             self.kernel.resetBrain()  # Manual remove
 
 
-class AIMLSolver(QuestionSolver):
-    def __init__(self, config=None):
+class AIMLSolver(RetrievalEngine):
+    def __init__(self, config: Optional[Dict[str, Any]] = None):
         config = config or {"lang": "en-us"}
         lang = config.get("lang") or "en-us"
         if lang != "en-us" and lang not in os.listdir(AimlBot.XDG_PATH):
-            config["lang"] = lang = "en-us"
-        super().__init__(config, internal_lang=lang, enable_tx=True, priority = 95)
-        self.brain = AimlBot(lang)
+            config["lang"] = "en-us"
+        super().__init__(config)
+        self.brain = AimlBot(self.config.get("lang"))
         self.brain.load_brain()
 
-    def get_spoken_answer(self, query: str,
-                          lang: Optional[str] = None,
-                          units: Optional[str] = None) -> Optional[str]:
+    def query(self, query: str, lang: Optional[str] = None, k: int = 3) -> List[Tuple[str, float]]:
         """
-        Obtain the spoken answer for a given query.
+        Searches the knowledge base for relevant documents or data.
 
         Args:
-            query (str): The query text.
-            lang (Optional[str]): Optional language code. Defaults to None.
-            units (Optional[str]): Optional units for the query. Defaults to None.
+            query: The search string.
+            lang: BCP-47 language code.
+            k: The maximum number of results to return.
 
         Returns:
-            str: The spoken answer as a text response.
+            List of tuples (content, score) for the top k matches.
         """
-        return self.brain.ask(query)
+        return [(self.brain.ask(query), 0.5)]
 
 
 if __name__ == "__main__":

requirements.txt

@@ -1,2 +1,2 @@
 aiml
-ovos-plugin-manager>=0.0.26,<3.0.0
+ovos-plugin-manager>=2.2.3a1,<3.0.0

setup.py

@@ -47,15 +47,15 @@ def get_version():
 setup(
     name='ovos-solver-aiml-plugin',
     version=get_version(),
-    description='A question solver plugin for ovos/neon/mycroft',
+    description='A chatbot plugin for OpenVoiceOS',
     url='https://github.com/OpenVoiceOS/ovos-solver-aiml-plugin',
     author='jarbasai',
     author_email='jarbasai@mailfence.com',
     license='MIT',
     packages=['ovos_solver_aiml_plugin'],
     zip_safe=True,
-    keywords='mycroft plugin utterance fallback query',
-    entry_points={'neon.plugin.solver': PLUGIN_ENTRY_POINT},
+    keywords='OpenVoiceOS OVOS plugin utterance fallback query',
+    entry_points={'opm.agents.retrieval': PLUGIN_ENTRY_POINT},
     install_requires=required("requirements.txt"),
     long_description=long_description,
     long_description_content_type='text/markdown'