Verbot 4 Manual

(1)

(2)

... 16 Merge Knowledge ... 20 Print KnowledgeBase ... 22 Synonyms ... 23 Replacement Profiles ... 24 Skin Editor ... 30 Search Rules ... 31 Test KnowledgeBase ... 34 Compile KnowledgeBase ... 34 Expand KnowledgeBase ... 35 3 Help ... 35 Editor Introduction ... 36 Online Help ... 37 Community Forum ... 38 About ... 39 4 Resource Files Details

... 40 Resource Files ... 40 5 Rules ... 41 Rule Name Verbot 4.0 Manual I

(3)

... 60 4 Creating Synonyms ... 63 5 Using Synonyms ... 67 6 Running Applications ... 69 7 Loading, Testing, and Talking - Oh my!

... 71 8 How to Compile a KnowledgeBase

... 72 9 The Teaching.vkb KnowledgeBase

Part V Advanced Features

76

... 77 1 Command Line Options

... 77 2 KnowledgeBase Templates and CSV Files

... 77 Creating a CSV file

... 80 Creating a KnowledgeBase Template

... 82 Expand or Compile ... 83 3 Variables ... 89 Internal Variables ... 91 Variables with Alternate Text

... 91 4 Tags and Inputs

... 92 MS Agent Tags ... 93 Special _Inputs ... 94 Verbot Tags ... 94 agent.load ... 94 exit ... 94 learn ... 97 load ... 97 mem.get ... 97 mem.set ... 98 quit ... 98 read ... 98 readprint ... 98 run ... 98 send

Part VI Glossary

99

... 99 1 Child Rules ... 103 2 Comma Separated Value (CSV) files

... 103 3 Compiled KnowledgeBase Files (ckb)

... 104 4 Expand ... 104 5 Inputs ... 108 6 KnowledgeBase ... 109 7 KnowledgeBase Template ... 109 8 Outputs ... 109 9 Primary Rule ... 110 10 Rule ... 110 11 Synonyms ... 112 12 Synonym Output © 2004 Conversive, Inc.

(4)

... 112 13 Verbot

... 112 14 Virtual Child Rules

... 112 15 Verbot KnowledgeBase Files (vkb)

Part VII Documentation History

113 Index

0

Verbot 4.0 Manual III

(5)

1 Verbot4

Last Update: Friday, January 28, 2005 2:43 PM Download this help file exe format Download this help file PDF format

2 Introduction

A Tale of Two Applications.

With Verbot® 4.0 technology, creating your own intelligent agent becomes as straightforward as typing a sentence or command in natural language text. This manual includes information which will quickly get you up to speed with creating your own Verbot® personality. Of course you don't have to create your own Verbot® KnowledgeBase, but doing so is half the fun!

Verbot® 4.0 Standard Edition comes with two applications. Verbot® 4.0 Standard Edition Player, and the Verbot® Scripting Interface.

(6)

Verbot 4.0 Manual 5

2.1 System Requirements

System Requirements: · Windows 2000/XP · Microsoft Agent

· Text to Speech Engine

· .Net Framework 1.1 or higher

· SAPI 4.0*

Microsoft Agent Links: Microsoft Agent Main page:

http://www.microsoft.com/msagent/ Microsoft Agent Download page:

http://www.microsoft.com/msagent/downloads/user.asp Microsoft Text to Speech Downloads:

http://www.microsoft.com/msagent/downloads/user.asp#tts *Windows XP users require SAPI 4.0 download

http://www.microsoft.com/msagent/downloads/user.asp#sapi Microsoft .Net Framework Downloads:

The best way to install the .Net Framework is through Windows Update. Locate it and install as needed from Windows Update.

http://www.windowsupdate.com

(Note: If .Net is not listed as a windows update, you already have it installed) Alternative Download:

http://msdn.microsoft.com/netframework/technologyinfo/howtoget/default.aspx

2.2 Getting Started

Verbot Technology was designed from the ground up to be user friendly, yet powerful. If you're eager to begin Scripting we provided links to a few terms and tutorials to quickly get you up and running. Terms you should know:

· KnowledgeBase

· Rule

(7)

· Using Synonyms

Once you've mastered creating Rules and Synonyms you'll be ready to move on to more advanced features. Click here for an overview of How To's

3 Verbot Scripting Interface (Overview)

When the Verbot Scripting Interface (VSI) first opens, you will have access to the following items:

· File · New · Open · Recent Files · Save · Save As · Exit · Tools

· Edit KnowledgeBase Info

· Merge KnowledgeBase · Print KnowledgeBase · Synonyms · Replacement Profiles · Skin Editor · Search Rules · Test KnowledgeBase · Compile KnowledgeBase · Expand KnowledgeBase · Help · Editor Introduction · Online Help · Community Forum · About

· Resource Files Details

(8)

(9)

(10)

3.1.2 Open

The "Open" item on the menu allows you to open a previously saved KnowledgeBase, or a KnowledgeBase which may have been downloaded.

(11)

3.1.3 Recent Files

The "Recent Files" item on the menu allows you to open recently opened KnowledgeBases. Use this feature to quickly load KnowledgeBases you have been working with.

(12)

3.1.4 Save

(13)

3.1.5 Save As

(14)

3.1.6 Exit

(15)

(16)

3.2 Tools

3.2.1 Edit KnowledgeBase Info

