This release is a pre-release and may not be stable for production use.
Adapt Intent Parser
Adapt is a keyword and rule based intent parser. It reads an utterance and matches it to a registered intent, then extracts the entity values the intent needs. This repository provides an OVOS pipeline plugin and bundles a maintained fork of the original MycroftAI/adapt parser, from the now-defunct MycroftAI.
Three OPM pipeline entry points are exposed:
ovos-adapt-pipeline-plugin(AdaptPipeline), the flat pipeline. It wraps a singleIntentDeterminationEngineand all skills share one trie.ovos-adapt-domain-pipeline-plugin(DomainAdaptPipeline), a per-skill pipeline. It wrapsDomainIntentDeterminationEngine. Eachskill_idgets its own sub-engine ("domain"). At match time every domain is scored in parallel and the global argmax wins. Configure it underintents.ovos_adapt_domain_pipeline.ovos-adapt-hierarchical-pipeline-plugin(HierarchicalAdaptPipeline), the same per-skill domain model, with two-stage routing. A stage-1 classifier picks one domain, then only that domain's sub-engine is scored. Configure it underintents.ovos_adapt_hierarchical_pipeline.
See Pipeline variants for when to use each.
Install
pip install ovos-adapt-parser
Usage
The adapt parser also works standalone, with no OVOS and no messagebus:
from ovos_adapt.intent import IntentBuilder
from ovos_adapt.engine import IntentDeterminationEngine
engine = IntentDeterminationEngine()
# register vocabulary: surface forms grouped by entity type
for word in ["weather", "forecast"]:
engine.register_entity(word, "WeatherKeyword")
for city in ["Seattle", "San Francisco", "Tokyo"]:
engine.register_entity(city, "Location")
# build an intent over those entity types
weather = IntentBuilder("WeatherIntent") \
.require("WeatherKeyword") \
.require("Location") \
.build()
engine.register_intent_parser(weather)
# match
for intent in engine.determine_intent("what is the forecast in Tokyo"):
if intent.get("confidence", 0) > 0:
print(intent)
In a full OVOS install the plugin runs as a pipeline stage instead. Skills
register vocabulary and intents over the messagebus, and the plugin matches
incoming utterances automatically. More runnable examples ship in the
examples/ folder.
Documentation
A full guide, from first concepts to internals, lives in docs/:
- Concepts, entities, intents, cliques, and confidence
- Quickstart, install, enable, match your first utterance
- Writing intents, the
IntentBuilderAPI with examples - Configuration, confidence tiers and every config key
- Pipeline variants, the flat, domain, and hierarchical plugins
- Bus protocol, the messagebus API skills register over
- Internals, tagging, clique expansion, and the confidence math
- Engine comparison reference, how the variants diverge
Related projects
- OpenVoiceOS/ovos-plugin-manager, discovers and loads this plugin by its OPM entry point.
- OpenVoiceOS/ovos-padatious-pipeline-plugin, a model-based intent matcher that runs alongside Adapt in the same pipeline.
- OpenVoiceOS/ovos-workshop, the skill framework that registers vocabulary and intents with this plugin.
- MycroftAI/adapt, the original parser this plugin's engine is forked from.
Reporting issues
Adapt is difficult to debug without full context. Include a serialized copy of the intent determination engine, using the debug dump utilities:
from ovos_adapt.engine import IntentDeterminationEngine
engine = IntentDeterminationEngine()
# load engine with vocabulary and parsers
import ovos_adapt.tools.debug as atd
atd.dump(engine, 'debug.ovos_adapt')
License
Apache License 2.0. See LICENSE.md.
1 maintainer
Metadata
1 maintainer
Release files for ovos-adapt-parser 1.6.8a1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ovos_adapt_parser-1.6.8a1.tar.gz | 71.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ovos_adapt_parser-1.6.8a1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 120.3 kB
Release files / ovos_adapt_parser-1.6.8a1.tar.gz
| Download URL | ovos_adapt_parser-1.6.8a1.tar.gz |
|---|---|
| Size | 71.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d6ab6d9066e97e5725db90cea3e30473fc52146a790ff075628d3ae73a90076a
|
|
BLAKE2b-256 checksum How to use checksums |
088776775c9e079f4635c283cab5249e4191b859c5187867a6c4832209f91a7c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / ovos_adapt_parser-1.6.8a1-py3-none-any.whl
| Download URL | ovos_adapt_parser-1.6.8a1-py3-none-any.whl |
|---|---|
| Size | 49.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a08b3940e3486cbdb9896e6992203308ba76131cec3ac131b8eec8c94eb20247
|
|
BLAKE2b-256 checksum How to use checksums |
3827dc3ab037a7f6d1986f980627306ffdb965f40ea31962af173753c9933fc3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for ovos-adapt-parser 1.6.8a1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
