botbook/book/chapter-05-gbdialog-reference.md
2022-06-04 10:58:09 -03:00

6.8 KiB

.gbdialog Reference

generalbots-2018

All direct communication from GeneralBots to the end user is made up of the .gbDialog extension. It can be composed of speech or writing directly with the bot. This extension facilitates support related to dialogues, as the system is divided by each service extension.

Importance of dialogue services.

Communication or dialogue between the end user is one of the most important services of a software, because the smooth functioning of the dialogue directly reflects the functioning for the user.

Using Conversational BASIC

The following file types are loaded from a .gbdialog package: .vbs, .vb, .basic and .bas.

General Bots BASIC reference

Instruction / Usage Description
HEAR variable Hears something from the person into a variable for later use.
confirm variable (Comming soon) Waits for confirmation like 'yes', 'y', 'yeah' and return true or false
TALK message Talk the specified message to the person.
GENERATE A PASSWORD Creates a new password into the system variable password for later use.
CREATE A BOT FARM USING params Deploys a new bot farm to the cloud.
WAIT seconds Wait a number of seconds before continuing the conversation.
variable = GET "file.xlsx", "A1:A1" Gets the value of the cell specified in range address
SET "file.xlsx", "A1:A1", 42 Gets the value of the cell specified in range address
variable = GET "https://server/query" Gets the value of the cell specified in range address
POST "https://", data Gets the value of the cell specified in range address
wait seconds Wait a number of seconds before continuing the conversation.
HEAR variable AS EMAIL
HEAR variable AS DATE
HEAR variable AS NAME
HEAR variable AS INTEGER eg.: HEAR approve as Boolean.
HEAR variable AS BOOLEAN
HEAR variable AS HOUR
HEAR variable AS MONEY
HEAR variable AS MOBILE
* HEAR variable AS FILE Returns a file uploaded by user to be saved with SAVE variable AS "folder/folder/file" on .gbdrive.
HEAR variable AS AUDIO Returns a audio uploaded by user to be saved with SAVE.
HEAR variable AS ZIPCODE
HEAR variable AS "Abacate", "Maçã", "Morango" Displays the specified menu and waits for this input until user select one of them.
HEAR variable AS LANGUAGE
HEAR variable AS LOGIN (internal) Waits for Active Directoy login integration before proceeding with the dialog .
GO TO [number,] dialogName Transfers the conversation to a next dialog for the specificed number or as last command, transfers the context to this dialog.
SET HTTP HEADER _key = value Defines an HTTP header to be used to next GET call.
SET HTTP USERNAME = value Defines the HTTP username to be used to next GET call.
SET HTTP PASSWORD = value Defines the HTTP password to be used to next GET call.
SEE CAPTION OF url AS variable Extracts an caption, using a pre-trained neural network, from a image.
SEE TEXT OF url AS variable Extracts text from the image in a OCR (Optical Character Recognition) feature.
SET HTTP PASSWORD = value Defines the HTTP password to be used to next GET call.
* data = SELECT a, SUM(b) AS b FROM data GROUP BY a Use SQL to manipulate a data variable returned from FIND or an array
* file = data AS IMAGE Converts a two dimension array into an image file, ready to be used with SAVE AS or SEND FILE.
  • = Work in progress.

How To

Use General Bots computer vision

  1. Develop a BASIC dialog and publish;

image

  1. Test it in the conversation

image

Using POST data

You can use POST passing a variable as the second param in the POST call. The example bellow shows how to call POST using an object that is returned from the Excel file.

Given the Excel file with the following contents and saved to the standard .gbdialog folder:

tokenId token comment
29187 AAMkAGEzMWIxMmI5 Prod1
98739 jZWYtNGQ3My1iNmM Prod2

The Word bellow will invoke POST call by using line contents as object attributes:

obj = FIND "dados.xlsx", "tokenId=29187"
POST "https://server/query", obj
' obj here is {tokenId: 29187, token: "AAMkAGEzMWIxMmI5", comment: "Prod1"}
  • OAuth2 is being implemented and no modification to previous calls will be necessary as this configuration will be an administrative conversation to get the token setup.

Generate a password for the person



talk "Let's generate a very dificult to guess password for the new bot:"
generate a password
talk "Your password is *" + password + "*. Keep it on a safe place only acessible to you."


Get the list of cloud subscriptions


hear one of subscriptions with email, password into subscriptionId
talk "The subscription selected was: " + subscriptionId