GeneralBots/botbook
2
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Several new topics to the gbkb reference.

Browse source
This commit is contained in:
Rodrigo Rodriguez 2019-03-04 12:11:32 -03:00
parent 05fe3815f8
commit 0ac57ccee0
2 changed files with 37 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
book/chapter-03-gbkb-reference.md
View file

@ -1,6 +1,39 @@
# .gbkb Reference
## Media Types
There are several media types that can be used in .gbkb package folder.
The table below shows the description of each one of them:
| Folder | File description |
|----------|----------------------------------------------------------------------------------------------------|
| tabular | .csv, .tsv or any tabular file used as an pair of question/answer and an optional hierarchy. |
| images | Images that can be used to enrich the answer to the user in the [Projector](glossary.md#projector) |
| videos | Videos used to answer questions made by users. |
| subjects | List of images of subjects that can be trated by the bot. |
| articles | Articles in .md that will be presented instead of text-only answers. |
## Using Videos
## Answering questions as videos
To display a video on the projector, just provide the Video URL to the desired question,
instead of specifing an text answer in the column **answer**.
The list of answers is a series of tabular files (.tsv, .csv, etc.) inside the **tabular** directory of the .gbkb.
## Calling dialogs from .gbkb
### Use Dialogs as answers instead of the default content
To call a dialog just when an answer would provide the desired question, just
use dialog:*dialogName* instead of specifing an text answer in the column
**answer**. The list of answers is a series of tabular files (.tsv, .csv, etc.)
inside the **tabular** directory of the .gbkb.
### Associating a [Subject Menu Item](glossary.md#subject-menu-item) to a Dialog
To call a dialog just when an answer would provide the desired question, just
use dialog:*dialogName* instead of specifing an text answer.
## How To

5
book/glossary.md
View file

@ -1,3 +1,6 @@
# Glossary
| Term | Description |
|-------------------|-----------------------------------------------------------------------------|
| Subject Menu Item | An item that is shown to the user when a request of known subjects is done. |
| Projector | A canvas that expresses the current conversation graphically. |