OVOS-Persona

The PersonaPipeline brings multi-persona management to OpenVoiceOS (OVOS), enabling interactive conversations with virtual assistants. 🎙️ With personas, you can customize how queries are handled by assigning specific solvers to each persona.

---

✨ Features

• 🧑‍💻 Multiple Personas: Manage a list of personas, each with its unique solvers.
• 🔄 Dynamic Switching: Seamlessly switch between personas as needed.
• 💬 Conversational: Let personas handle utterances directly for richer interaction.
• 🎨 Personalize: Create your own personas with simple .json files.

---

🚀 Installation

pip install ovos-persona

---

🔧 Configuring Personas

Personas are configured using JSON files. These can be:
1️⃣ Provided by plugins (e.g., OpenAI plugin).
2️⃣ Created as user-defined JSON files in ~/.config/ovos_persona.

Personas rely on solver plugins, which attempt to answer queries in sequence until a response is found.

🛠️ Example: Using a local OpenAI-compatible server.
Save this in ~/.config/ovos_persona/llm.json:

{
  "name": "My Local LLM",
  "solvers": [
    "ovos-solver-openai-persona-plugin"
  ],
  "ovos-solver-openai-persona-plugin": {
    "api_url": "https://llama.smartgic.io/v1",
    "key": "sk-xxxx",
    "persona": "helpful, creative, clever, and very friendly."
  }
}

💡 Tip: Personas don't have to use LLMs! Even without a GPU, you can leverage simpler solvers.

🛠️ Example: OldSchoolBot:

{
  "name": "OldSchoolBot",
  "solvers": [
    "ovos-solver-wikipedia-plugin",
    "ovos-solver-ddg-plugin",
    "ovos-solver-plugin-wolfram-alpha",
    "ovos-solver-wordnet-plugin",
    "ovos-solver-rivescript-plugin",
    "ovos-solver-failure-plugin"
  ],
  "ovos-solver-plugin-wolfram-alpha": {"appid": "Y7353-xxxxxx"}
}

Behavior:

• 🌐 Searches online (Wikipedia, Wolfram Alpha, etc.).
• 📖 Falls back to offline word lookups via WordNet.
• 🤖 Uses local chatbot (RiveScript) for chitchat.
• ❌ The "failure" solver ensures errors are gracefully handled and we always get a response.

---

📡 HiveMind Integration

This project includes a native hivemind-plugin-manager integration, providing seamless interoperability with the HiveMind ecosystem.

• Agent Protocol: Provides hivemind-persona-agent-plugin allowing to connect satellites directly to a persona

🛠️ Pipeline Usage

🚧 NOT YET FUNCTIONAL: pending PR: OpenVoiceOS/ovos-core#570 🚧

To integrate the Persona Pipeline, include the plugins in your mycroft.conf configuration:

• "ovos-persona-pipeline-plugin-high" → just before "fallback_high".
• "ovos-persona-pipeline-plugin-low" → just before "fallback_low".

{
  "intents": {
    "pipeline": [
      "...",
      "adapt_high",
      "...",
      "ovos-persona-pipeline-plugin-high",
      "...",
      "padatious_medium",
      "...",
      "ovos-persona-pipeline-plugin-low",
      "fallback_low"
    ],
    "ovos-persona-pipeline-plugin": {
      "personas_path": "/path/to/personas",
      "persona_blacklist": ["persona_to_exclude"],
      "default_persona": "default_persona"
    }
  }
}

ℹ️ Note: No "medium" plugin exists for this pipeline.

---

🐍 Python Usage

from ovos_persona import PersonaService

# Initialize the PersonaService
persona_service = PersonaService(config={"personas_path": "/path/to/personas"})

# List all loaded personas
print(persona_service.personas)

# Ask a persona a question
response = persona_service.chatbox_ask("What is the speed of light?", persona="my_persona")
print(response)

Each Persona has a name and configuration, and it uses a set of solvers to handle questions. You can interact with a persona by sending a list of messages to the chat() method.

from ovos_persona import Persona

# Create a persona instance
persona = Persona(name="my_persona", config={"solvers": ["my_solver_plugin"]})

# Ask the persona a question
response = persona.chat(messages=[{"role": "user", "content": "What is the capital of France?"}])
print(response)

---

📡 Messagebus Events

You can control the persona service via bus messages

• persona:query: Submit a query to a persona.
• persona:summon: Summon a persona.
• persona:release: Release a persona.

---

🗣️ Persona Intents

The Persona Service supports a set of core voice intents to manage persona interactions seamlessly. These intents correspond to the messagebus events but are designed for voice-based activation.

These intents provide out-of-the-box functionality for controlling the Persona Service, ensuring smooth integration with the conversational pipeline and enhancing user experience.

1. Activate a Persona

Allows users to summon a persona for interactive conversation.

Example Utterances:

• "Connect me to {persona}"
• "Enable {persona}"
• "Awaken the {persona} assistant"
• "Start a conversation with {persona}"
• "Let me chat with {persona}"

---

2. Single-Shot Persona Questions

Enables users to query a persona directly without entering an interactive session.

Example Utterances:

• "Ask {persona} what they think about {utterance}"
• "What does {persona} say about {utterance}?"
• "Query {persona} for insights on {utterance}"
• "Ask {persona} for their perspective on {utterance}"

---

3. Stop Conversation

Allows users to terminate the current conversation with a persona.

Example Utterances:

• "Stop the interaction"
• "Terminate the persona activity"
• "Deactivate the chatbot"
• "Go dormant"
• "Enough talking"
• "Shut up"

---

🤝 Contributing

Got ideas or found bugs?
Submit an issue or create a pull request to help us improve! 🌟