The "Edit KnowledgeBase Info" tool is used to fill in details about the loaded KnowledgeBase. Using the "Edit KnowledgeBase Info" tool you can do the following:

(17)

3.2.2 Merge Knowledge

Come together right now over me.

To merge to KnowledgeBases together, click the "Merge KnowledgeBase" link. The Merge KnowledgeBase dialog box.

(18)

When the dialog box first opens your current loaded KnowledgeBase is displayed. You may click any Rule in the "KnowledgeBase Rules" field to display its details in the "Rule Details" field.

To merge another KnowledgeBase with the currently displayed KnowledgeBase click the "Merge KnowledgeBase" button.

Select the KnowledgeBase you wish to merge with the currently displayed KnowledgeBase and click "Open"

(19)

Once you click "Open" the KnowledgeBase merge process will begin. It may take several minutes to process depending on the size of the KnowledgeBases.

As the KnowledgeBases are processed Information will be printed to the "Information" field. While the KnowledgeBase is being processed the "Ok" button will be grayed out. However, you can cancel the process anytime by clicking the "Cancel" button.

When the process is complete you can look over the changes or click the "Ok" button to except changes. You may also click "Cancel" to cancel all changes.

(20)

Look at all the pretty colors.

As the KnowledgeBase loads information about the process is color coded and printed in the

Information field. When the process is complete, Rules that have been changed in some form are also color coded.

Each color means something different. Here is a brief overview of what the color coding means:

· Green = The Rule that an Input existed in the original KnowledgeBase and the loaded KnowledgeBase.

(21)

(22)

(23)

(24)

3.2.5 Replacement Profiles

The "Replacement Profile" editor allows you to designate different text to be sent to the TTS verses the text displayed within the Verbot Output box.

If for example you created a "Replacement Profile" that might be used in the United Kingdom - you might want to map the text "Television" to the word "Telly".

With the "Replacement Profile" editor you can remap the word "Television" to send the word "Tell e" to the Verbot TTS Engine (spelling can be adjusted to allow the text to speech engine best represent the word.), and present the word "Telly" within the Verbot Output box.

Below is an image of the "Replacement Profile" Editor which includes the example above as well as "smilies" remaped to Verbot Animations.

The image below is the result from asking the Verbot "do you watch Television?". Although the original Output contained the text "Television" instead of "Telly". The Replacement Profile above replaced "Television" with "Telly" in the Output box, and sent the text "Tell e" to the Verbot TTS engine.

(25)

3.2.6 Skin Editor

The Verbot Skin Editor currently allows you to create skin files which can be loaded into the Verbot Player.

(26)

Agent to use

Select the Agent you wish the Skin to utilize when it first loads. TTS Mode

(27)

settings.

Window Height

You may select the height of the Verbot Player window in pixels. Window Width

You may select the width of the Verbot Player window in pixels. Allow User to resize window

By unchecking the check box disables the user from re-sizing the Verbot Player. Input Text Font

You may select the font style and size for the Input box. Output Text Font

You may select the font style and size for the Output box. Background Image Filename

Use the background choose button to select an image file to use as a background (skin) for the Verbot Player.

(28)

Input Background Color

Use the Choose Color button to select the color you wish to use for the Verbot Player's Input background.

(29)

Background Color

As an alternative to an image file you can simply select the background color you wish to use for the Verbot Player.

Output Text Color

(30)

Output Background Color

Use the Choose Color button to select the color you wish to use for the Verbot Player's Output background.

(31)

Agent Background Color

As an alternative to an image file you can simply select the background color you wish to use for the Agent's background in the Verbot Player.

3.2.7 Search Rules

The "Search Rules" tool allows for you to search a KnowledgeBase for a text string. Using the check boxes on the Search Rules interface you can search specific areas of the KnowledgeBase.

By default Rule Names, Rule Inputs, and Rule Outputs are checked. You can use the check boxes to select the area

(32)

3.2.8 Test KnowledgeBase

"Test KnowledgeBase" allows you to test an open KnowledgeBase within the Verbot Scripting Interface.

To use click on the "Tools" menu --> "Test KnowledgeBase"

(33)

Once you type in your question press the "Enter" key on your keyboard. Matches will be found and highlighted.

If a rule has Variables, they will be displayed within the Variable field with their current value. This is useful for finding out what Variables are set to during runtime and what is being captured.

(34)

You may click on any of the highlighted Compiled Inputs to load the Rule that fired into the Verbot Scripting Interface.

(35)

3.2.9 Compile KnowledgeBase

The "Compile KnowledgeBase" feature creates compiled KnowledgeBases which can in some cases speed up very large KnowledgeBase interactions.

You'll usually never need to compile a KnowledgeBase unless you notice that the Verbot is responding slowly to queries.

3.2.10 Expand KnowledgeBase

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.

(36)

3.3 Help

3.3.1 Editor Introduction

(37)

3.3.2 Online Help

(38)

3.3.3 Community Forum

The "Community Forum" menu item links to the Verbot Community Forum. You may wish to join the forum access Verbot downloads such as additional KnowledgeBases and Characters. You'll also be able to interact with a large audience of Verbot users from around the world.

(39)

3.3.4 About

(40)

.

(41)

3.4.1 Resource Files

The "Resource Files" field displays the currently assigned resources. Currently supported resource file types are Synonym Files.

