This release is a pre-release and may not be stable for production use.
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-v2model. 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.
Related projects
- OpenVoiceOS/ovos-core — the assistant this plugin ships with
- OpenVoiceOS/ovos-plugin-manager — loads this plugin as an
opm.pipelineentry point - OpenVoiceOS/ovos-flashrank-reranker-plugin — example reranker plugin
License
Apache-2.0
1 maintainer
Metadata
1 maintainer
Release files for ovos-common-query-pipeline-plugin 1.1.15a3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ovos_common_query_pipeline_plugin-1.1.15a3.tar.gz | 15.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ovos_common_query_pipeline_plugin-1.1.15a3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.5 kB
Release files / ovos_common_query_pipeline_plugin-1.1.15a3.tar.gz
| Download URL | ovos_common_query_pipeline_plugin-1.1.15a3.tar.gz |
|---|---|
| Size | 15.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d70ab2b1ec626d82f576a8fe033579d7a7f3e8745fdae4f22ea2ec70b06f88e5
|
|
BLAKE2b-256 checksum How to use checksums |
13653f0d6aebfa10d546663a5c559f2074b8f275fc0d6b80f003cab7d9f22d36
|
| Upload date | |
|
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.15a3-py3-none-any.whl
| Download URL | ovos_common_query_pipeline_plugin-1.1.15a3-py3-none-any.whl |
|---|---|
| Size | 23.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
375bfef277cec340d1fe981d4ba76e28b001fb92f9c6527faf179d0eb23d5892
|
|
BLAKE2b-256 checksum How to use checksums |
22528e99686b54b3c35b4019f4dd2c16db5a57a2c6c0789d09ddbe2751957b24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
