Skill Data

The SUSI skill CMS is an editor to write and edit skill easily. It follows an API-centric approach where the SUSI server acts as API server and a web front-end  act as the client for the API and provides the user interface. A skill is a set of intents. One text file represents one skill, it may contain several intents which all belong together. All the skills are stored in SUSI Skill Data repository and the schema is Models -> Groups -> Languages -> Skill -> Intents. http://api.susi.ai/cms/getAllLanguages.json To get the list of all the languages stored in Susi Skill Data repository, we used the endpoint provided by SUSI Server. @Override public UserRole getMinimalUserRole() { return UserRole.ANONYMOUS; } The getMinimalBaseRole method tells the minimum Userrole required to access this servlet it can also be ADMIN, USER. In our case it is Anonymous. A User need not to log in to access this endpoint. @Override public ServiceResponse serviceImpl(Query call, HttpServletResponse response, Authorization rights, final JsonObjectWithDefault permissions) { 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); JSONObject json = new JSONObject(true); json.put("accepted", false); String[] languages = group.list((current, name) -> new File(current, name).isDirectory()); JSONArray languagesArray = new JSONArray(languages); json.put("languagesArray", languagesArray); json.put("accepted", true); return new ServiceResponse(json); } One can access based on model and group. We can get the required parameters through call.get() method where first parameter is the key for which we want to get the value and second parameter is the default value. We make a json array of languages ISO codes and send it as a response for this endpoint. Next, to display the actual name we used a ISO-639-1 npm package for language name translation from their respective codes. console.log(ISO6391.getName('zh')) // 'Chinese' console.log(ISO6391.getNativeName('zh')) // '中文' Next we use getAlllanguages.json endpoint of Susi_server if (languages.length === 0) { $.ajax({ url: 'http://api.susi.ai/cms/getAllLanguages.json', jsonpCallback: 'pc', dataType: 'jsonp', jsonp: 'callback', crossDomain: true, success: function (data) { data = data.languagesArray this.setState({ languages: data }); for (let i = 0; i < data.length; i++) { if (ISO6391.getNativeName(data[i])) { languages.push(<MenuItem value={data[i]} key={data[i]} primaryText={ISO6391.getNativeName(data[i])} />); } else { languages.push(<MenuItem value={data[i]} key={data[i]} primaryText={'Universal'} />); } } }.bind(this) }); and make an Ajax network call to get the ISO codes from the above endpoints. We parses the response in data object, using ISO6391 npm package we added the native language name in the drop down for the languages. We defined a Universal language with code ‘xx’, for skills which is related to mathematical and computational problems. This is how we added language’s native form in Susi skill CMS, To add more skills or modify the existing ones visit skills.susi.ai. For more information and complete code take a look at Susi server and Susi_Skill_cms and join gitter chat channel for discussions. Resources Read more about Servets – https://www.tutorialspoint.com/servlets/ The source code -https://github.com/fossasia/susi_skill_cms Read about servlet interface - https://www.javatpoint.com/Servlet-interface Read about npm package - https://www.npmjs.com/package/iso-639-1

A skill is a set of intents. One text file represents one skill, it may contain several intents which all belong together. All the skills are stored in Susi Skill Data repository and the schema is Models -> Groups -> Languages -> Skill -> Intents. Using this, one can access any skill based on four tuples parameters model, group, language, skill. Susi skill CMS is an editor to write and edit skill easily. It follows an API-centric approach where the Susi server acts as API server and a web front-end act as the client for the API and provides the user interface. ::name <Skill_name> ::author <author_name> ::author_url <author_url> ::description <description> ::dynamic_content <Yes/No> ::developer_privacy_policy <link> ::image <image_url> ::terms_of_use <link> #Intent User query1|query2|quer3.... !example:<The question that should be shown in public skill displays> !expect:<The answer expected for the above example> Answer for the user query To give more information of a Skill above metadata was added to the text file. Where dynamic content, represents if the skill answer changes based on user inputs. And image is the path to image of the skill, stored in skill data repository. Let’s check how this is implemented in Susi Server. public static JSONObject readEzDSkill(BufferedReader br) throws JSONException { if (line.startsWith("::")) { int thenpos=-1; if (line.startsWith("::name") && (thenpos = line.indexOf(' ')) > 0) { skillName = line.substring(thenpos + 1).trim(); if(skillName.length() > 0) json.put("skill_name",skillName); } if (line.startsWith("::author") && (thenpos = line.indexOf(' ')) > 0) { authorName = line.substring(thenpos + 1).trim(); if(authorName.length() > 0) json.put("author",authorName); } if (line.startsWith("::author_url") && (thenpos = line.indexOf(' ')) > 0) { authorURL = line.substring(thenpos + 1).trim(); if(authorURL.length() > 0) json.put("author_url",authorURL); } lastLine = ""; example = ""; expect = ""; description = ""; image = ""; continue readloop; } Susi Skill class provides parser methods for sets of intents, given as text files. It reads the skill line by line. For differentiating skill metadata with skill code we have use (::) operator. If a line starts with ::, method knows it’s skill metadata, and process it respectively. It takes out the respective substring and puts in json to be later processed by SusiMind class. private final Map<String, String> skillNames; private final Map<String, String> authors; private final Map<String, String> authorsUrl; private final Map<String, String> devloperPrivacyPolicies; private final Map<String, String> termsOfUse; private final Map<String,Boolean> dynamicContent; if(json.has("description")) this.skillDescriptions.put(intent.getSkill(), json.getString("description")); // skill image if(json.has("image")) this.skillImage.put(intent.getSkill(), json.getString("image")); // adding skill meta data if(json.has("skill_name")) this.skillNames.put(intent.getSkill(), json.getString("skill_name")); if(json.has("author")) this.authors.put(intent.getSkill(), json.getString("author")); The SusiMind class process this json and stores the metadata in a map of skill path and data.This map is used by GetSkillMetadataService class to to list the skill metadata for all the skills given its model, group and language and skill. For adding the servlet we need to inherit the service class from AbstractAPIHandler and implement APIhandler interface.In Susi Server an abstract class AbstractAPIHandler extending HttpServelets and implementing API handler interface is provided. @Override public String getAPIPath() { return "/cms/getSkillMetadata.json"; } The getAPIPath() methods sets the API endpoint path, it gets appended to base path which is 127.0.0.1:4000/cms/getSkillMetadata.json for…