com.textkernel.tx.services

Class SkillsIntelligenceService

java.lang.Object

com.textkernel.tx.services.SkillsIntelligenceService

public class SkillsIntelligenceService
extends Object

See TxClient.skillsIntelligence()

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiEndpoints	_endpoints
protected EnvironmentSettings	_settings

Constructor Summary

Constructors

Constructor and Description
SkillsIntelligenceService(okhttp3.OkHttpClient httpClient, EnvironmentSettings settings) Do not use this.

Method Summary

Modifier and Type	Method and Description
ProfessionsAutoCompleteResponse	autocompleteProfession(String prefix) Returns normalized professions that begin with a given prefix, based on the default language of english.
ProfessionsAutoCompleteResponse	autocompleteProfession(String prefix, List<String> languages, String outputLanguage, int limit) Returns normalized professions that begin with a given prefix, based on the chosen language(s).
AutoCompleteSkillsResponse	autocompleteSkill(String prefix) Returns normalized skills that begin with a given prefix, based on the chosen language(s).
AutoCompleteSkillsResponse	autocompleteSkill(String prefix, List<String> languages, String outputLanguage, List<String> types, int limit) Returns normalized skills that begin with a given prefix, based on the chosen language(s).
CompareProfessionsResponse	compareProfessions(int profession1, int profession2, String outputLanguage) Compare two professions based on the skills associated with each.
CompareSkillsToProfessionResponse	compareSkillsToProfessions(int professionCodeId, String outputLanguage, List<SkillScore> skills) Compare a given set of skills to the skills related to a given profession.
CompareSkillsToProfessionResponse	compareSkillsToProfessions(ParsedResume resume, int professionCodeId, String outputLanguage, boolean weightSkillsByExperience) Compare the skills of a candidate to the skills related to a job using the Ontology API.
protected okhttp3.RequestBody	createJsonBody(Object body)
protected <T extends ApiResponse<?>> HttpResponse<T>	executeRequest(okhttp3.Request apiRequest, Class<T> classOfT, String requestBody)
ExtractSkillsResponse	extractSkills(String text) Extracts known skills from the given text.
ExtractSkillsResponse	extractSkills(String text, String language, String outputLanguage, float threshold) Extracts known skills from the given text.
GenerateJobResponse	generateJobDescription(GenerateJobRequest request) Generates a job description based on specified parameters.
GetProfessionsTaxonomyResponse	getProfessionsTaxonomy() Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
GetProfessionsTaxonomyResponse	getProfessionsTaxonomy(String language, TaxonomyFormat format) Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
GetMetadataResponse	getProfessionsTaxonomyMetadata() Get metadata about the professions taxonomy/service.
GetSkillsTaxonomyResponse	getSkillsTaxonomy() Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
GetSkillsTaxonomyResponse	getSkillsTaxonomy(TaxonomyFormat format) Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
GetMetadataResponse	getSkillsTaxonomyMetadata() Get metadata about the skills taxonomy/service.
LookupProfessionCodesResponse	lookupProfessions(List<Integer> codeIds) Get details for the given professions in the taxonomy.
LookupProfessionCodesResponse	lookupProfessions(List<Integer> codeIds, String outputLanguage) Get details for the given professions in the taxonomy.
LookupSkillCodesResponse	lookupSkills(List<String> skillIds) Get the details associated with given skills in the taxonomy.
LookupSkillCodesResponse	lookupSkills(List<String> skillIds, String outputLanguage) Get the details associated with given skills in the taxonomy.
NormalizeProfessionsResponse	normalizeProfessions(List<String> jobTitles) Normalize the given job titles to the most closely-related professions in the taxonomy.
NormalizeProfessionsResponse	normalizeProfessions(List<String> jobTitles, String language, String outputLanguage) Normalize the given job titles to the most closely-related professions in the taxonomy.
NormalizeSkillsResponse	normalizeSkills(List<String> skills) Normalize the given skills to the most closely-related skills in the taxonomy.
NormalizeSkillsResponse	normalizeSkills(List<String> skills, String language, String outputLanguage) Normalize the given skills to the most closely-related skills in the taxonomy.
protected void	setEnvironment(IndexingOptionsGeneric options)
SkillsSimilarityScoreResponse	skillsSimilarityScore(List<SkillScore> skillSetA, List<SkillScore> skillSetB) Determines how closely related one set of skills is to another.
SuggestProfessionsResponse	suggestProfessionsFromSkills(List<SkillScore> skills, int limit, boolean returnMissingSkills, String outputLanguage) Suggest professions based on a given set of skills.
SuggestProfessionsResponse	suggestProfessionsFromSkills(List<String> skillIds, String outputLanguage) Suggest professions based on a given set of skill IDs.
SuggestProfessionsResponse	suggestProfessionsFromSkills(ParsedJob job) Suggest professions based on the skills within a given job.
SuggestProfessionsResponse	suggestProfessionsFromSkills(ParsedJob job, int limit, boolean returnMissingSkills, String outputLanguage) Suggest professions based on the skills within a given job.
SuggestProfessionsResponse	suggestProfessionsFromSkills(ParsedJob job, String outputLanguage) Suggest professions based on the skills within a given job.
SuggestProfessionsResponse	suggestProfessionsFromSkills(ParsedResume resume) Suggest professions based on the skills within a given resume.
SuggestProfessionsResponse	suggestProfessionsFromSkills(ParsedResume resume, int limit, boolean returnMissingSkills, String outputLanguage, boolean weightSkillsByExperience) Suggest professions based on the skills within a given resume.
SuggestProfessionsResponse	suggestProfessionsFromSkills(ParsedResume resume, String outputLanguage) Suggest professions based on the skills within a given resume.
SuggestSkillsFromJobTitleResponse	suggestSkillsFromJobTitle(String jobTitle) Takes a job title and suggests relevant skills.
SuggestSkillsFromJobTitleResponse	suggestSkillsFromJobTitle(String jobTitle, String language, Integer limit) Takes a job title and suggests relevant skills.
SuggestSkillsResponse	suggestSkillsFromProfessions(List<Integer> professionCodeIds, int limit, String outputLanguage) Suggests skills related to given professions.
SuggestSkillsResponse	suggestSkillsFromProfessions(List<Integer> professionCodeIds, String outputLanguage) Suggests skills related to given professions.
SuggestSkillsResponse	suggestSkillsFromProfessions(ParsedJob job) Suggests skills related to a job based on the profession title in the job.
SuggestSkillsResponse	suggestSkillsFromProfessions(ParsedJob job, String outputLanguage) Suggests skills related to a job based on the profession title in the job.
SuggestSkillsResponse	suggestSkillsFromProfessions(ParsedResume resume) Suggests skills related to a resume based on the recent professions in the resume.
SuggestSkillsResponse	suggestSkillsFromProfessions(ParsedResume resume, String outputLanguage) Suggests skills related to a resume based on the recent professions in the resume.
SuggestSkillsResponse	suggestSkillsFromSkills(List<SkillScore> skills, int limit, String outputLanguage) Returns skills related to a given skill or set of skills.
SuggestSkillsResponse	suggestSkillsFromSkills(List<String> skillIds, String outputLanguage) Returns skills related to a given skill or set of skills.
SuggestSkillsResponse	suggestSkillsFromSkills(ParsedJob job, int limit, String outputLanguage) Suggests skills related to a job (but not in the job) based on the skills in the job.
SuggestSkillsResponse	suggestSkillsFromSkills(ParsedJob job, String outputLanguage) Suggests skills related to a job (but not in the job) based on the skills in the job.
SuggestSkillsResponse	suggestSkillsFromSkills(ParsedResume resume, int limit, String outputLanguage, boolean weightSkillsByExperience) Suggests skills related to a resume (but not in the resume) based on the skills in the resume.
SuggestSkillsResponse	suggestSkillsFromSkills(ParsedResume resume, String outputLanguage) Suggests skills related to a resume (but not in the resume) based on the skills in the resume.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_settings

