AgnesGsd
commented
7 years ago I'm trying to see if this new format works for all the sequences we have already developed (be it for Messenger or Android), and I have several questions/remarks/concerns to share for the quiz sequences and the stories.
Quiz
The reference file is this one: https://github.com/GhostWording/gw-config-apis/blob/master/data/bot/sequences/experiments/FastestDolphinOrWhaleV4.json
To show it was a quiz question (with a right and a wrong answer), we used to use a boolean like this: "Quiz": false. What I chose to do is to replace it with an Action as defined previously by @rhwy , using a true/false parameter, like this:
{
"Type": "Action",
"Id": "10",
"Name": "Quiz",
"Params": {
"additionalCounter": "False"
}
}But I have no idea if such an information (true/false) can be considered as a counter....?
rhwy
andreasdieryck
Frederikos
We want to introduce the notion of steps with some enhancements of the actual format. the proposal reference file is here: https://github.com/GhostWording/gw-config-apis/blob/master/data/bot/sequences/experiments/CatsOrDogsv4-1.json
Important Changes:
Label vs Steps
The
Labelshould disappear. Within questions, the label is just a special form of steps with only one step. in order to simplify the format of the construct we should keep only the steps and remove the Label. this means that a label in question (with no other steps) will become:Within commands, the
Labelsignification is different, as it refers to the label shown inside a button (not a text with a question). That's why it makes sense to keep it appart the Steps. But in order to clarify things, we'll call itCommandLabel:Types
actually, the main type is
questionand the sub-types are defining the action of a command which make the action implicit and complex if we want to do multiple commands. Basically what it's important is to note if something in the sequence tree is anode(something followed by a next step) or aleaf(a terminal action). That's why we'll try now to usetype=nodeandtype=leaf.Just to be clear, in a sequence we'll have a
type=nodewhen there's another element after, which mean that it has aCommandsproperty or aLinksToproperty, otherwise it'll be atype=leafSteps
Steps are a series of things to do,
before showing the command buttonsin a question/node and after the selection of a command within a command/leaf. The principle of the steps is tosimplifyactual logic by describing a series of things to do after and before an interaction with a user.Steps don't have a unique Id like a node or a leaf, they are part of it and executed sequentially, that's why we'll use the id as something do identify the step within the steps and to order them. It is recommended to use the ten by ten notation to be able to add a new step in between without renumbering everything (10,20,30...)
Actions
We talked about the property action (like :
"Actions": ["DoVote","ShowSurveyResults"]. But We miss 2 points here: 1/ we don't have an easy way to add to action some specific parameters and 2/ we don't know exactly when these actions are executed along with the steps defined in the command.That's why the simplest thing to do, is to add the actions to do as a step. doing that we can ensure the coherence of the order of actions, be able to show something before the action (showing a gif before showing the survey results for exemple) and because it's not just a string but an object we can add extra parameters: