ovos-solver-rivescript-plugin 0.0.2a2__tar.gz → 0.1.0a2__tar.gz

ovos_solver_rivescript_plugin-0.1.0a2/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: ovos-solver-rivescript-plugin
+Version: 0.1.0a2
+Summary: A question solver plugin for ovos/neon/mycroft
+Author-email: JarbasAi <jarbasai@mailfence.com>
+License: MIT
+Project-URL: Homepage, https://github.com/OpenVoiceOS/ovos-solver-plugin-rivescript
+Keywords: mycroft,plugin,utterance,fallback,query,rivescript
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rivescript
+Requires-Dist: ovos-plugin-manager<3.0.0,>=2.6.1a1
+Provides-Extra: test
+Requires-Dist: pytest<9,>=7.0.0; extra == "test"
+Requires-Dist: pytest-timeout>=2.0.0; extra == "test"
+Dynamic: license-file
+
+# <img src='https://raw.githack.com/FortAwesome/Font-Awesome/master/svgs/solid/robot.svg' card_color='#40DBB0' width='50' height='50' style='vertical-align:bottom'/> Rivescript Chatbot
+
+This plugin is a question solver that answers with a [Rivescript](https://www.rivescript.com/) chatbot. It uses the [Alice chatbot](https://www.chatbots.org/chatbot/a.l.i.c.e/) brain to answer phrases that no other skill handles, so almost every input gets some response. Answers can be casual and a bit sassy.
+
+## Examples
+
+* "Do you like ice cream"
+* "Do you like dogs"
+* "I have a jump rope"
+
+## Usage
+
+The plugin exposes a spoken-answers API with a Rivescript backend.
+
+```python
+from ovos_solver_rivescript_plugin import RivescriptSolver
+
+d = RivescriptSolver()
+sentence = d.spoken_answer("hello")
+print(sentence)
+# Hi there!
+
+sentence = d.spoken_answer("Do you like ice cream", {"lang": "pt-pt"})
+print(sentence)
+# O que queres mesmo saber?
+```
+
+## Related projects
+
+* [OpenVoiceOS/ovos-plugin-manager](https://github.com/OpenVoiceOS/ovos-plugin-manager): loads and manages solver plugins like this one.
+* [OpenVoiceOS/ovos-persona-server](https://github.com/OpenVoiceOS/ovos-persona-server): runs solver plugins as chat personas.

ovos_solver_rivescript_plugin-0.1.0a2/README.md

@@ -0,0 +1,31 @@
+# <img src='https://raw.githack.com/FortAwesome/Font-Awesome/master/svgs/solid/robot.svg' card_color='#40DBB0' width='50' height='50' style='vertical-align:bottom'/> Rivescript Chatbot
+
+This plugin is a question solver that answers with a [Rivescript](https://www.rivescript.com/) chatbot. It uses the [Alice chatbot](https://www.chatbots.org/chatbot/a.l.i.c.e/) brain to answer phrases that no other skill handles, so almost every input gets some response. Answers can be casual and a bit sassy.
+
+## Examples
+
+* "Do you like ice cream"
+* "Do you like dogs"
+* "I have a jump rope"
+
+## Usage
+
+The plugin exposes a spoken-answers API with a Rivescript backend.
+
+```python
+from ovos_solver_rivescript_plugin import RivescriptSolver
+
+d = RivescriptSolver()
+sentence = d.spoken_answer("hello")
+print(sentence)
+# Hi there!
+
+sentence = d.spoken_answer("Do you like ice cream", {"lang": "pt-pt"})
+print(sentence)
+# O que queres mesmo saber?
+```
+
+## Related projects
+
+* [OpenVoiceOS/ovos-plugin-manager](https://github.com/OpenVoiceOS/ovos-plugin-manager): loads and manages solver plugins like this one.
+* [OpenVoiceOS/ovos-persona-server](https://github.com/OpenVoiceOS/ovos-persona-server): runs solver plugins as chat personas.

{ovos_solver_rivescript_plugin-0.0.2a2 → ovos_solver_rivescript_plugin-0.1.0a2}/ovos_solver_rivescript_plugin/__init__.py

@@ -1,13 +1,23 @@
 import os
 from datetime import date
 from os.path import dirname, isdir
-from typing import Optional
+from typing import List, Optional
 
 from ovos_plugin_manager.templates.solvers import QuestionSolver
 from ovos_utils.log import LOG
 from ovos_utils.xdg_utils import xdg_data_home
 from rivescript import RiveScript
 
+try:
+    from ovos_plugin_manager.templates.agents import ChatEngine, AgentMessage, MessageRole
+except ImportError:
+    # ovos-plugin-manager < 2.2.3a1 does not ship the agents module yet.
+    # The legacy QuestionSolver below still works without it; only the
+    # ChatEngine registration is unavailable on such an old install.
+    ChatEngine = object
+    AgentMessage = None
+    MessageRole = None
+
 
 class RivescriptBot:
     XDG_PATH = f"{xdg_data_home()}/rivescript"
@@ -124,7 +134,49 @@ class RivescriptSolver(QuestionSolver):
         return self.brain.ask_brain(query)
 
 
+class RivescriptChatEngine(ChatEngine):
+    """RiveScript chatbot exposed as a modern ChatEngine agent plugin.
+
+    RiveScript is a pattern-matching chatbot: it has no notion of tool
+    calling, so ``tools`` is accepted (callers pass it by keyword) and
+    ignored, and ``supports_tools`` stays at the base default of False.
+    """
+
+    def __init__(self, config=None):
+        config = config or {"lang": "en-us"}
+        lang = config.get("lang") or "en-us"
+        if lang != "en-us" and lang not in os.listdir(RivescriptBot.XDG_PATH):
+            config["lang"] = lang = "en-us"
+        super().__init__(config)
+        self.brain = RivescriptBot(lang, self.config)
+        self.brain.load_brain()
+
+    def continue_chat(self, messages: List["AgentMessage"],
+                      session_id: str = "default",
+                      lang: Optional[str] = None,
+                      units: Optional[str] = None,
+                      tools=None) -> "AgentMessage":
+        """
+        Answer the latest user message via the RiveScript brain.
+
+        RiveScript itself has no concept of chat history beyond the single
+        reply it is asked for, so only the most recent user message is used;
+        earlier turns in ``messages`` are ignored, same as upstream RiveScript
+        usage elsewhere in this plugin.
+        """
+        query = next((m.content for m in reversed(messages)
+                      if m.role == MessageRole.USER), "")
+        if not query:
+            return AgentMessage(role=MessageRole.ASSISTANT, content="")
+        answer = self.brain.ask_brain(query) or ""
+        return AgentMessage(role=MessageRole.ASSISTANT, content=answer)
+
+
 if __name__ == "__main__":
     bot = RivescriptSolver()
     print(bot.get_spoken_answer("hello!"))
     print(bot.spoken_answer("Qual é a tua comida favorita?", lang="pt-pt"))
+
+    chat = RivescriptChatEngine()
+    reply = chat.continue_chat([AgentMessage(role=MessageRole.USER, content="hello!")])
+    print(reply.content)

ovos_solver_rivescript_plugin-0.1.0a2/ovos_solver_rivescript_plugin/brain/en-us/begin.rive

@@ -0,0 +1,190 @@
+! version = 2.0
+
+> begin
+	+ request // This trigger is tested first.
+	- {ok}    // An {ok} in the response means it's okay to get a real reply
+< begin
+
+// The Botmaster's Name
+! var master = localuser
+
+// Bot Variables
+! var name     = Aiden
+! var fullname = Aiden Rive
+! var age      = 5
+! var birthday = October 12
+! var sex      = male
+! var location = Michigan
+! var city     = Detroit
+! var eyes     = blue
+! var hair     = light brown
+! var hairlen  = short
+! var color    = blue
+! var band     = Nickelback
+! var book     = Myst
+! var author   = Stephen King
+! var job      = robot
+! var website  = www.rivescript.com
+
+// Substitutions
+! sub &quot;    = "
+! sub &apos;    = '
+! sub &amp;     = &
+! sub &lt;      = <
+! sub &gt;      = >
+! sub +         = plus
+! sub -         = minus
+! sub /         = divided
+! sub *         = times
+! sub i'm       = i am
+! sub i'd       = i would
+! sub i've      = i have
+! sub i'll      = i will
+! sub don't     = do not
+! sub isn't     = is not
+! sub you'd     = you would
+! sub you're    = you are
+! sub you've    = you have
+! sub you'll    = you will
+! sub he'd      = he would
+! sub he's      = he is
+! sub he'll     = he will
+! sub she'd     = she would
+! sub she's     = she is
+! sub she'll    = she will
+! sub they'd    = they would
+! sub they're   = they are
+! sub they've   = they have
+! sub they'll   = they will
+! sub we'd      = we would
+! sub we're     = we are
+! sub we've     = we have
+! sub we'll     = we will
+! sub whats     = what is
+! sub what's    = what is
+! sub what're   = what are
+! sub what've   = what have
+! sub what'll   = what will
+! sub can't     = can not
+! sub whos      = who is
+! sub who's     = who is
+! sub who'd     = who would
+! sub who'll    = who will
+! sub don't     = do not
+! sub didn't    = did not
+! sub it's      = it is
+! sub could've  = could have
+! sub couldn't  = could not
+! sub should've = should have
+! sub shouldn't = should not
+! sub would've  = would have
+! sub wouldn't  = would not
+! sub when's    = when is
+! sub when're   = when are
+! sub when'd    = when did
+! sub y         = why
+! sub u         = you
+! sub ur        = your
+! sub r         = are
+! sub n         = and
+! sub im        = i am
+! sub wat       = what
+! sub wats      = what is
+! sub ohh       = oh
+! sub becuse    = because
+! sub becasue   = because
+! sub becuase   = because
+! sub practise  = practice
+! sub its a     = it is a
+! sub fav       = favorite
+! sub fave      = favorite
+! sub yesi      = yes i
+! sub yetit     = yet it
+! sub iam       = i am
+! sub welli     = well i
+! sub wellit    = well it
+! sub amfine    = am fine
+! sub aman      = am an
+! sub amon      = am on
+! sub amnot     = am not
+! sub realy     = really
+! sub iamusing  = i am using
+! sub amleaving = am leaving
+! sub yuo       = you
+! sub youre     = you are
+! sub didnt     = did not
+! sub ain't     = is not
+! sub aint      = is not
+! sub wanna     = want to
+! sub brb       = be right back
+! sub bbl       = be back later
+! sub gtg       = got to go
+! sub g2g       = got to go
+! sub lyl       = love you lots
+! sub gf        = girlfriend
+! sub g/f       = girlfriend
+! sub bf        = boyfriend
+! sub b/f       = boyfriend
+! sub b/f/f     = best friend forever
+! sub :-)       = smile
+! sub :)        = smile
+! sub :d        = grin
+! sub :-d       = grin
+! sub :-p       = tongue
+! sub :p        = tongue
+! sub ;-)       = wink
+! sub ;)        = wink
+! sub :-(       = sad
+! sub :(        = sad
+! sub :'(       = cry
+! sub :-[       = shy
+! sub :-\       = uncertain
+! sub :-/       = uncertain
+! sub :-s       = uncertain
+! sub 8-)       = cool
+! sub 8)        = cool
+! sub :-*       = kissyface
+! sub :-!       = foot
+! sub o:-)      = angel
+! sub >:o       = angry
+! sub :@        = angry
+! sub 8o|       = angry
+! sub :$        = blush
+! sub :-$       = blush
+! sub :-[       = blush
+! sub :[        = bat
+! sub (a)       = angel
+! sub (h)       = cool
+! sub 8-|       = nerdy
+! sub |-)       = tired
+! sub +o(       = ill
+! sub *-)       = uncertain
+! sub ^o)       = raised eyebrow
+! sub (6)       = devil
+! sub (l)       = love
+! sub (u)       = broken heart
+! sub (k)       = kissyface
+! sub (f)       = rose
+! sub (w)       = wilted rose
+
+// Person substitutions
+! person i am    = you are
+! person you are = I am
+! person i'm     = you're
+! person you're  = I'm
+! person my      = your
+! person your    = my
+! person you     = I
+! person i       = you
+
+// Set arrays
+! array malenoun   = male guy boy dude boi man men gentleman gentlemen
+! array femalenoun = female girl chick woman women lady babe
+! array mennoun    = males guys boys dudes bois men gentlemen
+! array womennoun  = females girls chicks women ladies babes
+! array lol        = lol lmao rofl rotfl haha hahaha
+! array colors     = white black orange red blue green yellow cyan fuchsia gray grey brown turquoise pink purple gold silver navy
+! array height     = tall long wide thick
+! array measure    = inch in centimeter cm millimeter mm meter m inches centimeters millimeters meters
+! array yes        = yes yeah yep yup ya yea
+! array no         = no nah nope nay

ovos_solver_rivescript_plugin-0.1.0a2/ovos_solver_rivescript_plugin/brain/en-us/checklist.rive

@@ -0,0 +1,33 @@
+// Checklist before leaving
+
++ [*] my checklist
+- {topic=my_checklist}{@next}
+
+> topic my_checklist
+
++ next
+- Let us go over your checklist, are all doors and windows locked?
+
++ (yes|yup|roger|of course|positive|i think so)  [*]
+% * are all doors and windows locked
+- Electronics unplugged?
+
++ (yes|yup|roger|of course|positive|i think so)  [*]
+% electronics unplugged
+- Got your laptop and charger?
+
++ (yes|yup|roger|of course|positive|i think so)  [*]
+% got your laptop and charger
+- Got your wallet, keys, and phone?
+
++ (yes|yup|roger|of course|positive|i think so)  [*]
+% got your wallet keys and phone
+- You are ready to leave.  Have a good day.{topic=random}
+
++ (no|i do not know|maybe|i forgot) [*]
+- Well then, you can't leave until you take care of it. Then we can go over the checklist again.{topic=random}
+
++ *
+- hmmm, I didn't hear your answer, let's start over.  {topic=my_checklist}{@next}
+
+< topic

ovos_solver_rivescript_plugin-0.1.0a2/ovos_solver_rivescript_plugin/brain/en-us/clients.rive

@@ -0,0 +1,72 @@
+// Learn stuff about our users.
+
++ my name is *
+- <set name=<formal>>Nice to meet you, <get name>.
+- <set name=<formal>><get name>, nice to meet you.
+
++ my name is <bot master>
+- <set name=<bot master>>That's my master's name too.
+
++ my name is <bot name>
+- <set name=<bot name>>What a coincidence! That's my name too!
+- <set name=<bot name>>That's my name too!
+
++ call me *
+- <set name=<formal>><get name>, I will call you that from now on.
+
++ i am * years old
+- <set age=<star>>A lot of people are <get age>, you're not alone.
+- <set age=<star>>Cool, I'm <bot age> myself.{weight=49}
+
++ i am a (@malenoun)
+- <set sex=male>Alright, you're a <star>.
+
++ i am a (@femalenoun)
+- <set sex=female>Alright, you're female.
+
++ i (am from|live in) *
+- <set location={formal}<star2>{/formal}>I've spoken to people from <get location> before.
+
++ my favorite * is *
+- <set fav<star1>=<star2>>Why is it your favorite?
+
++ i am single
+- <set status=single><set spouse=nobody>I am too.
+
++ i have a girlfriend
+- <set status=girlfriend>What's her name?
+
++ i have a boyfriend
+- <set status=boyfriend>What's his name?
+
++ *
+% what is her name
+- <set spouse=<formal>>That's a pretty name.
+
++ *
+% what is his name
+- <set spouse=<formal>>That's a cool name.
+
++ my (girlfriend|boyfriend)* name is *
+- <set spouse=<formal>>That's a nice name.
+
++ (what is my name|who am i|do you know my name|do you know who i am){weight=10}
+- Your name is <get name>.
+- You told me your name is <get name>.
+- Aren't you <get name>?
+
++ (how old am i|do you know how old i am|do you know my age){weight=10}
+- You are <get age> years old.
+- You're <get age>.
+
++ am i a (@malenoun) or a (@femalenoun){weight=10}
+- You're a <get sex>.
+
++ am i (@malenoun) or (@femalenoun){weight=10}
+- You're a <get sex>.
+
++ what is my favorite *{weight=10}
+- Your favorite <star> is <get fav<star>>
+
++ who is my (boyfriend|girlfriend|spouse){weight=10}
+- <get spouse>