protected final EnvironmentSettings _settings

_endpoints

protected final ApiEndpoints _endpoints

Constructor Detail

SkillsIntelligenceService

public SkillsIntelligenceService(okhttp3.OkHttpClient httpClient,
                                 EnvironmentSettings settings)

Do not use this. See TxClient.skillsIntelligence()

Parameters:

httpClient - The http client for API calls

settings - environment settings

Method Detail

getSkillsTaxonomy

public GetSkillsTaxonomyResponse getSkillsTaxonomy(TaxonomyFormat format)
                                            throws TxException

Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.

Parameters:

format - The format of the returned taxonomy.
NOTE: if you set this to TaxonomyFormat.csv, only the Taxonomy.CsvOutput will be populated.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

getSkillsTaxonomy

public GetSkillsTaxonomyResponse getSkillsTaxonomy()
                                            throws TxException

Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

getSkillsTaxonomyMetadata

public GetMetadataResponse getSkillsTaxonomyMetadata()
                                              throws TxException

Get metadata about the skills taxonomy/service.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

autocompleteSkill

public AutoCompleteSkillsResponse autocompleteSkill(String prefix,
                                                    List<String> languages,
                                                    String outputLanguage,
                                                    List<String> types,
                                                    int limit)
                                             throws TxException

Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.

Parameters:

prefix - The skill prefix to be completed. Must contain at least 1 character.

languages - The language(s) used to search for matching skills (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
Default is 'en' only.

outputLanguage - The language to ouput the found skill descriptions in (default is 'en'). Must be one of the supported ISO codes.

types - If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, All.

limit - The maximum number of returned skills. The default is 10 and the maximum is 100.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

autocompleteSkill

public AutoCompleteSkillsResponse autocompleteSkill(String prefix)
                                             throws TxException

Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.

Parameters:

prefix - The skill prefix to be completed. Must contain at least 1 character.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

lookupSkills

public LookupSkillCodesResponse lookupSkills(List<String> skillIds,
                                             String outputLanguage)
                                      throws TxException

Get the details associated with given skills in the taxonomy.

Parameters:

skillIds - The IDs of the skills to get details about. A maximum of 100 IDs can be requested.

outputLanguage - The language to use for the output skill descriptions. If not provided, defaults to en. If specified, must be one of the supported ISO codes.
Default is 'en'.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

lookupSkills

public LookupSkillCodesResponse lookupSkills(List<String> skillIds)
                                      throws TxException

Get the details associated with given skills in the taxonomy.

Parameters:

skillIds - The IDs of the skills to get details about. A maximum of 100 IDs can be requested.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

normalizeSkills

public NormalizeSkillsResponse normalizeSkills(List<String> skills,
                                               String language,
                                               String outputLanguage)
                                        throws TxException

Normalize the given skills to the most closely-related skills in the taxonomy.

Parameters:

skills - The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).

language - The language of the given skills. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage - The language to use for the output skill descriptions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

normalizeSkills

public NormalizeSkillsResponse normalizeSkills(List<String> skills)
                                        throws TxException

Normalize the given skills to the most closely-related skills in the taxonomy.

Parameters:

skills - The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

extractSkills

public ExtractSkillsResponse extractSkills(String text,
                                           String language,
                                           String outputLanguage,
                                           float threshold)
                                    throws TxException

Extracts known skills from the given text.

Parameters:

text - The text to extract skills from. There is a 24,000 character limit.

language - The language of the input text. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage - The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes.

threshold - A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

extractSkills

public ExtractSkillsResponse extractSkills(String text)
                                    throws TxException

Extracts known skills from the given text.

Parameters:

text - The text to extract skills from. There is a 24,000 character limit.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