The "Add" button allows you to add new resources, files to the currently loaded KnowledgeBase. The "Delete" button allows you to remove resources from the currently loaded KnowledgeBase. For information on creating synonyms see: Part 3 : Creating Synonyms

For information on using synonyms in your KnowledgeBases see: Part 4 : Using Synonyms

(42)

3.5.1 Rule Name

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"

(43)

3.5.2 New Rule

The "New Rule" button is used to create a new Rule in the currently loaded KnowledgeBase.

(44)

3.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.

(45)

3.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.

(46)

4 How To's

From start to finish you'll have fun learning!

This Section is designed to get you up and running with the Verbot Scripting Interface.

(47)

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

Learn how to create Child Rules, that allow the Verbot to follow a hierarchy based conversation. Using Virtual Child Rules

Learn how to link Rules to other Rules using Virtual Child Rules. Creating Synonyms

To aid you with creating Inputs with minimal repetition. Verbot® Synonym files can be created and added to any KnowledgeBase you create. This section will step you through making a synonym file. Using Synonyms

The Creating Synonyms walked you through creating a powerful synonym file, This section will show you how to harness the power by stepping you through using synonyms within your Inputs.

Variables

Learn how to retain, and recall user based input with Variables. Variables with Alternate Text

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

(48)

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.

4.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.

(49)

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:

(50)

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.

(51)

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.

(52)

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.

(53)

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

(54)

before.

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.

(55)

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.

We'll start by creating a _startup Rule. A _startup is a special Input that the Verbot looks to fire when it is first loads.

(56)

As you can see above the _startup Rule now has three Child Rules. Here is what each Rule contains so far:

_startup Input: _startup

Output: Hi! Would you like to take a quick quiz? anything else

(57)

Okay let's test it. Click on "Tools" --> "Test KnowledgeBase"

The _startup Rule will fire and display: "Hi! Would you like to take a quick quiz?"

(58)

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.

(59)

(60)

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").

(61)

4.4 Creating Synonyms

The Synonym Editing Interface is used interchangeably to create groups of words which can be used as synonyms within Rule Inputs.

(62)

Next, enter the synonyms words/phrases. In this example we'll add "What is" and then the contraction "What's".

(63)

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.

(64)

4.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.

Quick Links:

Using Synonyms within an Input Using Synonyms within an Output 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

(65)

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

(66)

Add a new Rule

You should be familiar with creating Rules by now. If not, please review: Part 2 : 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".

(67)

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".

(68)

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.

(69)

To open a web address just type in the URL. For example: http://www.verbots.com

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

(70)

4.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.

(71)

4. Click on the "Add" button and locate the KnowledgeBase you created. 5. Once you have selected your KnowledgeBase, click "Open."

(72)

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.

4.8 How to Compile a KnowledgeBase

(73)

4.9 The Teaching.vkb KnowledgeBase

Who needs an Editor?

(74)

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?

(75)

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. Then press the "Enter" key.

(76)

Julia will say something along the lines of: I'll be sure to remember that.

To test her type in: What is a gizmo? Press the "Enter" key.

(77)

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: Verbot Tags section.

(78)

5.1 Command Line Options

The --input command line option allows you send an Input to the Verbot and start up. Verbot4Engine.exe --input="This is my input text."

5.2 KnowledgeBase Templates and CSV Files

KnowledgeBase Templates allow you to create data driven KnowledgeBases. For example, you can create a list of names and phone numbers in a spreadsheet program such as Microsoft Excel. Once complete you can export the data to a CSV file which an in turn be imported into the Verbot Scripting Interface. Using the data from the CSV and Template Rules, a new KnowledgeBase can be created which include the CSV data which can then be accessed through conversational interactions with the Verbot.

The following sections cover the creation of KnowledgeBase Templates and CSV files:

· Creating a CSV file

· Creating a KnowledgeBase Template

· Expanding or Compiling

5.2.1 Creating a CSV file

What is a CSV file?

CSV also known as Comma Separated Value files are a standard export format for many applications, most notably is Microsoft Excel. Use the CSV format you can create data driven KnowledgeBase by entering your data by way of a spreadsheet program such as Excel or Open Office Spreadsheet. Using KnowledgeBase Template Rules you can access CSV data by Compiling or Expanding the

KnowledgeBase Template.

Note: If you don't have Microsoft Excel you may want to download Open Office which includes a spreadsheet application.

Adding Data.

This section assumes you have Microsoft Excel. If you haven't done so already, open a blank Excel spreadsheet.

(79)

The first row is considered a heading. For this example you are going to make a Verbot phone book. So in row 1 column A enter "Name". Then in row 1 column B enter "Number". Your spreadsheet should look like the following:

(80)

Now that you have your headings and data entered, it's time to save the file as a CSV file. Click "File"-->"Save As"

(81)

Once your you've saved the file it's time to move on to the next section Creating a KnowledgeBase Template.

5.2.2 Creating a KnowledgeBase Template

What is a KnowledgeBase Template?

A KnowledgeBase Template is used to create data driven KnowledgeBases. The first step is to create a CSV file which contains the data you wish to access. Then create Template Rules to access the data.

(82)

Rule Name: Get Phone Number

Input: What is #Name's phone number? Output: #Name's phone number is #Number. You're screen should appear as shown below:

(83)

it to the Resource Files Details field.

Note: Multiple CSV files can be used within one KnowledgeBase.

