Expand KnowledgeBase creates a .vkb file based on a KnowledgeBase Template. Once a KnowledgeBase Template has been expanded it can be viewed and tweaked within the Verbot Scripting Interface.
For more information on KnowledgeBase Templates see: Creating a KnowledgeBase Template
3.1.3
Help
Verbot Editor 57
· Editor Introduction
· Online Help
· About
3.1.3.1 Editor Introduction
The Editor Introduction is a short cut to the online help. New Verbot users are encouraged to click the link to learn more about scripting.
3.1.3.2 Online Help
The "Online Help" links to the latest documentation. Currently updates are made daily.
3.1.3.3 Community Forum
Verbot Technology Manual 58
3.1.3.4 About
Verbot Editor 59
3.1.4
Resource Files Details
Learn more about the Resource Files Details panel:
· Resource Files
3.1.4.1 Resource Files
The "Resource Files" field displays the currently assigned resources. Currently supported resource file types are Synonym Files.
Verbot Technology Manual 60
3.1.5
Rules
Learn more about the Rules panel:
· Rule Names · New Rule · Rename Rule · New Child · Delete Rule 3.1.5.1 Rule Names
The first step for creating a KnowledgeBase is creating a Rule.
The "Rule Name" field is where you type in the name of the Rule you wish to create. The Rule name can be anything and is used only as an identifier.
To create a new Rule, type in the name of the Rule you wish to create and Click the "New Rule" button.
To create a Child Rule, select an existing Rule from the Rule tree field, type in a name for the Rule and click "New Child"
Verbot Editor 61
3.1.5.2 New Rule
Verbot Technology Manual 62
3.1.5.4 New Child
Child Rules are used to create a hierarchy within Rules. Once a Primary Rule fires the Child Rule is eligible to fire.
To create a Child Rule select a Rule within the Rule tree and click "New Child."
3.1.5.5 Delete Rule
To delete a Rule select a Rule from the Rule tree and click "Delete Rule". The selected Rule will be deleted.
Verbot Editor 63
3.2
Tutorials
From start to finish you'll have fun learning!
This Section is designed to get you up and running with the Verbot Scripting Interface.
Verbot® 4.0 has been designed to allow anyone to script complex and engaging virtual personalities, even those without previous programming experience. With the Verbot Scripting Interface, you can create your own personalized KnowledgeBases, as well as scripting interactions with applications and character animations.
The Verbot Editor Interface
This section will introduce you to the Verbot Scripting Interface. Learn out about the features of the interface and where they are located.
Creating your First Rule
KnowledgeBases are made up of Rules. Rules consist of Inputs and Outputs. This section will walk you through creating your first Verbot® Rule, from there you're on your way to making fantastic KnowledgeBases of your own design!
Creating Child Rules
Verbot Technology Manual 64
Learn how to display text when a Variable has not yet been set.
Internal Variables
Learn about built in Verbot Variables like displaying the time and date.
MS Agent Tags
Find out how to make your Verbot® smile, move about, and more!
Verbot Tags
Verbot Tags add functionality such as Read, Send, and Run.
Special _Inputs
Verbot® 4.0 has a few special inputs used for start up, and when the Verbot is left idle for an extended
period of time.
Running Applications
Now that you know Verbots® can smile and move around. Give them something to do! This section guides you through opening applications and urls.
Loading, Testing, and Talking
Now that you have a custom KnowledgeBase, find out how to load it and test it.
How to Compile a KnowledgeBase
Learn how to Compile a KnowledgeBase to share with your family and friends.
The Teaching.vkb KnowledgeBase
Learn how the Teaching.vkb KnowledgeBase helps your Verbot learn dynamically.
Advanced Features:
Creating a CSV file
Learn to create CSV files with your favorite spreadsheet software.
Creating a KnowledgeBase Template
Learn to create KnowledgeBase Templates that use data from a CSV file to create data driven KnowledgeBases.
Expand or Compile
Once you have a KnowledgeBase Template with associated CSV file ready to go, it's time to Compile it, Expand it, or you can do both. The following section describes the difference between Expanding and Compiling.
3.2.1
Creating Your First Rule
Creating Rules in Verbot® 4.0 is quick and easy.
Rules hold the knowledge of your Verbot®. A Rule is made up of Inputs and Outputs. An Input is used to match to what the user types. Once an Input finds a match the Output (or Response) is presented to the user.
To create a Rule you must first give it a name. Start by typing in the Rule Name input box. We'll use"Hello World" for this example.
Verbot Editor 65
Once you've typed "Hello World," click the "New Rule" button or simply press "Enter" to create a Primary Rule.
Your screen should look like the following:
Adding an Input to your Rule
Now that you've created a Rule. You'll need to add an input or two to make it available for your Verbot®
to use. An Input can be made up of single or multiple words.
For the purposes of this example, we simply want the Verbot® to respond to a user typing in "Hello" or "Hi".
Verbot Technology Manual 66
You'll notice that "Hello World" appears in the pop-up window and is highlighted. As a convenience, the Editor assumes your Rule name will be your first input. However for this example we want the Rule to fire on the input of "Hello" or "Hi". Change the text from "Hello World" to "Hello". And click "Ok" or press the "Enter" key.
Now that you've added "Hello," you may want to also add the Input "Hi". To add another Input, click the "Add" button within the "Inputs Group" and repeat the process as you did with "Hello". You can add as many inputs as desired.
Verbot Editor 67
To create an Output click the "Add" button within the "Outputs Group". A pop-up box appears with two fields. The top field is used to hold the Verbot® Output. The lower field is used to hold extra commands (i.e. a command to run a program).
Enter "Hello World" within the top field and click the "Ok" button or press the "Enter" key. The Output has been added. You've now created your first Rule.
Verbot Technology Manual 68
At this point it's a good idea to save your KnowledgeBase. Click "File" --> "Save" on the menu. After you've saved your KnowledgeBase you can test your Rule two different ways. You can: 1. Load the Verbot Player then load your KnowledgeBase or
2. Use "Test KnowledgeBase" from the "Tools" menu.
3.2.2
Creating Child Rules
A Child Rule is designed to fire only after a Parent or Primary rule has previously fired. Looking at the window, the child rules"red" or "yellow" will never fire unless the "two colors" rule has fired immediately before.
Verbot Editor 69
A primary rule can have as many Child Rules as you want. You may even choose to assign Child Rules to other Child Rules and can even have a conversation follow a hierarchy structure.
Note: In order to keep the User on track, you may want to use Virtual Child Rules to insure the Verbot is getting the response desired.
For more information on Rules see: Creating your First Rule
For more information on Virtual Child Rules see: Using Virtual Child Rules
3.2.3
Using Virtual Child Rules
Virtual Child Rules are used to link Rules to other Rules, virtually! The best way to understand how Virtual Child Rules work is through a tutorial to see them in action.
Example 1: All I want from you is a straight answer!
In the following example, you'll learn how to have the Verbot ask a question and receive one of three possible Inputs from the User.
Verbot Technology Manual 70
You can see that the _startup Rule has the Input "_startup" and the Output "Hi! Would you like to take a quick quiz?"
Next, we'll make a few Child Rules. One for the Input "yes," one for "no," and one that will fire if there is no match.
As you can see above the _startup Rule now has three Child Rules. Here is what each Rule contains so far:
_startup Input: _startup
Verbot Editor 71
Output: Hi! Would you like to take a quick quiz? anything else
Input: *
Output: I'm sorry. I really need a "Yes" or "No" Answer. no
Input: no
Output: Okay no problem. yes
Input: yes
Output: Great. Let's get started! What is the name of the planet most people live on? Okay let's test it. Click on "Tools" --> "Test KnowledgeBase"
Verbot Technology Manual 72
The problem we would have if you answered the Verbot with "yes" or "no" after the "anything else" Rule has fired - is that there are no Child Rules for the "anything else" Rule. This is where Virtual Child Rules come in.
Close the Verbot Script Tester window. Click on the Rule "anything else" to select them and then click on the "Virtual Child" button. The Rule Activation List window will pop up.
Verbot Editor 73
Once you've selected all three Rules click on "Ok". To test the Script open the "Verbot Script Tester" ("Tools" --> "Test KnowledgeBase") and test the KnowledgeBase again.
Type in the Input "maybe".
As before your Input of "maybe" fires the "anything else" Rule with the Output: "I'm sorry. I really need a "Yes" or "No" Answer."
The Verbot will keep firing the "anything else" Rule until the Input of one of the Virtual Child Rules is received ("no" or "yes").
Once "no" or "yes" is received by the Verbot, it will look for another Child Rule. If a Child Rule is not found it will search through the Primary Rules.
3.2.4
Creating Synonyms
The Synonym Editing Interface is used interchangeably to create groups of words which can be used as synonyms within Rule Inputs.
Verbot Technology Manual 74
Type in the text you would like to use to describe your synonym. In this example we will call our synonym "What is". Once you type in "What is," click the "Add" button. The Synonym should look like the following screen shot:
Next, enter the synonyms words/phrases. In this example we'll add "What is" and then the contraction "What's".
Save your Synonyms
Once you have added the desired amount of synonyms, click "File" --> "Save".
After you have named and saved your synonym, you may click "File --> Close" to close off the Synonym Editor Window.
That's it! You've created your first synonym file. For information on Synonyms see: Synonyms
Verbot Editor 75
3.2.5
Using Synonyms
First Things First...
The Synonym Editing Interface allows you to create groups of words or phrases which can be interchanged within an Input.
Before using Synonyms you should already be familiar with the Synonym Editing Interface, and have a synonym file saved.
Using Synonyms within an Input
When the Verbot Scripting Interface loads, it should look like the following screen shot. You'll notice the right side contains a group called "Resource Files". A Resource File is where you will load your
previously created synonym file.
To add a Resource File:
1. Click the "Add Files" button
2. Locate the Synonym file you created. The file should have the .vsn extension. 3. Select the Synonym file and click the "Open" button on the dialog box
Verbot Technology Manual 76
Add a new Rule
You should be familiar with creating Rules by now. If not, please review: Creating your First Rule. You should remember that your synonym file "what is" contains the synonyms "What is" and "What's."
The name of the synonym is "What is".
Before you can use the synonym, you'll need a rule. Below you'll see that a Rule entitled "What is a Verbot?" has been created.
Now that you have created a Rule, you need to add an Input. To use the synonym "What is" within the Input, you have to format it in a special way so that the Verbot Engine "knows" that a synonym exists for "What is".
In order to use a synonym, you will need to write the synonym name--in this case, "what is"-- and enclose it in parenthesis. Here is an example. Click the "Add" button within the Inputs group. When the Input dialog box appears, type in the following Input: "(what is) a Verbot?", then click ok.
Verbot Editor 77
As you can see, from the image above, the Output: "A verbal software robot." has been added. You now have one complete Rule ready to test. Make sure you save your KnowledgeBase by clicking "File --> Save."
If this is your first time saving, you'll need to name the file. That's it! You're now ready to test your Rule.
To see that it works properly, you should do some testing. To do so, click on "Tools"->"Test KnowledgeBase." You will notice that you get output if you type "What is a Verbot?" or "What's a Verbot?" and that is because you have a synonym that contains them both.
Using Synonyms within an Output
Much like using Synonyms within Inputs you can use Synonyms within Outputs. The Verbot will pick one of the phrases from that Synonym group and insert it in your output.
Verbot Technology Manual 78
To open a text file in Microsoft Notepad, type in the application name and file name to open. For example: notepad c:\docs\mytext.txt
Verbot Editor 79
3.2.7
Loading, Testing And Talking! Oh my!
By now, you should have a pretty good idea about creating Rules, Synonyms, and using Variables and Tags.
Now that you have your completed KnowledgeBase, it's time to load it up and test it.
Verbot Technology Manual 80
4. Click on the "Add" button and locate the KnowledgeBase you created. 5. Once you have selected your KnowledgeBase, click "Open."
Verbot Editor 81
7. Your KnowledgeBase will be added to the top of the list. The list order identifies what Rule will be evaluated first when two Rules match from each KnowledgeBase. In other words, if the engine finds matches for an Input in two different KnowledgeBases, it will fire the response from the KnowledgeBase that is at the top.
8. Before clicking "Close," you may uncheck any KnowledgeBase you do not wish the Verbot to use. Once you've finished selecting KnowledgeBases, click "Close."
9. The Verbot will load your selected KnowledgeBase(s). Now you should try testing the Rules you've created.
Note: That the above process reflects using the Verbot Player for final testing. You may also test during development of your Scripts using Test KnowledgeBase on the Verbot Scripting Interface menu.
Verbot Technology Manual 82
3.2.9
Using the Teaching.vkb KnowledgeBase
Who needs an Editor?
The Teaching.vkb KnowledgeBase allows new Rules to be dynamically added while chatting with the Standard Player. You may want to open the Teaching.vkb KnowledgeBase to see how the Learning Rules have been setup. You may also want to tweak Inputs to your own preference using the um... the Editor :)
Note: This feature can only be used if you own Verbot Standard Edition and is not supported by the Free Verbot Player. How to use the Teaching.vkb
To teach the Verbot while chatting with the Standard Edition Player do the following:
Make sure that the Verbot Standard Edition player has the required KnowledgeBases loaded and selected. Teacher.vkb and LearnedKnowledge.vkb should be loaded and checked.
Verbot Editor 83
To teach the Verbot something new type into the Input box on the Verbot Player and press "Enter". For example type in: What is a gizmo?
Verbot Technology Manual 84
The Verbot will respond with something along the lines of "I don't know" or some other response depending on the KnowledgeBases you have loaded.
Type in: remember a Gizmo is a special device.
Verbot Editor 85
Julia will say something along the lines of: I'll be sure to remember that.
To test her type in: What is a gizmo?
Verbot Technology Manual 86
Julia will now respond with: A Gizmo is a special device
Note: This is a new feature and we will be adding and tweaking the Teacher.vkb KnowledgeBase in coming updates. You may also want to create your own learning Rules using the Verbot Scripting Editor.
The Teacher.vkb contains various sample learning Rules that you can use to dynamically add Rules while interacting with the Verbot. You may also add your own learning Rules to capture different kinds of Inputs.
Note: When editing the default Teacher.vkb file, you may have to compile it to a .ckb file in order to interact with your changes in the Verbot Player.
To find out more about the learning tags used in the Teacking.vkb see: Tags and Inputs section.