getProfessionsTaxonomy

public GetProfessionsTaxonomyResponse getProfessionsTaxonomy(String language,
                                                             TaxonomyFormat format)
                                                      throws TxException

Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.

Parameters:

language - The language parameter returns the taxonomy with descriptions only in that specified language. If not specified, descriptions in all languages are returned. Must be specified as one of the supported ISO codes.

format - The format of the returned taxonomy.
NOTE: if you set this to TaxonomyFormat.csv, only the Taxonomy.CsvOutput will be populated.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

getProfessionsTaxonomy

public GetProfessionsTaxonomyResponse getProfessionsTaxonomy()
                                                      throws TxException

Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

getProfessionsTaxonomyMetadata

public GetMetadataResponse getProfessionsTaxonomyMetadata()
                                                   throws TxException

Get metadata about the professions taxonomy/service.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

autocompleteProfession

public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix,
                                                              List<String> languages,
                                                              String outputLanguage,
                                                              int limit)
                                                       throws TxException

Returns normalized professions that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.

Parameters:

prefix - The job title prefix to be completed. Must contain at least 1 character.

languages - The language(s) used to search for matching professions (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes. Default is 'en' only.

outputLanguage - The language to ouput the found professions in (default is 'en'). Must be one of the supported ISO codes.

limit - The maximum number of returned professions. The default is 10 and the maximum is 100.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

autocompleteProfession

public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix)
                                                       throws TxException

Returns normalized professions that begin with a given prefix, based on the default language of english. Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.

Parameters:

prefix - The job title prefix to be completed. Must contain at least 1 character.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

normalizeProfessions

public NormalizeProfessionsResponse normalizeProfessions(List<String> jobTitles,
                                                         String language,
                                                         String outputLanguage)
                                                  throws TxException

Normalize the given job titles to the most closely-related professions in the taxonomy.

Parameters:

jobTitles - The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).

language - The language of the input job titles. Must be one of the supported ISO codes.
Default is 'en'.

outputLanguage - The language to use for descriptions of the returned normalized professions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

normalizeProfessions

public NormalizeProfessionsResponse normalizeProfessions(List<String> jobTitles)
                                                  throws TxException

Normalize the given job titles to the most closely-related professions in the taxonomy.

Parameters:

jobTitles - The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

lookupProfessions

public LookupProfessionCodesResponse lookupProfessions(List<Integer> codeIds,
                                                       String outputLanguage)
                                                throws TxException

Get details for the given professions in the taxonomy.

Parameters:

codeIds - The profession code IDs to get details about from the Professions Taxonomy.

outputLanguage - The language to use for professions descriptions (default is en). Must be an allowed ISO code.
Default is 'en'.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

lookupProfessions

public LookupProfessionCodesResponse lookupProfessions(List<Integer> codeIds)
                                                throws TxException

Get details for the given professions in the taxonomy.

Parameters:

codeIds - The profession code IDs to get details about from the Professions Taxonomy.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

compareProfessions

public CompareProfessionsResponse compareProfessions(int profession1,
                                                     int profession2,
                                                     String outputLanguage)
                                              throws TxException

Compare two professions based on the skills associated with each.

Parameters:

profession1 - A profession code ID from the Professions Taxonomy to compare.

profession2 - A profession code ID from the Professions Taxonomy to compare.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

compareSkillsToProfessions

public CompareSkillsToProfessionResponse compareSkillsToProfessions(int professionCodeId,
                                                                    String outputLanguage,
                                                                    List<SkillScore> skills)
                                                             throws TxException

Compare a given set of skills to the skills related to a given profession.

Parameters:

professionCodeId - The profession code ID from the Professions Taxonomy to compare the skill set to.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

skills - The skills which should be compared against the given profession. The list can contain up to 50 skills.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

compareSkillsToProfessions

