OVOS Common Query Framework

The OVOS Common Query Framework answers questions. It gathers answers from several skills and picks the best one.

Common Query is only as fast as the slowest CommonQuerySkill. Latency depends on which skills you install.

Features

Utterance query type detection: If the user utterance does not resemble a question (for example, it has no "who", "what", or "when"), the system does not try to answer.
Skill availability check: If no common query skills are installed, the system does not try to respond. It issues queries only when a matching skill is available.
Answer selection: A reranker plugin can evaluate multiple skill responses and select the most relevant one.
Bad answer discarding: A reranker with a minimum score threshold (min_score) discards poor or irrelevant answers.
Timeout for late answers: The system stops waiting for answers after 2 seconds. It ignores any response that arrives after this time.

Install

This plugin ships with ovos-core by default. You do not need to install it explicitly.

pip install ovos-common-query-pipeline-plugin

Configuration

Reranker (optional)

Rerankers, also called MultipleChoiceSolvers, are optional. Install one explicitly to rank and select the most relevant response from multiple common query skills (for example, Wolfram Alpha or Wikipedia).

This example configures a reranker:

"intents": {
    "common_query": {
        "min_self_confidence": 0.5,
        "min_reranker_score": 0.5,
        "reranker": "ovos-flashrank-reranker-plugin",
        "ovos-flashrank-reranker-plugin": {
          "model": "ms-marco-TinyBERT-L-2-v2"
        }
    }
}

Notes:

A reranker plugin is optional. Install it explicitly for the framework to use it.
The example uses ovos-flashrank-reranker-plugin with the ms-marco-TinyBERT-L-2-v2 model. Other plugins and models work too, depending on your use case and performance needs.
Reranking may add latency on resource-constrained devices, such as a Raspberry Pi. Adjust the settings to match the device capabilities and the expected response time.

OpenVoiceOS/ovos-core — the assistant this plugin ships with
OpenVoiceOS/ovos-plugin-manager — loads this plugin as an opm.pipeline entry point
OpenVoiceOS/ovos-flashrank-reranker-plugin — example reranker plugin

License

Apache-2.0

Metadata

Release files for ovos-common-query-pipeline-plugin 1.1.19a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ovos-common-query-pipeline-plugin 1.1.19a1
File	Size	Uploaded
ovos_common_query_pipeline_plugin-1.1.19a1.tar.gz	19.7 kB	Sep 23, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-common-query-pipeline-plugin 1.1.19a1
File	Interpreter	ABI	Platform	Reset
ovos_common_query_pipeline_plugin-1.1.19a1-py3-none-any.whl 24.7 kB Sep 23, 2026	Python 3	none	any	Details

Total release size: 44.5 kB

Release files / ovos_common_query_pipeline_plugin-1.1.19a1.tar.gz

Download URL	ovos_common_query_pipeline_plugin-1.1.19a1.tar.gz
Size	19.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`f5e7c8486e3dfb31c798386d8f189c3fe5f798b2df424efc0ae173eccc8d0c69`
BLAKE2b-256 checksum How to use checksums	`212b61abb7fd33b1fffb90743f4888266531190880424f451f483b17e22cb0a3`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / ovos_common_query_pipeline_plugin-1.1.19a1-py3-none-any.whl

Download URL	ovos_common_query_pipeline_plugin-1.1.19a1-py3-none-any.whl
Size	24.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`aad0b56a8f55ed24db8d7c2e94310215e1946a0423efdc6b1357dd5e28c76567`
BLAKE2b-256 checksum How to use checksums	`d8257e48d8063f51b7c14a060d177f198df3223f42f94a290578d2489a9f600d`
Upload date	Sep 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`