In this blog post, we are going to discuss on how the feature to post user feedback was implemented on the SUSI. AI server side. The API endpoint by which a user can post feedback for a Skill is https://api.susi.ai/cms/feedbackSkill.json.
It accepts five url parameters –
- model – It tells the model to which the skill belongs. The default value is set to General.
- group – It tells the group(category) to which the skill belongs. The default value is set to Knowledge.
- language – It tells the language to which the skill belongs. The default value is set to en.
- skill – It is the name of the skill to be given a feedback. It is a compulsory param.
- feedback – It is the parameter that contains the string type feedback of the skill, that the user wants to update.
The minimalUserRole is set to USER for this API, as only logged-in users can use this API.
Going through the API development
- The parameters are first extracted via the call object that is passed to the main function. The parameters are then stored in variables. If any parameter is absent, then it is set to the default value.
- There is a check if the skill exists. It is done by checking, if there exists a file corresponding to that skill. If no, then an exception is thrown.
- This code snippet discusses the above two points –
@Override public ServiceResponse serviceImpl(Query call, HttpServletResponse response, Authorization authorization, final JsonObjectWithDefault permissions) throws APIException { String model_name = call.get("model", "general"); File model = new File(DAO.model_watch_dir, model_name); String group_name = call.get("group", "Knowledge"); File group = new File(model, group_name); String language_name = call.get("language", "en"); File language = new File(group, language_name); String skill_name = call.get("skill", null); File skill = SusiSkill.getSkillFileInLanguage(language, skill_name, false); String skill_feedback = call.get("feedback", null); JSONObject result = new JSONObject(); if (!skill.exists()) { throw new APIException(422, "Skill does not exist."); } . . .
- Then the feedbackSkill.json that was initialized in the DAO object, is then opened. It is a JSONTray, which is then parsed.
- It is checked if the skill is previously rated or not. If yes, has the user rated it before or not. In the case, when the user has given a feedback for it already, we just need to make changes in the feedbackSkill.json file as the feedback_count key present in the skillRatings.json doesn’t change. In case, the user hasn’t given the feedback earlier, the changes also needs to be reflected on the skillRatings.json file. For this use, the utility function addToSkillRatingJSON is called. The feedback_count of that skill is increased by one, as it is a unique feedback and changes need to be reflected on the file.
- The response object is then sent with three key values mainly, apart from the session object. They are –
- accepted – true – It tells that the skill feedback has been updated.
- message – “Skill feedback updated”
- feedback – <feedback> – It is the string that the client has sent as feedback.
Here are code snippets and data objects that will help in understanding the API well –
- addToSkillRating function –
public void addToSkillRatingJSON(Query call) { String model_name = call.get("model", "general"); String group_name = call.get("group", "Knowledge"); String language_name = call.get("language", "en"); String skill_name = call.get("skill", null); JsonTray skillRating = DAO.skillRating; JSONObject modelName = new JSONObject(); JSONObject groupName = new JSONObject(); JSONObject languageName = new JSONObject(); JSONObject skillName = new JSONObject(); if (skillRating.has(model_name)) { modelName = skillRating.getJSONObject(model_name); if (modelName.has(group_name)) { groupName = modelName.getJSONObject(group_name); if (groupName.has(language_name)) { languageName = groupName.getJSONObject(language_name); if (languageName.has(skill_name)) { skillName = languageName.getJSONObject(skill_name); } } } } if (skillName.has("feedback_count")) { int skillFeedback = skillName.getInt("feedback_count"); skillName.put("feedback_count", skillFeedback + 1 ); } else { skillName.put("feedback_count", 1); } if (!skillName.has("stars")) { JSONObject skillStars = new JSONObject(); skillStars.put("one_star", "0"); skillStars.put("two_star", "0"); skillStars.put("three_star", "0"); skillStars.put("four_star", "0"); skillStars.put("five_star", "0"); skillStars.put("avg_star", "0"); skillStars.put("total_star", "0"); skillName.put("stars", skillStars); } languageName.put(skill_name, skillName); groupName.put(language_name, languageName); modelName.put(group_name, groupName); skillRating.put(model_name, modelName, true); return; } }
- Sample of feedbackSkill.json file –
{
"general": {
"Knowledge": {
"en": {
"aboutsusi": [
{
"feedback": "The skill is awesome!",
"email": "email1@domain.com",
"timestamp": "2018-06-06 02:20:20.245"
},
{
"feedback": "Great!",
"email": "email2@domain.com",
"timestamp": "2018-06-06 02:20:20.245"
}
],
"quotes": [
{
"feedback": "Wow!",
"email": "email1@domain.com",
"timestamp": "2018-06-06 02:19:53.86"
}
]
}
}
}
}
- Sample of skillRatings.json file –
{
"general": {
"Knowledge": {
"en": {
"aboutsusi": {
"negative": "0",
"positive": "0",
"stars": {
"one_star": 0,
"four_star": 2,
"five_star": 0,
"total_star": 5,
"three_star": 3,
"avg_star": 3.4,
"two_star": 0
},
"feedback_count": 2
},
"quotes": {
"negative": "0",
"positive": "0",
"stars": {
"one_star": 0,
"four_star": 0,
"five_star": 0,
"total_star": 0,
"three_star": 0,
"avg_star": 0,
"two_star": 0
},
"feedback_count": 1
}
}
}
}
}
I hope the development of creating the aforesaid API is clear and proved to be helpful for your understanding.