Building Bots on the Pandorabots Platform
A tutorial for writing bots using the AIML 2.0 scripting language and the Pandorabots User Interface
Bot Development consists of a relationship between the following three entities:
chatbot(n.) or bot(n.) - a computer program designed to simulate conversation with a human end-user via voice or textual inputs
botmaster(n.) - a person who creates, develops, and maintains the code and content that make up a chatbot
client(n.) - a person chatting with a bot
The Pandorabots Platform is a feature-rich user interface designed to help you, the botmaster, create AIML-based chatbots.
- AIML(n.) - Artificial Intelligence Markup Language: the simple open standard language in which Pandorabots are written
Experienced AIML writers may choose to use their favorite text editor instead of this UI, but many find the features in this UI indispensable for bot creation, deployment, and maintenance.
The Pandorabots platform supports OAuth (single sign-on) via Google, Facebook, Twitter, Yahoo, and Github. You may also create an account using an email address and password. Upon initial log in, you will be assigned a username (taking the form of "unXXXXXXXX") and prompted to create your first bot. Bot names must be 3-64 characters in length and lowercase alphanumeric. Together, your username and botname form a unique identifier for your bot, also known as your "botid."
To create a new bot, use the "+" button next to My Bots on the left navigation panel. Note that AIML can be written in almost any natural language, and you can select the language for your bot from a drop-down upon creation. (For Asian and other languages that require segmentation, Pandorabots offers a machine learning-based segmenter as a service; email us to learn more).
Content Libraries (opensource AIML files) may be available depending on the language selected. For example, adding the "Small Talk" Library (also previously known as "Rosie") to your bot will enable basic chitchat right out of the gate. Adding Content Libraries can save you the hassle of reinventing the wheel by writing AIML categories to handle common things people say in conversation. However, you can always select "Blank Bot" if you prefer to build from scratch.
If you have written a library and would like to open source it and see it featured for other developers, contact us!
Clicking on My Bots on the left navigation panel will display some key global statistics for all of your bots for the past 30 days. These include total Interactions, Clients, Sessions, and the average number of Interactions/Session. In the broader ecosystem, "Interactions/Session" is also sometimes known as Turns per Conversation ("TPC"), and is a stat botmasters measure and reference to highlight client engagement with their chatbot.
Clicking on the name of each individual bot will display the same individual statistics for that specific bot.
Platform users who require more in-depth analytics can plug in additional third-party analytics engines of their choosing.
Selecting the name of an individual bot on the left navigation panel will open a drop-down menu consisting of several components, including: Edit, Deploy, Logs, and Delete. The Editor is your gateway to creating and maintaining your bot files.
From the Files tab drop-down you can accomplish the following:
- Create new files, including AIML files (the primary type of bot files), Sets, Maps, Substitutions, and Pdefaults
- Save Files
- Download a Zip File of your bot (which we recommend doing frequently as a backup!)
- Upload bot files (if, for example, you have been working from your local editor or have AIML files from another platform)
Access and open your files from the menu on the left. Selecting a file will open it in the text editor, which is an ACE editor optimized for XML editing (since AIML is an XML-based language). Formatting AIML with the incorrect syntax (for example, forgetting a character in an opening/closing tag) will cause an error alert to appear in the form of a red X next to problematic line of code, which will include an additional description of the error type on hover.
Beneath the text editor, you can find a status bar full of helpful information such as whether and when the file was last saved/modified, and the file load order.
Staging versus Production
A common best practice in computer programming is to have two versions of software when one of those versions is live for the public: a Production version that is live, and a Staging version that is in development where you can test (and back out of!) any changes. This way, if something goes wrong in the staging version of the software you are editing, your changes do not impact the production version and disrupt end-users. One great feature of bots is that you can instantly update them after making changes, but it is important to first verify that none of your changes are breaking changes by testing thoroughly.
So, if you have a bot deployed on the platform that is live for the public, any changes you make to your bot using the Editor will only impact the staging or Sandbox version of your bot. Once you have tested your bot, clicking Publish in the upper-right hand corner of the editor will push your changes live to production.
Bot Training via the Chat Widget
In the lower right hand corner of the interface, you may have noticed a circular chat icon. Clicking on this icon will allow you to chat with your bot as if you were the client from almost everywhere in the interface. This Chat Widget has several useful features that are vital for debugging and improving your bot.
Edit Icon -
Clicking the edit icon within the bot output chat bubble allows you to quickly specify a new bot response for a given input and save it to a specified aiml file.
Advanced Alter -
Clicking the drop down next to "New Response" when the Alter Response modal is open will allow you to also define
topicvalues for your new pattern-template pair.
Show Metadata -
Clicking Show Metadata beneath the bot response bubble will display some important information about the interaction, including the Pattern that matched, the values (if any) for
topic, and a link to the file containing the pattern that was matched, which you can click on to go edit directly.
Show Trace -
Beneath the displayed Metadata, you will also find an option to run a Trace. This will open a modal showing the series of steps the input underwent during processing to find a match, which is incredibly helpful for debugging.
Reset Bot Memory -
At the top of the Chat Widget next to your bot name, a refresh icon allows you to reset your bot's memory, which will clear any predicate values that have been set (###@TC ??) and allow you to start the conversation anew as if you were a brand new client.
Bot Log Review
Reviewing chat logs and updating your bot frequently is a critical aspect of bot development. You can review logs by clicking "Logs" beneath your bot name. Chat logs are displayed dating back 30 days and available for download.
Unread conversations appear in bold. Orange conversations contain at least one input that triggered the UDC. Orange highlighted input-output pairs that triggered the UDC are the highest priority log items to correct.
Clicking Show Metadata will reveal the same information about the interaction as doing so within the Chat Widget. You can also edit responses from here or by opening the linked file in the editor.
When you are ready to start collecting logs from actual clients, you can publish your bot via the Deploy page.
The Deploy Page, accessible via the Deploy link under each individual bot name displayed on the left nav, lists a variety of Integrations. Integrations provide an easy method for deploying your bot to popular third party platforms and channels like Facebook Messenger and the Web. Supported Integrations are determined by a variety of factors including, but not limited to, technical feasibility, ecosystem demand, and platform partner relationships. If you wish to see support added for a channel that is not currently available, please email us at email@example.com and we'd be happy to consider your request.
Pandorabots also provides a RESTful API, meaning developer users can integrate their chatbot into any application. Please refer to the API REFERENCE section for a list of API Endpoints, SDKs, and more. You may locate your Application ID ("App ID"), which is the same as your username, and your User Key, by clicking on the "API Keys" button next to the "Custom Application" integration.
Note: A number of features on the Deployment Page require entry of a valid credit card to access. Your card will only be billed for usage that isn't covered by the Free Tier, which provides for unlimited Sandbox usage and up to 1,000 interactions / month.
The Deploy Page provides an option to publish your bot to The Clubhouse, which will make your bot available to chat with other platform users. In the Clubhouse, accessible via the left nav, you can also chat with other bots whose botmasters have chosen to make their works-in-progress visible. This is a great way to collect chatlogs from other platform users to leverage for improving your bot prior to making it public, and to pay back the favor by chatting with their bots as well.
Basic AIML Training
Corrects some spelling errors and colloquialisms (e.g. "wanna" -->"want to")
Substitutes words for common emoticons (e.g. ":-)" -->"SMILE")
Expands contractions (e.g. "isn't" -->"is not")
Removes intra-sentence punctuation (e.g. "Dr. Wallace lives on St. John St. -->"Dr Wallace lives on St John St.")
We refer to the above substitution steps as Normalization.
These substitutions are contained in a substitution file called normal.substitution.
Normalization also splits sentences based on predefined punctuation characters ".", "!", and "?". It also removes these punctuation marks once the sentences have been split, leaving the inputs punctuation-free.
The bot responds to each sentence individually and forms a result by combining the responses together.
You can customize which punctuation marks determine the end of a sentence by modifying the value of the "sentence-splitting" property in your bot's properties file.
The AIML File
Create a new AIML files under the Files drop-down within the Editor. When selecting your new files, you'll notice that the Editor comes pre-populated with some code:
<?xml version="1.0" encoding="UTF-8"?> <aiml version="2.0"> <!-- insert your AIML categories here --> </aiml>
AIML is an extension of a standard called XML.
It is written using "tags" (code) and text, which should be familiar to anyone with HTML experience.
Some tags comes in pairs, with some context (text and/or other tags) appearing between, for example:
<template>Some string goes here</template>
Other tags are "self-closing" and do not require a partner or an inner string, for example:
<get name=“age” />
The AIML File
A category is the basic unit of knowledge in AIML.
A category always contains an input pattern and a response template. Categories are sometimes also described as rules, which you as the botmaster specify to describe how the chatbot should respond to client inputs.
Generally, the more categories you have, the more robust your chatbot will be.
Hello World Example
Let's take a closer look at the fundamental components of a category: the pattern and template.
<pattern> Matches what the user says.
<template> What the bot replies.
<category> <pattern>HI</pattern> <template>Hello world!</template> </category>
The above code would result in the following exchange between your bot and the client:
Bot: Hello world!
Explaining the "tags"
Delineates the beginning and end of a category, which is a unit of knowledge for your bot.
Defines a pattern that matches a certain input from the client.
Note: AIML matching is case insensitive, meaning it does not differentiate between capital and lowercase letters. So, if the client said either "hi" or "HI," the bot would still match this category. Using all caps to write the pattern is a convention adopted to make the code more readable.
Defines the bot's response to the matched pattern. Case does matter in the template! Your bots response will be returned to the client exactly as written between the template tags.
Marks the end of the category.
The bot will search through all of its categories to form a match with the user input.
IMPORTANT! Remember that the input pre-processor strips the input of all punctuation. Therefore, you must not include punctuation marks in your patterns!
<pattern>What is your name?</pattern>
<pattern>WHAT IS YOUR NAME</pattern>
HTML is also an extension of XML.
You can use HTML to markup your bot’s responses (templates) with the appropriate formatting.
You can also use HTML to include images and hyperlinks that lead to other websites. See this page for some HTML basics.
For example, the <br/> HTML tag allows you to insert line breaks in the text.
<category> <pattern>WHO ARE YOU</pattern> <template>I am a bot.<br/> I live in a computer. </template> </category>
Human: Who are you?
Bot: I am a bot.
I live in a computer.
The Ultimate Default Category (UDC)
What if the user input does not match any of the patterns you have defined?
The Ultimate Default Category (UDC) is used by the bot to provide an answer if no other suitable category can be matched. The * in this case will match anything undefined.
<category> <pattern>*</pattern> <template>I have no answer for that.</template> </category>
You can use the <random> tag to provide many different responses for the same input pattern. This is especially useful in the UDC because it can provide some variation to the default answer.
<category> <pattern>*</pattern> <template> <random> <li>What was that?</li> <li>I don’t understand</li> <li>Can you say that more clearly?</li> </random> </template> </category>
In the above example, each time a category is matched, the bot will pick one of the list elements (<li>) at random as it's response.
In the UDC, we used an asterisk (*) in the pattern to capture the user’s input. This symbol, in AIML, is known as a wildcard.
Wildcards are used to capture many inputs using only a single category.
* symbol is able to capture 1 or more words in the user input.
This pattern would match all of the following inputs:
- Hello there!
- Hello Daniel.
- Hello my good friend.
This pattern would NOT match the word "Hello" by itself, because there must be at least one word captured by the
* to form a match.
^ symbol is also a wildcard, however, it can capture 0 or more words.
This pattern would match all of the following inputs:
- Hello there!
- Hello Daniel.
- Hello my good friend.
What if both
HELLO * and
HELLO ^ exist? Which one will form a match?
Wildcards are ranked in order of priority, so that certain patterns will take precedence over others.
The ^ has a higher priority, so if the input is "Hello there", then
HELLO ^ would be matched first.
If a pattern forms an exact match with the input, the exact match category will take precedence over any containing the
* wildcards that it could potentially match.
So, if the input is "Hello there", and the pattern
HELLO THERE exists, it will match before the other wildcard patterns
HELLO ^ and
There are two other wildcards,
#. These wildcards take the highest priority when matching.
Even if the input forms an exact match with a pattern, the match can be overridden by a pattern containing one of these wildcards.
If the input is "Hello there", the pattern above will form a match even if
<pattern>HELLO THERE</pattern> has been defined.
_ wildcard is a "1 or more" wildcard, like
# wildcard is a "0 or more" wildcard, like
Wildcard Matching Priority
The graphic below shows the matching priority for all four wildcards, along with a pattern that contains an exact match:
HELLO # >
HELLO _ >
HELLO THERE >
HELLO ^ >
IMPORTANT! Be very careful when using
_, because they will override all other patterns you may wish to match!
Highest Priority Matching
Sometimes, there is an exact match that we would like to take highest priority, overriding the
# wildcards. we can use the
$ sign to signify that a pattern will be matched first given a particular word.
<pattern>$WHO IS MIKE</pattern> matches "Who is Mike?", and
<pattern>_ MIKE</pattern> matches all other inputs ending with "Mike".
$ is not a wildcard. It is a marker that says "for this particular word(s) - "WHO" in the example above - override the category that would have been otherwise matched.
Visualizing Matching Priority
All of the bot's AIML categories are loaded into a structure called the Graphmaster. The order in which patterns take matching priority can be visualized in the Graphmaster:
You can "echo" the words captured by the wildcard from within the template using the <star/> tag. For example:
<category> <pattern>MY NAME IS *</pattern> <template>Hello, <star/>.</template> </category>
Human: My name is Daniel.
Bot: Hello, Daniel.
You can have more than one wildcard per pattern. You can also echo multiple wildcards in your pattern by using
<star index="x"/>, where x corresponds to the index number (position in the sentence) of the wildcard:
<category> <pattern>MY NAME IS * AND I AM * YEARS OLD</pattern> <template>Hi <star/>. I am also <star index=“2”/> years old!</template> </category>
What are Variables?
In computer programming, a variable is a symbol whose value can be changed.
AIML has variables as well. These can be used to store information about your bot, user, or anything else you would like. There are three types of variables:
- Properties: global constants for the bot. These can only by changed by the botmaster.
- Predicates: global variables for the bot. These are usually set by the client during conversation when a template is activated.
- Local Variables: the same as predicates except their scope is limited to one category.
You can use a property to store your bot's age. Create a new property with the name "age" and the value "8". Then, insert this category:
<category> <pattern>HOW OLD ARE YOU</pattern> <template>I am <bot name=“age”/> years old.</template> </category>
Human: How old are you?
Bot: I am 8 years old.
Using a predicate variable, you can write a category that will store the name of the client. This category will store the client's name under a predicate called "name":
<category> <pattern>MY NAME IS *</pattern> <template>Nice to meet you, <set name=“name”><star/></set></template> </category>
Note how the user of the
* wildcard and
<star/> allows you to write a single category that will capture any name!
Once you have set a predicate, it can be recalled elsewhere in your AIML.
<category> <pattern>WHAT IS MY NAME</pattern> <template>Your name is <get name=“name”/>.</template> </category>
If you have set the predicate using the category in the previous example above, this will now recall the value of the predicate called "name".
In combination, the previous two examples would enable the following conversation:
Human: My name is Daniel.
Bot: Nice to meet you, Daniel.
Human: What is my name?
Bot: Your name is Daniel.
Local variables work almost exactly like predicates, but their scope is limited to a single category. These are different than predicates, which can be recalled at any time during the conversation. For example:
<category> <pattern>THE APPLE IS *</pattern> <template> <think><set var=“color”><star/></set></think> I like <get var= “color”> apples. </template> </category>
We will revisit local variables in more detail in the section on "Context."
Recursion and Reduction
What is Recursion?
In AIML, you can define a template that calls another category.
This has a wide range of uses:
- Simplifying an input using fewer words
- Linking many synonymous inputs to the same template
- Correcting spelling errors made by the client
- Replacing colloquial expression with proper English
- Removing unnecessary words from the input (Reduction)
About half of the categories in a bot use recursion in some way.
<srai> tag tells the bot to look for another category:
<category> <pattern>HELLO</pattern> <template><srai>HI</srai></template> </category>
If this category is matched (i.e., the input is "Hello"), the bot will recurse. Before returning some text, it will first look for a different category that matches HI.
The <srai> tag effectively translates the input that matches the categories below to "Hi", contained in the terminal category.
<category> <pattern>HELLO</pattern> <template><srai>HI</srai></template> </category> <category> <pattern>HI THERE</pattern> <template><srai>HI</srai></template> </category> <category> <pattern>HOWDY</pattern> <template><srai>HI</srai></template> </category> : <category> <pattern>HI</pattern> <template>Hi, how are you?</template> </category>
The pattern in the terminal category is also commonly known as the Intent, which is the canonical form of what the words being used fundamentally mean. In this case,
<srai> is the method for specifying that Hello, Hi There, and Howdy, all mean the same thing as "Hi" (which we humans generally intend as a Greeting). Much of the work in bot development involves capturing all the different way we humans say the same thing insofar as it relates to your domain, which is why it is so important to regularly review your chatlogs and continously improve your bot over time.
Common Misspellings & Colloquial Expressions
People are bad at spelling and typing, which may cause your bot to fail when trying to find a match. You can use <srai> to account for common spelling mistakes:
<category> <pattern>HOW R U</pattern> <template><srai>HOW ARE YOU</srai></template> </category>
You can also use
<srai> in conjunction with wildcards to define synonymous words or phrases:
<category> <pattern>_ DAD *</pattern> <template><srai><star/> FATHER <star index=“2”/></srai></template> </category>
Anytime the user input contains the word "dad", the bot will replace it with "father" and recuse using the same input.
Thesaurus.com lists 52 synonyms for the word “good”. To account for this, you would need 52 additional categories for every one that contains the word “good”.
If your bot has 100 patterns that contain the word “good”, that’s 5200 additional categories you would have to write. Using the synonyms technique, you can reduce that number to just 52.
NOTE: once a word has been defined as a synonym, you cannot use it in patterns. The leading underscore `` ensures that the bot translates the synonym before doing anything else._
We can also use
<srai> to remove unnecessary words from the input.
<category> <pattern>I SEE NOW THAT YOU ARE *</pattern> <template><srai>YOU ARE <star/></srai></template> </category>
Reductions make writing AIML and adding to your bot a far more enjoyable process. The more reductions you have, the better your bot will be at providing relevant matches.
Returning Text and Recursing
The previous examples of
<srai> have directly returned no text of their own. You template, however, can return both text and
<category> <pattern>HOWDY</pattern> <template> <srai>HELLO</srai> Are you a cowboy? </template> </category>
Sets and Maps
An AIML Set is a list of unique text strings. You can create a set using the File drop-down in the Editor.
A set called "colors" might contain the following:
Sets are used to dramatically reduce your bot's overall categories. Consider the following conversation:
Human: Is green a color?
Bot: Yes, green is a color.
Human: Is blue a color?
Bot: Yes, blue is a color.
Human: Is peanut butter a color?
Bot: No, peanut butter is not a color.
Imagine how many categories would be needed to cover every color in the spectrum!
Instead of giving each color its own category, we can create a set that contains a number of colors, and write a single category that checks to see if the user's input contained a color in the set.
This category will only be matched if the user's input does, in fact, contain one of the colors in the set. If the user's input does not contain one of the colors listed in the set, the category will not be matched.
How Sets Work
The set functions like a wildcard. It captures one or more words found in the user's input.
The name of the relevant set file is placed between the
<category> <pattern>IS <set>colors</set> A COLOR</pattern> <template>Yes, <star/> is a color.</template> </category>
If the input contained a string not found in the set, then that pattern would not form a match. To account for this possibility, we can provide a default answer using a
<category> <pattern>IS <set>colors</set> A COLOR</pattern> <template>Yes, <star/> is a color.</template> </category> <category> <pattern>IS * A COLOR</pattern> <template>No, <star/> is not a color.</template> </category>
The first category will match if the input contains a string found in the set.
The second category will match if the input contains a string NOT found in the set.
More on Sets
Sets take precedence over * and ^, but can be overridden by
#, and an exact word match.
The input captured by the
<set> tags can be echoed using the
<star/> tag, just like a wildcard can be echoed.
<category> <pattern>IS <set>colors</set> A COLOR</pattern> <template>Yes, <star/> is my favorite color!</template> </category>
Set files are a simple string array and are written in the following format:
[[ "Austin" ], ["Baltimore"], [ "Chicago" ], [ "Dallas"]]
A map is a list of key-value pairs used to form associations between words. You can create a map using the Files drop-down in the editor.
A map called "statecapitals" might look like this:
- California: Sacramento
- New York: Albany
- Texas: Austin
Maps are accessed from within the template. They are used in conjunction with a set that contains a list of its keys (the words on the left of the colon above). For example, a set that corresponds to the "statecapitals" map would be called "states":
- New York
Maps: Test Case
Consider the following conversation:
Human: What is the capital of California?
Bot: Sacramento is the capital of California.
Human: What is the capital of New York?
Bot: Albany is the capital of New York.
Human: What is the capital of Texas?
Bot: Austin is the capital of Texas.
We can enable this conversation with a single category, one set, and one map:
<category> <pattern>WHAT IS THE CAPITAL OF <set>states</set></pattern> <template> <map name=“statecapitals”><star/></map> is the capital of <star/> </template> </category>
Feel free to try creating the set and map files we discussed, and then add this category to your AIML. Your bot will now be able to relay the capital of the states listed in your set and map.
More on Maps
Like sets, we can include a "default" category when the wildcard contents do not match an item in the map.
<category> <pattern>WHAT IS THE CAPITAL OF *</pattern> <template> I don’t know what the capital of <star/> is. </template> </category>
Human: What is the capital of Pennsyltucky?
Bot: I don't know what the capital of Pennsyltucky is.
Map files are simple key-value pairs in an array, and are written in the following format:
[["Texas" , "Austin"], ["California" , "Sacramento"]]
Built-in Sets and Maps
Pandorabots has some pre-built sets and maps that are not visible from the editor.
###Is this still true in uUI?
<set>number</set> - matches any natural number
<map name=”successor”> - maps any number n to n+1
<map name=”predecessor”> - maps any number to n-1
<map name=”plural”> - (attempts to) find the plural form of a singular noun (English only)
<map name=”singular”> - (attempts to) find the singular form of a plural noun (English only)
What is Context?
When humans have a conversation, we are able to remember the things that have been previously said.
Human 1: Do you like coffee?
Human 2: Yes.
Human 1 knows that "Yes" is a response to their question, because they have said it in particular context.
There are several features in AIML that allow you to provide context within your category.
The <that> tag, which sits between the pattern and template, enables the bot to remember that last sentence it uttered.
A category containing a
<that> statement will ONLY be matched if the contents between the tags match the last sentence given by the bot.
This allows you to have many duplicate patterns which, depending on the previous response, will trigger different templates.
In the example below, the second category is bound to a particular context. It will only be matched if the last sentence the bot said was "Do you like coffee?".
<category> <pattern>^ COFFEE ^</pattern> <template>Do you like coffee?</template> </category> <category> <pattern>YES</pattern> <that>DO YOU LIKE COFFEE</that> <template>Do you prefer dark or medium roast?</template> </category>
Human: I should drink some coffee.
Bot: Do you like coffee?
Bot: Do you prefer dark or medium roast?
The previous sentence stated by your bot will be stripped of punctuation when read by a category referencing if with
The new category will also ignore differences in capitalization / non-capitalized letters, and will expect any normalization you have specified in the normal.substituion file.
For these reasons, you must write the contents of your
<that> tags like you write patterns: no punctuation, all capital letters, and normalized. If you
<that> tags are failing, it is usually because one of these three items is amiss.
<that> tags can also contain wildcards! Values for
<that> variables are only valid within the scope of the active conversation.
There is a built-in predicate variable called
topic. Categories can be grouped together based on different values for
topic. These categories can only be matched if the topic predicate has been set to a certain value.
Topic allows your bot to keep context for longer than one interaction (the function of the
<that>tag). This can also be used to write duplicate patterns whose templates vary depending on the context of the conversation.
First, you need a category that sets the topic predicate. The following example would set the topic to "coffee":
<category> <pattern>CAN WE TALK ABOUT COFFEE</pattern> <template>Do you like <set name=“topic”>coffee</set>?</template> </category>
Now, you can group together categories within the coffee topic. _Note that
<topic> tags appear outside the categories. _In AIML 2.0,
<topic> can appear inside the category, like
<topic name= “coffee”> <category> <pattern>I LIKE THE TASTE</pattern> <template>I love how coffee tastes.</template> </category> <category> <pattern>IT IS TOO BITTER</pattern> <template>Maybe you should drink tea.</template> </category> </topic>
The patterns above will only match if the topic has been set to "coffee." If no category within the topic tags forms a match with the input, the input will match a category with no topic specified.
###(By default, that = topic = *) <set name="topic"></set> --> topic="unknown"
The default value of topic is
*. If you set a topic with no value (i.e.,
<set name="topic"></set>) the value will be "unknown."
Values for topic variables are only within the scope of an active conversation.
The values of predicates and local variables provide a third type of context in AIML. Using the
<condition> tag, a bot can respond differently to the same input depending on the value of a predicate or local variable.
The concept is the same as an IF - THEN - ELSE statement found in most programming languages.
Conditionals: Test Case I
Consider the following:
Human: Today is Monday.
Bot: The start of the work week!
Human: Today is Tuesday.
Bot: Tuesday already?
Human: Today is Wednesday.
Bot: Humpday, we're halfway to the weekend!
The bot response is conditioned on the day of the week. Using the <condition> tag within the template enables this with a single category:
<condition name=“today”> <li value=“Monday”>...</li> <li value=“Tuesday”>...</li> <li value =“Wednesday”>...</li> </condition>
The opening tag specifies the name of a predicate to check for; if the value of the predicate matches the value of any list element (
<li>), _then _the text of that element will be returned.
Altogether, the category for this test case would look like this:
<category> <pattern>TODAY IS *</pattern> <template> <think><set name=“today”> <star/></set></think> <condition name=“today”> <li value=“Monday”>Ah. The start of a new week.</li> <li value=“Tuesday”>Tuesday already?</li> <li value=”Wednesday>Humpday, halfway to the weekend!</li> ... <li>That isn’t the name of a day!</li> </condition> </template> </category>
The final list element (the one without a value attribute) will be returned if none of the other conditions are met.
Conditionals: Test Case II
You can also use conditionals to check the status of a predicate, i.e., whether or not it has been set.
<category> <pattern>WHAT IS MY NAME</pattern> <template> <condition name=“name”> <li value=“*”>Your name is <get name=“name”></li> <li>You haven’t told me your name yet!</li> </condition> </template> </category>
If the "name" predicate has been set to anything (denoted by the asterisk), the first list element will return; if it has not been set, then the second list element will return.
Attributes v. Tags
In AIML 2.0, any given value given by an XML attribute may also be expressed using a subtag of the same name. For example,
<li value="X"> may also be written as
<li><value>X</value>. This makes it possible to vary the values of attributes using XML expressions, for example:
<category> <pattern>IS * EQUAL TO *</pattern> <template> <think><set var=”star”><star/></set></think> <condition var=”star”> <li><value><star index=”2”/></value>Yes</li> <li>No.</li> </condition> </template> </category>
Loops are used in programming to iterate an action or function over a series of values, until a particular state has been reached. In AIML, we can loop over list elements in a condition until a certain value has been reached, at which point the loop will terminate and the bot will give a response.
Let's say we want to recreate the following interaction:
Human: Count to 8
Bot: 1 2 3 4 5 6 7 8
We will be using the "number" set and the "successor" map to establish the relationships between numbers.
First, set up the pattern:
<pattern>COUNT TO <set>number</set></pattern>
Next, you'll want to set a local variable in your template. The variable starts your count at 0. As we loop over our list elements, this count will change:
Next, we need to set up a condition whose list elements are dependent on the value of the variable "count":
Then, we create an empty list element whose value is
<star/>. This element will be returned when the value of "count" reaches the number specified in the input:
Our second list element will contain the loop. Using the "successor" map, we can simultaneously change the value of count, and add it to the bot's response:
<li> <set name="count"> <map><name>successor</name><get var="count"/></map> </set> <loop/> </li>
This resets the value of “count” to the corresponding number of its current value, found in the “successor” map. It will then add the successive value to the bot’s response. Finally,
<loop/> tells it to return the list element again, however this time, with the new value of “count”.
Altogether, the above components form the following code:
<category> <pattern>COUNT TO <set>number</set></pattern> <template><think><set var="count">0</set> </think> <condition var="count"> <li><value><star/></value></li> <li><set var="count"><map><name>successor</name><get name="count"/></map></set> <loop/></li> </condition></template> </category>
When the second
<li> has looped enough time for "count" to equal 8, the first list item will be returned and the loop will terminate. The bot will then respond to all of the text returned by the second list item (notice that when the "count" variable is reset, there is no
What is Learning?
AIML 2.0 has features that allow your clients to teach the bot new information.
<learnf> tags, clients can actually generate new categories from within their conversation.
Categories learned using
<learn> will only be accessible to that particular conversation, and will eventually be cleared after some idle time of no interaction with the bot.
Categories learned using
<learnf> will be written to a new AIML file and can be accessed by anyone talking with your bot. (Careful! Your clients may teach the bot naughty things, so use
<learnf> with extreme caution.)
How Learning Works
When the category below is matched, the bot will now have access to the category found within the <learn> tags:
<category> <pattern>THE SKY IS BLUE</pattern> <template>I will remember that the sky is blue <learn> <category> <pattern>WHAT COLOR IS THE SKY</pattern> <template>The sky is blue</template> </category> </learn> </template> </category>
Learning involves nested categories. To access variables defined in the outer category from the inner category, we use the
<eval> tags. Anything found within the <eval> tags will be evaluated FIRST, before the new category is actually created. This allows us to use
<learn> tags to access parts of the input matched by the outer category.
<category> <pattern>THE * IS BLUE</pattern> <template>I will remember that the <star/> is blue <learn> <category> <pattern>WHAT COLOR IS THE <eval><star/></eval></pattern> <template>The <eval><star/></eval> is blue</template> </category> </learn> </template> </category>
We can now reference the words captured by the wildcard in our new category.
Revisiting Key Platform Components
The Chat Widget
In addition to allowing you to converse with your bot as if you were the end-user, the Chat Widget also displays some vital information about each interaction and allows you to train your chatbot by making changes to the AIML within the interface.
Beneath each message bubble containing the bot's response, there is an option to Show Metadata. Displaying the metadata will show you the following information:
- Pattern: The pattern that matched your input and triggered the output in the message bubble
- That: Displays the previous response from the bot (blank if you have just started the dialog)
- Topic: Displays the topic if one has been set
- File: A link to the file containing the relevant file, which you may click on to edit that file directly in the Editor
Beneath the above metadata, you also have the option to run a Trace. Running a Trace will show you the exact series of steps that led from the input to your bot's output, which can be vital for debugging purposes.
You may also edit the bot response directly from within the chat widget by selecting the edit icon within the bot message bubble. This will open the Alter Response modal and prompt you to define a new response (template) and save it to a given
Clicking on the arrow icon next to the New Response input field will open additional fields allowing you to directly edit the Pattern, Template, That, and Topic values. ###Should these be typed with/without tags? Not clear in the interface!
Retyping your original input after altering the bot response should return the new template you defined.
To reset the bot's memory, which will clear any predicates stored about the current conversation, click on the refresh icon next to your bot's name on the top bar of the chat widget.
The Clubhouse and
<sraix> tag (first introduced in the AIML 2.0 spec) allows your bot to access the categories of another bot. The tag is very similar to
<srai>, however, instead of searching your own bot for another category to match, it will search the bot you have specified in the attribute.
You can use
<sraix> to leverage the knowledge bases' of other bots in the Clubhouse, specifying them based on their botid (username/botname). If you have published your bot to the Clubhouse, and chosen to make your botid available, other platform users may use
<sraix> to link up with your bot.
Why is this useful? Imagine another platform user has created a bot that is an expert about anything related to coffee botid: unXXXXXXXX/coffeebot).
If this bot has been published to the Clubhouse, your bot can access its expertise (contained in its AIML categories) by sending it any input that relates to coffee:
<category> <pattern>I LIKE COFFEE</pattern> <template><sraix bot=“johndoe/coffeebot”>COFFEE</sraix></template> </category>
If coffeebot is able to form a match, your bot will return coffeebot's output as if it were its own output to the client.
Bot Libraries are opensource AIML files that provide some base content you can build on as an alternative to building a Blank Bot from scratch. Currently, you can add the Small Talk library to English language bots. Please visit the Rosie Tutorial to learn more about how to leverage this Library.
Additional AIML Features
<rest> tags to access certain words in the input:
<first>A B C</first> = A
<rest>A B C</rest> = B C
Note that a "word" in AIML is separated from other words using a space. These tags will have no effect if the content is (1) empty or (2) a single word.
<rest></rest> = NIL
Substitutions are used to "normalize" interactions that involve pronounces, punctuation, gender, etc. You can call a substitution by using the file's name within a tag, for example:
<category> <pattern>I AM *</pattern> <template> YOU ARE <person><star/></person> </template> </category>
Human: I am waiting for you.
Bot: You are waiting for me.
In this category above, the substitution file "person" has found a 2nd-person pronoun in the wildcard contents and converted it to a 1st-person pronoun when echoed in the template.
This works in reverse as well.
The example above made use of the file
person.substitution, which is used to transform pronouns between first and second person.
person2.substitution is used to transform between first and third person pronouns.
gender.substitution is used to transform between male and female gender pronouns.
Earlier in the tutorial, we introduced the concept of input pre-processing or "normalization". This involved the correction of common misspellings, contractions, and most importantly, the removal/replacement of punctuation found in the input.
This means that punctuation is not "preserved" by simply echoing part of the user's input, for example:
<category> <pattern>URL *</pattern> <template><star/></template> </category>
Human: URL google.com
Bot: google dot com
To preserve punctuation found in the input we use
denormalize.substitution. This file contains all of the words that punctuation marks are normalized to. From the previous example, we know that the string ".com" is normalized to "dot com". To reverse this substitution, we echo the user's input within the denormalize tags:
<category> <pattern>URL *</pattern> <template> <denormalize><star/></denormalize> </template> </category>
Human: URL google.com
###More relevant example using emoji?
The Default Substitutions Files
Substitutions are available to you via the substitution files provided by default. We strongly suggest that you do not remove any of these substitutions. The contents of these files will only become applicable if you reference them in your template, so you should keep them in tact in case you wish to use any of the operations. You may also add to or update your substitution files.
You can return the current date in the format of your choice, specified like the arguments to the UNIX strftime function.
<date format="%B %d, %Y /> will return today's date.
You can use
<style> to calculate the internal between two dates (in this case, the bot's birthdate property and today's date):
<category> <pattern>AGE IN YEARS</pattern> <template><interval format="%B %d, %Y"> <style>years</style> <from><bot name="birthdate"/></from> <to><date format="%B %d, %Y" /></to> </interval></template> </category>
Next Steps: Deploying your Bot
Congratulations! If you've made it this far, we hope you are well on your way to becoming a proficient botmaster.
After a period of initial development, you may find yourself wanting to share your bot with the world by unleashing it on popular messaging or voice channels. There are a number of different ways to make bots built on the Pandorabots Platform public.
Downloading your Bot Files
You may download your bot files at any time via the Files tab in the Editor, and we recommend making frequent, regular backups. Since AIML is an open-standard, there are a number of opensource packages, including some interpreters, you can use. Pandorabots is one of the few platforms that is an open system (not a black box) and therefore actually exposes your code to you and allows you to download it and make full use of it elsewhere.
Of course, writing your own interpreter or attempting to make use of opensource projects with little or deprecated support can be incredibly challenging and time consuming, which is why Pandorabots offers its state-of-the-art interpreter as a service and provides API access to its hosting platform and SDKs
Using the Pandorabots API
If you are a developer or have one on staff, you may use the Pandorabots API to integrate your chatbot into any application. Visit the API Reference section to learn more.
Using the Turnkey Platform Integrations
The easiest way to make your bots available to the public (in a few simple steps!) is via the Deploy Page, accessible from the menu that appears whenever an individual bot is selected. Simply navigate to the interface and follow the instructions listed for each available Integration you wish to use.
Updating your Bot
Regularly reviewing chatlogs and continuously updating your chatbot based on what clients are actually saying is a critical component of bot development. In fact, we often say that the real work starts after your initial launch, because you cannot design a conversational experience in a vacuum. Even if you have data like call center or live agent chat logs, you still cannot predict everything that your end-users are going to say.
Visit the Logs page for your bot to review conversation logs, and make updates based on high priority logs (which appear at the top) where your bot didn't have a sufficient answer.
Frequently updating your bot to account for all the possible things a human might say in conversation may seem like a daunting task. However, you may rest assured that in reality - and especially with regard to a particular domain - people actually tend to say the same thing in conversation most of the time. This phenomenon is known as Zipf's Law, which explains a curve that represents the frequency at which words appear in human language.
As you can see, there is a word that occurs most frequently, followed by another word that occurs next most frequently, followed by a third word that occurs less frequently and so on. For a given body of text, it doesn't matter whether you break the text into letters, words, phrases, or sentences: the same distribution will always appear for natural languages.
In the course of bot development, you will find that many people say the same thing or ask the same types of questions, so you only need to define a finite number of rules to create a decent bot.