129 lines
7.7 KiB
Markdown
129 lines
7.7 KiB
Markdown
# .gbdialog Reference
|
|
|
|
|
|
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.
|
|
|
|
## The Dialog
|
|
|
|
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. |
|
|
| 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 | _variable_ = CHART "pie", data| Generates a chart from data. |
|
|
| * file = data AS IMAGE| Converts a two dimension array into an image file, ready to be used with SAVE AS or SEND FILE.|
|
|
| * page = GET PAGE _url_ | Web automation retrival of a web page.|
|
|
| * _variable_ = GET page, cssSelector, "body > img" | Retrives an element within an IFRAME specified by selector eg.: "[name=iFrameName]", to be used later. |
|
|
| * SET page, cssSelector, value | Define an field to value eg. "value 123" on the webpage specified by selector eg. "#id". |
|
|
| * CLICK page, cssSelector | Clicks on an element inside the web page being automated by General Bots. |
|
|
| * DOWNLOAD | |
|
|
|
|
### Options
|
|
|
|
| Instruction / Usage | Description |
|
|
| ------------------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
| 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. |
|
|
| SET HEAR ON "mobile"| |
|
|
| SET MAX LINES _value_ | |
|
|
| SET SCHEDULE "2 * * * * *" | |
|
|
| SET LANGUAGE _value_ | |
|
|
| set translator [ON|OFF]| |
|
|
| set whole word [TRUE|FALSE]| |
|
|
|
|
|
|
* = Work in progress.
|
|
|
|
## How To
|
|
|
|
### Use General Bots computer vision
|
|
|
|
1. Develop a BASIC dialog and publish;
|
|
|
|
|
|
|
|
2. Test it in the conversation
|
|
|
|
|
|
|
|
|
|
### 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:
|
|
|
|
``` BASIC
|
|
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
|
|
|
|
```vb
|
|
|
|
|
|
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
|
|
|
|
```vb
|
|
|
|
hear one of subscriptions with email, password into subscriptionId
|
|
talk "The subscription selected was: " + subscriptionId
|
|
|
|
|
|
```
|