Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

OVOS-Persona

PersonaPipeline adds multi-persona management to OpenVoiceOS (OVOS). Personas are configurable virtual assistants: each one assigns its own set of solver plugins to answer queries, so you can customize how OVOS handles a conversation.

See docs/index.md for the architecture and API reference.


Quick Start

  1. Update the core and install the plugin:
    pip install -U ovos-core>=0.5.1 ovos-persona
    
  2. Install or update the plugins and skills a persona needs:
    pip install -U skill-wolfie ovos-skill-wikipedia ovos-skill-wikihow skill-wordnet ovos-openai-plugin
    
  3. Uninstall the ChatGPT fallback skill, since ovos-persona replaces it:
    pip uninstall skill-ovos-fallback-chatgpt
    
  4. Edit mycroft.conf. The "..." below is a placeholder for your existing pipeline entries, not literal text.
    {
      "intents": {
          "persona": {
            "handle_fallback":  true,
            "default_persona": "Remote Llama",
            "short-term-memory": true
          },
          "pipeline": [
              "stop_high",
              "converse",
              "ocp_high",
              "padatious_high",
              "adapt_high",
              "ovos-persona-pipeline-plugin-high",
              "ocp_medium",
              "...",
              "fallback_medium",
              "ovos-persona-pipeline-plugin-low",
              "fallback_low"
        ]
      }
    }
    
  5. Restart OVOS.
  6. Check the logs to confirm the persona loaded without errors:
    cat ~/.local/state/mycroft/skills.log | grep persona
    
  7. Read the Persona Intents section for the voice commands.

Features

  • Multiple personas: manage a list of personas, each with its own solver plugins.
  • Dynamic switching: activate a different persona at any time.
  • Per-session state: the active persona and conversation memory are tracked per session, so concurrent conversations stay isolated.
  • Short-term memory: a default short-term memory ships with ovos-persona and is always available. Swap it for any opm.agents.memory plugin through the memory_module config key. See docs/memory.md.
  • Conversational: personas can handle utterances directly, without a matching skill.
  • Personalize: create a persona with a simple .json file. See docs/defining-personas.md.

Installation

pip install ovos-persona

Persona Intents

The persona service supports voice intents for managing persona interactions: listing personas, checking the active persona, activating a persona, asking a persona a single question, and stopping the conversation. Each intent corresponds to a messagebus event.

See the OVOS technical manual: Persona Pipeline for the full list of example utterances and bus events.


Pipeline Configuration

Where you place "ovos-persona-pipeline-plugin-high" in the pipeline decides whether the active persona gets full control of an utterance, or only handles it after high-confidence skills fail to match. "ovos-persona-pipeline-plugin-low" handles utterances as a fallback even when no persona is explicitly active, replacing OpenVoiceOS/ovos-skill-fallback-chatgpt.

See the OVOS technical manual: Persona Pipeline for the pipeline configuration strategies and example mycroft.conf snippets.


Creating a Persona

Personas are configured with JSON files. A persona can come from:

  1. a plugin (for example, the OpenVoiceOS/ovos-openai-plugin), or
  2. a user-defined JSON file in ~/.config/ovos_persona.

Personas rely on solver plugins, which try to answer a query in sequence until one succeeds.

Example: a persona using a local OpenAI-compatible server. Save this as ~/.config/ovos_persona/llm.json:

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

A persona does not need an LLM. Simpler solvers work too, even without a GPU.

Example: OldSchoolBot, a persona built from non-LLM solvers.

{
  "name": "OldSchoolBot",
  "handlers": [
    "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 sources such as Wikipedia and Wolfram Alpha.
  • Falls back to offline word lookups through WordNet.
  • Uses a local chatbot (RiveScript) for chitchat.
  • The "failure" solver catches errors so the persona always returns a response.

HiveMind Integration

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


Related Projects


Contributing

Found a bug or have an idea? Open an issue or submit a pull request.


Credits

Developed by TigreGótico for OpenVoiceOS.

NGI0 Commons Fund

This project was funded through the NGI0 Commons Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101135429.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovos_persona-0.9.0a21.tar.gz (95.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ovos_persona-0.9.0a21-py3-none-any.whl (144.5 kB view details)

Uploaded Python 3

File details

Details for the file ovos_persona-0.9.0a21.tar.gz.

File metadata

  • Download URL: ovos_persona-0.9.0a21.tar.gz
  • Upload date:
  • Size: 95.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ovos_persona-0.9.0a21.tar.gz
Algorithm Hash digest
SHA256 ef325a6ad02c0b7ce146ba6ab92aaa9543134b2aa014c25537a4b438207560f0
MD5 1e978dfced394f0c188bfdd666f73960
BLAKE2b-256 4d4fa591fc4e4ed45e98e303cd946998e6c06f7384e30db37816274ef57ae447

See more details on using hashes here.

File details

Details for the file ovos_persona-0.9.0a21-py3-none-any.whl.

File metadata

File hashes

Hashes for ovos_persona-0.9.0a21-py3-none-any.whl
Algorithm Hash digest
SHA256 ae80de5e0136ad50b7234319f9e783dbcad7d038a667a7d8201dec397e02007a
MD5 05c7661cf4d00a1f5f36ac146c294b2b
BLAKE2b-256 372d8f84f016d087d8a4e5df612caf4fd29c04fc08f91052a149e53340727059

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.9.0a21 This release

2 files

0.7.1

2 files

0.6.24

2 files

0.6.23

2 files

0.6.22

2 files

0.6.18

2 files

0.6.16

2 files

0.6.14

2 files

0.6.13

2 files

0.6.11

2 files

0.6.9

2 files

0.6.7

2 files

0.6.6

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.5.0

2 files

0.4.4

2 files

0.4.3

2 files

0.4.1

2 files

0.4.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page