updates for SuggestProfessionsFromSkills

Author: JW Wesson

src/main/java/com/sovren/SovrenClient.java

@@ -73,11 +73,11 @@
 import java.io.IOException;
 import java.time.Instant;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Collectors;
 
 /**
  * The SDK client to perform Sovren API calls.
@@ -1616,14 +1616,13 @@ public CompareProfessionsResponse compareProfessions(int profession1, int profes
      * @return The API response body
      * @throws SovrenException Thrown when an API error occurs
      */
-    public CompareSkillsToProfessionResponse compareSkillsToProfessions(int professionCodeId, String outputLanguage, SkillScore... skills) throws SovrenException {
+    public CompareSkillsToProfessionResponse compareSkillsToProfessions(int professionCodeId, String outputLanguage, List<SkillScore> skills) throws SovrenException {
         CompareSkillsToProfessionRequest request = new CompareSkillsToProfessionRequest();
         request.Skills = new ArrayList<SkillScore>();
-        List<SkillScore> newList = Arrays.asList(skills);
-        int amountOfSkills = newList.size() > 50 ? 50 : newList.size();
+        int amountOfSkills = skills.size() > 50 ? 50 : skills.size();
 
         for(int i = 0; i < amountOfSkills; i++) {
-            request.Skills.add(newList.get(i));
+            request.Skills.add(skills.get(i));
         };
         request.ProfessionCodeId = professionCodeId;
         request.OutputLanguage = outputLanguage;
@@ -1643,7 +1642,7 @@ public CompareSkillsToProfessionResponse compareSkillsToProfessions(int professi
      * @param resume The resume containing the skills of the candidate
      * @param professionCodeId The profession code ID from the <a href="https://sovren.com/technical-specs/latest/rest-api/data-enrichment/overview/#professions-taxonomies">Professions Taxonomy</a> to compare the skill set to.
      * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported <a href="https://sovren.com/technical-specs/latest/rest-api/data-enrichment/overview/#skills-languages">ISO code</a>
-     * @param weightSkillsByExperience The language to use for the returned descriptions.
+     * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with.
      * @return The API response body
      * @throws SovrenException Thrown when an API error occurs
      */
@@ -1653,23 +1652,7 @@ public CompareSkillsToProfessionResponse compareSkillsToProfessions(
         String outputLanguage,
         boolean weightSkillsByExperience) throws SovrenException {
         if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){
-            SkillScore[] skills = new SkillScore[resume.Skills.Normalized.size()];
-
-            ResumeNormalizedSkill maxExperienceSkill = Collections.max(resume.Skills.Normalized, Comparator.comparing(s -> s.MonthsExperience != null ? s.MonthsExperience.Value : 0));
-            Integer maxExperience = Optional.ofNullable(maxExperienceSkill).map(s -> s.MonthsExperience).map(e -> e.Value).orElse(0);
-
-            for(int i = 0; i < resume.Skills.Normalized.size(); i++) {
-                SkillScore curSkill = new SkillScore();
-                ResumeNormalizedSkill curSkillOrig = resume.Skills.Normalized.get(i);
-                curSkill.Id = curSkillOrig.Id;
-
-                int curMonthsExperience = Optional.ofNullable(curSkillOrig.MonthsExperience).map(e -> e.Value).orElse(0);
-                curSkill.Score = (weightSkillsByExperience && maxExperience > 0) ? curMonthsExperience / (float)maxExperience : 1; 
-
-                skills[i] = curSkill;
-            }
-
-            return compareSkillsToProfessions(professionCodeId, outputLanguage, skills);
+            return compareSkillsToProfessions(professionCodeId, outputLanguage, getNormalizedSkillsFromResume(resume, weightSkillsByExperience));
         }
         throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled");
     }
@@ -1769,80 +1752,132 @@ public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job) throws
         return suggestSkillsFromProfessions(job, null);
     }
 
+    private List<SkillScore> getNormalizedSkillsFromResume(ParsedResume resume, boolean weightSkillsByExperience) {
+        if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){
+            List<SkillScore> skills = new ArrayList<SkillScore>();
+
+            ResumeNormalizedSkill maxExperienceSkill = Collections.max(resume.Skills.Normalized, Comparator.comparing(s -> s.MonthsExperience != null ? s.MonthsExperience.Value : 0));
+            Integer maxExperience = Optional.ofNullable(maxExperienceSkill).map(s -> s.MonthsExperience).map(e -> e.Value).orElse(0);
+
+            for(int i = 0; i < resume.Skills.Normalized.size(); i++) {
+                ResumeNormalizedSkill curSkill = resume.Skills.Normalized.get(i);
+                SkillScore newSkill = new SkillScore(curSkill.Id);
+                int curMonthsExperience = Optional.ofNullable(curSkill.MonthsExperience).map(e -> e.Value).orElse(0);
+                newSkill.Score = (weightSkillsByExperience && maxExperience > 0) ? curMonthsExperience / (float)maxExperience : 1; 
+
+                skills.add(newSkill);
+            }
+
+            return skills;
+        }
+        throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled.");
+    }
+
     /**
      * Suggest professions based on the <b>skills</b> within a given resume.
      * @param resume The professions are suggested based on the <b>skills</b> within this resume.
      * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
      * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession.
+     * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported <a href="https://sovren.com/technical-specs/latest/rest-api/data-enrichment/overview/#professions-languages">ISO code</a>
+     * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with.
      * @return The API response body
      * @throws SovrenException Thrown when an API error occurs
      */
-    public SuggestProfessionsResponse suggestProfessions(ParsedResume resume, int limit, boolean returnMissingSkills) throws SovrenException {
+    public SuggestProfessionsResponse suggestProfessionsFromSkills(
+        ParsedResume resume,
+        int limit,
+        boolean returnMissingSkills,
+        String outputLanguage,
+        boolean weightSkillsByExperience) throws SovrenException {
         if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){
-            List<String> ids = new ArrayList<String>();
-            for(ResumeNormalizedSkill skill: resume.Skills.Normalized){
-                ids.add(skill.Id);   
-            } 
-
-            return suggestProfessions(ids,limit,returnMissingSkills);
+            return suggestProfessionsFromSkills(getNormalizedSkillsFromResume(resume, weightSkillsByExperience), limit, returnMissingSkills, outputLanguage);
         }
         throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled.");
     }
 
+    /**
+     * Suggest professions based on the <b>skills</b> within a given resume.
+     * @param resume The professions are suggested based on the <b>skills</b> within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
+     * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported <a href="https://sovren.com/technical-specs/latest/rest-api/data-enrichment/overview/#professions-languages">ISO code</a>
+     * @return The API response body
+     * @throws SovrenException Thrown when an API error occurs
+     */
+    public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume, String outputLanguage) throws SovrenException {
+        return suggestProfessionsFromSkills(resume, 10, false, outputLanguage, true);
+    }
+
     /**
      * Suggest professions based on the <b>skills</b> within a given resume.
      * @param resume The professions are suggested based on the <b>skills</b> within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
      * @return The API response body
      * @throws SovrenException Thrown when an API error occurs
      */
-    public SuggestProfessionsResponse suggestProfessions(ParsedResume resume) throws SovrenException {
-        return suggestProfessions(resume,10,false);
+    public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume) throws SovrenException {
+        return suggestProfessionsFromSkills(resume, null);
     }
 
     /**
      * Suggest professions based on the <b>skills</b> within a given job.
      * @param job The professions are suggested based on the <b>skills</b> within this job.
      * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
      * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession.
+     * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported <a href="https://sovren.com/technical-specs/latest/rest-api/data-enrichment/overview/#professions-languages">ISO code</a>
      * @return The API response body
      * @throws SovrenException Thrown when an API error occurs
      */
-    public SuggestProfessionsResponse suggestProfessions(ParsedJob job, int limit, boolean returnMissingSkills) throws SovrenException {
+    public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job, int limit, boolean returnMissingSkills, String outputLanguage) throws SovrenException {
         if(job != null && job.Skills != null && job.Skills.Normalized != null && job.Skills.Normalized.size() > 0){
-            List<String> ids = new ArrayList<String>();
+            List<SkillScore> skills = new ArrayList<SkillScore>();
             int amountOfSkills = job.Skills.Normalized.size() > 50 ? 50 : job.Skills.Normalized.size();
             for(int i = 0; i < amountOfSkills; i++) {
-                ids.add(job.Skills.Normalized.get(i).Id);
+                skills.add(new SkillScore(job.Skills.Normalized.get(i).Id));
             }
 
-            return suggestProfessions(ids,limit,returnMissingSkills);
+            return suggestProfessionsFromSkills(skills, limit, returnMissingSkills, outputLanguage);
         }
         throw new IllegalArgumentException("The job must be parsed with V2 skills selected, and with skills normalization enabled");
     }
 
     /**
      * Suggest professions based on the <b>skills</b> within a given job.
      * @param job The professions are suggested based on the <b>skills</b> within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
+     * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported <a href="https://sovren.com/technical-specs/latest/rest-api/data-enrichment/overview/#professions-languages">ISO code</a>
      * @return The API response body
      * @throws SovrenException Thrown when an API error occurs
      */
-    public SuggestProfessionsResponse suggestProfessions(ParsedJob job) throws SovrenException {
-        return suggestProfessions(job,10,false);
+    public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job, String outputLanguage) throws SovrenException {
+        return suggestProfessionsFromSkills(job, 10, false, outputLanguage);
     }
 
     /**
-     * Suggest professions based on a given set of skill IDs.
-     * @param skillIds The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs.
+     * Suggest professions based on the <b>skills</b> within a given job.
+     * @param job The professions are suggested based on the <b>skills</b> within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
+     * @return The API response body
+     * @throws SovrenException Thrown when an API error occurs
+     */
+    public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job) throws SovrenException {
+        return suggestProfessionsFromSkills(job, null);
+    }
+
+    /**
+     * Suggest professions based on a given set of skills.
+     * @param skillIds The skills used to return the most relevant professions. The list can contain up to 50 skills.
      * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
      * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession.
+     * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported <a href="https://sovren.com/technical-specs/latest/rest-api/data-enrichment/overview/#professions-languages">ISO code</a>
      * @return The API response body
      * @throws SovrenException Thrown when an API error occurs
      */
-    public SuggestProfessionsResponse suggestProfessions(List<String> skillIds, int limit, boolean returnMissingSkills) throws SovrenException {
+    public SuggestProfessionsResponse suggestProfessionsFromSkills(
+        List<SkillScore> skills,
+        int limit,
+        boolean returnMissingSkills,
+        String outputLanguage) throws SovrenException {
         SuggestProfessionsRequest request = new SuggestProfessionsRequest();
-        request.SkillIds = skillIds;
+        request.Skills = skills;
         request.Limit = limit;
         request.ReturnMissingSkills = returnMissingSkills;
+        request.OutputLanguage = outputLanguage;
 
         RequestBody body = createJsonBody(request);
         Request apiRequest = new Request.Builder()
@@ -1857,10 +1892,14 @@ public SuggestProfessionsResponse suggestProfessions(List<String> skillIds, int
     /**
      * Suggest professions based on a given set of skill IDs.
      * @param skillIds The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
+     * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported <a href="https://sovren.com/technical-specs/latest/rest-api/data-enrichment/overview/#professions-languages">ISO code</a>
      * @return The API response body
      * @throws SovrenException Thrown when an API error occurs
      */
-    public SuggestProfessionsResponse suggestProfessions(List<String> skillIds) throws SovrenException {
-        return suggestProfessions(skillIds,10,false);
+    public SuggestProfessionsResponse suggestProfessionsFromSkills(List<String> skillIds, String outputLanguage) throws SovrenException {
+        List<SkillScore> skills = skillIds.stream()
+            .map(s -> new SkillScore(s))
+            .collect(Collectors.toList());
+        return suggestProfessionsFromSkills(skills, 10, false, outputLanguage);
     }
 }

src/main/java/com/sovren/models/api/dataenrichment/ontology/request/SuggestProfessionsRequest.java

@@ -7,10 +7,12 @@
 
 import java.util.List;
 
+import com.sovren.models.api.dataenrichment.ontology.response.SkillScore;
+
 /** Request body for a 'SuggestProfessions' request  */
 public class SuggestProfessionsRequest {
-    /** The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs. */
-    public List<String> SkillIds;
+    /** The skills used to return the most relevant professions. The list can contain up to 50 skills. */
+    public List<SkillScore> Skills;
     /** Flag to enable returning a list of missing skills per suggested profession. */
     public boolean ReturnMissingSkills = false;
     /** The maximum amount of professions returned. If not specified this parameter defaults to 10. */

src/main/java/com/sovren/models/api/dataenrichment/ontology/response/SkillScore.java

@@ -13,4 +13,9 @@ public class SkillScore {
     public String Id;
     /** The description of the skill in the Skills Taxonomy. Will only be returned if OutputLanguage is specified in the request. This has no effect in a request body. */
     public String Description;
+
+    public SkillScore() {}
+    public SkillScore(String id) {
+        Id = id;
+    }
 }

src/test/java/com/sovren/integration/DataEnrichmentServiceTests.java

@@ -14,6 +14,7 @@
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 
 import java.util.ArrayList;
+import java.util.List;
 
 public class DataEnrichmentServiceTests extends TestBase {
     @Test
@@ -117,13 +118,11 @@ public void testCompareProfessions() {
     @Test
     public void testCompareSkillsToProfessions() {
         assertDoesNotThrow(() -> {
-            SkillScore s1 = new SkillScore();
-            SkillScore s2 = new SkillScore();
+            List<SkillScore> skills = new ArrayList<SkillScore>();
+            skills.add(new SkillScore("KS120076FGP5WGWYMP0F"));
+            skills.add(new SkillScore("KS04UWLJBN9X1M3N0PZ4"));
 
-            s1.Id = "KS120076FGP5WGWYMP0F";
-            s2.Id = "KS04UWLJBN9X1M3N0PZ4";
-
-            Client.compareSkillsToProfessions(696, "en", s1, s2);
+            Client.compareSkillsToProfessions(696, "en", skills);
         });
     }
 
@@ -132,7 +131,7 @@ public void testSuggestSkillsFromProfessions() {
         assertDoesNotThrow(() -> {
             ArrayList<Integer> professionCodeIds = new ArrayList<Integer>();
             professionCodeIds.add(696);
-            Client.suggestSkillsFromProfessions(professionCodeIds, 10);
+            Client.suggestSkillsFromProfessions(professionCodeIds, 10, null);
         });
     }
 
@@ -143,7 +142,7 @@ public void testSuggestProfessions() {
             skillIds.add("KS120076FGP5WGWYMP0F");
             skillIds.add("KS125HH5XDBPZT3RFGZZ");
             skillIds.add("KS124PR62MV42B5C9S9F");
-            Client.suggestProfessions((skillIds));
+            Client.suggestProfessionsFromSkills(skillIds, null);
         });
     }
 }