Please don’t take this to mean:
Well, this is how you MUST ask questions otherwise you don’t really know what you are doing.
Rather, I have been answering many questions on the API.AI discussion forum, and I have noticed some patterns amongst the questions which go unanswered. Instead of a DONT list, I will give you a DO list.
These tips might help you get your question answered.
Do some homework
Do some homework and show us that you have done it. Don’t write your entire business problem out and ask “So, how do I go about it?”.
This is a cliche, but cliches get their status because they are usually true. 😉
Here is a simple test to check if you have done your homework. Can you break your question down into these three parts?
- What you did
- What you expected should happen
- What actually happened
This format won’t work for all questions, but it usually does for many of them.
Show your flowchart
If you have already created a flowchart for your chatbot (and it has no proprietary stuff), then share it. All the more if your question is more of a “am I doing the right thing in choosing my intents/entities/contexts?” type. Don’t create one just to ask the question though, unless that is the only option to explain your problem clearly.
Show the full intent
If you have an intent which is too long, use a tool such as the Full Page Screen Capture Extension for Chrome instead of choosing to skip it.
Show console output JSON
In the console output, you have an option to choose JSON. Copy/paste the JSON where possible as it gives a clearer picture.
Read up on the terminology
Unfortunately, API.AI has terminology which has very specific meaning but also is common in programming – e.g. event, action, entity. So be sure to read up on the terminology.
If you are posting on discuss.api.ai, feel free to CC me on your question and I will do my best to help.
Clearly, I like to brag about myself a little. 🙂
Sometimes I get my best blog post questions from the forum, so I don’t mind it at all if you CC me on the question.
And sometimes I might just get busy and not answer. Don’t take it personally! Someone else will usually pitch in.