This release is a pre-release and may not be stable for production use.
AIML Chatbot
An OVOS question solver plugin that answers with an AIML chatbot. It uses the Alice chatbot brain to hold open-ended conversation. It answers utterances that no other skill or solver handles, so most utterances get some response.
Examples
- "Do you like ice cream"
- "Do you like dogs"
- "I have a jump rope"
Install
pip install ovos-solver-aiml-plugin
Usage
from ovos_solver_aiml_plugin import AIMLChatEngine
from ovos_plugin_manager.templates.agents import AgentMessage, MessageRole
engine = AIMLChatEngine({"lang": "en-us"})
reply = engine.continue_chat([AgentMessage(role=MessageRole.USER, content="hello")])
print(reply.content)
# Hi there!
Language support
The bundled AIML brain is English. Brain files live under
ovos_solver_aiml_plugin/aiml_data/<lang>/ (bundled) or
~/.local/share/aiml/<lang>/ (user-supplied).
Opt-in query translation (enable_tx)
Set enable_tx: true in the plugin config to answer non-English queries. The plugin translates the user utterance into the brain language (English), answers it, then translates the answer back.
This is off by default, so a plain install needs no translate plugin and English deployments pay no extra cost.
{
"ovos-solver-aiml-plugin": {
"lang": "pt-pt",
"enable_tx": true,
"translate_plugin": "ovos-translate-plugin-server"
}
}
The plugin loads the translator lazily, on the first non-English turn. If the translator fails to load, or a translation fails, the plugin answers in the original text instead of raising an error.
Translator plugin note: translation agents tend to be instantiated repeatedly, so a local model-based translate plugin pays its full model-load cost each time. Use a remote translate service, such as ovos-translate-plugin-server.
Converter scripts
The bundled aiml_data/<lang>/*.aiml files are the brain. The helper scripts
in scripts/ are an optional convenience for authoring or inspecting content
in OVOS notation. They are not part of the runtime and not wired into CI:
brain_to_locale.py: exports the cleanly-mappable subset of an AIML or RiveScript brain to paired.intent/.dialogfiles ({query}slot for wildcards).locale_to_brain.py: the reverse. It regenerates a brain from such files.
The conversion is deliberately partial. Entries that rely on constructs with
no direct OVOS equivalent (<srai>, <condition>, <star>, topic state, and
so on) are skipped, and exports never emit residual <…> markup. See
docs/converters.md.
Related projects
- OpenVoiceOS/ovos-plugin-manager: loads this plugin through the
opm.agents.chatentry point. - OpenVoiceOS/ovos-translate-plugin-server: recommended remote translate plugin for
enable_tx.
Docker
This repo publishes ghcr.io/openvoiceos/ovos-solver-plugin-aiml, a
standalone ovos-persona-server that serves one persona, AimlBot, backed
by the AIMLChatEngine in this plugin. Matching runs entirely offline
against the bundled aiml_data, so the image needs no key and no network
access to answer.
docker run -p 8391:8337 ghcr.io/openvoiceos/ovos-solver-plugin-aiml:dev
curl http://localhost:8391/v1/models
curl http://localhost:8391/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{"model": "AimlBot", "messages": [{"role": "user", "content": "hello"}]}'
A compose snippet:
services:
ovos-aiml-persona:
image: ghcr.io/openvoiceos/ovos-solver-plugin-aiml:dev
ports:
- "8391:8337"
restart: unless-stopped
The image builds on every pull request touching Dockerfile,
.dockerignore, pyproject.toml, or the docker workflow itself (build only,
no push), and publishes on pushes to master (latest), dev (dev), and
version tags. See the docker workflow.
License
Metadata
Release files for ovos-solver-aiml-plugin 0.0.2a12
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 | Actions |
|---|---|---|---|---|
| ovos_solver_aiml_plugin-0.0.2a12.tar.gz | 1.0 MB | Without provenance | Details for ovos_solver_aiml_plugin-0.0.2a12.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ovos_solver_aiml_plugin-0.0.2a12-py3-none-any.whl | Python 3 | none | any | Details for ovos_solver_aiml_plugin-0.0.2a12-py3-none-any.whl |
Total release size: 2.1 MB
Release files / ovos_solver_aiml_plugin-0.0.2a12.tar.gz
| Download URL | ovos_solver_aiml_plugin-0.0.2a12.tar.gz |
|---|---|
| Size | 1.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2f341063dedb054695b190fbf7f03335d05f1da98c1bd2cc4fb5907da1a001c0
|
|
BLAKE2b-256 checksum How to use checksums |
98e99783fb75fbd4626915d415c92218787a0f6bc6ee533b3287d44b64a01cad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / ovos_solver_aiml_plugin-0.0.2a12-py3-none-any.whl
| Download URL | ovos_solver_aiml_plugin-0.0.2a12-py3-none-any.whl |
|---|---|
| Size | 1.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f300d5fcbbd568ca4b4f818be7eabed34b8f8303331ae6a48d8d1c84fd404f14
|
|
BLAKE2b-256 checksum How to use checksums |
5ac96adb05b06d6e37c31be8e46868bd84f19bf91c746a513b72b080fccd021e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for ovos-solver-aiml-plugin 0.0.2a12
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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.