Several new topics to the gbkb reference.
This commit is contained in:
parent
05fe3815f8
commit
0ac57ccee0
2 changed files with 37 additions and 1 deletions
|
@ -1,6 +1,39 @@
|
||||||
# .gbkb Reference
|
# .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
|
## How To
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,6 @@
|
||||||
# Glossary
|
# 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. |
|
||||||
|
|
Loading…
Add table
Reference in a new issue