public CompareSkillsToProfessionResponse compareSkillsToProfessions(ParsedResume resume,
                                                                    int professionCodeId,
                                                                    String outputLanguage,
                                                                    boolean weightSkillsByExperience)
                                                             throws TxException

Compare the skills of a candidate to the skills related to a job using the Ontology API.

Parameters:

resume - The resume containing the skills of the candidate

professionCodeId - The profession code ID from the Professions Taxonomy to compare the skill set to.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

weightSkillsByExperience - Whether or not to give a higher weight to skills that the candidate has more experience with.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromProfessions

public SuggestSkillsResponse suggestSkillsFromProfessions(List<Integer> professionCodeIds,
                                                          int limit,
                                                          String outputLanguage)
                                                   throws TxException

Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.

Parameters:

professionCodeIds - The code IDs of the professions to suggest skills for.

limit - The maximum amount of suggested skills returned. If not sure what value should be, provide 10 as default limit.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromProfessions

public SuggestSkillsResponse suggestSkillsFromProfessions(List<Integer> professionCodeIds,
                                                          String outputLanguage)
                                                   throws TxException

Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.

Parameters:

professionCodeIds - The code IDs of the professions to suggest skills for.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromProfessions

public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedResume resume,
                                                          String outputLanguage)
                                                   throws TxException

Suggests skills related to a resume based on the recent professions in the resume.

Parameters:

resume - The resume to suggest skills for (based on the professions in the resume).

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromProfessions

public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedResume resume)
                                                   throws TxException

Suggests skills related to a resume based on the recent professions in the resume.

Parameters:

resume - The resume to suggest skills for (based on the professions in the resume).

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromProfessions

public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job,
                                                          String outputLanguage)
                                                   throws TxException

Suggests skills related to a job based on the profession title in the job.

Parameters:

job - The resume to suggest skills for (based on the professions in the resume).

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromProfessions

public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job)
                                                   throws TxException

Suggests skills related to a job based on the profession title in the job.

Parameters:

job - The resume to suggest skills for (based on the professions in the resume).

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestProfessionsFromSkills

public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume,
                                                               int limit,
                                                               boolean returnMissingSkills,
                                                               String outputLanguage,
                                                               boolean weightSkillsByExperience)
                                                        throws TxException

Suggest professions based on the skills within a given resume.

Parameters:

resume - The professions are suggested based on the skills within this resume.

limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.

returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

weightSkillsByExperience - Whether or not to give a higher weight to skills that the candidate has more experience with.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestProfessionsFromSkills

public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume,
                                                               String outputLanguage)
                                                        throws TxException

Suggest professions based on the skills within a given resume.

Parameters:

resume - The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestProfessionsFromSkills

public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume)
                                                        throws TxException

Suggest professions based on the skills within a given resume.

Parameters:

resume - The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestProfessionsFromSkills

public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job,
                                                               int limit,
                                                               boolean returnMissingSkills,
                                                               String outputLanguage)
                                                        throws TxException

Suggest professions based on the skills within a given job.

Parameters:

job - The professions are suggested based on the skills within this job.

limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.

returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestProfessionsFromSkills

public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job,
                                                               String outputLanguage)
                                                        throws TxException

Suggest professions based on the skills within a given job.

Parameters:

job - The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestProfessionsFromSkills

public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job)
                                                        throws TxException

Suggest professions based on the skills within a given job.

Parameters:

job - The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestProfessionsFromSkills

public SuggestProfessionsResponse suggestProfessionsFromSkills(List<SkillScore> skills,
                                                               int limit,
                                                               boolean returnMissingSkills,
                                                               String outputLanguage)
                                                        throws TxException

Suggest professions based on a given set of skills.

Parameters:

skills - The skills used to return the most relevant professions. The list can contain up to 50 skills.

limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.

returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestProfessionsFromSkills

public SuggestProfessionsResponse suggestProfessionsFromSkills(List<String> skillIds,
                                                               String outputLanguage)
                                                        throws TxException

