pyaiml21 1.0.0rc2

Simple interpreter for AIML 2.1

pyaiml21

AIML [^AIML] 2.1 Chatbot Design Language Interpreter in Python 3.

The AIML language is a (simple) XML-derived language for description of chatbots and the communication with the user based on the pattern-matching the user's query and evaluating (human-coded) response.

pyaiml21 is an AIML interpreter, supporting the latest AIML specification. It was created as a bachelor thesis and should be fully compatible with its predecessor, PyAiml [^pyaiml].

Installation

Install the project from PYPI:

$ python -m pip install pyaiml21

Quick Example

This example demonstrates how to quickly set-up and run a basic chatbot with publicly available source files from ALICE [^ALICE].

Running via console script

pyaiml21 comes with a simple script to run your chatbots, if you unpacked the contents of your bot into alice/ folder (so that the structure is alice/aiml/.., alice/aimlif/.., alice/sets/.. ..), then running the following will start your bot:

$ aiml --bot alice

Running from Python

It is still possible to start your bot directly from python[^example], e.g.

>>> from pyaiml21 import Bot
>>> my_bot = Bot()
>>> my_bot.learn_aiml("path to .aiml file")
>>> # more loading stuff, see `pyaiml21.utils` for helpers
>>> my_bot.respond("Hello", "USER_1")
Hi! How are you doing?

For examples of simple bots, checkout /examples folder.

Motivation

This project was created to support the AIML 2.1 in Python while preserving the simplicity of user interface from pyaiml. Note that for Python, there exists an AIML interpreter, program-y [^program-y], but it does come with the full chatbot platform, the simple interface is missing.

Documentation

Please visit the official documentation.

License

MIT.

---

[^ALICE]: alice source code

[^AIML]: Artificial Intelligence Markup Language (Dr. Wallace, 2001); see the official specification of version 2.1

[^example]: The actual response depends on your AIML file, to load .aimlif, substitutions.., see methods of pyaiml21.Bot

[^pyaiml]: original interpreter in python for AIML 1.0

[^program-y]: AIML Interpreter in Python3