At this point it's a good idea to save your KnowledgeBase.

Now that you have a Template Rule and a loaded CSV file it's time to Expand or Compile the KnowledgeBase.

5.2.3 Expand or Compile

Expanding or Compiling

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 information describes the difference between

Expanding and Compiling.

Why should a KnowledgeBase be Expanded?

When a KnowledgeBase Template is Expanded a new .vkb file is created based on the

KnowledgeBase Template Rules and the loaded CSV file. Once the KnowledgeBase is Expanded and the new .vkb file is created, the new .vkb file can be loaded within the Verbot Scripting Editor for tweaking or to view the results.

How to Expand a KnowledgeBase Template

Why should a KnowledgeBase be Compiled?

Compiling a KnowledgeBase Template creates a new .ckb file which created based on the

KnowledgeBase Template Rules and the loaded CSV file. Once the KnowledgeBase is compiled a new .vkb file is created which can be loaded into the Free Verbot Player or the Verbot Standard Edition Player for testing or use. It is important to note that the Free Verbot Player can only load Compiled KnowledgeBases (.ckb). To share your KnowledgeBase with friends you'll need to provide them with this link to the Free Verbot Player and supply them with your KnowledgeBase Compiled (.ckb). How to Compile a KnowledgeBase Template

(84)

Click the save button to begin the Expand process. Depending on the size of the CSV file and the amount of Template Rules it may be several seconds to Expand the KnowledgeBase Template. Once the Template is expanded you may load the resulting .vkb file into the Verbot Scripting Interface to see the results and tweak if needed.

How to Compile a KnowledgeBase Template

To compile a KnowledgeBase Template click on the Compile icon or click "Tools"-->"Compile KnowledgeBase" on the menu.

Once you have clicked "Compile" the process begins. (Note: no dialog box pops up. The file is automatically saved with the .ckb extension)

Depending on the size of the CSV file and the amount of Template Rules it may take several minutes to Compile the KnowledgeBase Template. Once the Template is compiled you may load the resulting .ckb file into the Verbot Player to interact with it. In order to view the results of a KnowledgeBase and CSV file you will need to Expand the KnowledgeBase.

(85)

Understanding What Variables do.

When a user first speaks with a Verbot, the Verbot doesn't know the user's name. For example, if you asked the Verbot "What is my name?" it would most likely respond with "Your name is Friend."

However, if you told the Verbot "My name is Mary" the Verbot would respond with "It's nice to meet you Mary."

The Verbot now knows that your name is Mary. If you were to ask "What is my name?" the Verbot would now respond "Your name is Mary."

What is my name?

Let's look at a sample response in which the Verbot does not know your name. "What is my name" Rule first - so we can see how the Verbot responds with "Friend" if it doesn't know your name. Rule Name: What is my name

Input: (what is) my name

Output: Your name is [name:Friend].

Note: (what is) <-- is a Synonym. Click Here to find out more about Synonyms

You might have noticed that before you tell the Verbot your name, it call you "Friend". The Verbot uses "Friend" because the Variable "name" is not set.

The following example shows a Variable with the default setting of "Friend". You can of course replace "Friend" with anything you like (or not use an alternate at all, which would return nothing).

Example:

(86)

My name is [name]

We now know that if a variable is not set it will use alternate text if available, but how do we set the Variable? It's actually rather simple. Let's look at the Rule "My name is [name]."

Rule Name: My name is [name] Input: My name is [name]. Output: Good to meet you [name]!

(87)

Variables in Variables: "Joe's phone number is 555-5555"

There are times when you want to save information, such as recording your friend's telephone numbers. To do this, you need to use Variables inside other variables.

(88)

Let's see what happens when you type the following Input: "Joe's phone number is 555-5555." First, thing that happens is "Joe" is stored within the Variable "[contactname]."

Now that "Joe" is stored within the Variable "[contactname]," the Verbot can then use "Joe" within another Variable. In this case, "[[contactname]s_phone]" is set to the Variable name of "Joes_phone" with the value of "555-5555".

So, here is what you end up with: contactname = "Joe"

joes_phone = "555-5555"

Note that is you typed in the same sentence using a different friend' information, you would get another unique variable. For example, if you typed in "Jenny's phone number is 555-8888." The Variables would be as follows:

contactname = "Jenny" jennys_phone="555-8888"

Notice that contactname is always set to the last Input (Jenny) but a unique variable is created (jennys_phone).

(89)

Retrieving the Variable: "What is Joe's phone number?"

Using the example above - we have two Variables available: joes_phone and jennys_phone. To access the Variables we create the following Rule:

(90)

5.3.1 Internal Variables

Internal Variables.

Assuming you've read the Variables section, you already know that Variables are used to capture information from within an Input as well as display that captured information later. Internal Variables

(91)

[_lastinput] [_lastoutput]

Pardon me do you have the time? (Time Variables)

The Date and Time Internal Variables allow the Verbot to present the time, date, year, and more within a response. Listed here are the different Time Variable's and a description of what they present:

Tag: (Used within Verbot Output) Output Format: Example Output: Example Verbot Output:

[_time] h:mm tt The time is [_time] "The time is

4:20 PM"