Suggest professions based on a given set of skill IDs.

Parameters:

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.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromSkills

public SuggestSkillsResponse suggestSkillsFromSkills(List<SkillScore> skills,
                                                     int limit,
                                                     String outputLanguage)
                                              throws TxException

Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.

Parameters:

skills - The skills (and optionally, scores) for which the service should return related skills. The list can contain up to 50 skills.

limit - The maximum amount of suggested skills returned. The maximum is 25.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromSkills

public SuggestSkillsResponse suggestSkillsFromSkills(List<String> skillIds,
                                                     String outputLanguage)
                                              throws TxException

Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.

Parameters:

skillIds - The skill IDs for which the service should return related skills. The list can contain up to 50 skills.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromSkills

public SuggestSkillsResponse suggestSkillsFromSkills(ParsedJob job,
                                                     int limit,
                                                     String outputLanguage)
                                              throws TxException

Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.

Parameters:

job - The job to suggest skills for (based on the skills in the job).

limit - The maximum amount of suggested skills returned. The maximum is 25.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromSkills

public SuggestSkillsResponse suggestSkillsFromSkills(ParsedJob job,
                                                     String outputLanguage)
                                              throws TxException

Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.

Parameters:

job - The job to suggest skills for (based on the skills in the job).

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromSkills

public SuggestSkillsResponse suggestSkillsFromSkills(ParsedResume resume,
                                                     int limit,
                                                     String outputLanguage,
                                                     boolean weightSkillsByExperience)
                                              throws TxException

Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.

Parameters:

resume - The resume to suggest skills for (based on the skills in the resume).

limit - The maximum amount of suggested skills returned. The maximum is 25.

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

weightSkillsByExperience - Whether or not to give a higher weight to skills that the candidate has more experience with.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromSkills

public SuggestSkillsResponse suggestSkillsFromSkills(ParsedResume resume,
                                                     String outputLanguage)
                                              throws TxException

Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.

Parameters:

resume - The resume to suggest skills for (based on the skills in the resume).

outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

skillsSimilarityScore

public SkillsSimilarityScoreResponse skillsSimilarityScore(List<SkillScore> skillSetA,
                                                           List<SkillScore> skillSetB)
                                                    throws TxException

Determines how closely related one set of skills is to another. The service defines closely related skills such that knowing a skill either implies knowledge about another skill, or should make it considerably easier to acquire knowledge about that skill.

Parameters:

skillSetA - A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.

skillSetB - A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

generateJobDescription

public GenerateJobResponse generateJobDescription(GenerateJobRequest request)
                                           throws TxException

Generates a job description based on specified parameters.

Parameters:

request - The request body

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromJobTitle

public SuggestSkillsFromJobTitleResponse suggestSkillsFromJobTitle(String jobTitle,
                                                                   String language,
                                                                   Integer limit)
                                                            throws TxException

Takes a job title and suggests relevant skills.

Parameters:

jobTitle - The title of the job for which skills are being suggested.

language - Language of the suggested skills in ISO 639-1 code format.

limit - Maximum number of skills to suggest. If not specified this parameter defaults to 10. This value cannot exceed 50.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

suggestSkillsFromJobTitle

public SuggestSkillsFromJobTitleResponse suggestSkillsFromJobTitle(String jobTitle)
                                                            throws TxException

Takes a job title and suggests relevant skills.

Parameters:

jobTitle - The title of the job for which skills are being suggested.

Returns:

The API response body

Throws:

TxException - Thrown when an API error occurs

setEnvironment

protected void setEnvironment(IndexingOptionsGeneric options)

createJsonBody

protected okhttp3.RequestBody createJsonBody(Object body)

executeRequest

protected <T extends ApiResponse<?>> HttpResponse<T> executeRequest(okhttp3.Request apiRequest,
                                                                    Class<T> classOfT,
                                                                    String requestBody)
                                                             throws TxException

Throws:

TxException