Skip to main content
Pre-release

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

ovos-utterance-plugin-cancel

PyPI License

This is an OpenVoiceOS utterance transformer plugin. It cancels an utterance when the user says a cancel or "nevermind" phrase at the end.

Example: for the phrase "Hey Mycroft, can you tell me the weather in… ugh, nevermind that", the plugin drops the utterance, and no skill fires.

Installation

pip install ovos-utterance-plugin-cancel

How it works

The plugin runs before skill matching. It checks whether the end of the utterance matches any phrase from locale/<lang>/cancel.intent. On a match, it returns an empty utterance list with context {"canceled": True, "cancel_word": "<phrase>"}.

The plugin selects the language automatically with langcodes.closest_match. Phrases support bracket-expansion syntax, for example cancel (it|that).

Supported languages

ca-ES · da-DK · de-DE · en-US · es-ES · fr-FR · gl-ES · it-IT · nl-NL · pt-BR · pt-PT

To add a language, create ovos_utterance_plugin_cancel/locale/<lang>/cancel.intent with one phrase per line.

Configuration

This plugin is enabled by default in ovos-config alongside the other standard utterance transformers:

"utterance_transformers": {
    "ovos-utterance-normalizer": {},
    "ovos-utterance-plugin-cancel": {},
    "ovos-utterance-corrections-plugin": {}
}

To disable it, add "enable": false to your config:

"utterance_transformers": {
    "ovos-utterance-plugin-cancel": {"enable": false}
}

Development

git clone https://github.com/OpenVoiceOS/ovos-utterance-plugin-cancel
cd ovos-utterance-plugin-cancel
uv pip install -e ".[dev]"
uv run pytest test/ -v --cov=ovos_utterance_plugin_cancel

Related projects

Credits

Download files

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

Source Distribution

ovos_utterance_plugin_cancel-0.3.3a2.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file ovos_utterance_plugin_cancel-0.3.3a2.tar.gz.

File metadata

File hashes

Hashes for ovos_utterance_plugin_cancel-0.3.3a2.tar.gz
Algorithm Hash digest
SHA256 f0a69116c5c073f3bbf3c1787510a13e798c012b196ac54ed467094b954788b2
MD5 51185b43e5ceee4f21f9f737ab7f7dbd
BLAKE2b-256 394fede782ea4033d5f1e8ce46c26508474304f60e77f471a8caf4f47282b691

See more details on using hashes here.

File details

Details for the file ovos_utterance_plugin_cancel-0.3.3a2-py3-none-any.whl.

File metadata

File hashes

Hashes for ovos_utterance_plugin_cancel-0.3.3a2-py3-none-any.whl
Algorithm Hash digest
SHA256 3cd59d912dfbead6c56fc64e560d7698e6c381d48da5599cebc55081316df993
MD5 a58a8cf64ba536ffee3642fdb2a40000
BLAKE2b-256 1589a688d926e304b1fd8627b19308800f136f90f10866f92b93dcf4baf0dea0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page