[_time24] _HH:mm _{Wake up soldier it's [_time24]} _{"Wake up}

soldier it's 16:20"

[_date] MMM. d, yyyy Today is [_date] "Today is

Jan. 3, 2010"

[_month] MMMM Another beautiful [_month] "Another

beautiful January"

[_dayofmonth] _d _{Today is day [_dayofmonth]} _{"Today is}

day 3"

[_year] yyyy The year is [_year] "The year is

2010"

[_dayofweek] _dddd _{Today is [_dayofweek]} _{"Today is}

Saturday" What did I say? You said [_input]!

[_input]

Prints last User Input within the Verbot response. This tag can also be used to save User Input to other variables.

Ex.

Rule Name: What did I say? Input: What did I say? Output: You said: [_input]

(92)

Input: What did I say?

Output: You said: [_lastinput] Sample Conversation

User Input: "How old are you?" Verbot Output: "I'm 5 years old." User Input: "What did I say?"

Verbot Output: "You said: How old are you?" What did you say? I said [_lastoutput]!

[_lastoutput]

Prints last Verbot response. Ex.

Rule Name: What did you say? Input: What did you say? Output: I said: [_lastoutput] Sample Conversation

User Input: "How old are you?" Verbot Output: "I'm 5 years old." User Input: "What did you say?"

Verbot Output: "I said: I'm 5 years old."

5.3.2 Variables with Alternate Text

I'm sorry I didn't catch that? (Alternate Text Variable)

The Alternate Text Variable allows you assign alternate text in case a variable has not yet been defined.

[name:alternate text] Example:

Rule Name: What is my name? Input: What is my name?

Output: As far as I know, your name is [name:Friend].

In the example above if the User asks "What is my name?", the Verbot will respond in one of two ways depending on if the Variable name is set.

(93)

· MS Agent Tags

These tags are used to interact with the MS Agent Character. Includes movement and animation tags.

· Special Inputs

This section covers special Inputs which can be used in KnowledgeBases

· Verbot Tags

Allow your Verbot to interact with Users in dynamic ways.

5.4.1 MS Agent Tags

Tags and Microsoft Agent

Verbot® 4.0 utilizes Microsoft Agent, because of this, not only will you be able to create your own characters for use with Verbot® 4.0 engine, but you'll also be able to utilize the animation features of MS Agent.

Note: All Verbot® animation is done with tags that are inserted into Output/Response fields. For example, to make a Verbot® character smile, simply insert the following: "Here is my smile <agent.play smile>"

Microsoft Agent Tags: <agent.play animation> <agent.gestureAt x y> <agent.moveTo x y speed> <agent.moveHome> <agent.pause ms> <agent.speak text>

Show a little emotion will ya? <agent.play animation> Plays the agent animation.

Ex: I really like you.<agent.play quiz> Animation Available:

Verbot® Character Sylvie® currently has the following animations: angry lookaround quiz Sad smile stickit wow

(94)

<agent.moveTo x y speed>

Moves the agent to the given screen coordinates(?).

The moveto command allows you to set screen coordinates for the Verbot® character to move to. Like the Animation Tags, the moveto tag is inserted into Outputs.

To make the character move, you would insert "<agent.moveto x y s>" where "x" is the x screen coordinate, "y" is the y screen coordinate, and "s" is the speed in which to move.

Ex.

"I'm going to move up. <agent.moveto 800 600 1>"

or

"<agent.moveTo 0 0 1>Can't catch me!<agent.moveTo 500 400 10>" Get back here!

<agent.moveHome>

Moves agent back to center of Verbot Player window.

The moveHome command should be used to reposition the agent to the center of Verbot Player window. The command is usually helpful after using the moveto command above.

How to make a Verbot® relax a little. <agent.pause ms>

Pauses the agent for the given number of milliseconds. Ex: My name is<agent.pause 2000> Rex!

Say it, don't text it! <agent.speak text>

Speaks the given text without displaying it. Example:

If you were to use the following text within an Output, "The secret word is:" would be displayed in the out put box.

However, the text "This text will not display in the output box." would only be spoken, but NOT displayed in the Output box.

The secret word is: <agent.speak This text will not display in the output box.>

5.4.2 Special _Inputs

The following special inputs are used to interact with Verbot 4.0 in a few different ways. _startup

(95)

_blank

The _blank Input is used to fire a rule based on an Input that contains no text. For example: if you were to submit an Input with no text (i.e. by pressing enter) when interacting with the Verbot, this would reply something like: "To talk to me, you need to type something in the Input box."

5.4.3 Verbot Tags

Read! Run! Send! Verbot Tags add functionality.

The Verbot engine utilizes custom tags used for interacting with the Verbot engine. Tags include reading text files, running programs, and adding dynamic Rule creation abilities.

Note: All Verbot® tags are inserted into Output/Response fields. For example, to make a Verbot® shut down the Verbot Interface, simply insert the following: "See ya later! <exit>"

Verbot 4.0 Tags: <agent.load agentfile> <exit> <learn options> <load knowledgeBase> <mem.get variable> <mem.set variable value> <quit> <read filename> <readprint filename> <run command> <send text> 5.4.3.1 agent.load

I need a new look!

During interaction with a user, you may want to change the current agent. Using the <agent.load agentfile> tag allows you to swap between different installed agent characters.

<agent.load agentfile>

This will change the agent to the one you specify with agentfile. Example:

Output: I'm going to change to Julia. <agent.load julia2004.acs> The above scripted output will switch to Julia if she isn't already loaded. 5.4.3.2 exit

(96)

This section will be expanded as this feature set matures. Please log on to our forums if you have additional questions.

<learn

#file:filename.vkb (optional) #name:rule name (optional) #input:keywords

#output:verbot response

#command:command text (optional) #childof: rulename (optional) #vchildof: rulename (optional) #vparentof: rulename (optional) >

Notes:

· The Learn command can have tags within it Example:

#output:<send hello>

For more information on tags see: Verbot Tags

· The Learn command (as of version 4.0.5.4) no longer merges rules with same inputs unless the rulename specified is the same as the merged rule name.

Learning to Learn.

The following is a break down of the required and optional Learn command attributes. Optional tags add additional functionality, but are not required for the command to operate.

#file (optional)

The optional #file allows you to specify a file name to append knowledge to. Note: The default KnowledgeBase is learnedKnowledge.vkb

Format: <learn

#file: filename.vkb #input: keywords

#output: verbot response >

#name (optional)

The optional #name allows you to specify a Rule name to create within the learnedKnowledge.vkb. If a Rule name is not specified the User input will be used as the Rule name if an existing Rule is not found.

Note: In most cases you should NOT specify a Rule name to allow the Verbot engine to automatically merge new Inputs with existing like Rules.

Format: <learn

(97)

<learn

#input: keywords

#output

The required #output defines the Output that will be used to create the new Rule within the learnedKnowledge.vkb

Format: <learn

#input: keywords

#command (optional)

The optional #command defines the command to run when the newly created Rule is fired. For more information on using Command see: Running Applications

Format: <learn

#input: keywords

#output: verbot response #command: command text >

#childof (optional)

The optional #childof defines a Rule name to allow the newly created Rule to be a child of. For information on Child Rules see: Creating Child Rules

Format: <learn

#input: keywords

#output: verbot response #childof: rule name >

#vchildof (optional)

The optional #vchildof adds the newly created rule as a virtual child of the given existing rule. For more information on Virtual Child Rules see: Using Virtual Child Rules

(98)

#output: verbot response #vparentof: rule name >

Note: you can have as many #vchildof or #vparentof lines as you want (one line for each reference to add)

For more information on using the learning ability see: The Teaching.vkb KnowledgeBase or visit our forums online.

5.4.3.4 load

I've changed my mind!

The <load knowledgeBase> tag allows you to load a specified KnowledgeBase file. When used in conjunction with the <agent.load agentfile> command you can change both the character's look and knowledge.

<load knowledgeBase> Example:

Output: I'm gong to change my mind! <load julia.ckb>

This will load and select the given KnowledgeBase File. In this example the julia.ckb KnowledgeBase from My Documents\Verbot4 will be loaded.

5.4.3.5 mem.get

I'm like an elephant. I never forget.

The mem.get function allows you to get the value of variable and display it in a response. Format:

<mem.get variable> Example:

Rule: My dog's name is [dogname] Input: My dog's name is [dogname]

Output: <mem.get dogname> is a good name for a dog.

Note: <mem.get variableName> behaves like [variableName] within Outputs and can be used interchangeably.

Sample Dialog:

User: My dog's name is Jack

(99)

Example:

Rule: My dog's name is [dogname] Input: My dog's name is [dogname]

Output: [dogname] is a good name for a dog. <mem.set hasDog Yes> Rule: Do I have a dog?

Input: Do I have a dog?

Output: [hasDog:Not that I'm aware of]. Sample Dialog:

User: Do I have a dog? Verbot: Not that I am aware of. User: My dog's name is Jack. Verbot: Jack is a good name for a dog. User: Do I have a dog?

Verbot: Yes. 5.4.3.7 quit

How do you close a Verbot®? Tell it to quit or exit! <quit>

Exits the Verbot program. Ex: Goodbye.<exit>

Note: <quit> and <exit> behave exactly the same making them interchangeable. 5.4.3.8 read

Tell me a story. <read filename>

The read command allows the Verbot to load a .txt or .rtf file and read it back. Ex. Let me read something. <read mytextfile.txt>

5.4.3.9 readprint

Don't just say it, print it too! <readprint filename>

The readprint command allows the Verbot to load a text file and print its content to the Verbot Output box.

(100)

Is used to fire a Rule using text as the Input within Output. Example:

Output: "Your answer was correct on that last question. Get ready here comes the next question. <send nextquestion>"

"nextquestion" is the Input for another Rule. Once the Verbot speaks the text "Your answer was correct on that last question. Get ready here comes the next question." It sends the Input "nextquestion" to itself, and fires the Rule that matches to that Input.

6 Glossary

Glossary Index:

· Child Rules

· Compiled KnowledgeBase Files (ckb)

· Inputs · KnowledgeBase · Outputs · Primary Rule · Rule · Synonyms · Verbot

· Virtual Child Rules

· Verbot KnowledgeBase Files (vkb)

6.1 Child Rules

Child Rules are Rules that become available only after a Primary Rule fires.

Child Rules are useful for branching conversations in which you are expecting a follow up Input from the User, after the previous Verbot response.

For example, the Verbot asks the question "Do you like sports?" The Verbot would be expecting a "Yes" or "No" Input from the User. By using Child Rules, the Verbot can respond with the appropriate Output and attempt to better follow the conversation.

For example You have the following two Rules: "Goodbye" and "Smile for me"

(101)

The "No" and "Yes" Rules are called Child Rules. Because they are attached to "Smile for me," (which is the Primary Rule) they cannot fire until after "Smile for me" Rule has fired. In other words, if you were to type the Input "yes" or "no" into the simulator, the Verbot would return the response "No match found" because the "Smile for me" Rule has not fired yet and thus, it has not enabled the "Smile for me" Child Rules to fire.

(102)

Verbot 4.0 Manual 101

However, if you type in the Input "Smile for me" the Verbot will respond with "You want me to smile for you?".

(103)

Once the "Smile for me" Rule has fired, you can now type "yes" or "no" as an Input, because the Child Rules are now enabled to fire.

(104)

Note that the "Yes" and "No" Rules are only available to match after the "Smile for me" Rule has fired. If a "Yes" or "No" Rule does match to the next Input by the user Verbot 4.0 will return to searching the Primary Rules.

(105)

Edition. However, vkb files can only be opened within the Verbot Standard Edition. Learn more about: How to Compile a KnowledgeBase

Learn more about: Verbot KnowledgeBase Files (vkb)

6.4 Expand

The Expand function is used to create a .vkb file from a KnowledgeBase Template and CSV file. When a KnowledgeBase Template is Expanded a new .vkb file is created based on the

KnowledgeBase Template Rules and the loaded CSV file. Once the KnowledgeBase is Expanded and the new .vkb file is created, the new .vkb file can be loaded within the Verbot Scripting Editor for tweaking or to view the results.

6.5 Inputs

An Input is the text string used to match to an incoming query from a user. For example:

The Verbots KnowledgeBase contains Rules. The screen shot below shows a loaded KnowledgeBase which contains the Rule "This is a Hello Rule".

(106)

(107)

As you can see, Inputs are a very important part of Rules. You can also use synonyms as Inputs. For example, you might want a Rule that fires when a user types "Hello" or "Hi," To create a Rule like this, you could add two Inputs for that Rule: one Input as "Hello" and one as "Hi."

(108)

Also, you can create a synonym file for "hello" that contains both, "hello" and "hi" in

"Tools-->Synonyms". Once you have created the Synonym file, you can just type in "(hello)" in the

Input box and it should match to both "hello" and "hi."

(109)

For more information on Synonym creation see: Part 3 : Creating Synonyms. For more information on using Synonyms see: Part 4 : Using Synonyms. For more information on Synonyms see: Synonyms.

(110)

6.7 KnowledgeBase Template

What is a KnowledgeBase Template?

A KnowledgeBase Template is used to create data driven KnowledgeBases. You first create Rules which are setup using special tags. Once your Rules are setup you load a CSV file. You may choose to then Expand or Compile the KnowledgeBase.

For example, a Template Rule might look like this: Input: What is #Name's phone number?

Output: #Name's phone number is #PhoneNumber. Related Topics:

· KnowledgeBase Templates and CSV Files

· Creating a CSV file

· Creating a KnowledgeBase Template

6.8 Outputs

Rules are made of Inputs and Outputs.

Outputs (also known as Responses) allow the Verbot to react to users queries.

Outputs can contain commands as well as Animation Tags and other Special tags that tell Verbots to play animations and load programs.

For more information on Animation Tags see: Animation Tags and More For more information on Commands and Special Tags see: Special _Inputs

6.9 Primary Rule

(111)

As you can see Primary Rules can have Child Rules which in turn can have more Child Rules.

6.10 Rule

(112)

For example, you can create a synonym named "What is". "What is" can contain "What is" and "What's". If an Input contains the synonym "What is" a user can type "What is" or "What's" to fire a response.

For example:

Rule: What is your name? Input: (What is) your name? Output: My name is Julia.

The user can then type one of the following Inputs to fire the Rule: What is your name?

or

(113)

6.12 Synonym Output

Verbot 4.0 KnowledgeBases can use Synonym files you create to interchange a word (or words) within an Input or an Output.

Synonym Outputs are Synonyms used within a Verbot's Response to interchange text.

For example, you can create a synonym named "VerbotRandomThought". "VerbotRandomThought" can contain "I'm feeling great today." and "Today seems like a great day to chat."

Once you've added alternate Synonym Outputs you can place the Synonym in an Output and the Verbot will randomly select a phrase from the Synonym Output's list.

For example: Rule: Hello Input: hello

Output: (VerbotRandomThought) What would you like to talk about?

Sample Dialog: User: Hello

Verbot: I'm feeling great today. What would you like to talk about?

User: Hello

Verbot: Today seems like a great day to chat. What would you like to talk

about?

6.13 Verbot

Verbot®? A Verbal Software Robot! :)

6.14 Virtual Child Rules

Virtual Child Rules are used to link one Rule to one or more Rules which may or may not be directly linked to the selected Rule.

You can use Virtual Children to activate rules that wouldn't normally be available. Normally, Child rules can only fire right after their parent fires. Virtual Children let you get around that requirement by creating a Virtual Parent-Child relationship.

To designate a rule as a Virtual Child select the rule that you want to be the parent, then click the "Add Virtual Children" button, and then check the boxes next to the rules that you want to be able to fire immediately after the selected rule.

(114)

have created, you must compile your KnowledgeBase for friends and family who may then download the Free Verbot Player to interact with your KnowledgeBase.

Learn more about: Compiled KnowledgeBase Files (ckb)

7 Documentation History

This section covers additions and changes to the Verbot Scripting Interface Online Help (This file). January 24th 2005

· Added [_lastinput] to Internal Variables

· Added new Tags and Inputs Section which now includes MS Agent Tags, Special _Inputs and Verbot Tags

· Added Internal Variables and Variables with Alternate Text to Variables Section

· Added information on <mem.get variableName> to Advanced Features --> Tags and Inputs --> Verbot Tags

· Added information on <mem.set variableName value> to Advanced Features --> Tags and Inputs --> Verbot Tags

· Broke down Verbot Tags in to seperate topics.

· Moved Verbot Tags section to Advanced Features (It didn't really make sense to have it in the How-To section)

· Moved Variables section to Advanced Features (It didn't really make sense to have it in the How-To section)

· Moved Internal Variables section to Advanced Features (It didn't really make sense to have it in the How-To section)

· Moved Variables with Alternate Text section to Advanced Features (It didn't really make sense to have it in the How-To section)

· Moved MS Agent Tags section to Advanced Features (It didn't really make sense to have it in the How-To section)

· Moved Special _Inputs section to Advanced Features (It didn't really make sense to have it in the How-To section)

January 21st 2005

· Fixed bad example in Verbot Tags. Example: <read mytextfile.txt> should have been: <readprint mytextfile.txt> (Thanks Topdaryl for the catch)

· Fixed bad link from The Teaching.vkb KnowledgeBase to Verbot Tags

· This help file now has a keyword index available. (Click Keyword Index top left side of online manual)

· Added Synonym Output to Glossary Section.

· Fixed spelling errors here and there... January 20th 2005

· Added missing [_lastoutput] to Internal Variables section

· Added information on #file:filename.vkb (optional)

(115)

September 20th, 2004

· Added <agent.load agentfile> tag to Verbot Tags section.

· Added <load knowledgebase> tag to Verbot Tags section.

· Added note that Multiple CSV files can be used within one KnowledgeBase.

· Added Command Line Options section added. July 8th, 2004

· Fixed example for <agent.pause ms> tag (Thanks! Treehouse for pointing this out :)

· Added Internal Variable section

· Added information on Time Variables

· Added Variables with Alternate Text section

· Added information on Alternate Text Variables

· Added link to Variables with Alternate Text from How To's section

· Added information on <readprint filename> tag to Verbot Tags section.

· Added link to Internal Variables from How To's section

· Added PDF download link to Verbot section June 24th, 2004

· Added missing links to new features on the Scripting Interface (VSI) page.

· Added explanation of the Expand KnowledgeBase menu item.

· Added Advanced Features topic

· Added KnowledgeBase Templates and CSV File section to Advanced Features section

· Added Creating a KnowledgeBase Template section to Advanced Features section

· Added Creating a CSV file section to Advanced Features section

· Added Expand or Compile section to Advanced Features section

· Added glossary entry for: KnowledgeBase Template

· Added glossary entry for: Comma Separated Value (CSV) files

· Renamed topic: The Verbot Scripting Interface (VS) to Verbot Scripting Interface (Overview)

· Deleted Welcome topic and moved text to Introduction topic

· Added Getting Started topic

· Added quick links to terms and tutorials to Getting Started topic

· Separated MS Agent Tags from Verbot Tags and created them as new sections.

· deleted Animation and more topic due to tag separation. June 4th, 2004

· Added Glossary Entry for Compiled KnowledgeBase Files

· Added Glossary Entry for Verbot KnowledgeBase Files

· Added new section: The Teaching.vkb KnowledgeBase for the latest features added

· Added new learning tags to Animation Tags and More section

· Added new section How to Compile a KnowledgeBase

(116)

May 19th, 2004

· Added section on new "Print KnowledgeBase" feature

· Fixed more spelling errors...Arg!

· Updated links within online *this* Help document May 17th, 2004

· Added AutoDate to Introduction page - so I don't have to remember to put the last publish date manually...

May 10th, 2004

· Skin Editor Section: Added information on Speed Slider and Pitch Slider

· Skin Editor Section: Added images of color schemes.

· Updated Older Screen Shots May 7th, 2004

· Change Online Help from Javascript Driven to Html links (Mozilla had problems)

Verbot 4 Manual

Table of Contents

Part I Verbot4

4

Part II Introduction

4

Part III Verbot Scripting Interface (Overview)

6

Part V Advanced Features

76

Part VI Glossary

99

Part VII Documentation History

113

Index

0

1

Verbot4

2

Introduction

2.1

System Requirements

2.2

Getting Started

3

Verbot Scripting Interface (Overview)

3.1.2

Open

3.1.3

Recent Files

3.1.4

Save

3.1.5

Save As

3.1.6

Exit

3.2

Tools

3.2.1

Edit KnowledgeBase Info

3.2.2

Merge Knowledge

3.2.5

Replacement Profiles

3.2.6

Skin Editor

3.2.7

Search Rules

3.2.8

Test KnowledgeBase

3.2.9

Compile KnowledgeBase

3.2.10 Expand KnowledgeBase

3.3

Help

3.3.1

Editor Introduction

3.3.2

Online Help

3.3.3

Community Forum

3.3.4

About

3.4.1

Resource Files

3.5.1

Rule Name

3.5.2

New Rule

3.5.4

New Child

3.5.5

Delete Rule

4

How To's

4.1

Creating your First Rule

4.4

Creating Synonyms

4.5